SubdivisionExtrudeCageBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SubdivisionExtrudeCageBuilder Class

class `NXOpen.Features.Subdivision.``SubdivisionExtrudeCageBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilder` builder.

  To create a new instance of this class, use `NXOpen.Features.Subdivision.SubdivisionBodyCollection.CreateSubdivisionExtrudeCageBuilder()`

  Default values.

  Property | Value
  --- | ---
  CanRelocateToolToSelection | true
  CanReorientToolToSelection | true
  NumberOfSegments | 1

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
CanMoveToolOnly | Returns or sets the flag indicating if transformer tool can be moved without transforming the selected cage topology.
CanRelocateToolToSelection | Returns or sets the flag indicating if transformer tool can be relocated based on cage topology selection.
CanReorientToolToSelection | Returns or sets the flag indicating if transformer tool can be reoriented based on cage topology selection.
Continuity | Returns or sets the continuity.
DirectionOption | Returns or sets the direction option
Distance | Returns the distance.
NumberOfSegments | Returns or sets the number of segments.
ScalingMethod | Returns or sets the scaling method.
SelectionObject | Returns the selection object.
Tag | Returns the Tag for this object.
TransformationMethod | Returns or sets the transformation method.
Transformer | Returns the transformation tool.
Vector | Returns or sets the vector for extrude.

# 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.
Extrude | Perform extrude operation.
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.

# Enumerations

SubdivisionExtrudeCageBuilderContinuityType Enumeration | Type of continuity.
SubdivisionExtrudeCageBuilderDirectionType Enumeration | Represents the extrude direction.
SubdivisionExtrudeCageBuilderScalingMethodType Enumeration | Scaling method
SubdivisionExtrudeCageBuilderTransformationMethodType Enumeration | Transformation method types

# Property Detail

## CanMoveToolOnly

`SubdivisionExtrudeCageBuilder.``CanMoveToolOnly`

  Returns or sets the flag indicating if transformer tool can be moved without transforming the selected cage topology.

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

  Getter Method

  Signature `CanMoveToolOnly`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CanMoveToolOnly`

  Parameters: | canMove (bool) –

  New in version NX11.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## CanRelocateToolToSelection

`SubdivisionExtrudeCageBuilder.``CanRelocateToolToSelection`

  Returns or sets the flag indicating if transformer tool can be relocated based on cage topology selection.

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

  Getter Method

  Signature `CanRelocateToolToSelection`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CanRelocateToolToSelection`

  Parameters: | canRelocate (bool) –

  New in version NX11.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## CanReorientToolToSelection

`SubdivisionExtrudeCageBuilder.``CanReorientToolToSelection`

  Returns or sets the flag indicating if transformer tool can be reoriented based on cage topology selection.

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

  Getter Method

  Signature `CanReorientToolToSelection`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CanReorientToolToSelection`

  Parameters: | canReorient (bool) –

  New in version NX11.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## Continuity

`SubdivisionExtrudeCageBuilder.``Continuity`

  Returns or sets the continuity.

  The continuity is used to specify creases in the limit surface corresponding to the outer edges of the faces or boundary edges specified by `NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilder.SelectionObject()`.

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

  Getter Method

  Signature `Continuity`

  Returns: |
  Return type: | `NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilderContinuityType`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Continuity`

  Parameters: | continuity (`NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilderContinuityType`) –

  New in version NX11.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## DirectionOption

`SubdivisionExtrudeCageBuilder.``DirectionOption`

  Returns or sets the direction option

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

  Getter Method

  Signature `DirectionOption`

  Returns: |
  Return type: | `NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilderDirectionType`

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DirectionOption`

  Parameters: | directionOption (`NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilderDirectionType`) –

  New in version NX10.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## Distance

`SubdivisionExtrudeCageBuilder.``Distance`

  Returns the distance.

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

  Getter Method

  Signature `Distance`

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

  New in version NX9.0.0.

  License requirements: None.

## NumberOfSegments

`SubdivisionExtrudeCageBuilder.``NumberOfSegments`

  Returns or sets the number of segments.

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

  Getter Method

  Signature `NumberOfSegments`

  Returns: |
  Return type: | int

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfSegments`

  Parameters: | numOfSegments (int) –

  New in version NX10.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## ScalingMethod

`SubdivisionExtrudeCageBuilder.``ScalingMethod`

  Returns or sets the scaling method.

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

  Getter Method

  Signature `ScalingMethod`

  Returns: |
  Return type: | `NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilderScalingMethodType`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ScalingMethod`

  Parameters: | scalingMethod (`NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilderScalingMethodType`) –

  New in version NX11.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## SelectionObject

`SubdivisionExtrudeCageBuilder.``SelectionObject`

  Returns the selection object.

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

  Getter Method

  Signature `SelectionObject`

  Returns: |
  Return type: | `NXOpen.Features.Subdivision.SelectCageObjectData`

  New in version NX9.0.0.

  License requirements: None.

## TransformationMethod

`SubdivisionExtrudeCageBuilder.``TransformationMethod`

  Returns or sets the transformation method.

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

  Getter Method

  Signature `TransformationMethod`

  Returns: |
  Return type: | `NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilderTransformationMethodType`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TransformationMethod`

  Parameters: | method (`NXOpen.Features.Subdivision.SubdivisionExtrudeCageBuilderTransformationMethodType`) –

  New in version NX11.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## Transformer

`SubdivisionExtrudeCageBuilder.``Transformer`

  Returns the transformation tool.

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

  Getter Method

  Signature `Transformer`

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

  New in version NX11.0.0.

  License requirements: None.

## Vector

`SubdivisionExtrudeCageBuilder.``Vector`

  Returns or sets the vector for extrude.

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

  Getter Method

  Signature `Vector`

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

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Vector`

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

  New in version NX10.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

# Method Detail

## Extrude

`SubdivisionExtrudeCageBuilder.``Extrude`

  Perform extrude operation.

  Signature `Extrude()`

  New in version NX9.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## Validate

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