NXOpen::GeometricUtilities::SpiralPattern Class Reference

the Spiral pattern definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::SpiralPattern:

Public Types
enum	OrientType { OrientTypeLefthand, OrientTypeRighthand }
	This defines spiral direction method. More...
enum	SpiralDefineSize { SpiralDefineSizeNumberOfTurns, SpiralDefineSizeTotalAngle }
	This defines size spiral type. More...

Public Member Functions
NXOpen::GeometricUtilities::SpiralPattern::OrientType	DirectionType ()
	Returns the type of spiral direction method Created in NX8.0.0.
NXOpen::GeometricUtilities::HorizontalReference *	HorizontalRef ()
	Returns the horizontal reference Created in NX8.0.0.
NXOpen::Expression *	NumberOfTurns ()
	Returns the number of turns of spiral Created in NX8.0.0.
NXOpen::GeometricUtilities::OnPathDistancePatternSpacing *	PitchAlongSpiral ()
	Returns the pitch along spiral curve Created in NX8.0.0.
NXOpen::Expression *	RadialPitch ()
	Returns the radial pitch of spiral Created in NX8.0.0.
void	SetDirectionType (NXOpen::GeometricUtilities::SpiralPattern::OrientType directionType)
	Sets the type of spiral direction method Created in NX8.0.0.
void	SetSizeSpiralType (NXOpen::GeometricUtilities::SpiralPattern::SpiralDefineSize sizeSpiralType)
	Sets the size spiral type Created in NX8.0.0.
void	SetSpiralNormal (NXOpen::Direction *spiralNormal)
	Sets the spiral normal vector Created in NX8.0.0.
NXOpen::GeometricUtilities::SpiralPattern::SpiralDefineSize	SizeSpiralType ()
	Returns the size spiral type Created in NX8.0.0.
NXOpen::Direction *	SpiralNormal ()
	Returns the spiral normal vector Created in NX8.0.0.
NXOpen::Expression *	TotalAngle ()
	Returns the total angle of spiral Created in NX8.0.0.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

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:

OrientTypeLefthand	Left hand orientation.
OrientTypeRighthand	Right hand orientation.

enum NXOpen::GeometricUtilities::SpiralPattern::SpiralDefineSize

This defines size spiral type.

Enumerator:

SpiralDefineSizeNumberOfTurns	using number of turns to define size of spiral
SpiralDefineSizeTotalAngle	using total angle to define size of spiral

Member Function Documentation

NXOpen::GeometricUtilities::SpiralPattern::OrientType NXOpen::GeometricUtilities::SpiralPattern::DirectionType

(

)

Returns the type of spiral direction method
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::HorizontalReference* NXOpen::GeometricUtilities::SpiralPattern::HorizontalRef

(

)

Returns the horizontal reference
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::SpiralPattern::NumberOfTurns

(

)

Returns the number of turns of spiral
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::OnPathDistancePatternSpacing* NXOpen::GeometricUtilities::SpiralPattern::PitchAlongSpiral

(

)

Returns the pitch along spiral curve
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::SpiralPattern::RadialPitch

(

)

Returns the radial pitch of spiral
Created in NX8.0.0.

License requirements : None

void NXOpen::GeometricUtilities::SpiralPattern::SetDirectionType

(

NXOpen::GeometricUtilities::SpiralPattern::OrientType

directionType

)

Sets the type of spiral direction method
Created in NX8.0.0.

License requirements : None

Parameters

directionType

directiontype

void NXOpen::GeometricUtilities::SpiralPattern::SetSizeSpiralType

(

NXOpen::GeometricUtilities::SpiralPattern::SpiralDefineSize

sizeSpiralType

)

Sets the size spiral type
Created in NX8.0.0.

License requirements : None

Parameters

sizeSpiralType

sizespiraltype

void NXOpen::GeometricUtilities::SpiralPattern::SetSpiralNormal

(

NXOpen::Direction *

spiralNormal

)

Sets the spiral normal vector
Created in NX8.0.0.

License requirements : None

Parameters

spiralNormal

spiralnormal

NXOpen::GeometricUtilities::SpiralPattern::SpiralDefineSize NXOpen::GeometricUtilities::SpiralPattern::SizeSpiralType

(

)

Returns the size spiral type
Created in NX8.0.0.

License requirements : None

NXOpen::Direction* NXOpen::GeometricUtilities::SpiralPattern::SpiralNormal

(

)

Returns the spiral normal vector
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::SpiralPattern::TotalAngle

(

)

Returns the total angle of spiral
Created in NX8.0.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::SpiralPattern::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

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

• GeometricUtilities_SpiralPattern.hxx