SpineCurveBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SpineCurveBuilder Class

class `NXOpen.Features.``SpineCurveBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `Features.SpineCurve` builder

  To create a new instance of this class, use `NXOpen.Features.FreeformCurveCollection.CreateSpineCurveBuilder()`

  Default values.

  Property | Value
  --- | ---
  Associative | 0
  Closed | 0

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
ArcSegmentsType | Returns or sets the option indicating type of shape
Associative | Returns or sets the flag indicating if an associative Spine Curve (Feature) should be created.
Closed | Returns or sets the flag indicating if a closed curve should be created if possible.
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
ReverseStartDirection | Returns or sets the flag indicating if starting direction of the curve should be opposite to the first plane normal.
StartPoint | Returns or sets the start point
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
ThroughPlanesList | Returns the plane list containing the through planes.

# 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

SpineCurveBuilderArcSegmentsTypes Enumeration | This enum represents the arc segments types

# Property Detail

## ArcSegmentsType

`SpineCurveBuilder.``ArcSegmentsType`

  Returns or sets the option indicating type of shape

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

  Getter Method

  Signature `ArcSegmentsType`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ArcSegmentsType`

  Parameters: | curveOption (`NXOpen.Features.SpineCurveBuilderArcSegmentsTypes`) –

  New in version NX11.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Associative

`SpineCurveBuilder.``Associative`

  Returns or sets the flag indicating if an associative Spine Curve (Feature) should be created.

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

  Getter Method

  Signature `Associative`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Associative`

  Parameters: | associative (bool) –

  New in version NX11.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Closed

`SpineCurveBuilder.``Closed`

  Returns or sets the flag indicating if a closed curve should be created if possible.

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

  Getter Method

  Signature `Closed`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Closed`

  Parameters: | closed (bool) –

  New in version NX11.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ReverseStartDirection

`SpineCurveBuilder.``ReverseStartDirection`

  Returns or sets the flag indicating if starting direction of the curve should be opposite to the first plane normal.

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

  Getter Method

  Signature `ReverseStartDirection`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReverseStartDirection`

  Parameters: | direction (bool) –

  New in version NX11.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## StartPoint

`SpineCurveBuilder.``StartPoint`

  Returns or sets the start point

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

  Getter Method

  Signature `StartPoint`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StartPoint`

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

  New in version NX11.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ThroughPlanesList

`SpineCurveBuilder.``ThroughPlanesList`

  Returns the plane list containing the through planes.

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

  Getter Method

  Signature `ThroughPlanesList`

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

  New in version NX11.0.0.

  License requirements: None.

# Method Detail

## Evaluate

`SpineCurveBuilder.``Evaluate`

  Evaluates the curve

  Signature `Evaluate()`

  New in version NX11.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

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