PatternDefinition Class¶
-
class
NXOpen.GeometricUtilities.
PatternDefinition
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
pattern spacing for several pattern based commands.
See PatternEnum definition below for a listing of the various pattern definitions available. .. versionadded:: NX7.5.0
Properties¶
Property | Description |
---|---|
AlongPathDefinition | Returns the along path definition. |
CircularDefinition | Returns the circular definition. |
FrameOnlyToggle | Returns or sets the frameOnlyToggle, a logical flag to indicate if the we need only instances on the boundary. |
GeneralDefinition | Returns the general definition. |
HelixDefinition | Returns the helix definition. |
MirrorDefinition | Returns the mirror definition. |
PatternFill | Returns the pattern fill definition. |
PatternIncrementsBuilder | Returns the pattern increments definition. |
PatternOrientation | Returns the pattern orientation definition. |
PatternType | Returns or sets the pattern type |
PolygonDefinition | Returns the polygon definition. |
RectangularDefinition | Returns the linear definition. |
ReferenceDefinition | Returns the reference definition. |
SeedOnlyToggle | Returns or sets the seedOnlyToggle, a logical flag to indicate if the we need only instances for the seed along the second direction. |
SpiralDefinition | Returns the spiral definition. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
CreateClockingBuilder | Creates a pattern clocking object @return |
CreatePatternInstanceEditBuilder | This is the default creator for NXOpen.GeometricUtilities.PatternInstanceEditBuilder . |
GetClocking | Returns the clocking data for a NXOpen.GeometricUtilities.PatternDefinition instance @return |
GetDeleteState | Gets the delete state for the instance at the specified indicies. |
GetSuppressState | Gets the suppress state for the instance at the specified indicies. |
RemoveClocking | Removes clocking from pattern definition instance |
RemoveVariance | Removes variance from pattern definition instance |
SetDeleteState | Sets the delete state for the instance at the specified indicies. |
SetSpreadsheetData | Sets the spreadsheet data |
SetSuppressState | Sets the suppress state for the instance at the specified indicies. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
PatternDefinitionPatternEnum Enumeration | pattern types available. |
Property Detail¶
AlongPathDefinition¶
-
PatternDefinition.
AlongPathDefinition
¶ Returns the along path definition.
See AlongPathPattern for details.
-------------------------------------
Getter Method
Signature
AlongPathDefinition()
Returns: Return type: NXOpen.GeometricUtilities.AlongPathPattern
New in version NX7.5.0.
License requirements: None.
CircularDefinition¶
-
PatternDefinition.
CircularDefinition
¶ Returns the circular definition.
See CircularPattern for details.
-------------------------------------
Getter Method
Signature
CircularDefinition()
Returns: Return type: NXOpen.GeometricUtilities.CircularPattern
New in version NX7.5.0.
License requirements: None.
FrameOnlyToggle¶
-
PatternDefinition.
FrameOnlyToggle
¶ Returns or sets the frameOnlyToggle, a logical flag to indicate if the we need only instances on the boundary.
-------------------------------------
Getter Method
Signature
FrameOnlyToggle()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FrameOnlyToggle(frameOnlyToggle)
Parameters: frameOnlyToggle (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”)
GeneralDefinition¶
-
PatternDefinition.
GeneralDefinition
¶ Returns the general definition.
See GeneralPattern for details.
-------------------------------------
Getter Method
Signature
GeneralDefinition()
Returns: Return type: NXOpen.GeometricUtilities.GeneralPattern
New in version NX8.0.0.
License requirements: None.
HelixDefinition¶
-
PatternDefinition.
HelixDefinition
¶ Returns the helix definition.
See HelixPattern for details.
-------------------------------------
Getter Method
Signature
HelixDefinition()
Returns: Return type: NXOpen.GeometricUtilities.HelixPattern
New in version NX9.0.0.
License requirements: None.
MirrorDefinition¶
-
PatternDefinition.
MirrorDefinition
¶ Returns the mirror definition.
See MirrorPattern for details.
-------------------------------------
Getter Method
Signature
MirrorDefinition()
Returns: Return type: NXOpen.GeometricUtilities.MirrorPattern
New in version NX8.0.0.
License requirements: None.
PatternFill¶
-
PatternDefinition.
PatternFill
¶ Returns the pattern fill definition.
See PatternFill for details.
-------------------------------------
Getter Method
Signature
PatternFill()
Returns: Return type: NXOpen.GeometricUtilities.PatternFill
New in version NX7.5.0.
License requirements: None.
PatternIncrementsBuilder¶
-
PatternDefinition.
PatternIncrementsBuilder
¶ Returns the pattern increments definition.
See
NXOpen.GeometricUtilities.PatternIncrementsBuilder
for details.-------------------------------------
Getter Method
Signature
PatternIncrementsBuilder()
Returns: Return type: NXOpen.GeometricUtilities.PatternIncrementsBuilder
New in version NX7.5.0.
License requirements: None.
PatternOrientation¶
-
PatternDefinition.
PatternOrientation
¶ Returns the pattern orientation definition.
See PatternOrientation for details.
-------------------------------------
Getter Method
Signature
PatternOrientation()
Returns: Return type: NXOpen.GeometricUtilities.PatternOrientation
New in version NX7.5.0.
License requirements: None.
PatternType¶
-
PatternDefinition.
PatternType
¶ Returns or sets the pattern type
-------------------------------------
Getter Method
Signature
PatternType()
Returns: Return type: NXOpen.GeometricUtilities.PatternDefinitionPatternEnum
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PatternType(patternType)
Parameters: patternType ( NXOpen.GeometricUtilities.PatternDefinitionPatternEnum
) –New in version NX7.5.0.
License requirements: None.
PolygonDefinition¶
-
PatternDefinition.
PolygonDefinition
¶ Returns the polygon definition.
See PolygonPattern for details.
-------------------------------------
Getter Method
Signature
PolygonDefinition()
Returns: Return type: NXOpen.GeometricUtilities.PolygonPattern
New in version NX8.0.0.
License requirements: None.
RectangularDefinition¶
-
PatternDefinition.
RectangularDefinition
¶ Returns the linear definition.
See LinearPattern for details.
-------------------------------------
Getter Method
Signature
RectangularDefinition()
Returns: Return type: NXOpen.GeometricUtilities.RectangularPattern
New in version NX7.5.0.
License requirements: None.
ReferenceDefinition¶
-
PatternDefinition.
ReferenceDefinition
¶ Returns the reference definition.
See ReferencePattern for details.
-------------------------------------
Getter Method
Signature
ReferenceDefinition()
Returns: Return type: NXOpen.GeometricUtilities.ReferencePattern
New in version NX8.0.0.
License requirements: None.
SeedOnlyToggle¶
-
PatternDefinition.
SeedOnlyToggle
¶ Returns or sets the seedOnlyToggle, a logical flag to indicate if the we need only instances for the seed along the second direction.
-------------------------------------
Getter Method
Signature
SeedOnlyToggle()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SeedOnlyToggle(seedOnlyToggle)
Parameters: seedOnlyToggle (bool) – New in version NX8.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”)
SpiralDefinition¶
-
PatternDefinition.
SpiralDefinition
¶ Returns the spiral definition.
See SpiralPattern for details.
-------------------------------------
Getter Method
Signature
SpiralDefinition()
Returns: Return type: NXOpen.GeometricUtilities.SpiralPattern
New in version NX8.0.0.
License requirements: None.
Method Detail¶
CreateClockingBuilder¶
-
PatternDefinition.
CreateClockingBuilder
¶ Creates a pattern clocking object
Signature
CreateClockingBuilder(ix, iy)
Parameters: - ix (int) – x index of instance to initialize to
- iy (int) – y index of instance to initialize to
Returns: Return type: New in version NX7.5.0.
License requirements: None.
CreatePatternInstanceEditBuilder¶
-
PatternDefinition.
CreatePatternInstanceEditBuilder
¶ This is the default creator for
NXOpen.GeometricUtilities.PatternInstanceEditBuilder
.Signature
CreatePatternInstanceEditBuilder()
Returns: Return type: NXOpen.GeometricUtilities.PatternInstanceEditBuilder
New in version NX7.5.0.
License requirements: None.
GetClocking¶
-
PatternDefinition.
GetClocking
¶ Returns the clocking data for a
NXOpen.GeometricUtilities.PatternDefinition
instanceSignature
GetClocking(index1, index2)
Parameters: - index1 (int) – First index into pattern instance array
- index2 (int) – Second index into pattern instance array
Returns: Return type: New in version NX7.5.0.
Deprecated since version NX8.0.0: Use
NXOpen.GeometricUtilities.PatternDefinition.CreateClockingBuilder
instead.License requirements: None.
GetDeleteState¶
-
PatternDefinition.
GetDeleteState
¶ Gets the delete state for the instance at the specified indicies.
Signature
GetDeleteState(index1, index2)
Parameters: - index1 (int) – First index of instance
- index2 (int) – Second index of instance
Returns: Return type: bool
New in version NX8.0.0.
License requirements: None.
GetSuppressState¶
-
PatternDefinition.
GetSuppressState
¶ Gets the suppress state for the instance at the specified indicies.
Signature
GetSuppressState(index1, index2)
Parameters: - index1 (int) – First index of instance
- index2 (int) – Second index of instance
Returns: Return type: bool
New in version NX7.5.0.
License requirements: None.
RemoveClocking¶
-
PatternDefinition.
RemoveClocking
¶ Removes clocking from pattern definition instance
Signature
RemoveClocking(index1, index2)
Parameters: - index1 (int) – First index into pattern instance array
- index2 (int) – Second index into pattern instance array
New in version NX7.5.0.
License requirements: None.
RemoveVariance¶
-
PatternDefinition.
RemoveVariance
¶ Removes variance from pattern definition instance
Signature
RemoveVariance(index1, index2)
Parameters: - index1 (int) – First index into pattern instance array
- index2 (int) – Second index into pattern instance array
New in version NX8.0.0.
License requirements: None.
SetDeleteState¶
-
PatternDefinition.
SetDeleteState
¶ Sets the delete state for the instance at the specified indicies.
Signature
SetDeleteState(index1, index2, deleteState)
Parameters: - index1 (int) – First index of instance
- index2 (int) – Second index of instance
- deleteState (bool) – Input suppress state
New in version NX8.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”)
SetSpreadsheetData¶
-
PatternDefinition.
SetSpreadsheetData
¶ Sets the spreadsheet data
Signature
SetSpreadsheetData(spreadsheetTableArray, locationTableArray, defaultTableArray)
Parameters: - spreadsheetTableArray (list of float) –
- locationTableArray (list of float) –
- defaultTableArray (list of bool) –
New in version NX8.0.0.
License requirements: None.
SetSuppressState¶
-
PatternDefinition.
SetSuppressState
¶ Sets the suppress state for the instance at the specified indicies.
Signature
SetSuppressState(index1, index2, suppressState)
Parameters: - index1 (int) – First index of instance
- index2 (int) – Second index of instance
- suppressState (bool) – Input suppress state
New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”)
Validate¶
-
PatternDefinition.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.