TransformBlockBuilder Class

class NXOpen.MechanicalRouting.TransformBlockBuilder

Bases: NXOpen.Builder

Represents NXOpen.MechanicalRouting.TransformBlockBuilder.

To create a new instance of this class, use NXOpen.MechanicalRouting.BuilderFactory.CreateTransformBlockBuilder()

New in version NX11.0.0.

Properties

Property Description
ActiveTransformType Returns or sets the transform type setting.
ConstrainedPoint Returns or sets the constrained point setting.
InitialOrientation Returns or sets the initial orientation setting.
InitialPosition Returns or sets the initial position setting.
OrientExpress Returns the orient express setting.
Plane Returns or sets the plane setting.
Tag Returns the Tag for this object.
TempOrientation Returns or sets the temp orientation setting.
TempPosition Returns or sets the temp position setting.
Vector Returns or sets the vector setting.

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

TransformBlockBuilderTransformtype Enumeration Specifies the options available for transform.

Property Detail

ActiveTransformType

TransformBlockBuilder.ActiveTransformType

Returns or sets the transform type setting.

Allows you to specify the type of tool to be used for transform.

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

Getter Method

Signature ActiveTransformType

Returns:
Return type:NXOpen.MechanicalRouting.TransformBlockBuilderTransformtype

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

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

Setter Method

Signature ActiveTransformType

Parameters:transformType (NXOpen.MechanicalRouting.TransformBlockBuilderTransformtype) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

ConstrainedPoint

TransformBlockBuilder.ConstrainedPoint

Returns or sets the constrained point setting.

Allows you to specify the constrained point.

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

Getter Method

Signature ConstrainedPoint

Returns:
Return type:NXOpen.Point

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

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

Setter Method

Signature ConstrainedPoint

Parameters:constrainedPoint (NXOpen.Point) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

InitialOrientation

TransformBlockBuilder.InitialOrientation

Returns or sets the initial orientation setting.

Allows you to specify initial orientation for the transform tools.

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

Getter Method

Signature InitialOrientation

Returns:
Return type:NXOpen.Matrix3x3

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

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

Setter Method

Signature InitialOrientation

Parameters:initialOrientation (NXOpen.Matrix3x3) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

InitialPosition

TransformBlockBuilder.InitialPosition

Returns or sets the initial position setting.

Allows you to specify start point for the transform tool.

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

Getter Method

Signature InitialPosition

Returns:
Return type:NXOpen.Point3d

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

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

Setter Method

Signature InitialPosition

Parameters:initialPosition (NXOpen.Point3d) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

OrientExpress

TransformBlockBuilder.OrientExpress

Returns the orient express setting.

Allows you to access the orient express object.

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

Getter Method

Signature OrientExpress

Returns:
Return type:NXOpen.GeometricUtilities.OrientXpressBuilder

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

Plane

TransformBlockBuilder.Plane

Returns or sets the plane setting.

Allows you to specify the constraint plane.

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

Getter Method

Signature Plane

Returns:
Return type:NXOpen.Plane

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

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

Setter Method

Signature Plane

Parameters:plane (NXOpen.Plane) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

TempOrientation

TransformBlockBuilder.TempOrientation

Returns or sets the temp orientation setting.

Allows you to specify final orientation for the transform tools.

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

Getter Method

Signature TempOrientation

Returns:
Return type:NXOpen.Matrix3x3

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

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

Setter Method

Signature TempOrientation

Parameters:tempOrientation (NXOpen.Matrix3x3) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

TempPosition

TransformBlockBuilder.TempPosition

Returns or sets the temp position setting.

Allows you to specify final position for the transform tool.

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

Getter Method

Signature TempPosition

Returns:
Return type:NXOpen.Point3d

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

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

Setter Method

Signature TempPosition

Parameters:tmepPosition (NXOpen.Point3d) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

Vector

TransformBlockBuilder.Vector

Returns or sets the vector setting.

Allows you to specify the constraint direction.

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

Getter Method

Signature Vector

Returns:
Return type:NXOpen.Direction

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

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

Setter Method

Signature Vector

Parameters:vector (NXOpen.Direction) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

Method Detail

Validate

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