SpiralPattern Class¶
-
class
NXOpen.GeometricUtilities.
SpiralPattern
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
the Spiral pattern definition.
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
DirectionType | Returns or sets the type of spiral direction method |
HorizontalRef | Returns the horizontal reference |
NumberOfTurns | Returns the number of turns of spiral |
PitchAlongSpiral | Returns the pitch along spiral curve |
RadialPitch | Returns the radial pitch of spiral |
SizeSpiralType | Returns or sets the size spiral type |
SpiralNormal | Returns or sets the spiral normal vector |
Tag | Returns the Tag for this object. |
TotalAngle | Returns the total angle of spiral |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
SpiralPatternOrientType Enumeration | This defines spiral direction method |
SpiralPatternSpiralDefineSize Enumeration | This defines size spiral type |
Property Detail¶
DirectionType¶
-
SpiralPattern.
DirectionType
¶ Returns or sets the type of spiral direction method
-------------------------------------
Getter Method
Signature
DirectionType()
Returns: Return type: NXOpen.GeometricUtilities.SpiralPatternOrientType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DirectionType(directionType)
Parameters: directionType ( NXOpen.GeometricUtilities.SpiralPatternOrientType
) –New in version NX8.0.0.
License requirements: None.
HorizontalRef¶
-
SpiralPattern.
HorizontalRef
¶ Returns the horizontal reference
-------------------------------------
Getter Method
Signature
HorizontalRef()
Returns: Return type: NXOpen.GeometricUtilities.HorizontalReference
New in version NX8.0.0.
License requirements: None.
NumberOfTurns¶
-
SpiralPattern.
NumberOfTurns
¶ Returns the number of turns of spiral
-------------------------------------
Getter Method
Signature
NumberOfTurns()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
PitchAlongSpiral¶
-
SpiralPattern.
PitchAlongSpiral
¶ Returns the pitch along spiral curve
-------------------------------------
Getter Method
Signature
PitchAlongSpiral()
Returns: Return type: NXOpen.GeometricUtilities.OnPathDistancePatternSpacing
New in version NX8.0.0.
License requirements: None.
RadialPitch¶
-
SpiralPattern.
RadialPitch
¶ Returns the radial pitch of spiral
-------------------------------------
Getter Method
Signature
RadialPitch()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
SizeSpiralType¶
-
SpiralPattern.
SizeSpiralType
¶ Returns or sets the size spiral type
-------------------------------------
Getter Method
Signature
SizeSpiralType()
Returns: Return type: NXOpen.GeometricUtilities.SpiralPatternSpiralDefineSize
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SizeSpiralType(sizeSpiralType)
Parameters: sizeSpiralType ( NXOpen.GeometricUtilities.SpiralPatternSpiralDefineSize
) –New in version NX8.0.0.
License requirements: None.
SpiralNormal¶
-
SpiralPattern.
SpiralNormal
¶ Returns or sets the spiral normal vector
-------------------------------------
Getter Method
Signature
SpiralNormal()
Returns: Return type: NXOpen.Direction
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SpiralNormal(spiralNormal)
Parameters: spiralNormal ( NXOpen.Direction
) –New in version NX8.0.0.
License requirements: None.
TotalAngle¶
-
SpiralPattern.
TotalAngle
¶ Returns the total angle of spiral
-------------------------------------
Getter Method
Signature
TotalAngle()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
SpiralPattern.
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.