the Helix pattern definition. More...

Inheritance diagram for NXOpen.GeometricUtilities.HelixPattern:

Public Types
enum	DirectionTypes { Righthand, Lefthand }
	This defines helix direction method More...

enum	SizeOptions { CountAngleDistance, CountHelixPitchAndTurns, CountHelixPitchAndSpan, AngleHelixPitchAndTurns, AngleHelixPitchAndSpan }
	defines Helix size options for Helix type pattern. 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.Expression	AnglePitch `[get]`
	Returns the angle pitch expression for the Helix type pattern More...

unsafe NXOpen.Expression	CountOfInstances `[get]`
	Returns the count of instances for the Helix type pattern More...

unsafe NXOpen.GeometricUtilities.HelixPattern.DirectionTypes	DirectionType `[get, set]`
	Returns or sets the type of helix direction method More...

unsafe NXOpen.Expression	DistancePitch `[get]`
	Returns the distance pitch expression for the Helix type pattern More...

unsafe NXOpen.Expression	HelixPitch `[get]`
	Returns the helix pitch expression for the Helix type pattern More...

unsafe NXOpen.Expression	HelixSpan `[get]`
	Returns the helix span expression for the Helix type pattern More...

unsafe NXOpen.Expression	NumberOfTurns `[get]`
	Returns the number of turns for the Helix type pattern More...

unsafe NXOpen.Axis	RotationAxis `[get, set]`
	Returns or sets the rotation axis for the pattern. More...

unsafe NXOpen.GeometricUtilities.HelixPattern.SizeOptions	SizeOption `[get, set]`
	Returns or sets the Helix size option 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 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
Righthand	Right hand orientation.
Lefthand	Left hand orientation.

enum NXOpen.GeometricUtilities.HelixPattern.SizeOptions

defines Helix size options for Helix type pattern.

Enumerator
CountAngleDistance	use Count, Angle, Distance to define a Helix
CountHelixPitchAndTurns	use Count, Helix Pitch, Turns to define a Helix
CountHelixPitchAndSpan	use Count, Helix Pitch, Span to define a Helix
AngleHelixPitchAndTurns	use Angle, Helix Pitch, Turns to define a Helix
AngleHelixPitchAndSpan	use Angle, Helix Pitch, Span to define a Helix

Member Function Documentation

unsafe bool NXOpen.GeometricUtilities.HelixPattern.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.Expression NXOpen.GeometricUtilities.HelixPattern.AnglePitch

get

Returns the angle pitch expression for the Helix type pattern

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.HelixPattern.CountOfInstances

get

Returns the count of instances for the Helix type pattern

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.HelixPattern.DirectionTypes NXOpen.GeometricUtilities.HelixPattern.DirectionType

getset

Returns or sets the type of helix direction method

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.HelixPattern.DistancePitch

get

Returns the distance pitch expression for the Helix type pattern

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.HelixPattern.HelixPitch

get

Returns the helix pitch expression for the Helix type pattern

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.HelixPattern.HelixSpan

get

Returns the helix span expression for the Helix type pattern

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.HelixPattern.NumberOfTurns

get

Returns the number of turns for the Helix type pattern

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Axis NXOpen.GeometricUtilities.HelixPattern.RotationAxis

getset

Returns or sets the rotation axis for the pattern.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.HelixPattern.SizeOptions NXOpen.GeometricUtilities.HelixPattern.SizeOption

getset

Returns or sets the Helix size option

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

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

GeometricUtilities_HelixPattern.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation