NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricUtilities::SpiralPattern Class Reference

the Spiral pattern definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::SpiralPattern:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::HorizontalReferenceHorizontalRef ()
 Returns the horizontal reference
Created in NX8.0.0.
NXOpen::ExpressionNumberOfTurns ()
 Returns the number of turns of spiral
Created in NX8.0.0.
NXOpen::GeometricUtilities::OnPathDistancePatternSpacingPitchAlongSpiral ()
 Returns the pitch along spiral curve
Created in NX8.0.0.
NXOpen::ExpressionRadialPitch ()
 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::DirectionSpiralNormal ()
 Returns the spiral normal vector
Created in NX8.0.0.
NXOpen::ExpressionTotalAngle ()
 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.

Detailed Description

the Spiral pattern definition.


Created in NX8.0.0.


Member Enumeration Documentation

This defines spiral direction method.

Enumerator:
OrientTypeLefthand 

Left hand orientation.

OrientTypeRighthand 

Right hand orientation.

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

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



License requirements : None

Returns the horizontal reference
Created in NX8.0.0.



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Parameters:
directionTypedirectiontype

Sets the size spiral type
Created in NX8.0.0.



License requirements : None

Parameters:
sizeSpiralTypesizespiraltype

Sets the spiral normal vector
Created in NX8.0.0.



License requirements : None

Parameters:
spiralNormalspiralnormal

Returns the size spiral type
Created in NX8.0.0.



License requirements : None

Returns the spiral normal vector
Created in NX8.0.0.



License requirements : None

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



License requirements : None

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.