HelixBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# HelixBuilder Class

class `NXOpen.Features.``HelixBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  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

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
AngleTolerance | Returns or sets the angle tolerance
CoordinateSystem | Returns or sets the coordinate system
DistanceTolerance | Returns or sets the distance tolerance
EndLimit | Returns the end limit
LengthMethod | Returns or sets the length method
NumberOfTurns | Returns or sets the number of turns
OrientationOption | Returns or sets the orientation option
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
PitchLaw | Returns the pitch
SizeLaw | Returns the size law
SizeOption | Returns or sets the size option
Spine | Returns the length spine
StartAngle | Returns the start angle
StartLimit | Returns the start limit
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TurnDirection | Returns or sets the turn direction
Turns | Returns the number of turns
Type | Returns or sets the type

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
Evaluate | Evaluates the curve
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

HelixBuilderLengthMethods Enumeration | Method for defining the length
HelixBuilderOrientationOptions Enumeration | Orientation options for along spine type
HelixBuilderSizeOptions Enumeration | Option indicating how size is defined
HelixBuilderTurnDirections Enumeration | Option indicating direction of the turn
HelixBuilderTypes Enumeration | Type of helix

# Property Detail

## AngleTolerance

`HelixBuilder.``AngleTolerance`

  Returns or sets the angle tolerance

  `-------------------------------------`

  Getter Method

  Signature `AngleTolerance`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AngleTolerance`

  Parameters: | angleTolerance (float) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CoordinateSystem

`HelixBuilder.``CoordinateSystem`

  Returns or sets the coordinate system

  `-------------------------------------`

  Getter Method

  Signature `CoordinateSystem`

  Returns: |
  Return type: | `NXOpen.CoordinateSystem`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CoordinateSystem`

  Parameters: | coordinateSystem (`NXOpen.CoordinateSystem`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## DistanceTolerance

`HelixBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance

  `-------------------------------------`

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## EndLimit

`HelixBuilder.``EndLimit`

  Returns the end limit

  `-------------------------------------`

  Getter Method

  Signature `EndLimit`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.OnPathDimensionBuilder`

  New in version NX8.5.0.

  License requirements: None.

## LengthMethod

`HelixBuilder.``LengthMethod`

  Returns or sets the length method

  `-------------------------------------`

  Getter Method

  Signature `LengthMethod`

  Returns: |
  Return type: | `NXOpen.Features.HelixBuilderLengthMethods`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LengthMethod`

  Parameters: | lengthMethod (`NXOpen.Features.HelixBuilderLengthMethods`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## NumberOfTurns

`HelixBuilder.``NumberOfTurns`

  Returns or sets the number of turns

  `-------------------------------------`

  Getter Method

  Signature `NumberOfTurns`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  Deprecated since version NX12.0.0: Use `NXOpen.Features.HelixBuilder.Turns()`

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NumberOfTurns`

  Parameters: | numberOfTurns (str) –

  New in version NX8.5.0.

  Deprecated since version NX12.0.0: Use `NXOpen.Features.HelixBuilder.Turns()`

  License requirements: solid_modeling (“SOLIDS MODELING”)

## OrientationOption

`HelixBuilder.``OrientationOption`

  Returns or sets the orientation option

  `-------------------------------------`

  Getter Method

  Signature `OrientationOption`

  Returns: |
  Return type: | `NXOpen.Features.HelixBuilderOrientationOptions`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OrientationOption`

  Parameters: | orientationOption (`NXOpen.Features.HelixBuilderOrientationOptions`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## PitchLaw

`HelixBuilder.``PitchLaw`

  Returns the pitch

  `-------------------------------------`

  Getter Method

  Signature `PitchLaw`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.LawBuilder`

  New in version NX8.5.0.

  License requirements: None.

## SizeLaw

`HelixBuilder.``SizeLaw`

  Returns the size law

  `-------------------------------------`

  Getter Method

  Signature `SizeLaw`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.LawBuilder`

  New in version NX8.5.0.

  License requirements: None.

## SizeOption

`HelixBuilder.``SizeOption`

  Returns or sets the size option

  `-------------------------------------`

  Getter Method

  Signature `SizeOption`

  Returns: |
  Return type: | `NXOpen.Features.HelixBuilderSizeOptions`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SizeOption`

  Parameters: | sizeOption (`NXOpen.Features.HelixBuilderSizeOptions`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Spine

`HelixBuilder.``Spine`

  Returns the length spine

  `-------------------------------------`

  Getter Method

  Signature `Spine`

  Returns: |
  Return type: | `NXOpen.Section`

  New in version NX8.5.0.

  License requirements: None.

## StartAngle

`HelixBuilder.``StartAngle`

  Returns the start angle

  `-------------------------------------`

  Getter Method

  Signature `StartAngle`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

## StartLimit

`HelixBuilder.``StartLimit`

  Returns the start limit

  `-------------------------------------`

  Getter Method

  Signature `StartLimit`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.OnPathDimensionBuilder`

  New in version NX8.5.0.

  License requirements: None.

## TurnDirection

`HelixBuilder.``TurnDirection`

  Returns or sets the turn direction

  `-------------------------------------`

  Getter Method

  Signature `TurnDirection`

  Returns: |
  Return type: | `NXOpen.Features.HelixBuilderTurnDirections`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TurnDirection`

  Parameters: | turnDirection (`NXOpen.Features.HelixBuilderTurnDirections`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Turns

`HelixBuilder.``Turns`

  Returns the number of turns

  `-------------------------------------`

  Getter Method

  Signature `Turns`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX12.0.0.

  License requirements: None.

## Type

`HelixBuilder.``Type`

  Returns or sets the type

  `-------------------------------------`

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Features.HelixBuilderTypes`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.HelixBuilderTypes`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## Evaluate

`HelixBuilder.``Evaluate`

  Evaluates the curve

  Signature `Evaluate()`

  New in version NX8.5.0.

  License requirements: features_modeling (“FEATURES MODELING”)

## Validate

`HelixBuilder.``Validate`

  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.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.