Component3DTextureBuilder Class Reference
Last update: 16.07.2025Represents a 3D Texture component Builder. More...
Static Public Attributes | |
| str | AxisSystem = property(fget=__GetAxisSystem) |
| Gets the axis system. | |
| str | BooleanOperation = property(fget=__GetBooleanOperation, fset=__SetBooleanOperation) |
| Gets or sets the boolean operation. | |
| str | CircularMappingAreaRadius = property(fget=__GetCircularMappingAreaRadius, fset=__SetCircularMappingAreaRadius) |
| Gets or sets the mapping area radius for circular mapping. | |
| str | CircularRadialDistance = property(fget=__GetCircularRadialDistance, fset=__SetCircularRadialDistance) |
| Gets or sets the radial distance for circular mapping. | |
| str | CircularRingsDistance = property(fget=__GetCircularRingsDistance, fset=__SetCircularRingsDistance) |
| Gets or sets the distance between two rings for circular mapping. | |
| str | CircularXAngle = property(fget=__GetCircularXAngle, fset=__SetCircularXAngle) |
| Gets or sets the angle for circular mapping. | |
| str | EndIndex = property(fget=__GetEndIndex, fset=__SetEndIndex) |
| Gets or sets the end index. | |
| str | FeatureToPattern = property(fget=__GetFeatureToPattern, fset=__SetFeatureToPattern) |
| Gets or sets the pattern geometry. | |
| str | FilterSurface = property(fget=__GetFilterSurface, fset=__SetFilterSurface) |
| Gets or sets the filter surface. | |
| str | GlobaleScale = property(fget=__GetGlobaleScale, fset=__SetGlobaleScale) |
| Gets or sets the global scale of the pattern. | |
| str | HexagonalCentersDistance = property(fget=__GetHexagonalCentersDistance, fset=__SetHexagonalCentersDistance) |
| Gets or sets the hexagon distance between centers for hexagonal mapping. | |
| str | HexagonalCentralPoint = property(fget=__GetHexagonalCentralPoint, fset=__SetHexagonalCentralPoint) |
| Gets or sets the central point property for hexagonal mapping. | |
| str | HexagonalEdgeLength = property(fget=__GetHexagonalEdgeLength, fset=__SetHexagonalEdgeLength) |
| Gets or sets the hexagon edge length for hexagonal mapping. | |
| str | HexagonalMappingAreaXLength = property(fget=__GetHexagonalMappingAreaXLength, fset=__SetHexagonalMappingAreaXLength) |
| Gets or sets the mapping area X length for hexagonal mapping. | |
| str | HexagonalMappingAreaYLength = property(fget=__GetHexagonalMappingAreaYLength, fset=__SetHexagonalMappingAreaYLength) |
| Gets or sets the mapping area Y length for hexagonal mapping. | |
| str | HexagonalRegularMapping = property(fget=__GetHexagonalRegularMapping, fset=__SetHexagonalRegularMapping) |
| Gets or sets the central point property for hexagonal mapping. | |
| str | HexagonalXAngle = property(fget=__GetHexagonalXAngle, fset=__SetHexagonalXAngle) |
| Gets or sets the X angle for hexagonal mapping. | |
| str | HexagonalXWidth = property(fget=__GetHexagonalXWidth, fset=__SetHexagonalXWidth) |
| Gets or sets the hexagon width for hexagonal mapping. | |
| str | HexagonalYAngle = property(fget=__GetHexagonalYAngle, fset=__SetHexagonalYAngle) |
| Gets or sets the Y angle for hexagonal mapping. | |
| str | HexagonalYHeight = property(fget=__GetHexagonalYHeight, fset=__SetHexagonalYHeight) |
| Gets or sets the hexagon height for hexagonal mapping. | |
| str | MappingType = property(fget=__GetMappingType, fset=__SetMappingType) |
| Gets or sets the mapping. | |
| str | MaxPointToDisplay = property(fget=__GetMaxPointToDisplay, fset=__SetMaxPointToDisplay) |
| Gets or sets the max point to display. | |
| str | Orientation = property(fget=__GetOrientation, fset=__SetOrientation) |
| Gets or sets the pattern orientation. | |
| str | PatternXScale = property(fget=__GetPatternXScale, fset=__SetPatternXScale) |
| Gets or sets the pattern X scale. | |
| str | PatternYScale = property(fget=__GetPatternYScale, fset=__SetPatternYScale) |
| Gets or sets the pattern Y scale. | |
| str | PatternZScale = property(fget=__GetPatternZScale, fset=__SetPatternZScale) |
| Gets or sets the pattern Z scale. | |
| str | RectangularMappingAreaXLength = property(fget=__GetRectangularMappingAreaXLength, fset=__SetRectangularMappingAreaXLength) |
| Gets or sets the area X Length for rectangular mapping. | |
| str | RectangularMappingAreaYLength = property(fget=__GetRectangularMappingAreaYLength, fset=__SetRectangularMappingAreaYLength) |
| Gets or sets the area Y Length for rectangular mapping. | |
| str | RectangularXAngle = property(fget=__GetRectangularXAngle, fset=__SetRectangularXAngle) |
| Gets or sets the X direction angle for rectangular mapping. | |
| str | RectangularXDistance = property(fget=__GetRectangularXDistance, fset=__SetRectangularXDistance) |
| Gets or sets the X distance between patterns for rectangular mapping. | |
| str | RectangularYAngle = property(fget=__GetRectangularYAngle, fset=__SetRectangularYAngle) |
| Gets or sets the Y direction angle for rectangular mapping. | |
| str | RectangularYDistance = property(fget=__GetRectangularYDistance, fset=__SetRectangularYDistance) |
| Gets or sets the Y distance between patterns for rectangular mapping. | |
| str | ShiftScaleRatio = property(fget=__GetShiftScaleRatio, fset=__SetShiftScaleRatio) |
| Gets or sets the shift scale ratio. | |
| str | ShiftSurface = property(fget=__GetShiftSurface, fset=__SetShiftSurface) |
| Gets or sets the shift surface. | |
| str | StartIndex = property(fget=__GetStartIndex, fset=__SetStartIndex) |
| Gets or sets the start index. | |
| str | SupportToPattern = property(fget=__GetSupportToPattern, fset=__SetSupportToPattern) |
| Gets or sets the support geometry on which to apply the pattern. | |
| str | Texture3DMappingFilePath = property(fget=__GetTexture3DMappingFilePath, fset=__SetTexture3DMappingFilePath) |
| Gets or sets the texture 3D Mapping file path. | |
| str | VariablePitchesMappingAreaXLength = property(fget=__GetVariablePitchesMappingAreaXLength, fset=__SetVariablePitchesMappingAreaXLength) |
| Gets or sets the mapping area X length for variable pitches mapping. | |
| str | VariablePitchesMappingAreaYLength = property(fget=__GetVariablePitchesMappingAreaYLength, fset=__SetVariablePitchesMappingAreaYLength) |
| Gets or sets the mapping area Y length for variable pitches mapping. | |
| str | VariablePitchesXAngle = property(fget=__GetVariablePitchesXAngle, fset=__SetVariablePitchesXAngle) |
| Gets or sets the X angle for variable pitches mapping. | |
| str | VariablePitchesXPitchCurve = property(fget=__GetVariablePitchesXPitchCurve, fset=__SetVariablePitchesXPitchCurve) |
| Gets or sets the X pitch curve for variable pitches mapping. | |
| str | VariablePitchesXPitchRatio = property(fget=__GetVariablePitchesXPitchRatio, fset=__SetVariablePitchesXPitchRatio) |
| Gets or sets the X pitch ratio for variable pitches mapping. | |
| str | VariablePitchesYAngle = property(fget=__GetVariablePitchesYAngle, fset=__SetVariablePitchesYAngle) |
| Gets or sets the Y angle for variable pitches mapping. | |
| str | VariablePitchesYPitchCurve = property(fget=__GetVariablePitchesYPitchCurve, fset=__SetVariablePitchesYPitchCurve) |
| Gets or sets the Y pitch curve for variable pitches mapping. | |
| str | VariablePitchesYPitchRatio = property(fget=__GetVariablePitchesYPitchRatio, fset=__SetVariablePitchesYPitchRatio) |
| Gets or sets the Y pitch ratio for variable pitches mapping. | |
| str | XScaleRatio = property(fget=__GetXScaleRatio, fset=__SetXScaleRatio) |
| Gets or sets the X scale ratio. | |
| str | YScaleRatio = property(fget=__GetYScaleRatio, fset=__SetYScaleRatio) |
| Gets or sets the Y scale ratio. | |
| str | ZScaleRatio = property(fget=__GetZScaleRatio, fset=__SetZScaleRatio) |
| Gets or sets the Z scale ratio. | |
 Static Public Attributes inherited from FeatureBuilder | |
