CircularPattern Class¶
-
class
NXOpen.GeometricUtilities.
CircularPattern
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
the circular pattern definition.
Allows specification along both the angular and radial directions. .. versionadded:: NX7.5.0
Properties¶
Property | Description |
---|---|
AngularSpacing | Returns the angular spacing of the instances of the pattern |
CenterPoint | Returns the center point object for 2D mode. |
CreateLastStaggered | Returns or sets the option to generate the last item in a staggered row. |
Flip | Returns or sets the flip object for 2D mode. |
HorizontalRef | Returns the horizontal reference |
IncludeSeedToggle | Returns or sets the IncludeSeed toggle attribute. |
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. |
StaggerType | Returns or sets the type of stagger to be used by the 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¶
CircularPatternStaggerOptions Enumeration | defines any stagger to be defined on the pattern. |
Property Detail¶
AngularSpacing¶
-
CircularPattern.
AngularSpacing
¶ Returns the angular spacing of the instances of the pattern
-------------------------------------
Getter Method
Signature
AngularSpacing()
Returns: Return type: NXOpen.GeometricUtilities.AngularPatternSpacing
New in version NX7.5.0.
License requirements: None.
CenterPoint¶
-
CircularPattern.
CenterPoint
¶ Returns the center point object for 2D mode.
This function gets center point object of the 2D pattern
-------------------------------------
Getter Method
Signature
CenterPoint()
Returns: Return type: NXOpen.SelectNXObject
New in version NX7.5.0.
Deprecated since version NX8.0.0: Use
GeometricUtilities.CircularPattern.RotationCenter()
instead.License requirements: None.
CreateLastStaggered¶
-
CircularPattern.
CreateLastStaggered
¶ Returns or sets the option to generate the last item in a staggered row.
If ‘true’ the pattern will be narrower on rows that have been staggered.
-------------------------------------
Getter Method
Signature
CreateLastStaggered()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateLastStaggered(create)
Parameters: create (bool) – New in version NX7.5.0.
License requirements: None.
Flip¶
-
CircularPattern.
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 NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Flip(enabled)
Parameters: enabled (bool) – New in version NX7.5.0.
License requirements: None.
HorizontalRef¶
-
CircularPattern.
HorizontalRef
¶ Returns the horizontal reference
-------------------------------------
Getter Method
Signature
HorizontalRef()
Returns: Return type: NXOpen.GeometricUtilities.HorizontalReference
New in version NX8.0.0.
License requirements: None.
IncludeSeedToggle¶
-
CircularPattern.
IncludeSeedToggle
¶ Returns or sets the IncludeSeed toggle attribute.
This function gets the IncludeSeed toggle value
-------------------------------------
Getter Method
Signature
IncludeSeedToggle()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IncludeSeedToggle(toggle)
Parameters: toggle (bool) – New in version NX7.5.0.
License requirements: None.
RadialSpacing¶
-
CircularPattern.
RadialSpacing
¶ Returns the radial spacing of the instances of the pattern
-------------------------------------
Getter Method
Signature
RadialSpacing()
Returns: Return type: NXOpen.GeometricUtilities.DistancePatternSpacing
New in version NX7.5.0.
License requirements: None.
RotationAxis¶
-
CircularPattern.
RotationAxis
¶ Returns or sets the rotation axis for the pattern.
-------------------------------------
Getter Method
Signature
RotationAxis()
Returns: Return type: NXOpen.Axis
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RotationAxis(rotationAxis)
Parameters: rotationAxis ( NXOpen.Axis
) –New in version NX7.5.0.
License requirements: None.
RotationCenter¶
-
CircularPattern.
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.
StaggerType¶
-
CircularPattern.
StaggerType
¶ Returns or sets the type of stagger to be used by the pattern
-------------------------------------
Getter Method
Signature
StaggerType()
Returns: Return type: NXOpen.GeometricUtilities.CircularPatternStaggerOptions
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StaggerType(spaceType)
Parameters: spaceType ( NXOpen.GeometricUtilities.CircularPatternStaggerOptions
) –New in version NX7.5.0.
License requirements: None.
UseRadialDirectionToggle¶
-
CircularPattern.
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 NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseRadialDirectionToggle(toggle)
Parameters: toggle (bool) – New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
CircularPattern.
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.