SectionCurveBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SectionCurveBuilder Class

class `NXOpen.Features.``SectionCurveBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.SectionCurve` builder.

  Inputs to this class can be convergent objects.

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

  Default values.

  Property | Value
  --- | ---
  Associative | True
  CurveFitData.CurveJoinMethod | No
  CurveFitData.Degree | 7
  CurveFitData.FitMethod | DegreeAndSegments
  CurveFitData.IsAdvancedFit | 0
  CurveFitData.IsAlignShape | 0
  CurveFitData.MaximumDegree | 7
  CurveFitData.MaximumSegments | 1
  CurveFitData.MinimumDegree | 5
  CurveFitData.Segments | 1
  CurveFitJoinOptions.CurveFitOptions.FitOption | Cubic
  CurveFitJoinOptions.CurveFitOptions.MaximumDegree | 7
  CurveFitJoinOptions.CurveFitOptions.MaximumSegments | 1
  EndAngle | 20.0
  EndDistance | 10.0 (millimeters part), 0.5 (inches part)
  EndPercentage | 100.0
  GroupObjects | False
  Increment | 5.0 (millimeters part), 0.25 (inches part)
  NumberOfCopies | 2
  OutputPoints | False
  Ratio | 1.0
  SampleDistance | 1.0 (millimeters part), 0.04 (inches part)
  SpacingAlongCurveType | EqualArcLength
  StartAngle | 0.0
  StartDistance | 0.0 (millimeters part), 0.0 (inches part)
  StartPercentage | 0.0
  StepAngle | 10.0
  StepDistance | 5.0 (millimeters part), 0.25 (inches part)
  Type | Selected

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
Associative | Returns or sets the associativity
BasePlane | Returns or sets the base plane
ChordalTolerance | Returns or sets the chordal tolerance
CurveFitData | Returns the curve fit settings
CurveFitJoinOptions | Returns the curve fit join option
CurveForPerpendicularPlane | Returns the curve for perpendicular to curve type
EndAngle | Returns or sets the end angle
EndDistance | Returns or sets the the end distance
EndPercentage | Returns or sets the end percentage.
GroupObjects | Returns or sets the grouping
Increment | Returns or sets the increment
NumberOfCopies | Returns or sets the number of copies
ObjectsToSection | Returns the selected objects
OutputPoints | Returns or sets the output points
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
RadialPlanePoint | Returns or sets the point for radial plane type
RadialPlaneVector | Returns or sets the vector for radial plane type
Ratio | Returns or sets the ratio
SampleDistance | Returns or sets the sample distance
SectionPlane | Returns or sets the plane
SectionPlanes | Returns the selected planes
SpacingAlongCurveType | Returns or sets the type of spacing
StartAngle | Returns or sets the start angle
StartDistance | Returns or sets the the start distance
StartPercentage | Returns or sets the start percentage.
StepAngle | Returns or sets the step angle
StepDistance | Returns or sets the step distance
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Tolerance | Returns or sets the tolerance
Type | Returns or sets the type of the section curve builder

# 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.
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.
GetOutputGroups | Gets the output groups for non-associated output curve
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

SectionCurveBuilderPlaneType Enumeration | Represents section plane type.
SectionCurveBuilderSpacingType Enumeration | Represents spacing type.

# Property Detail

## Associative

