## On this page

  

 

 # Component3DTextureBuilder Class Reference

 Last update: 16.07.2025 

Represents a 3D Texture component Builder. [More...](#details)

Inheritance diagram for Component3DTextureBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_component3_d_texture_builder.png)



## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [AxisSystem](#af0a012d49a5b59a4f43bb342b8c725c2) = property(fget=\_\_GetAxisSystem) Gets the axis system.   
 str [BooleanOperation](#a1b606be95ec09c24eaa3a8790b7105ca) = property(fget=\_\_GetBooleanOperation, fset=\_\_SetBooleanOperation) Gets or sets the boolean operation.   
 str [CircularMappingAreaRadius](#a44f90fe6f8ffa779091ad00a6b2651dc) = property(fget=\_\_GetCircularMappingAreaRadius, fset=\_\_SetCircularMappingAreaRadius) Gets or sets the mapping area radius for circular mapping.   
 str [CircularRadialDistance](#a9180d4a30e1b2a009bdc6036a1ccd323) = property(fget=\_\_GetCircularRadialDistance, fset=\_\_SetCircularRadialDistance) Gets or sets the radial distance for circular mapping.   
 str [CircularRingsDistance](#ac86179f5bb9c965f65501316469827cc) = property(fget=\_\_GetCircularRingsDistance, fset=\_\_SetCircularRingsDistance) Gets or sets the distance between two rings for circular mapping.   
 str [CircularXAngle](#ac707012cb340e4f769f4c86768fd3287) = property(fget=\_\_GetCircularXAngle, fset=\_\_SetCircularXAngle) Gets or sets the angle for circular mapping.   
 str [EndIndex](#a2de68c8122019aa03fcb76b78a884b7f) = property(fget=\_\_GetEndIndex, fset=\_\_SetEndIndex) Gets or sets the end index.   
 str [FeatureToPattern](#a8beedffd039240a83ed91d6d2847fe25) = property(fget=\_\_GetFeatureToPattern, fset=\_\_SetFeatureToPattern) Gets or sets the pattern geometry.   
 str [FilterSurface](#a53df9af370c67609179866b1aad06a30) = property(fget=\_\_GetFilterSurface, fset=\_\_SetFilterSurface) Gets or sets the filter surface.   
 str [GlobaleScale](#aee56921e42baaf34f9bd4ebd1a7ff1fc) = property(fget=\_\_GetGlobaleScale, fset=\_\_SetGlobaleScale) Gets or sets the global scale of the pattern.   
 str [HexagonalCentersDistance](#aaaa1ef4ab93603b2a589f8a990fa9e38) = property(fget=\_\_GetHexagonalCentersDistance, fset=\_\_SetHexagonalCentersDistance) Gets or sets the hexagon distance between centers for hexagonal mapping.   
 str [HexagonalCentralPoint](#a49170ec437677c2943d7e8378cd34161) = property(fget=\_\_GetHexagonalCentralPoint, fset=\_\_SetHexagonalCentralPoint) Gets or sets the central point property for hexagonal mapping.   
 str [HexagonalEdgeLength](#ad0aff397daa36ffaa557b846a9dc2f44) = property(fget=\_\_GetHexagonalEdgeLength, fset=\_\_SetHexagonalEdgeLength) Gets or sets the hexagon edge length for hexagonal mapping.   
 str [HexagonalMappingAreaXLength](#a977825da18c081069d6f7f19779fdefb) = property(fget=\_\_GetHexagonalMappingAreaXLength, fset=\_\_SetHexagonalMappingAreaXLength) Gets or sets the mapping area X length for hexagonal mapping.   
 str [HexagonalMappingAreaYLength](#a932093f70cae02d9b3cbfda3dd44aa46) = property(fget=\_\_GetHexagonalMappingAreaYLength, fset=\_\_SetHexagonalMappingAreaYLength) Gets or sets the mapping area Y length for hexagonal mapping.   
 str [HexagonalRegularMapping](#a5c7a255a158ee0e8b79b8e0bfcbc2f69) = property(fget=\_\_GetHexagonalRegularMapping, fset=\_\_SetHexagonalRegularMapping) Gets or sets the central point property for hexagonal mapping.   
 str [HexagonalXAngle](#a2370715d317573debb69bc17287e92e8) = property(fget=\_\_GetHexagonalXAngle, fset=\_\_SetHexagonalXAngle) Gets or sets the X angle for hexagonal mapping.   
 str [HexagonalXWidth](#a059af3ac40fa1ecb9d1dc511677291c1) = property(fget=\_\_GetHexagonalXWidth, fset=\_\_SetHexagonalXWidth) Gets or sets the hexagon width for hexagonal mapping.   
 str [HexagonalYAngle](#ac973fdfcebb3fbcea9b49e99faff279e) = property(fget=\_\_GetHexagonalYAngle, fset=\_\_SetHexagonalYAngle) Gets or sets the Y angle for hexagonal mapping.   
 str [HexagonalYHeight](#aacbf3dceaf5a6b2e47f8326ecf03636d) = property(fget=\_\_GetHexagonalYHeight, fset=\_\_SetHexagonalYHeight) Gets or sets the hexagon height for hexagonal mapping.   
 str [MappingType](#a7acb5bae36f4ae7fba9254070a9b7632) = property(fget=\_\_GetMappingType, fset=\_\_SetMappingType) Gets or sets the mapping.   
 str [MaxPointToDisplay](#acd8bed39c610c5c985e15f0401a9342b) = property(fget=\_\_GetMaxPointToDisplay, fset=\_\_SetMaxPointToDisplay) Gets or sets the max point to display.   
 str [Orientation](#a6eb41f84a29e82c187c30a960d2956fa) = property(fget=\_\_GetOrientation, fset=\_\_SetOrientation) Gets or sets the pattern orientation.   
 str [PatternXScale](#a7a4ec229204063b5e835d7c74c168d7e) = property(fget=\_\_GetPatternXScale, fset=\_\_SetPatternXScale) Gets or sets the pattern X scale.   
 str [PatternYScale](#a77907d9ad6dc71ab92d03fa528e9622b) = property(fget=\_\_GetPatternYScale, fset=\_\_SetPatternYScale) Gets or sets the pattern Y scale.   
 str [PatternZScale](#a1718184f9fc91b67cc1ecb2780750ca0) = property(fget=\_\_GetPatternZScale, fset=\_\_SetPatternZScale) Gets or sets the pattern Z scale.   
 str [RectangularMappingAreaXLength](#a0ea18fbe8793c7b0c67fcbbfca90d26c) = property(fget=\_\_GetRectangularMappingAreaXLength, fset=\_\_SetRectangularMappingAreaXLength) Gets or sets the area X Length for rectangular mapping.   
 str [RectangularMappingAreaYLength](#a621687850d4948a3bfc320a26486e997) = property(fget=\_\_GetRectangularMappingAreaYLength, fset=\_\_SetRectangularMappingAreaYLength) Gets or sets the area Y Length for rectangular mapping.   
 str [RectangularXAngle](#a164b7537d74f9776dc719eaa0cf641b6) = property(fget=\_\_GetRectangularXAngle, fset=\_\_SetRectangularXAngle) Gets or sets the X direction angle for rectangular mapping.   
 str [RectangularXDistance](#aed02953b9a0e2a30483e3dba4fc6a8f2) = property(fget=\_\_GetRectangularXDistance, fset=\_\_SetRectangularXDistance) Gets or sets the X distance between patterns for rectangular mapping.   
 str [RectangularYAngle](#ae25db2fb0b49295b1eb719ae238e63bf) = property(fget=\_\_GetRectangularYAngle, fset=\_\_SetRectangularYAngle) Gets or sets the Y direction angle for rectangular mapping.   
 str [RectangularYDistance](#a66e33aa416cde792e16675fbd5f95efa) = property(fget=\_\_GetRectangularYDistance, fset=\_\_SetRectangularYDistance) Gets or sets the Y distance between patterns for rectangular mapping.   
 str [ShiftScaleRatio](#a9e8e9d83be294c3ad0586f4920266f23) = property(fget=\_\_GetShiftScaleRatio, fset=\_\_SetShiftScaleRatio) Gets or sets the shift scale ratio.   
 str [ShiftSurface](#a7c34ac7d16598d769e0e71f63fb03b02) = property(fget=\_\_GetShiftSurface, fset=\_\_SetShiftSurface) Gets or sets the shift surface.   
 str [StartIndex](#a5d7f8e8e0914f8909e47c35d81222093) = property(fget=\_\_GetStartIndex, fset=\_\_SetStartIndex) Gets or sets the start index.   
 str [SupportToPattern](#aee0aebd68d25fc3b1eaf5fa7bb0e3906) = property(fget=\_\_GetSupportToPattern, fset=\_\_SetSupportToPattern) Gets or sets the support geometry on which to apply the pattern.   
 str [Texture3DMappingFilePath](#a6f64bd44d8b9b9e97b64e50473994ca0) = property(fget=\_\_GetTexture3DMappingFilePath, fset=\_\_SetTexture3DMappingFilePath) Gets or sets the texture 3D Mapping file path.   
 str [VariablePitchesMappingAreaXLength](#a9f125442a0d3e4fc2add790ffc2b4d9e) = property(fget=\_\_GetVariablePitchesMappingAreaXLength, fset=\_\_SetVariablePitchesMappingAreaXLength) Gets or sets the mapping area X length for variable pitches mapping.   
 str [VariablePitchesMappingAreaYLength](#a9e9c86526fb95d389a24345a19bf7669) = property(fget=\_\_GetVariablePitchesMappingAreaYLength, fset=\_\_SetVariablePitchesMappingAreaYLength) Gets or sets the mapping area Y length for variable pitches mapping.   
 str [VariablePitchesXAngle](#a3eda28180fc148cc1e36487782f720fe) = property(fget=\_\_GetVariablePitchesXAngle, fset=\_\_SetVariablePitchesXAngle) Gets or sets the X angle for variable pitches mapping.   
 str [VariablePitchesXPitchCurve](#a033ec060640d52c1ac1da0128862b37e) = property(fget=\_\_GetVariablePitchesXPitchCurve, fset=\_\_SetVariablePitchesXPitchCurve) Gets or sets the X pitch curve for variable pitches mapping.   
 str [VariablePitchesXPitchRatio](#a0c24ebc6cb5c8a015767fc198b9d3b3a) = property(fget=\_\_GetVariablePitchesXPitchRatio, fset=\_\_SetVariablePitchesXPitchRatio) Gets or sets the X pitch ratio for variable pitches mapping.   
 str [VariablePitchesYAngle](#a9f0c3d6a4a57983c1d30a071e84c3a9a) = property(fget=\_\_GetVariablePitchesYAngle, fset=\_\_SetVariablePitchesYAngle) Gets or sets the Y angle for variable pitches mapping.   
 str [VariablePitchesYPitchCurve](#a36bd6a03495b0d02263142d3c0bb93a3) = property(fget=\_\_GetVariablePitchesYPitchCurve, fset=\_\_SetVariablePitchesYPitchCurve) Gets or sets the Y pitch curve for variable pitches mapping.   
 str [VariablePitchesYPitchRatio](#ac3e48f53fd19299f388bab80484de68c) = property(fget=\_\_GetVariablePitchesYPitchRatio, fset=\_\_SetVariablePitchesYPitchRatio) Gets or sets the Y pitch ratio for variable pitches mapping.   
 str [XScaleRatio](#a8e4f53e2468627e01d5576fea8bf9746) = property(fget=\_\_GetXScaleRatio, fset=\_\_SetXScaleRatio) Gets or sets the X scale ratio.   
 str [YScaleRatio](#a022091df97972833163d2b009985170d) = property(fget=\_\_GetYScaleRatio, fset=\_\_SetYScaleRatio) Gets or sets the Y scale ratio.   
 str [ZScaleRatio](#ab9c27d6822e653161aa682c3f166beba) = property(fget=\_\_GetZScaleRatio, fset=\_\_SetZScaleRatio) Gets or sets the Z scale ratio.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x__2412_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
 str [FullName](class_speos_n_x__2412_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x__2412_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited.   
 str [NameWithContext](class_speos_n_x__2412_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 str [Status](class_speos_n_x__2412_1_1_feature_builder.xhtml#abfd5ba295bea008a0edf2f1a85bc6368) = property(fget=\_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="properties" name="properties"></a>Properties

<a id="a50e9fbdd6a13e9e50cfba34656086bb6" name="a50e9fbdd6a13e9e50cfba34656086bb6"></a> **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) 'None' **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) 'None' [Commit](class_speos_n_x__2412_1_1_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
 <a id="details" name="details"></a>## 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 <a class="el" href="">FeatureCollection::CreateComponent3DTextureBuilder</a>.



## Member Data Documentation

<a id="af0a012d49a5b59a4f43bb342b8c725c2" name="af0a012d49a5b59a4f43bb342b8c725c2"></a>## [◆ ](#af0a012d49a5b59a4f43bb342b8c725c2)AxisSystem

 str [AxisSystem](class_speos_n_x__2412_1_1_axis_system.xhtml) = property(fget=\_\_GetAxisSystem)  static 

Gets the axis system.

**Value type**: AxisSystem object.





<a id="a1b606be95ec09c24eaa3a8790b7105ca" name="a1b606be95ec09c24eaa3a8790b7105ca"></a>## [◆ ](#a1b606be95ec09c24eaa3a8790b7105ca)BooleanOperation

 str BooleanOperation = property(fget=\_\_GetBooleanOperation, fset=\_\_SetBooleanOperation)  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.





<a id="a44f90fe6f8ffa779091ad00a6b2651dc" name="a44f90fe6f8ffa779091ad00a6b2651dc"></a>## [◆ ](#a44f90fe6f8ffa779091ad00a6b2651dc)CircularMappingAreaRadius

 str CircularMappingAreaRadius = property(fget=\_\_GetCircularMappingAreaRadius, fset=\_\_SetCircularMappingAreaRadius)  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.





<a id="a9180d4a30e1b2a009bdc6036a1ccd323" name="a9180d4a30e1b2a009bdc6036a1ccd323"></a>## [◆ ](#a9180d4a30e1b2a009bdc6036a1ccd323)CircularRadialDistance

 str CircularRadialDistance = property(fget=\_\_GetCircularRadialDistance, fset=\_\_SetCircularRadialDistance)  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.





<a id="ac86179f5bb9c965f65501316469827cc" name="ac86179f5bb9c965f65501316469827cc"></a>## [◆ ](#ac86179f5bb9c965f65501316469827cc)CircularRingsDistance

 str CircularRingsDistance = property(fget=\_\_GetCircularRingsDistance, fset=\_\_SetCircularRingsDistance)  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.





<a id="ac707012cb340e4f769f4c86768fd3287" name="ac707012cb340e4f769f4c86768fd3287"></a>## [◆ ](#ac707012cb340e4f769f4c86768fd3287)CircularXAngle

 str CircularXAngle = property(fget=\_\_GetCircularXAngle, fset=\_\_SetCircularXAngle)  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.





<a id="a2de68c8122019aa03fcb76b78a884b7f" name="a2de68c8122019aa03fcb76b78a884b7f"></a>## [◆ ](#a2de68c8122019aa03fcb76b78a884b7f)EndIndex

 str EndIndex = property(fget=\_\_GetEndIndex, fset=\_\_SetEndIndex)  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.





<a id="a8beedffd039240a83ed91d6d2847fe25" name="a8beedffd039240a83ed91d6d2847fe25"></a>## [◆ ](#a8beedffd039240a83ed91d6d2847fe25)FeatureToPattern

 str FeatureToPattern = property(fget=\_\_GetFeatureToPattern, fset=\_\_SetFeatureToPattern)  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.





<a id="a53df9af370c67609179866b1aad06a30" name="a53df9af370c67609179866b1aad06a30"></a>## [◆ ](#a53df9af370c67609179866b1aad06a30)FilterSurface

 str FilterSurface = property(fget=\_\_GetFilterSurface, fset=\_\_SetFilterSurface)  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.





<a id="aee56921e42baaf34f9bd4ebd1a7ff1fc" name="aee56921e42baaf34f9bd4ebd1a7ff1fc"></a>## [◆ ](#aee56921e42baaf34f9bd4ebd1a7ff1fc)GlobaleScale

 str GlobaleScale = property(fget=\_\_GetGlobaleScale, fset=\_\_SetGlobaleScale)  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.





<a id="aaaa1ef4ab93603b2a589f8a990fa9e38" name="aaaa1ef4ab93603b2a589f8a990fa9e38"></a>## [◆ ](#aaaa1ef4ab93603b2a589f8a990fa9e38)HexagonalCentersDistance

 str HexagonalCentersDistance = property(fget=\_\_GetHexagonalCentersDistance, fset=\_\_SetHexagonalCentersDistance)  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.





<a id="a49170ec437677c2943d7e8378cd34161" name="a49170ec437677c2943d7e8378cd34161"></a>## [◆ ](#a49170ec437677c2943d7e8378cd34161)HexagonalCentralPoint

 str HexagonalCentralPoint = property(fget=\_\_GetHexagonalCentralPoint, fset=\_\_SetHexagonalCentralPoint)  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.





<a id="ad0aff397daa36ffaa557b846a9dc2f44" name="ad0aff397daa36ffaa557b846a9dc2f44"></a>## [◆ ](#ad0aff397daa36ffaa557b846a9dc2f44)HexagonalEdgeLength

 str HexagonalEdgeLength = property(fget=\_\_GetHexagonalEdgeLength, fset=\_\_SetHexagonalEdgeLength)  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.





<a id="a977825da18c081069d6f7f19779fdefb" name="a977825da18c081069d6f7f19779fdefb"></a>## [◆ ](#a977825da18c081069d6f7f19779fdefb)HexagonalMappingAreaXLength

 str HexagonalMappingAreaXLength = property(fget=\_\_GetHexagonalMappingAreaXLength, fset=\_\_SetHexagonalMappingAreaXLength)  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.





<a id="a932093f70cae02d9b3cbfda3dd44aa46" name="a932093f70cae02d9b3cbfda3dd44aa46"></a>## [◆ ](#a932093f70cae02d9b3cbfda3dd44aa46)HexagonalMappingAreaYLength

 str HexagonalMappingAreaYLength = property(fget=\_\_GetHexagonalMappingAreaYLength, fset=\_\_SetHexagonalMappingAreaYLength)  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.





<a id="a5c7a255a158ee0e8b79b8e0bfcbc2f69" name="a5c7a255a158ee0e8b79b8e0bfcbc2f69"></a>## [◆ ](#a5c7a255a158ee0e8b79b8e0bfcbc2f69)HexagonalRegularMapping

 str HexagonalRegularMapping = property(fget=\_\_GetHexagonalRegularMapping, fset=\_\_SetHexagonalRegularMapping)  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.





<a id="a2370715d317573debb69bc17287e92e8" name="a2370715d317573debb69bc17287e92e8"></a>## [◆ ](#a2370715d317573debb69bc17287e92e8)HexagonalXAngle

 str HexagonalXAngle = property(fget=\_\_GetHexagonalXAngle, fset=\_\_SetHexagonalXAngle)  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.





<a id="a059af3ac40fa1ecb9d1dc511677291c1" name="a059af3ac40fa1ecb9d1dc511677291c1"></a>## [◆ ](#a059af3ac40fa1ecb9d1dc511677291c1)HexagonalXWidth

 str HexagonalXWidth = property(fget=\_\_GetHexagonalXWidth, fset=\_\_SetHexagonalXWidth)  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.





<a id="ac973fdfcebb3fbcea9b49e99faff279e" name="ac973fdfcebb3fbcea9b49e99faff279e"></a>## [◆ ](#ac973fdfcebb3fbcea9b49e99faff279e)HexagonalYAngle

 str HexagonalYAngle = property(fget=\_\_GetHexagonalYAngle, fset=\_\_SetHexagonalYAngle)  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.





<a id="aacbf3dceaf5a6b2e47f8326ecf03636d" name="aacbf3dceaf5a6b2e47f8326ecf03636d"></a>## [◆ ](#aacbf3dceaf5a6b2e47f8326ecf03636d)HexagonalYHeight

 str HexagonalYHeight = property(fget=\_\_GetHexagonalYHeight, fset=\_\_SetHexagonalYHeight)  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.





<a id="a7acb5bae36f4ae7fba9254070a9b7632" name="a7acb5bae36f4ae7fba9254070a9b7632"></a>## [◆ ](#a7acb5bae36f4ae7fba9254070a9b7632)MappingType

 str MappingType = property(fget=\_\_GetMappingType, fset=\_\_SetMappingType)  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.





<a id="acd8bed39c610c5c985e15f0401a9342b" name="acd8bed39c610c5c985e15f0401a9342b"></a>## [◆ ](#acd8bed39c610c5c985e15f0401a9342b)MaxPointToDisplay

 str MaxPointToDisplay = property(fget=\_\_GetMaxPointToDisplay, fset=\_\_SetMaxPointToDisplay)  static 

Gets or sets the max point to display.

**Value type**: Integer.

The default value is 10000.





<a id="a6eb41f84a29e82c187c30a960d2956fa" name="a6eb41f84a29e82c187c30a960d2956fa"></a>## [◆ ](#a6eb41f84a29e82c187c30a960d2956fa)Orientation

 str Orientation = property(fget=\_\_GetOrientation, fset=\_\_SetOrientation)  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.





<a id="a7a4ec229204063b5e835d7c74c168d7e" name="a7a4ec229204063b5e835d7c74c168d7e"></a>## [◆ ](#a7a4ec229204063b5e835d7c74c168d7e)PatternXScale

 str PatternXScale = property(fget=\_\_GetPatternXScale, fset=\_\_SetPatternXScale)  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.





<a id="a77907d9ad6dc71ab92d03fa528e9622b" name="a77907d9ad6dc71ab92d03fa528e9622b"></a>## [◆ ](#a77907d9ad6dc71ab92d03fa528e9622b)PatternYScale

 str PatternYScale = property(fget=\_\_GetPatternYScale, fset=\_\_SetPatternYScale)  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.





<a id="a1718184f9fc91b67cc1ecb2780750ca0" name="a1718184f9fc91b67cc1ecb2780750ca0"></a>## [◆ ](#a1718184f9fc91b67cc1ecb2780750ca0)PatternZScale

 str PatternZScale = property(fget=\_\_GetPatternZScale, fset=\_\_SetPatternZScale)  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.





<a id="a0ea18fbe8793c7b0c67fcbbfca90d26c" name="a0ea18fbe8793c7b0c67fcbbfca90d26c"></a>## [◆ ](#a0ea18fbe8793c7b0c67fcbbfca90d26c)RectangularMappingAreaXLength

 str RectangularMappingAreaXLength = property(fget=\_\_GetRectangularMappingAreaXLength, fset=\_\_SetRectangularMappingAreaXLength)  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.





<a id="a621687850d4948a3bfc320a26486e997" name="a621687850d4948a3bfc320a26486e997"></a>## [◆ ](#a621687850d4948a3bfc320a26486e997)RectangularMappingAreaYLength

 str RectangularMappingAreaYLength = property(fget=\_\_GetRectangularMappingAreaYLength, fset=\_\_SetRectangularMappingAreaYLength)  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.





<a id="a164b7537d74f9776dc719eaa0cf641b6" name="a164b7537d74f9776dc719eaa0cf641b6"></a>## [◆ ](#a164b7537d74f9776dc719eaa0cf641b6)RectangularXAngle

 str RectangularXAngle = property(fget=\_\_GetRectangularXAngle, fset=\_\_SetRectangularXAngle)  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.





<a id="aed02953b9a0e2a30483e3dba4fc6a8f2" name="aed02953b9a0e2a30483e3dba4fc6a8f2"></a>## [◆ ](#aed02953b9a0e2a30483e3dba4fc6a8f2)RectangularXDistance

 str RectangularXDistance = property(fget=\_\_GetRectangularXDistance, fset=\_\_SetRectangularXDistance)  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.





<a id="ae25db2fb0b49295b1eb719ae238e63bf" name="ae25db2fb0b49295b1eb719ae238e63bf"></a>## [◆ ](#ae25db2fb0b49295b1eb719ae238e63bf)RectangularYAngle

 str RectangularYAngle = property(fget=\_\_GetRectangularYAngle, fset=\_\_SetRectangularYAngle)  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.





<a id="a66e33aa416cde792e16675fbd5f95efa" name="a66e33aa416cde792e16675fbd5f95efa"></a>## [◆ ](#a66e33aa416cde792e16675fbd5f95efa)RectangularYDistance

 str RectangularYDistance = property(fget=\_\_GetRectangularYDistance, fset=\_\_SetRectangularYDistance)  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.





<a id="a9e8e9d83be294c3ad0586f4920266f23" name="a9e8e9d83be294c3ad0586f4920266f23"></a>## [◆ ](#a9e8e9d83be294c3ad0586f4920266f23)ShiftScaleRatio

 str ShiftScaleRatio = property(fget=\_\_GetShiftScaleRatio, fset=\_\_SetShiftScaleRatio)  static 

Gets or sets the shift scale ratio.

**Value type**: Double.

The default value is 1.0.





<a id="a7c34ac7d16598d769e0e71f63fb03b02" name="a7c34ac7d16598d769e0e71f63fb03b02"></a>## [◆ ](#a7c34ac7d16598d769e0e71f63fb03b02)ShiftSurface

 str ShiftSurface = property(fget=\_\_GetShiftSurface, fset=\_\_SetShiftSurface)  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.





<a id="a5d7f8e8e0914f8909e47c35d81222093" name="a5d7f8e8e0914f8909e47c35d81222093"></a>## [◆ ](#a5d7f8e8e0914f8909e47c35d81222093)StartIndex

 str StartIndex = property(fget=\_\_GetStartIndex, fset=\_\_SetStartIndex)  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.





<a id="aee0aebd68d25fc3b1eaf5fa7bb0e3906" name="aee0aebd68d25fc3b1eaf5fa7bb0e3906"></a>## [◆ ](#aee0aebd68d25fc3b1eaf5fa7bb0e3906)SupportToPattern

 str SupportToPattern = property(fget=\_\_GetSupportToPattern, fset=\_\_SetSupportToPattern)  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.





<a id="a6f64bd44d8b9b9e97b64e50473994ca0" name="a6f64bd44d8b9b9e97b64e50473994ca0"></a>## [◆ ](#a6f64bd44d8b9b9e97b64e50473994ca0)Texture3DMappingFilePath

 str Texture3DMappingFilePath = property(fget=\_\_GetTexture3DMappingFilePath, fset=\_\_SetTexture3DMappingFilePath)  static 

Gets or sets the texture 3D Mapping file path.

**Value type**: String.

The default value is an empty file path (string).





<a id="a9f125442a0d3e4fc2add790ffc2b4d9e" name="a9f125442a0d3e4fc2add790ffc2b4d9e"></a>## [◆ ](#a9f125442a0d3e4fc2add790ffc2b4d9e)VariablePitchesMappingAreaXLength

 str VariablePitchesMappingAreaXLength = property(fget=\_\_GetVariablePitchesMappingAreaXLength, fset=\_\_SetVariablePitchesMappingAreaXLength)  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.





<a id="a9e9c86526fb95d389a24345a19bf7669" name="a9e9c86526fb95d389a24345a19bf7669"></a>## [◆ ](#a9e9c86526fb95d389a24345a19bf7669)VariablePitchesMappingAreaYLength

 str VariablePitchesMappingAreaYLength = property(fget=\_\_GetVariablePitchesMappingAreaYLength, fset=\_\_SetVariablePitchesMappingAreaYLength)  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.





<a id="a3eda28180fc148cc1e36487782f720fe" name="a3eda28180fc148cc1e36487782f720fe"></a>## [◆ ](#a3eda28180fc148cc1e36487782f720fe)VariablePitchesXAngle

 str VariablePitchesXAngle = property(fget=\_\_GetVariablePitchesXAngle, fset=\_\_SetVariablePitchesXAngle)  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.





<a id="a033ec060640d52c1ac1da0128862b37e" name="a033ec060640d52c1ac1da0128862b37e"></a>## [◆ ](#a033ec060640d52c1ac1da0128862b37e)VariablePitchesXPitchCurve

 str VariablePitchesXPitchCurve = property(fget=\_\_GetVariablePitchesXPitchCurve, fset=\_\_SetVariablePitchesXPitchCurve)  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.





<a id="a0c24ebc6cb5c8a015767fc198b9d3b3a" name="a0c24ebc6cb5c8a015767fc198b9d3b3a"></a>## [◆ ](#a0c24ebc6cb5c8a015767fc198b9d3b3a)VariablePitchesXPitchRatio

 str VariablePitchesXPitchRatio = property(fget=\_\_GetVariablePitchesXPitchRatio, fset=\_\_SetVariablePitchesXPitchRatio)  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.





<a id="a9f0c3d6a4a57983c1d30a071e84c3a9a" name="a9f0c3d6a4a57983c1d30a071e84c3a9a"></a>## [◆ ](#a9f0c3d6a4a57983c1d30a071e84c3a9a)VariablePitchesYAngle

 str VariablePitchesYAngle = property(fget=\_\_GetVariablePitchesYAngle, fset=\_\_SetVariablePitchesYAngle)  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.





<a id="a36bd6a03495b0d02263142d3c0bb93a3" name="a36bd6a03495b0d02263142d3c0bb93a3"></a>## [◆ ](#a36bd6a03495b0d02263142d3c0bb93a3)VariablePitchesYPitchCurve

 str VariablePitchesYPitchCurve = property(fget=\_\_GetVariablePitchesYPitchCurve, fset=\_\_SetVariablePitchesYPitchCurve)  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.





<a id="ac3e48f53fd19299f388bab80484de68c" name="ac3e48f53fd19299f388bab80484de68c"></a>## [◆ ](#ac3e48f53fd19299f388bab80484de68c)VariablePitchesYPitchRatio

 str VariablePitchesYPitchRatio = property(fget=\_\_GetVariablePitchesYPitchRatio, fset=\_\_SetVariablePitchesYPitchRatio)  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.





<a id="a8e4f53e2468627e01d5576fea8bf9746" name="a8e4f53e2468627e01d5576fea8bf9746"></a>## [◆ ](#a8e4f53e2468627e01d5576fea8bf9746)XScaleRatio

 str XScaleRatio = property(fget=\_\_GetXScaleRatio, fset=\_\_SetXScaleRatio)  static 

Gets or sets the X scale ratio.

**Value type**: Double.

The default value is 1.0.





<a id="a022091df97972833163d2b009985170d" name="a022091df97972833163d2b009985170d"></a>## [◆ ](#a022091df97972833163d2b009985170d)YScaleRatio

 str YScaleRatio = property(fget=\_\_GetYScaleRatio, fset=\_\_SetYScaleRatio)  static 

Gets or sets the Y scale ratio.

**Value type**: Double.

The default value is 1.0.





<a id="ab9c27d6822e653161aa682c3f166beba" name="ab9c27d6822e653161aa682c3f166beba"></a>## [◆ ](#ab9c27d6822e653161aa682c3f166beba)ZScaleRatio

 str ZScaleRatio = property(fget=\_\_GetZScaleRatio, fset=\_\_SetZScaleRatio)  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**