NXOpen.GeometricUtilities.SpiralPattern Class Reference

the Spiral pattern definition. More...

Inheritance diagram for NXOpen.GeometricUtilities.SpiralPattern:

Public Types
enum	OrientType { Lefthand, Righthand }
	This defines spiral direction method More...
enum	SpiralDefineSize { NumberOfTurns, TotalAngle }
	This defines size spiral type More...

Public Member Functions
unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
override string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.GeometricUtilities.SpiralPattern.OrientType	DirectionType [get, set]
	Returns or sets the type of spiral direction method More...
unsafe NXOpen.GeometricUtilities.HorizontalReference	HorizontalRef [get]
	Returns the horizontal reference More...
unsafe NXOpen.Expression	NumberOfTurns [get]
	Returns the number of turns of spiral More...
unsafe NXOpen.GeometricUtilities.OnPathDistancePatternSpacing	PitchAlongSpiral [get]
	Returns the pitch along spiral curve More...
unsafe NXOpen.Expression	RadialPitch [get]
	Returns the radial pitch of spiral More...
unsafe NXOpen.GeometricUtilities.SpiralPattern.SpiralDefineSize	SizeSpiralType [get, set]
	Returns or sets the size spiral type More...
unsafe NXOpen.Direction	SpiralNormal [get, set]
	Returns or sets the spiral normal vector More...
unsafe NXOpen.Expression	TotalAngle [get]
	Returns the total angle of spiral More...
Properties inherited from NXOpen.TaggedObject
Tag	Tag [get]
	Returns the tag of this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

the Spiral pattern definition.

Created in NX8.0.0

Member Enumeration Documentation

enum NXOpen.GeometricUtilities.SpiralPattern.OrientType

This defines spiral direction method

Enumerator
Lefthand	Left hand orientation.
Righthand	Right hand orientation.

enum NXOpen.GeometricUtilities.SpiralPattern.SpiralDefineSize

This defines size spiral type

Enumerator
NumberOfTurns	using number of turns to define size of spiral
TotalAngle	using total angle to define size of spiral

Member Function Documentation

unsafe bool NXOpen.GeometricUtilities.SpiralPattern.Validate ( )

inline

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.

Created in NX3.0.1

License requirements: None.

Returns

Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.GeometricUtilities.SpiralPattern.OrientType NXOpen.GeometricUtilities.SpiralPattern.DirectionType

getset

Returns or sets the type of spiral direction method

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.HorizontalReference NXOpen.GeometricUtilities.SpiralPattern.HorizontalRef

get

Returns the horizontal reference

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.SpiralPattern.NumberOfTurns

get

Returns the number of turns of spiral

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.OnPathDistancePatternSpacing NXOpen.GeometricUtilities.SpiralPattern.PitchAlongSpiral

get

Returns the pitch along spiral curve

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.SpiralPattern.RadialPitch

get

Returns the radial pitch of spiral

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.SpiralPattern.SpiralDefineSize NXOpen.GeometricUtilities.SpiralPattern.SizeSpiralType

getset

Returns or sets the size spiral type

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Direction NXOpen.GeometricUtilities.SpiralPattern.SpiralNormal

getset

Returns or sets the spiral normal vector

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.SpiralPattern.TotalAngle

get

Returns the total angle of spiral

Created in NX8.0.0

License requirements: None.

---

The documentation for this class was generated from the following file:

• GeometricUtilities_SpiralPattern.cs