CollisionBodyBuilder Class¶
-
class
NXOpen.Mechatronics.
CollisionBodyBuilder
¶ Bases:
NXOpen.Mechatronics.CollisionShapeBuilder
Represents a
NXOpen.Mechatronics.CollisionBodyBuilder
.To create a new instance of this class, use
NXOpen.Mechatronics.CollisionBodyCollection.CreateCollisionBodyBuilder
New in version NX7.5.1.
Properties¶
Property | Description |
---|---|
Category | Returns or sets the category. |
CenterPoint | Returns or sets the center point. |
CollisionFactor | Returns or sets the collision factor. |
CollisionMaterial | Returns or sets the material. |
CollisionProperties | Returns or sets the shape option. |
CollisionShape | Returns or sets the shape type. |
Geometry | Returns the geometries. |
Height | Returns the height. |
HighlightOnCollision | Returns or sets the highlight on collision. |
Length | Returns the length. |
Name | Returns or sets the name. |
Orientation | Returns or sets the orientation. |
Radius | Returns the radius. |
StickCollision | Returns or sets the option for stick when collision. |
Tag | Returns the Tag for this object. |
Width | Returns the width. |
Methods¶
Method | Description |
---|---|
CalculateConvex | The convex of the collide. |
CalculateMesh | The mesh of the collide. |
CalculateMultiConvex | The multi-convex of the collide. |
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. |
SetGeometry | Sets the geometry |
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¶
CollisionBodyBuilderCollisionShapeTypes Enumeration | the collide shape types. |
CollisionBodyBuilderShapePropertyTypes Enumeration | the shape calculation option. |
Property Detail¶
Category¶
-
CollisionBodyBuilder.
Category
¶ Returns or sets the category.
It should be between 0 and 16.
-------------------------------------
Getter Method
Signature
Category()
Returns: Return type: int New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Category(category)
Parameters: category (int) – New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
CollisionFactor¶
-
CollisionBodyBuilder.
CollisionFactor
¶ Returns or sets the collision factor.
It should be between 0 and 1.0.
-------------------------------------
Getter Method
Signature
CollisionFactor()
Returns: Return type: float New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
CollisionFactor(factor)
Parameters: factor (float) – New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
CollisionMaterial¶
-
CollisionBodyBuilder.
CollisionMaterial
¶ Returns or sets the material.
This can be a
NXOpen.Mechatronics.CollisionMaterial
.-------------------------------------
Getter Method
Signature
CollisionMaterial()
Returns: Return type: NXOpen.Mechatronics.CollisionMaterial
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
CollisionMaterial(collisionMaterial)
Parameters: collisionMaterial ( NXOpen.Mechatronics.CollisionMaterial
) –New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
CollisionProperties¶
-
CollisionBodyBuilder.
CollisionProperties
¶ Returns or sets the shape option.
-------------------------------------
Getter Method
Signature
CollisionProperties()
Returns: Return type: NXOpen.Mechatronics.CollisionBodyBuilderShapePropertyTypes
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
CollisionProperties(collisionProperties)
Parameters: collisionProperties ( NXOpen.Mechatronics.CollisionBodyBuilderShapePropertyTypes
) –New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
CollisionShape¶
-
CollisionBodyBuilder.
CollisionShape
¶ Returns or sets the shape type.
-------------------------------------
Getter Method
Signature
CollisionShape()
Returns: Return type: NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
CollisionShape(collisionShape)
Parameters: collisionShape ( NXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes
) –New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Geometry¶
-
CollisionBodyBuilder.
Geometry
¶ Returns the geometries.
This can be a
NXOpen.Assemblies.ComponentAssembly
,NXOpen.Point
NXOpen.Face
,NXOpen.Edge
, bodies and curves.-------------------------------------
Getter Method
Signature
Geometry()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
HighlightOnCollision¶
-
CollisionBodyBuilder.
HighlightOnCollision
¶ Returns or sets the highlight on collision.
-------------------------------------
Getter Method
Signature
HighlightOnCollision()
Returns: Return type: bool New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
HighlightOnCollision(highlight)
Parameters: highlight (bool) – New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Name¶
-
CollisionBodyBuilder.
Name
¶ Returns or sets the name.
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Name(name)
Parameters: name (str) – New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
StickCollision¶
-
CollisionBodyBuilder.
StickCollision
¶ Returns or sets the option for stick when collision.
If stickCollision is true, then this collision body will become sticky in the simulation.
-------------------------------------
Getter Method
Signature
StickCollision()
Returns: Return type: bool New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
StickCollision(stickCollision)
Parameters: stickCollision (bool) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
CalculateConvex¶
-
CollisionBodyBuilder.
CalculateConvex
¶ The convex of the collide.
Call this function to generate convex when
NXOpen.Mechatronics.CollisionBodyBuilder.CollisionShapeTypes
is set toNXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Convex
.Signature
CalculateConvex()
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
CalculateMesh¶
-
CollisionBodyBuilder.
CalculateMesh
¶ The mesh of the collide.
Call this function to generate mesh when
NXOpen.Mechatronics.CollisionBodyBuilder.CollisionShapeTypes
is set toNXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.Mesh
.Signature
CalculateMesh()
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
CalculateMultiConvex¶
-
CollisionBodyBuilder.
CalculateMultiConvex
¶ The multi-convex of the collide.
Call this function to generate multi-convex when
NXOpen.Mechatronics.CollisionBodyBuilder.CollisionShapeTypes
is set toNXOpen.Mechatronics.CollisionBodyBuilderCollisionShapeTypes.MultiConvex
.Signature
CalculateMultiConvex()
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SetGeometry¶
-
CollisionBodyBuilder.
SetGeometry
¶ Sets the geometry
Signature
SetGeometry(geometries)
Parameters: geometries (list of NXOpen.NXObject
) – Input geometriesNew in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
CollisionBodyBuilder.
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.