`SectionCurveBuilder.``Associative`

  Returns or sets the associativity

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

  Getter Method

  Signature `Associative`

  Returns: | associative
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Associative`

  Parameters: | associative (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## BasePlane

`SectionCurveBuilder.``BasePlane`

  Returns or sets the base plane

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

  Getter Method

  Signature `BasePlane`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BasePlane`

  Parameters: | basePlane (`NXOpen.ISurface`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ChordalTolerance

`SectionCurveBuilder.``ChordalTolerance`

  Returns or sets the chordal tolerance

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

  Getter Method

  Signature `ChordalTolerance`

  Returns: | chordal tolerance
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ChordalTolerance`

  Parameters: | chordalTolerance (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CurveFitData

`SectionCurveBuilder.``CurveFitData`

  Returns the curve fit settings

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

  Getter Method

  Signature `CurveFitData`

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

  New in version NX8.0.0.

  License requirements: None.

## CurveFitJoinOptions

`SectionCurveBuilder.``CurveFitJoinOptions`

  Returns the curve fit join option

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

  Getter Method

  Signature `CurveFitJoinOptions`

  Returns: | Curve Fit Join
  Return type: | `NXOpen.GeometricUtilities.CurveFitJoin`

  New in version NX5.0.0.

  License requirements: None.

## CurveForPerpendicularPlane

`SectionCurveBuilder.``CurveForPerpendicularPlane`

  Returns the curve for perpendicular to curve type

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

  Getter Method

  Signature `CurveForPerpendicularPlane`

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

  New in version NX5.0.0.

  License requirements: None.

## EndAngle

`SectionCurveBuilder.``EndAngle`

  Returns or sets the end angle

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

  Getter Method

  Signature `EndAngle`

  Returns: | end angle
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EndAngle`

  Parameters: | endAngle (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## EndDistance

`SectionCurveBuilder.``EndDistance`

  Returns or sets the the end distance

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

  Getter Method

  Signature `EndDistance`

  Returns: | end distance
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EndDistance`

  Parameters: | endDistance (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## EndPercentage

`SectionCurveBuilder.``EndPercentage`

  Returns or sets the end percentage.

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

  Getter Method

  Signature `EndPercentage`

  Returns: | end percentage
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EndPercentage`

  Parameters: | endPercentage (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## GroupObjects

`SectionCurveBuilder.``GroupObjects`

  Returns or sets the grouping

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

  Getter Method

  Signature `GroupObjects`

  Returns: | group objects
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `GroupObjects`

  Parameters: | groupObjects (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Increment

`SectionCurveBuilder.``Increment`

  Returns or sets the increment

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

  Getter Method

  Signature `Increment`

  Returns: | increment
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Increment`

  Parameters: | increment (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## NumberOfCopies

`SectionCurveBuilder.``NumberOfCopies`

  Returns or sets the number of copies

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

  Getter Method

  Signature `NumberOfCopies`

  Returns: | number of copies
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfCopies`

  Parameters: | numberOfCopies (int) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ObjectsToSection

`SectionCurveBuilder.``ObjectsToSection`

  Returns the selected objects

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

  Getter Method

  Signature `ObjectsToSection`

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

  New in version NX5.0.0.

  License requirements: None.

## OutputPoints

`SectionCurveBuilder.``OutputPoints`

  Returns or sets the output points

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

  Getter Method

  Signature `OutputPoints`

  Returns: | output points
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputPoints`

  Parameters: | outputPoints (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## RadialPlanePoint

`SectionCurveBuilder.``RadialPlanePoint`

  Returns or sets the point for radial plane type

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

  Getter Method

  Signature `RadialPlanePoint`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RadialPlanePoint`

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

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## RadialPlaneVector

`SectionCurveBuilder.``RadialPlaneVector`

  Returns or sets the vector for radial plane type

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

  Getter Method

  Signature `RadialPlaneVector`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RadialPlaneVector`

  Parameters: | radialPlaneVector (`NXOpen.Direction`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Ratio

`SectionCurveBuilder.``Ratio`

  Returns or sets the ratio

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

  Getter Method

  Signature `Ratio`

  Returns: | ratio
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Ratio`

  Parameters: | ratio (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SampleDistance

`SectionCurveBuilder.``SampleDistance`

  Returns or sets the sample distance

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

  Getter Method

  Signature `SampleDistance`

  Returns: | sample distance
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SampleDistance`

  Parameters: | sampleDistance (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SectionPlane

`SectionCurveBuilder.``SectionPlane`

  Returns or sets the plane

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

  Getter Method

  Signature `SectionPlane`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionPlane`

  Parameters: | sectionPlane (`NXOpen.Plane`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SectionPlanes

`SectionCurveBuilder.``SectionPlanes`

  Returns the selected planes

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

  Getter Method

  Signature `SectionPlanes`

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

  New in version NX5.0.0.

  License requirements: None.

## SpacingAlongCurveType

`SectionCurveBuilder.``SpacingAlongCurveType`

  Returns or sets the type of spacing

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

  Getter Method

  Signature `SpacingAlongCurveType`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SpacingAlongCurveType`

  Parameters: | spacingAlongCurve (`NXOpen.Features.SectionCurveBuilderSpacingType`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## StartAngle

`SectionCurveBuilder.``StartAngle`

  Returns or sets the start angle

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

  Getter Method

  Signature `StartAngle`

  Returns: | start angle
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StartAngle`

  Parameters: | startAngle (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## StartDistance

`SectionCurveBuilder.``StartDistance`

  Returns or sets the the start distance

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

  Getter Method

  Signature `StartDistance`

  Returns: | start distance
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StartDistance`

  Parameters: | startDistance (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## StartPercentage

`SectionCurveBuilder.``StartPercentage`

  Returns or sets the start percentage.

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

  Getter Method

  Signature `StartPercentage`

  Returns: | start percentage
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StartPercentage`

  Parameters: | startPercentage (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## StepAngle

`SectionCurveBuilder.``StepAngle`

  Returns or sets the step angle

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

  Getter Method

  Signature `StepAngle`

  Returns: | step angle
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StepAngle`

  Parameters: | stepAngle (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## StepDistance

`SectionCurveBuilder.``StepDistance`

  Returns or sets the step distance

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

  Getter Method

  Signature `StepDistance`

  Returns: | step distance
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StepDistance`

  Parameters: | stepDistance (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Tolerance

`SectionCurveBuilder.``Tolerance`

  Returns or sets the tolerance

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

  Getter Method

  Signature `Tolerance`

  Returns: | tolerance
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Tolerance`

  Parameters: | tolerance (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Type

`SectionCurveBuilder.``Type`

  Returns or sets the type of the section curve builder

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

  Getter Method

  Signature `Type`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

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

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## GetOutputGroups

`SectionCurveBuilder.``GetOutputGroups`

  Gets the output groups for non-associated output curve

  Signature `GetOutputGroups()`

  Returns: |
  Return type: | list of `NXOpen.Group`

  New in version NX8.0.0.

  License requirements: None.

## Validate

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