AlignBodyBuilder Class¶
-
class
NXOpen.Mechatronics.
AlignBodyBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.AlignBody
builder.To create a new instance of this class, use
NXOpen.Mechatronics.AlignBodyCollection.CreateAlignBodyBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
AttachBody | Returns the rigid body which snap point attaches on. This should be a NXOpen.Mechatronics.RigidBody |
AttachPoint | Returns or sets the positioning of snap point. |
Category | Returns or sets the category. It should be an integer bigger or equal to zero. |
JunctionName | Returns or sets the junction name converted from MTB. |
Name | Returns or sets the name. |
Orientation | Returns or sets the orientation of snap point. |
Proximity | Returns the proximity for distance detection. |
SnapRole | Returns or sets the role type |
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. |
SetAttachbody | Sets the attached rigid body. |
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¶
AlignBodyBuilderRoleType Enumeration | the Snap role types. |
Property Detail¶
AttachBody¶
-
AlignBodyBuilder.
AttachBody
¶ Returns the rigid body which snap point attaches on. This should be a
NXOpen.Mechatronics.RigidBody
-------------------------------------
Getter Method
Signature
AttachBody
Returns: Return type: NXOpen.Mechatronics.SelectRigidBody
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
AttachPoint¶
-
AlignBodyBuilder.
AttachPoint
¶ Returns or sets the positioning of snap point.
-------------------------------------
Getter Method
Signature
AttachPoint
Returns: Return type: NXOpen.Point
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
AttachPoint
Parameters: attachPoint ( NXOpen.Point
) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Category¶
-
AlignBodyBuilder.
Category
¶ Returns or sets the category. It should be an integer bigger or equal to zero.
-------------------------------------
Getter Method
Signature
Category
Returns: Return type: int New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Category
Parameters: category (int) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
JunctionName¶
-
AlignBodyBuilder.
JunctionName
¶ Returns or sets the junction name converted from MTB.
-------------------------------------
Getter Method
Signature
JunctionName
Returns: Return type: str New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
JunctionName
Parameters: junction (str) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Name¶
-
AlignBodyBuilder.
Name
¶ Returns or sets the name.
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Orientation¶
-
AlignBodyBuilder.
Orientation
¶ Returns or sets the orientation of snap point.
-------------------------------------
Getter Method
Signature
Orientation
Returns: Return type: NXOpen.CoordinateSystem
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Orientation
Parameters: orientation ( NXOpen.CoordinateSystem
) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Proximity¶
-
AlignBodyBuilder.
Proximity
¶ Returns the proximity for distance detection.
-------------------------------------
Getter Method
Signature
Proximity
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SnapRole¶
-
AlignBodyBuilder.
SnapRole
¶ Returns or sets the role type
-------------------------------------
Getter Method
Signature
SnapRole
Returns: Return type: NXOpen.Mechatronics.AlignBodyBuilderRoleType
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
SnapRole
Parameters: roleType ( NXOpen.Mechatronics.AlignBodyBuilderRoleType
) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
SetAttachbody¶
-
AlignBodyBuilder.
SetAttachbody
¶ Sets the attached rigid body.
Signature
SetAttachbody(rigid)
Parameters: rigid ( NXOpen.NXObject
) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
AlignBodyBuilder.
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.