Share

ModelSurfaceTextureSymbolDefinition Object


Description

ModelSurfaceTextureSymbolDefinition Object.

Methods

Name Description
AddLeader Method that adds a leader branch with the input points. This is the equivalent of the 'Add Leader' command in the user interface. This method will succeed only if the HasRootNode property returns False (i.e. there are no existing leader segments). If there are existing leader segments, you should use the ModelLeaderNode.AddLeader method instead.
Copy Method that creates a copy of this ModelSurfaceTextureSymbolDefinition object. The new ModelSurfaceTextureSymbolDefinition object is independent of any surface texture symbols. It can edited and used as input to edit an existing surface texture symbol or to create a new surface texture symbol.

Properties

Name Description
AdditionalProductionMethod Read-write property that gets and sets an additional tail for the production method if the drafting standard is based on ISO or DIN. Setting this property will return an error if the ProductionMethod property is not specified. Denoted by B' in the surface tex.
AdditionalRoughness Read-write property that gets and sets the roughness value other than Ra or the parameter value other than Ra. For ANSI, this property can also be used to specify the waviness height. Denoted by F in the surface texture symbol dialog.
AdditionalSamplingLength Read-write property that gets and sets the following: (1)the roughness cutoff or sampling length for additional roughness value for ANSI (2)the sampling length for additional roughness value for ISO or DIN (3)the reference length and evaluation length for JIS.
AllAroundSymbol Read-write property that gets and sets whether to add the all-around indicator to the symbol.
AllLeafNodes Read-only that returns a flat collection of all the leaf nodes in the leader tree. This property will return Nothing if the HasRootNode property returns False.
AllNodes Read-only that returns a flat collection of all the nodes in the leader tree. This property will return Nothing if the HasRootNode property returns False.
AnnotationPlane Read-write property that gets and sets the annotation plane for the symbol.
AnnotationPlaneDefinition Read-write property that gets and sets the annotation plane definition for the symbol.
Application Gets the root Application object. Where the property is weakly-typed, it can be set to (QueryInterfaced for) 'Application' when running with Inventor whereas, 'ApprenticeServer' when running with the Apprentice Server.
Faces Gets or sets the faces the surface texture symbol is associative with.
HasRootNode Read-only property that returns if a root node exists for this leader. If False, there are no leader segments associated with this leader and the RootNode property will return Nothing.
Intent Read-write property that gets and sets the geometric entity the note is attached to.
IsForceTailShown Read-write property that gets and sets whether a tail is added to the symbol.
IsMajority Read-write property that gets and sets whether this symbol specifies the standard surface characteristics for the component.
LayDirection Read-write property that gets and sets the direction of lay. Setting this property will return an error if the SurfaceTextureType is specified to be kMaterialRemovalProhibitedSurfaceType. Denoted by D in the surface texture symbol dialog.
Leader Read-only property that returns the leader associated with the leader note.
MachiningAllowance Read-write property that gets and sets the machining allowance. Setting this property will return an error if the SurfaceTextureType is not kMaterialRemovalRequiredSurfaceType. Denoted by E in the surface texture symbol dialog.
ManufacturingProcess Gets and sets the manufacturing process.
MaximumRoughness Read-write property that gets and sets the roughness value, roughness value Ra maximum, maximum roughness value, or grade number. Denoted by A' in the surface texture symbol dialog.
MinimumRoughness Read-write property that gets and sets the roughness value, roughness value Ra minimum, minimum roughness value, or grade number. Setting this property will return an error if the MaximumRoughness property is not specified. Denoted by A in the surface texture.
NumberOfFeatureElements Gets and sets the number of feature elements.
Parent Gets the parent object from whom this object can logically be reached.
Position Gets and sets the position of the symbol on the model.
ProductionMethod Read-write property that gets and sets the production method, treatment, or coating. If the active drafting standard is based on ANSI, this property can be used to specify a note callout. Denoted by B in the surface texture symbol dialog.
ProfileDirection Gets and sets the profile direction relative to primary surface lay direction.
RootNode Read-only property that returns the root node of this leader. This property will return Nothing if the HasRootNode property returns False.
SamplingLength Read-write property that gets and sets the following: (1)the roughness cutoff or sampling length for roughness average for ANSI (2)the waviness height or sampling length for ISO or DIN (3)the cutoff value and evaluation length for JIS.
StandardReference Returns the standard reference type.
SurfaceProfileLowerTolerance Gets and sets the surface profile lower tolerance.
SurfaceProfileUpperTolerance Gets and sets the surface profile upper tolerance.
SurfaceTextureType Read-write property that gets and sets the surface type for the symbol. Possible values kBasicSurfaceType, kMaterialRemovalRequiredSurfaceType and kMaterialRemovalProhibitedSurfaceType.
SurfaceWaviness Read-write property that gets and sets the surface waviness for JIS, or general comments for BSI. This property is ignored for ANSI, ISO, or DIN standards. Denoted by F' or G in the surface texture symbol dialog.
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

ModelGeneralNotes.CreateEmbeddedSurfaceTextureSymbolDefinition, ModelSurfaceTextureSymbol.Definition, ModelSurfaceTextureSymbolDefinition.Copy, ModelSurfaceTextureSymbolProxy.Definition, ModelSurfaceTextureSymbols.CreateDefinition

Version

Introduced in version 2018

Was this information helpful?