PolygonPattern Class¶
-
class
NXOpen.GeometricUtilities.
PolygonPattern
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
the polygon pattern definition.
Allows specification along both the angular and radial directions. .. versionadded:: NX8.0.0
Properties¶
Property | Description |
---|---|
Flip | Returns or sets the flip object for 2D mode. |
HorizontalRef | Returns the horizontal reference |
NumberOfSides | Returns the number of sides for the polygon type pattern will generated in this direction |
PolygonSizeOption | Returns or sets the polygon size option |
PolygonSpacing | Returns the polygon spacing of the instances of the pattern |
RadialSpacing | Returns the radial spacing of the instances of the pattern |
RotationAxis | Returns or sets the rotation axis for the pattern. |
RotationCenter | Returns or sets the rotation center for the 2d pattern. |
Tag | Returns the Tag for this object. |
UseRadialDirectionToggle | Returns or sets the UseRadialDirection toggle attribute. |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
PolygonPatternSizeOptions Enumeration | defines polygon size options for polygon type pattern. |
Property Detail¶
Flip¶
-
PolygonPattern.
Flip
¶ Returns or sets the flip object for 2D mode.
This function gets the flip attribute of the 2D pattern.
-------------------------------------
Getter Method
Signature
Flip()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Flip(enabled)
Parameters: enabled (bool) – New in version NX8.0.0.
License requirements: None.
HorizontalRef¶
-
PolygonPattern.
HorizontalRef
¶ Returns the horizontal reference
-------------------------------------
Getter Method
Signature
HorizontalRef()
Returns: Return type: NXOpen.GeometricUtilities.HorizontalReference
New in version NX8.0.0.
License requirements: None.
NumberOfSides¶
-
PolygonPattern.
NumberOfSides
¶ Returns the number of sides for the polygon type pattern will generated in this direction
-------------------------------------
Getter Method
Signature
NumberOfSides()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
PolygonSizeOption¶
-
PolygonPattern.
PolygonSizeOption
¶ Returns or sets the polygon size option
-------------------------------------
Getter Method
Signature
PolygonSizeOption()
Returns: Return type: NXOpen.GeometricUtilities.PolygonPatternSizeOptions
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PolygonSizeOption(option)
Parameters: option ( NXOpen.GeometricUtilities.PolygonPatternSizeOptions
) –New in version NX8.0.0.
License requirements: None.
PolygonSpacing¶
-
PolygonPattern.
PolygonSpacing
¶ Returns the polygon spacing of the instances of the pattern
-------------------------------------
Getter Method
Signature
PolygonSpacing()
Returns: Return type: NXOpen.GeometricUtilities.PolygonPatternSpacing
New in version NX8.0.0.
License requirements: None.
RadialSpacing¶
-
PolygonPattern.
RadialSpacing
¶ Returns the radial spacing of the instances of the pattern
-------------------------------------
Getter Method
Signature
RadialSpacing()
Returns: Return type: NXOpen.GeometricUtilities.DistancePatternSpacing
New in version NX8.0.0.
License requirements: None.
RotationAxis¶
-
PolygonPattern.
RotationAxis
¶ Returns or sets the rotation axis for the pattern.
-------------------------------------
Getter Method
Signature
RotationAxis()
Returns: Return type: NXOpen.Axis
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RotationAxis(rotationAxis)
Parameters: rotationAxis ( NXOpen.Axis
) –New in version NX8.0.0.
License requirements: None.
RotationCenter¶
-
PolygonPattern.
RotationCenter
¶ Returns or sets the rotation center for the 2d pattern.
-------------------------------------
Getter Method
Signature
RotationCenter()
Returns: Return type: NXOpen.Point
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RotationCenter(rotationCenter)
Parameters: rotationCenter ( NXOpen.Point
) –New in version NX8.0.0.
License requirements: None.
UseRadialDirectionToggle¶
-
PolygonPattern.
UseRadialDirectionToggle
¶ Returns or sets the UseRadialDirection toggle attribute.
This function gets the UseRadialDirection toggle value
-------------------------------------
Getter Method
Signature
UseRadialDirectionToggle()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseRadialDirectionToggle(toggle)
Parameters: toggle (bool) – New in version NX8.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
PolygonPattern.
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.