Represents a NXOpen::Features::Helix builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateHelixBuilder
Default values. More...

Inheritance diagram for NXOpen::Features::HelixBuilder:

Public Types
enum	LengthMethods { LengthMethodsLimits, LengthMethodsTurns }
	Method for defining the length. More...

enum	OrientationOptions { OrientationOptionsInferred, OrientationOptionsSpecified }
	Orientation options for along spine type. More...

enum	SizeOptions { SizeOptionsDiameter, SizeOptionsRadius }
	Option indicating how size is defined. More...

enum	TurnDirections { TurnDirectionsRightHand, TurnDirectionsLeftHand }
	Option indicating direction of the turn. More...

enum	Types { TypesAlongVector, TypesAlongSpine }
	Type of helix. More...

Public Member Functions
double	AngleTolerance ()
	Returns the angle tolerance Created in NX8.5.0. More...

NXOpen::CoordinateSystem *	CoordinateSystem ()
	Returns the coordinate system Created in NX8.5.0. More...

double	DistanceTolerance ()
	Returns the distance tolerance Created in NX8.5.0. More...

NXOpen::GeometricUtilities::OnPathDimensionBuilder *	EndLimit ()
	Returns the end limit Created in NX8.5.0. More...

void	Evaluate ()
	Evaluates the curve Created in NX8.5.0. More...

NXOpen::Features::HelixBuilder::LengthMethods	LengthMethod ()
	Returns the length method Created in NX8.5.0. More...

NXString	NumberOfTurns ()
	Returns the number of turns More...

NXOpen::Features::HelixBuilder::OrientationOptions	OrientationOption ()
	Returns the orientation option Created in NX8.5.0. More...

NXOpen::GeometricUtilities::LawBuilder *	PitchLaw ()
	Returns the pitch Created in NX8.5.0. More...

void	SetAngleTolerance (double angleTolerance)
	Sets the angle tolerance Created in NX8.5.0. More...

void	SetCoordinateSystem (NXOpen::CoordinateSystem *coordinateSystem)
	Sets the coordinate system Created in NX8.5.0. More...

void	SetDistanceTolerance (double distanceTolerance)
	Sets the distance tolerance Created in NX8.5.0. More...

void	SetLengthMethod (NXOpen::Features::HelixBuilder::LengthMethods lengthMethod)
	Sets the length method Created in NX8.5.0. More...

void	SetNumberOfTurns (const NXString &numberOfTurns)
	Sets the number of turns More...

void	SetNumberOfTurns (const char *numberOfTurns)
	Sets the number of turns More...

void	SetOrientationOption (NXOpen::Features::HelixBuilder::OrientationOptions orientationOption)
	Sets the orientation option Created in NX8.5.0. More...

void	SetSizeOption (NXOpen::Features::HelixBuilder::SizeOptions sizeOption)
	Sets the size option Created in NX8.5.0. More...

void	SetTurnDirection (NXOpen::Features::HelixBuilder::TurnDirections turnDirection)
	Sets the turn direction Created in NX8.5.0. More...

void	SetType (NXOpen::Features::HelixBuilder::Types type)
	Sets the type Created in NX8.5.0. More...

NXOpen::GeometricUtilities::LawBuilder *	SizeLaw ()
	Returns the size law Created in NX8.5.0. More...

NXOpen::Features::HelixBuilder::SizeOptions	SizeOption ()
	Returns the size option Created in NX8.5.0. More...

NXOpen::Section *	Spine ()
	Returns the length spine Created in NX8.5.0. More...

NXOpen::Expression *	StartAngle ()
	Returns the start angle Created in NX8.5.0. More...

NXOpen::GeometricUtilities::OnPathDimensionBuilder *	StartLimit ()
	Returns the start limit Created in NX8.5.0. More...

NXOpen::Features::HelixBuilder::TurnDirections	TurnDirection ()
	Returns the turn direction Created in NX8.5.0. More...

NXOpen::Expression *	Turns ()
	Returns the number of turns Created in NX12.0.0. More...

NXOpen::Features::HelixBuilder::Types	Type ()
	Returns the type Created in NX8.5.0. More...

Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::Feature *	CommitFeature ()
	Commits the feature parameters and creates the feature. More...

NXOpen::Features::Feature *	GetFeature ()
	Returns the feature currently being edited by this builder. More...

void	HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
	Re-suppress an internal parent feature (a slave feature) after it has been edited. More...

bool	ParentFeatureInternal ()
	Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0. More...

bool	PatchSolutionFlag ()
	Returns the patch solution flag Created in NX8.0.1. More...

NXString	PatchSurfaceFilename ()
	Returns the patch surface filename Created in NX8.0.1. More...

void	SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the parent features which would be internal or slaves to the feature being created or commited Created in NX6.0.0. More...

void	SetParentFeatureInternal (bool isInternal)
	Sets whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0. More...

void	SetPatchSolutionFlag (bool optionValue)
	Sets the patch solution flag Created in NX8.0.1. More...

void	SetPatchSurfaceFilename (const NXString &surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1. More...

void	SetPatchSurfaceFilename (const char *surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1. More...

void	SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1. More...

void	SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1. More...

void	ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
	Unsuppress an internal parent feature (a slave feature) so it can be edited. More...

NXString	SurroundingPatchSurfaceFilename ()
	Returns the surrounding patch surface filename Created in NX8.0.1. More...

void	UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the internal parent feature of the feature being edited to external Created in NX6.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::Features::Helix builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateHelixBuilder
Default values.

Property

Value

LengthMethod

Limits

PitchLaw.Function

ft

PitchLaw.LawType

Constant

PitchLaw.Parameter

t

SizeOption

Diameter

TurnDirection

RightHand

Type

AlongVector

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::Features::HelixBuilder::LengthMethods

Method for defining the length.

Enumerator
LengthMethodsLimits	Length by start and end limit.
LengthMethodsTurns	Length by number of turns.

enum NXOpen::Features::HelixBuilder::OrientationOptions

Orientation options for along spine type.

Enumerator

OrientationOptionsInferred

Local coordinate system is inferred from spine, at the start.

OrientationOptionsSpecified

Local coordinate system is specified by the user.

The spine is transformed using this coordinate system.

enum NXOpen::Features::HelixBuilder::SizeOptions

Option indicating how size is defined.

Enumerator
SizeOptionsDiameter	Size by diameter.
SizeOptionsRadius	Size by radius.

enum NXOpen::Features::HelixBuilder::TurnDirections

Option indicating direction of the turn.

Enumerator
TurnDirectionsRightHand	Right handed helix.
TurnDirectionsLeftHand	Left handed helix.

enum NXOpen::Features::HelixBuilder::Types

Type of helix.

Enumerator
TypesAlongVector	Along a vector.
TypesAlongSpine	Along a spine.

Member Function Documentation

double NXOpen::Features::HelixBuilder::AngleTolerance ( )

Returns the angle tolerance
Created in NX8.5.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::Features::HelixBuilder::CoordinateSystem ( )

Returns the coordinate system
Created in NX8.5.0.

License requirements : None

double NXOpen::Features::HelixBuilder::DistanceTolerance ( )

Returns the distance tolerance
Created in NX8.5.0.

License requirements : None

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Features::HelixBuilder::EndLimit ( )

Returns the end limit
Created in NX8.5.0.

License requirements : None

void NXOpen::Features::HelixBuilder::Evaluate ( )

Evaluates the curve
Created in NX8.5.0.

License requirements : features_modeling ("FEATURES MODELING")

NXOpen::Features::HelixBuilder::LengthMethods NXOpen::Features::HelixBuilder::LengthMethod ( )

Returns the length method
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::HelixBuilder::NumberOfTurns ( )

Returns the number of turns

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::Features::HelixBuilder::Turns

Created in NX8.5.0.

License requirements : None

NXOpen::Features::HelixBuilder::OrientationOptions NXOpen::Features::HelixBuilder::OrientationOption ( )

Returns the orientation option
Created in NX8.5.0.

License requirements : None

NXOpen::GeometricUtilities::LawBuilder* NXOpen::Features::HelixBuilder::PitchLaw ( )

Returns the pitch
Created in NX8.5.0.

License requirements : None

void NXOpen::Features::HelixBuilder::SetAngleTolerance ( double angleTolerance )

Sets the angle tolerance
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

angleTolerance angletolerance

void NXOpen::Features::HelixBuilder::SetCoordinateSystem ( NXOpen::CoordinateSystem * coordinateSystem )

Sets the coordinate system
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

coordinateSystem coordinatesystem

void NXOpen::Features::HelixBuilder::SetDistanceTolerance ( double distanceTolerance )

Sets the distance tolerance
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

distanceTolerance distancetolerance

void NXOpen::Features::HelixBuilder::SetLengthMethod ( NXOpen::Features::HelixBuilder::LengthMethods lengthMethod )

Sets the length method
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

lengthMethod lengthmethod

void NXOpen::Features::HelixBuilder::SetNumberOfTurns ( const NXString & numberOfTurns )

Sets the number of turns

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::Features::HelixBuilder::Turns

Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

numberOfTurns numberofturns

void NXOpen::Features::HelixBuilder::SetNumberOfTurns ( const char * numberOfTurns )

Sets the number of turns

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::Features::HelixBuilder::Turns

Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

numberOfTurns numberofturns

void NXOpen::Features::HelixBuilder::SetOrientationOption ( NXOpen::Features::HelixBuilder::OrientationOptions orientationOption )

Sets the orientation option
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

orientationOption orientationoption

void NXOpen::Features::HelixBuilder::SetSizeOption ( NXOpen::Features::HelixBuilder::SizeOptions sizeOption )

Sets the size option
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

sizeOption sizeoption

void NXOpen::Features::HelixBuilder::SetTurnDirection ( NXOpen::Features::HelixBuilder::TurnDirections turnDirection )

Sets the turn direction
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

turnDirection turndirection

void NXOpen::Features::HelixBuilder::SetType ( NXOpen::Features::HelixBuilder::Types type )

Sets the type
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

type type

NXOpen::GeometricUtilities::LawBuilder* NXOpen::Features::HelixBuilder::SizeLaw ( )

Returns the size law
Created in NX8.5.0.

License requirements : None

NXOpen::Features::HelixBuilder::SizeOptions NXOpen::Features::HelixBuilder::SizeOption ( )

Returns the size option
Created in NX8.5.0.

License requirements : None

NXOpen::Section* NXOpen::Features::HelixBuilder::Spine ( )

Returns the length spine
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::HelixBuilder::StartAngle ( )

Returns the start angle
Created in NX8.5.0.

License requirements : None

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Features::HelixBuilder::StartLimit ( )

Returns the start limit
Created in NX8.5.0.

License requirements : None

NXOpen::Features::HelixBuilder::TurnDirections NXOpen::Features::HelixBuilder::TurnDirection ( )

Returns the turn direction
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::HelixBuilder::Turns ( )

Returns the number of turns
Created in NX12.0.0.

License requirements : None

NXOpen::Features::HelixBuilder::Types NXOpen::Features::HelixBuilder::Type ( )

Returns the type
Created in NX8.5.0.

License requirements : None

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

Features_HelixBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation