TransformCageData Class

class NXOpen.Features.Subdivision.TransformCageData

Bases: NXOpen.Builder

Represents a NXOpen.Features.Subdivision.TransformCageData builder.

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

Default values.

Property Value
CanRelocateToolToSelection true
CanReorientToolToSelection true

New in version NX9.0.0.

Properties

Property Description
CageManipulator Returns the cage manipulation data.
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.
FallOffFactor Returns or sets the falloff factor.
FallOffMethod Returns or sets the falloff method.
FallOffObjects Returns the falloff objects.
MovementMethod Returns or sets the movement method.
MovementPlane Returns or sets the movement plane.
MovementVector Returns or sets the movement vector.
ScalingMethod Returns or sets the scaling method.
Tag Returns the Tag for this object.
TransformationMethod Returns or sets the transformation method.
WCSOption Returns or sets the WCS option.

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.
ResetFallOffToLinear Resets the falloff scale to linear.
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

CageManipulator

TransformCageData.CageManipulator

Returns the cage manipulation data.

-------------------------------------

Getter Method

Signature CageManipulator

Returns:
Return type:NXOpen.Features.Subdivision.CageManipulatorData

New in version NX9.0.0.

License requirements: None.

CanMoveToolOnly

TransformCageData.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 NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CanMoveToolOnly

Parameters:canMove (bool) –

New in version NX9.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

CanRelocateToolToSelection

TransformCageData.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 NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CanRelocateToolToSelection

Parameters:canRelocate (bool) –

New in version NX9.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

CanReorientToolToSelection

TransformCageData.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 NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CanReorientToolToSelection

Parameters:canReorient (bool) –

New in version NX9.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

FallOffFactor

TransformCageData.FallOffFactor

Returns or sets the falloff factor.

-------------------------------------

Getter Method

Signature FallOffFactor

Returns:
Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FallOffFactor

Parameters:factor (float) –

New in version NX10.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

FallOffMethod

TransformCageData.FallOffMethod

Returns or sets the falloff method.

-------------------------------------

Getter Method

Signature FallOffMethod

Returns:
Return type:NXOpen.Features.Subdivision.TransformCageDataFallOffMethodType

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FallOffMethod

Parameters:fallOffMethod (NXOpen.Features.Subdivision.TransformCageDataFallOffMethodType) –

New in version NX10.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

FallOffObjects

TransformCageData.FallOffObjects

Returns the falloff objects.

-------------------------------------

Getter Method

Signature FallOffObjects

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

New in version NX10.0.0.

License requirements: None.

MovementMethod

TransformCageData.MovementMethod

Returns or sets the movement method.

-------------------------------------

Getter Method

Signature MovementMethod

Returns:
Return type:NXOpen.Features.Subdivision.TransformCageDataMovementMethodType

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MovementMethod

Parameters:movementMethod (NXOpen.Features.Subdivision.TransformCageDataMovementMethodType) –

New in version NX9.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

MovementPlane

TransformCageData.MovementPlane

Returns or sets the movement plane.

-------------------------------------

Getter Method

Signature MovementPlane

Returns:
Return type:NXOpen.Plane

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MovementPlane

Parameters:movementPlane (NXOpen.Plane) –

New in version NX9.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

MovementVector

TransformCageData.MovementVector

Returns or sets the movement vector.

-------------------------------------

Getter Method

Signature MovementVector

Returns:
Return type:NXOpen.Direction

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MovementVector

Parameters:movementVector (NXOpen.Direction) –

New in version NX9.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

ScalingMethod

TransformCageData.ScalingMethod

Returns or sets the scaling method.

-------------------------------------

Getter Method

Signature ScalingMethod

Returns:
Return type:NXOpen.Features.Subdivision.TransformCageDataScalingMethodType

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ScalingMethod

Parameters:scalingMethod (NXOpen.Features.Subdivision.TransformCageDataScalingMethodType) –

New in version NX9.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

TransformationMethod

TransformCageData.TransformationMethod

Returns or sets the transformation method.

-------------------------------------

Getter Method

Signature TransformationMethod

Returns:
Return type:NXOpen.Features.Subdivision.TransformCageDataTransformationMethodType

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TransformationMethod

Parameters:method (NXOpen.Features.Subdivision.TransformCageDataTransformationMethodType) –

New in version NX9.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

WCSOption

TransformCageData.WCSOption

Returns or sets the WCS option.

-------------------------------------

Getter Method

Signature WCSOption

Returns:
Return type:NXOpen.Features.Subdivision.TransformCageDataWCSOptionType

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature WCSOption

Parameters:wcsOption (NXOpen.Features.Subdivision.TransformCageDataWCSOptionType) –

New in version NX9.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

Method Detail

ResetFallOffToLinear

TransformCageData.ResetFallOffToLinear

Resets the falloff scale to linear.

Signature ResetFallOffToLinear()

New in version NX11.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

Validate

TransformCageData.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.