| str | Feature = property(fget=__GetFeature) |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| str | FullName = property(fget=__GetFullName) |
| Gets the full name of the feature being edited. | |
| str | Name = property(fget=__GetName, fset=__SetName) |
| Gets or sets the name of the feature being edited. | |
| str | NameWithContext = property(fget=__GetNameWithContext) |
| Gets the name with context of the feature being edited. | |
| str | Status = property(fget=__GetStatus) |
| Returns the status of the feature being edited. | |
Properties | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
| Properties inherited from FeatureBuilder | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
| Properties inherited from Builder | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
Additional Inherited Members | |
| Public Member Functions inherited from FeatureBuilder | |
| 'None' | ShowResult (self) |
| Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. | |
| Public Member Functions inherited from Builder | |
| 'None' | Commit (self) |
| Commits any edits that have been applied to the builder. | |
Detailed Description
Represents a 3D Texture component Builder.
The 3D Texture component Builder is used to create and edit 3D Texture features.
To create a new instance of this class, use FeatureCollection::CreateComponent3DTextureBuilder.
Member Data Documentation
◆ AxisSystem
|
static |
Gets the axis system.
Value type: AxisSystem object.
◆ BooleanOperation
|
static |
Gets or sets the boolean operation.
The values are:
0 - Remove.
1 - Add on same material.
2 - Add on different material.
3 - Add in.
4 - Insert.
Value type: Integer.
The default value is 1.
◆ CircularMappingAreaRadius
|
static |
Gets or sets the mapping area radius for circular mapping.
Prerequisite: The MappingType property must be 1.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 100.0 mm.
◆ CircularRadialDistance
|
static |
Gets or sets the radial distance for circular mapping.
Prerequisite: The MappingType property must be 1.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 1.0 mm.
◆ CircularRingsDistance
|
static |
Gets or sets the distance between two rings for circular mapping.
Prerequisite: The MappingType property must be 1.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 1.0 mm.
◆ CircularXAngle
|
static |
Gets or sets the angle for circular mapping.
Prerequisite: The MappingType property must be 1.
Value type: Double (in degree).
The default value is 0.0 degree.
◆ EndIndex
|
static |
Gets or sets the end index.
Value type: Integer.
Range: The value must be superior to the StartIndex property.
The default value is 2.
◆ FeatureToPattern
|
static |
Gets or sets the pattern geometry.
The FeatureToPattern property takes a feature tag and returns a feature tag.
The pattern must be placed on the axis system of the assembly.
Value type: Integer.
The default value is 0.
◆ FilterSurface
|
static |
Gets or sets the filter surface.
The FilterSurface property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ GlobaleScale
|
static |
Gets or sets the global scale of the pattern.
Value type: Double.
Range: The value must be superior to 0.0.
The default value is 1.0.
◆ HexagonalCentersDistance
|
static |
Gets or sets the hexagon distance between centers for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 100.0 mm.
◆ HexagonalCentralPoint
|
static |
Gets or sets the central point property for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
True: Enables Central Point.
False: Disables Central Point.
Value type: Boolean.
The default value is False.
◆ HexagonalEdgeLength
|
static |
Gets or sets the hexagon edge length for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 1.0 mm.
◆ HexagonalMappingAreaXLength
|
static |
Gets or sets the mapping area X length for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 100.0 mm.
◆ HexagonalMappingAreaYLength
|
static |
Gets or sets the mapping area Y length for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 100.0 mm.
◆ HexagonalRegularMapping
|
static |
Gets or sets the central point property for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
True: Enables Regular Mapping.
False: Disables Regular Mapping.
Value type: Boolean.
The default value is False.
◆ HexagonalXAngle
|
static |
Gets or sets the X angle for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
Value type: Double (in degree).
The default value is 0.0 degree.
◆ HexagonalXWidth
|
static |
Gets or sets the hexagon width for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 0.7 mm.
◆ HexagonalYAngle
|
static |
Gets or sets the Y angle for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
Value type: Double (in degree).
The default value is 0.0 degree.
◆ HexagonalYHeight
|
static |
Gets or sets the hexagon height for hexagonal mapping.
Prerequisite: The MappingType property must be 2.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 0.7 mm.
◆ MappingType
|
static |
Gets or sets the mapping.
Each type describes a way to create a virtual grid that is going to be projected on a part's surface.
The values are:
0 - Rectangular.
1 - Circular.
2 - Hexagonal.
3 - Variable Pitches.
4 - Library.
Value type: Integer.
The default value is 0.
◆ MaxPointToDisplay
|
static |
Gets or sets the max point to display.
Value type: Integer.
The default value is 10000.
◆ Orientation
|
static |
Gets or sets the pattern orientation.
The values are:
0 - Constant, orientates the pattern according to the support of the 3D Texture.
1 - Normal, orientates the pattern according to the normal of the surface.
Value type: Integer.
The default value is 0.
◆ PatternXScale
|
static |
Gets or sets the pattern X scale.
The PatternXScale property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ PatternYScale
|
static |
Gets or sets the pattern Y scale.
The PatternYScale property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ PatternZScale
|
static |
Gets or sets the pattern Z scale.
The PatternZScale property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ RectangularMappingAreaXLength
|
static |
Gets or sets the area X Length for rectangular mapping.
Prerequisite: The MappingType property must be 0.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 100.0 mm.
◆ RectangularMappingAreaYLength
|
static |
Gets or sets the area Y Length for rectangular mapping.
Prerequisite: The MappingType property must be 0.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 100.0 mm.
◆ RectangularXAngle
|
static |
Gets or sets the X direction angle for rectangular mapping.
Prerequisite: The MappingType property must be 0.
Value type: Double (in degree).
The default value is 0.0 degree.
◆ RectangularXDistance
|
static |
Gets or sets the X distance between patterns for rectangular mapping.
Prerequisite: The MappingType property must be 0.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 1.0 mm.
◆ RectangularYAngle
|
static |
Gets or sets the Y direction angle for rectangular mapping.
Prerequisite: The MappingType property must be 0.
Value type: Double (in degree).
The default value is 0.0 degree.
◆ RectangularYDistance
|
static |
Gets or sets the Y distance between patterns for rectangular mapping.
Prerequisite: The MappingType property must be 0.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 1.0 mm.
◆ ShiftScaleRatio
|
static |
Gets or sets the shift scale ratio.
Value type: Double.
The default value is 1.0.
◆ ShiftSurface
|
static |
Gets or sets the shift surface.
The ShiftSurface property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ StartIndex
|
static |
Gets or sets the start index.
Value type: Integer.
Range: The value must be superior to 0 and inferior to the EndIndex property.
The default value is 1.
◆ SupportToPattern
|
static |
Gets or sets the support geometry on which to apply the pattern.
The SupportToPattern property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ Texture3DMappingFilePath
|
static |
Gets or sets the texture 3D Mapping file path.
Value type: String.
The default value is an empty file path (string).
◆ VariablePitchesMappingAreaXLength
|
static |
Gets or sets the mapping area X length for variable pitches mapping.
Prerequisite: The MappingType property must be 3.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 100.0 mm.
◆ VariablePitchesMappingAreaYLength
|
static |
Gets or sets the mapping area Y length for variable pitches mapping.
Prerequisite: The MappingType property must be 3.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 100.0 mm.
◆ VariablePitchesXAngle
|
static |
Gets or sets the X angle for variable pitches mapping.
Prerequisite: The MappingType property must be 3.
Value type: Double (in degree).
The default value is 0.0 degree.
◆ VariablePitchesXPitchCurve
|
static |
Gets or sets the X pitch curve for variable pitches mapping.
Prerequisite: The MappingType property must be 3.
The VariablePitchesXPitchCurve property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ VariablePitchesXPitchRatio
|
static |
Gets or sets the X pitch ratio for variable pitches mapping.
Prerequisite: The MappingType property must be 3.
Value type: Double.
Range: The value must be superior to 0.0.
The default value is 1.0.
◆ VariablePitchesYAngle
|
static |
Gets or sets the Y angle for variable pitches mapping.
Prerequisite: The MappingType property must be 3.
Value type: Double (in degree).
The default value is 0.0 degree.
◆ VariablePitchesYPitchCurve
|
static |
Gets or sets the Y pitch curve for variable pitches mapping.
Prerequisite: The MappingType property must be 3.
The VariablePitchesYPitchCurve property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ VariablePitchesYPitchRatio
|
static |
Gets or sets the Y pitch ratio for variable pitches mapping.
Prerequisite: The MappingType property must be 3.
Value type: Double.
Range: The value must be superior to 0.0.
The default value is 1.0.
◆ XScaleRatio
|
static |
Gets or sets the X scale ratio.
Value type: Double.
The default value is 1.0.
◆ YScaleRatio
|
static |
Gets or sets the Y scale ratio.
Value type: Double.
The default value is 1.0.
◆ ZScaleRatio
|
static |
Gets or sets the Z scale ratio.
Value type: Double.
The default value is 1.0.
The documentation for this class was generated from the following file:
- SpeosNX_2412.py
