NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Features.HelixBuilder Class Reference

Represents a NXOpen.Features.Helix builder More...

Inheritance diagram for NXOpen.Features.HelixBuilder:
NXOpen.Features.FeatureBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  LengthMethods { Limits, Turns }
 Method for defining the length More...
 
enum  OrientationOptions { Inferred, Specified }
 Orientation options for along spine type More...
 
enum  SizeOptions { Diameter, Radius }
 Option indicating how size is defined More...
 
enum  TurnDirections { RightHand, LeftHand }
 Option indicating direction of the turn More...
 
enum  Types { AlongVector, AlongSpine }
 Type of helix More...
 

Public Member Functions

unsafe void Evaluate ()
 Evaluates the curve More...
 
- Public Member Functions inherited from NXOpen.Features.FeatureBuilder
unsafe NXOpen.Features.Feature CommitFeature ()
 Commits the feature parameters and creates the feature More...
 
unsafe NXOpen.Features.Feature GetFeature ()
 Returns the feature currently being edited by this builder. More...
 
unsafe void HideInternalParentFeatureAfterEdit (NXOpen.Features.Feature parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
unsafe void SetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited More...
 
unsafe void ShowInternalParentFeatureForEdit (NXOpen.Features.Feature parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
unsafe void UnsetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the internal parent feature of the feature being edited to external More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
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 double AngleTolerance [get, set]
 Returns or sets the angle tolerance More...
 
unsafe NXOpen.CoordinateSystem CoordinateSystem [get, set]
 Returns or sets the coordinate system More...
 
unsafe double DistanceTolerance [get, set]
 Returns or sets the distance tolerance More...
 
unsafe
NXOpen.GeometricUtilities.OnPathDimensionBuilder 
EndLimit [get]
 Returns the end limit More...
 
unsafe
NXOpen.Features.HelixBuilder.LengthMethods 
LengthMethod [get, set]
 Returns or sets the length method More...
 
unsafe string NumberOfTurns [get, set]
 Returns or sets the number of turns More...
 
unsafe
NXOpen.Features.HelixBuilder.OrientationOptions 
OrientationOption [get, set]
 Returns or sets the orientation option More...
 
unsafe
NXOpen.GeometricUtilities.LawBuilder 
PitchLaw [get]
 Returns the pitch More...
 
unsafe
NXOpen.GeometricUtilities.LawBuilder 
SizeLaw [get]
 Returns the size law More...
 
unsafe
NXOpen.Features.HelixBuilder.SizeOptions 
SizeOption [get, set]
 Returns or sets the size option More...
 
unsafe NXOpen.Section Spine [get]
 Returns the length spine More...
 
unsafe NXOpen.Expression StartAngle [get]
 Returns the start angle More...
 
unsafe
NXOpen.GeometricUtilities.OnPathDimensionBuilder 
StartLimit [get]
 Returns the start limit More...
 
unsafe
NXOpen.Features.HelixBuilder.TurnDirections 
TurnDirection [get, set]
 Returns or sets the turn direction More...
 
unsafe NXOpen.Expression Turns [get]
 Returns the number of turns More...
 
unsafe
NXOpen.Features.HelixBuilder.Types 
Type [get, set]
 Returns or sets the type More...
 
- Properties inherited from NXOpen.Features.FeatureBuilder
unsafe bool ParentFeatureInternal [get, set]
 Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal More...
 
unsafe bool PatchSolutionFlag [get, set]
 Returns or sets the patch solution flag More...
 
unsafe string PatchSurfaceFilename [get, set]
 Returns or sets the patch surface filename More...
 
unsafe string SurroundingPatchSurfaceFilename [get, set]
 Returns or sets the surrounding patch surface filename More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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

Method for defining the length

Enumerator
Limits 

Length by start and end limit

Turns 

Length by number of turns

Orientation options for along spine type

Enumerator
Inferred 

Local coordinate system is inferred from spine, at the start

Specified 

Local coordinate system is specified by the user.

The spine is transformed using this coordinate system.

Option indicating how size is defined

Enumerator
Diameter 

Size by diameter

Radius 

Size by radius

Option indicating direction of the turn

Enumerator
RightHand 

Right handed helix

LeftHand 

Left handed helix

Type of helix

Enumerator
AlongVector 

Along a vector

AlongSpine 

Along a spine

Member Function Documentation

unsafe void NXOpen.Features.HelixBuilder.Evaluate ( )
inline

Evaluates the curve

Created in NX8.5.0

License requirements: features_modeling ("FEATURES MODELING")

Property Documentation

unsafe double NXOpen.Features.HelixBuilder.AngleTolerance
getset

Returns or sets the angle tolerance

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.CoordinateSystem NXOpen.Features.HelixBuilder.CoordinateSystem
getset

Returns or sets the coordinate system

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe double NXOpen.Features.HelixBuilder.DistanceTolerance
getset

Returns or sets the distance tolerance

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.GeometricUtilities.OnPathDimensionBuilder NXOpen.Features.HelixBuilder.EndLimit
get

Returns the end limit

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.Features.HelixBuilder.LengthMethods NXOpen.Features.HelixBuilder.LengthMethod
getset

Returns or sets the length method

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe string NXOpen.Features.HelixBuilder.NumberOfTurns
getset

Returns or sets the number of turns

Created in NX8.5.0

Deprecated in NX12.0.0. Use NXOpen.Features.HelixBuilder.Turns

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Features.HelixBuilder.OrientationOptions NXOpen.Features.HelixBuilder.OrientationOption
getset

Returns or sets the orientation option

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.GeometricUtilities.LawBuilder NXOpen.Features.HelixBuilder.PitchLaw
get

Returns the pitch

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.LawBuilder NXOpen.Features.HelixBuilder.SizeLaw
get

Returns the size law

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.Features.HelixBuilder.SizeOptions NXOpen.Features.HelixBuilder.SizeOption
getset

Returns or sets the size option

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Section NXOpen.Features.HelixBuilder.Spine
get

Returns the length spine

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Features.HelixBuilder.StartAngle
get

Returns the start angle

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.OnPathDimensionBuilder NXOpen.Features.HelixBuilder.StartLimit
get

Returns the start limit

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.Features.HelixBuilder.TurnDirections NXOpen.Features.HelixBuilder.TurnDirection
getset

Returns or sets the turn direction

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Expression NXOpen.Features.HelixBuilder.Turns
get

Returns the number of turns

Created in NX12.0.0

License requirements: None.

unsafe NXOpen.Features.HelixBuilder.Types NXOpen.Features.HelixBuilder.Type
getset

Returns or sets the type

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.