the Helix pattern definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::HelixPattern:

Public Types
enum	DirectionTypes { DirectionTypesRighthand, DirectionTypesLefthand }
	This defines helix direction method. More...

enum	SizeOptions { SizeOptionsCountAngleDistance, SizeOptionsCountHelixPitchAndTurns, SizeOptionsCountHelixPitchAndSpan, SizeOptionsAngleHelixPitchAndTurns, SizeOptionsAngleHelixPitchAndSpan }
	defines Helix size options for Helix type pattern. More...

Public Member Functions
NXOpen::Expression *	AnglePitch ()
	Returns the angle pitch expression for the Helix type pattern Created in NX9.0.0.

NXOpen::Expression *	CountOfInstances ()
	Returns the count of instances for the Helix type pattern Created in NX9.0.0.

NXOpen::GeometricUtilities::HelixPattern::DirectionTypes	DirectionType ()
	Returns the type of helix direction method Created in NX9.0.0.

NXOpen::Expression *	DistancePitch ()
	Returns the distance pitch expression for the Helix type pattern Created in NX9.0.0.

NXOpen::Expression *	HelixPitch ()
	Returns the helix pitch expression for the Helix type pattern Created in NX9.0.0.

NXOpen::Expression *	HelixSpan ()
	Returns the helix span expression for the Helix type pattern Created in NX9.0.0.

NXOpen::Expression *	NumberOfTurns ()
	Returns the number of turns for the Helix type pattern Created in NX9.0.0.

NXOpen::Axis *	RotationAxis ()
	Returns the rotation axis for the pattern.

void	SetDirectionType (NXOpen::GeometricUtilities::HelixPattern::DirectionTypes directionType)
	Sets the type of helix direction method Created in NX9.0.0.

void	SetRotationAxis (NXOpen::Axis *rotationAxis)
	Sets the rotation axis for the pattern.

void	SetSizeOption (NXOpen::GeometricUtilities::HelixPattern::SizeOptions option)
	Sets the Helix size option Created in NX9.0.0.

NXOpen::GeometricUtilities::HelixPattern::SizeOptions	SizeOption ()
	Returns the Helix size option Created in NX9.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 Helix pattern definition.

Allows specification along both the angular and radial directions.
Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::HelixPattern::DirectionTypes

This defines helix direction method.

Enumerator:

DirectionTypesRighthand	Right hand orientation.
DirectionTypesLefthand	Left hand orientation.

enum NXOpen::GeometricUtilities::HelixPattern::SizeOptions

defines Helix size options for Helix type pattern.

Enumerator:

SizeOptionsCountAngleDistance	use Count, Angle, Distance to define a Helix
SizeOptionsCountHelixPitchAndTurns	use Count, Helix Pitch, Turns to define a Helix
SizeOptionsCountHelixPitchAndSpan	use Count, Helix Pitch, Span to define a Helix
SizeOptionsAngleHelixPitchAndTurns	use Angle, Helix Pitch, Turns to define a Helix
SizeOptionsAngleHelixPitchAndSpan	use Angle, Helix Pitch, Span to define a Helix

Member Function Documentation

NXOpen::Expression* NXOpen::GeometricUtilities::HelixPattern::AnglePitch ( )

Returns the angle pitch expression for the Helix type pattern
Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::HelixPattern::CountOfInstances ( )

Returns the count of instances for the Helix type pattern
Created in NX9.0.0.

License requirements : None

NXOpen::GeometricUtilities::HelixPattern::DirectionTypes NXOpen::GeometricUtilities::HelixPattern::DirectionType ( )

Returns the type of helix direction method
Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::HelixPattern::DistancePitch ( )

Returns the distance pitch expression for the Helix type pattern
Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::HelixPattern::HelixPitch ( )

Returns the helix pitch expression for the Helix type pattern
Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::HelixPattern::HelixSpan ( )

Returns the helix span expression for the Helix type pattern
Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::HelixPattern::NumberOfTurns ( )

Returns the number of turns for the Helix type pattern
Created in NX9.0.0.

License requirements : None

NXOpen::Axis* NXOpen::GeometricUtilities::HelixPattern::RotationAxis ( )

Returns the rotation axis for the pattern.

Created in NX9.0.0.

License requirements : None

void NXOpen::GeometricUtilities::HelixPattern::SetDirectionType ( NXOpen::GeometricUtilities::HelixPattern::DirectionTypes directionType )

Sets the type of helix direction method
Created in NX9.0.0.

License requirements : None

Parameters

directionType directiontype

void NXOpen::GeometricUtilities::HelixPattern::SetRotationAxis ( NXOpen::Axis * rotationAxis )

Sets the rotation axis for the pattern.

Created in NX9.0.0.

License requirements : None

Parameters

rotationAxis rotationaxis

void NXOpen::GeometricUtilities::HelixPattern::SetSizeOption ( NXOpen::GeometricUtilities::HelixPattern::SizeOptions option )

Sets the Helix size option
Created in NX9.0.0.

License requirements : None

Parameters

option option

NXOpen::GeometricUtilities::HelixPattern::SizeOptions NXOpen::GeometricUtilities::HelixPattern::SizeOption ( )

Returns the Helix size option
Created in NX9.0.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::HelixPattern::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_HelixPattern.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation