CollisionShapeBuilder Class

class NXOpen.Mechatronics.CollisionShapeBuilder

Bases: NXOpen.Builder

This is an abstract class, and cannot be created.

This is an abstract class, and cannot be created.

New in version NX7.5.1.

Properties

Property Description
CenterPoint Returns or sets the center point.
Height Returns the height.
Length Returns the length.
Orientation Returns or sets the orientation.
Radius Returns the radius.
Tag Returns the Tag for this object.
Width Returns the width.

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.

Property Detail

CenterPoint

CollisionShapeBuilder.CenterPoint

Returns or sets the center point.

Valid to all collsion shape types except NXOpen.Mechatronics.CollisionBodyBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Convex.

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

Getter Method

Signature CenterPoint

Returns:
Return type:NXOpen.Point

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature CenterPoint

Parameters:centerPoint (NXOpen.Point) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Height

CollisionShapeBuilder.Height

Returns the height.

Valid if NXOpen.Mechatronics.CollisionBodyBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Box or NXOpen.Mechatronics.CollisionSensorBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionSensorBuilderCollisionShapeTypes.Box.

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

Getter Method

Signature Height

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Length

CollisionShapeBuilder.Length

Returns the length.

Valid if NXOpen.Mechatronics.CollisionBodyBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Box or NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Capsule or NXOpen.Mechatronics.CollisionSensorBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionSensorBuilderCollisionShapeTypes.Box or NXOpen.Mechatronics.CollisionSensorBuilderCollisionShapeTypes.Line.

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

Getter Method

Signature Length

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Orientation

CollisionShapeBuilder.Orientation

Returns or sets the orientation.

Valid if NXOpen.Mechatronics.CollisionBodyBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Box or NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Capsule or NXOpen.Mechatronics.CollisionSensorBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionSensorBuilderCollisionShapeTypes.Box or NXOpen.Mechatronics.CollisionSensorBuilderCollisionShapeTypes.Line.

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

Getter Method

Signature Orientation

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature Orientation

Parameters:orientation (NXOpen.CoordinateSystem) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Radius

CollisionShapeBuilder.Radius

Returns the radius.

Valid if NXOpen.Mechatronics.CollisionBodyBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Sphere or NXOpen.Mechatronics.CollisionSensorBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionSensorBuilderCollisionShapeTypes.Sphere.

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

Getter Method

Signature Radius

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Width

CollisionShapeBuilder.Width

Returns the width.

Valid if NXOpen.Mechatronics.CollisionBodyBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Box or NXOpen.Mechatronics.CollisionSensorBuilder.CollisionShape() is set to NXOpen.Mechatronics.CollisionSensorBuilderCollisionShapeTypes.Box.

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

Getter Method

Signature Width

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

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