RouteSweptTwistBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# RouteSweptTwistBuilder Class

class `NXOpen.Routing.``RouteSweptTwistBuilder`

  Bases: `NXOpen.Builder`

  To create a new instance of this class, use `NXOpen.Routing.RouteManager.CreateRouteSweptTwistBuilder()`

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Spine | Returns the spine
Stock | Returns the stock
Tag | Returns the Tag for this object.
TwistPoint | Returns or sets the twist point
TwistPointList | Returns the twist point list

# Methods

Method | Description
--- | ---
AskExistingTwistData | The twist data i.
Commit | Commits any edits that have been applied to the builder.
CreateSpine | Creates a new spine
CreateSpinePoint | Creates a new spine point
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## Spine

`RouteSweptTwistBuilder.``Spine`

  Returns the spine

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

  Getter Method

  Signature `Spine`

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

  New in version NX6.0.0.

  License requirements: routing_harness (“Routing Harness”)

## Stock

`RouteSweptTwistBuilder.``Stock`

  Returns the stock

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

  Getter Method

  Signature `Stock`

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

  New in version NX6.0.0.

  License requirements: routing_harness (“Routing Harness”)

## TwistPoint

`RouteSweptTwistBuilder.``TwistPoint`

  Returns or sets the twist point

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

  Getter Method

  Signature `TwistPoint`

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

  New in version NX6.0.0.

  License requirements: routing_harness (“Routing Harness”)

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

  Setter Method

  Signature `TwistPoint`

  Parameters: | twistPoint (`NXOpen.Point`) –

  New in version NX6.0.0.

  License requirements: routing_harness (“Routing Harness”)

## TwistPointList

`RouteSweptTwistBuilder.``TwistPointList`

  Returns the twist point list

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

  Getter Method

  Signature `TwistPointList`

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

  New in version NX6.0.0.

  License requirements: routing_harness (“Routing Harness”)

# Method Detail

## AskExistingTwistData

`RouteSweptTwistBuilder.``AskExistingTwistData`

  The twist data i.

  e locations and angles

  Signature `AskExistingTwistData()`

  Returns: | a tuple
  Return type: | A tuple consisting of (locations, angles) locations is a list of float. Number of locations angles is a list of float. Number of angles

  New in version NX6.0.0.

  License requirements: routing_harness (“Routing Harness”)

## CreateSpine

`RouteSweptTwistBuilder.``CreateSpine`

  Creates a new spine

  Signature `CreateSpine()`

  New in version NX6.0.0.

  License requirements: routing_harness (“Routing Harness”)

## CreateSpinePoint

`RouteSweptTwistBuilder.``CreateSpinePoint`

  Creates a new spine point

  Signature `CreateSpinePoint()`

  Returns: | OnPathDimWithValueBuilder Object
  Return type: | `NXOpen.GeometricUtilities.OnPathDimWithValueBuilder`

  New in version NX6.0.0.

  License requirements: routing_harness (“Routing Harness”)

## Validate

`RouteSweptTwistBuilder.``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.