ObjectTransformerBuilder Class¶
-
class
NXOpen.Mechatronics.
ObjectTransformerBuilder
¶ Bases:
NXOpen.Mechatronics.PhysicsConstraintBuilder
Represents a
NXOpen.Mechatronics.ObjectTransformer
builder.To create a new instance of this class, use
NXOpen.Mechatronics.ObjectTransformerCollection.CreateObjectTransformerBuilder()
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
CollisionSensor | Returns the object select. |
ExecuteOnce | Returns or sets the execute once per activation. |
Name | Returns or sets the name. |
RigidBody | Returns the rigid body object. |
Source | Returns the source select. |
SourceType | Returns or sets the option to transform source. |
Tag | Returns the Tag for this object. |
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¶
ObjectTransformerBuilderTransformSourceType Enumeration | the transform option. |
Property Detail¶
CollisionSensor¶
-
ObjectTransformerBuilder.
CollisionSensor
¶ Returns the object select.
-------------------------------------
Getter Method
Signature
CollisionSensor
Returns: Return type: NXOpen.Mechatronics.SelectCollisionSensorList
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ExecuteOnce¶
-
ObjectTransformerBuilder.
ExecuteOnce
¶ Returns or sets the execute once per activation.
If the executeOnce is true, then the transformation will only happen once.
-------------------------------------
Getter Method
Signature
ExecuteOnce
Returns: Return type: bool New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
ExecuteOnce
Parameters: executeOnce (bool) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
RigidBody¶
-
ObjectTransformerBuilder.
RigidBody
¶ Returns the rigid body object.
-------------------------------------
Getter Method
Signature
RigidBody
Returns: Return type: NXOpen.Mechatronics.SelectRigidBody
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Source¶
-
ObjectTransformerBuilder.
Source
¶ Returns the source select.
This can be a
NXOpen.Mechatronics.ObjectTransformer
orNXOpen.Mechatronics.ObjectSource
.-------------------------------------
Getter Method
Signature
Source
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SourceType¶
-
ObjectTransformerBuilder.
SourceType
¶ Returns or sets the option to transform source.
-------------------------------------
Getter Method
Signature
SourceType
Returns: Return type: NXOpen.Mechatronics.ObjectTransformerBuilderTransformSourceType
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
SourceType
Parameters: srcType ( NXOpen.Mechatronics.ObjectTransformerBuilderTransformSourceType
) –New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
ObjectTransformerBuilder.
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.