SubdivideSegmentBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SubdivideSegmentBuilder Class

class `NXOpen.Routing.``SubdivideSegmentBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Routing.SubdivideSegmentBuilder`.

  This is used to subidivide a given segment into two or more segments based on one of the three spacing methods.

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

  Default values.

  Property | Value
  --- | ---
  EqualSegmentsOption | EqualArcLength
  SubdivideNumSegments | 2

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
EqualSegmentsOption | Returns or sets the equal segments option as `NXOpen.Routing.SubdivideSegmentBuilderEqualSegmentsMethod`
ReverseSubdividePoint | Returns or sets the direction of the start of segment to subdivide.
Segment | Returns the segment to subdivide
SubdivideArcLength | Returns the arc length of each resulting segment from subdivision, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.ArcLengthSegments`
SubdivideEndPercentage | Returns the end location of subdivision on the segment as percentage, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.EqualSegments` or `NXOpen.Routing.SubdivideSegmentBuilderTypes.ArcLengthSegments`
SubdivideNumSegments | Returns or sets the number of subdivisions to do on the given segment, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.EqualSegments` or `NXOpen.Routing.SubdivideSegmentBuilderTypes.ArcLengthSegments`
SubdividePoint | Returns the location of the subdivision point on segment as arclength or %arclength or point, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.AtPoint`
SubdivideStartPercentage | Returns the start location of subdivision on the segment as percentage, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.EqualSegments` or `NXOpen.Routing.SubdivideSegmentBuilderTypes.ArcLengthSegments`
Tag | Returns the Tag for this object.
Type | Returns or sets the spacing method as `NXOpen.Routing.SubdivideSegmentBuilderTypes`

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
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.
GetSplineSettings | Gets the current subdivide spline settings.
SetSplineSettings | Sets options for subdividing splines.
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.

# Enumerations

SubdivideSegmentBuilderEqualSegmentsMethod Enumeration | Options for subdivision with Equal Segments spacing method.
SubdivideSegmentBuilderTypes Enumeration | Spacing method to use for subdivision.

# Property Detail

## EqualSegmentsOption

`SubdivideSegmentBuilder.``EqualSegmentsOption`

  Returns or sets the equal segments option as `NXOpen.Routing.SubdivideSegmentBuilderEqualSegmentsMethod`

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

  Getter Method

  Signature `EqualSegmentsOption`

  Returns: |
  Return type: | `NXOpen.Routing.SubdivideSegmentBuilderEqualSegmentsMethod`

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `EqualSegmentsOption`

  Parameters: | equalSegmentsOption (`NXOpen.Routing.SubdivideSegmentBuilderEqualSegmentsMethod`) –

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

## ReverseSubdividePoint

`SubdivideSegmentBuilder.``ReverseSubdividePoint`

  Returns or sets the direction of the start of segment to subdivide.

  The distance of the subdivision point on the segment is measured from this end.

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

  Getter Method

  Signature `ReverseSubdividePoint`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `ReverseSubdividePoint`

  Parameters: | reverseSubdividePoint (bool) –

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

## Segment

`SubdivideSegmentBuilder.``Segment`

  Returns the segment to subdivide

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

  Getter Method

  Signature `Segment`

  Returns: |
  Return type: | `NXOpen.Routing.SelectISegment`

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

## SubdivideArcLength

`SubdivideSegmentBuilder.``SubdivideArcLength`

  Returns the arc length of each resulting segment from subdivision, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.ArcLengthSegments`

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

  Getter Method

  Signature `SubdivideArcLength`

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

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

## SubdivideEndPercentage

`SubdivideSegmentBuilder.``SubdivideEndPercentage`

  Returns the end location of subdivision on the segment as percentage, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.EqualSegments` or `NXOpen.Routing.SubdivideSegmentBuilderTypes.ArcLengthSegments`

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

  Getter Method

  Signature `SubdivideEndPercentage`

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

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

## SubdivideNumSegments

`SubdivideSegmentBuilder.``SubdivideNumSegments`

  Returns or sets the number of subdivisions to do on the given segment, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.EqualSegments` or `NXOpen.Routing.SubdivideSegmentBuilderTypes.ArcLengthSegments`

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

  Getter Method

  Signature `SubdivideNumSegments`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `SubdivideNumSegments`

  Parameters: | subdivideNumSegments (int) –

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

## SubdividePoint

`SubdivideSegmentBuilder.``SubdividePoint`

  Returns the location of the subdivision point on segment as arclength or %arclength or point, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.AtPoint`

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

  Getter Method

  Signature `SubdividePoint`

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

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

## SubdivideStartPercentage

`SubdivideSegmentBuilder.``SubdivideStartPercentage`

  Returns the start location of subdivision on the segment as percentage, if `NXOpen.Routing.SubdivideSegmentBuilderTypes` is `NXOpen.Routing.SubdivideSegmentBuilderTypes.EqualSegments` or `NXOpen.Routing.SubdivideSegmentBuilderTypes.ArcLengthSegments`

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

  Getter Method

  Signature `SubdivideStartPercentage`

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

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

## Type

`SubdivideSegmentBuilder.``Type`

  Returns or sets the spacing method as `NXOpen.Routing.SubdivideSegmentBuilderTypes`

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

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Routing.SubdivideSegmentBuilderTypes`

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Routing.SubdivideSegmentBuilderTypes`) –

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

# Method Detail

## GetSplineSettings

`SubdivideSegmentBuilder.``GetSplineSettings`

  Gets the current subdivide spline settings.

  Signature `GetSplineSettings()`

  Returns: | a tuple
  Return type: | A tuple consisting of (createTangency, createPoints) createTangency is a bool. Creates tangency at the point where the spline is subdivided by adding parallel extensions.createPoints is a bool. Add points to the new segments to maintain shape after subdivision.

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

## SetSplineSettings

`SubdivideSegmentBuilder.``SetSplineSettings`

  Overloaded method SetSplineSettings

  - `SetSplineSettings(createTangency, addPoints)`
  - `SetSplineSettings(createTangency, addPoints, addFixConstraint)`

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

  Sets options for subdividing splines.

  Signature `SetSplineSettings(createTangency, addPoints)`

  Parameters:

  - createTangency (bool) – Creates tangency at the point where the spline is subdivided by adding parallel extensions.
  - addPoints (bool) – Add points to the new segments to maintain shape after subdivision.

  New in version NX6.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Sets options for subdividing splines.

  Signature `SetSplineSettings(createTangency, addPoints, addFixConstraint)`

  Parameters:

  - createTangency (bool) – Creates tangency at the point where the spline is subdivided by adding parallel extensions.
  - addPoints (bool) – Add points to the new segments to maintain shape after subdivision.
  - addFixConstraint (bool) – Adds a fix constraint at newly created subdivision locations

  New in version NX7.5.2.

  License requirements: routing_base (“Routing Basic”)

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

## Validate

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