CollisionSensorBuilder Class¶
-
class
NXOpen.Mechatronics.
CollisionSensorBuilder
¶ Bases:
NXOpen.Mechatronics.CollisionShapeBuilder
Represents a
NXOpen.Mechatronics.CollisionSensor
builder.To create a new instance of this class, use
NXOpen.Mechatronics.CollisionSensorCollection.CreateCollisionSensorBuilder
New in version NX7.5.1.
Properties¶
Property | Description |
---|---|
Category | Returns or sets the category. |
CenterPoint | Returns or sets the center point. |
CollisionShape | Returns or sets the collision shape type. |
Geometry | Returns the geometries. |
Height | Returns the height. |
HighlightOnCollision | Returns or sets the option of highlight on collision. |
Length | Returns the length. |
Name | Returns or sets the name. |
Orientation | Returns or sets the orientation. |
Radius | Returns the radius. |
ShapeProperties | Returns or sets the trigger shape option. |
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. |
SetGeometry | Sets the geometries. |
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¶
CollisionSensorBuilderCollisionShapeTypes Enumeration | the Trigger Shape Types. |
CollisionSensorBuilderShapePropertiesOption Enumeration | the Trigger Shape Option. |
Property Detail¶
Category¶
-
CollisionSensorBuilder.
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”)
CollisionShape¶
-
CollisionSensorBuilder.
CollisionShape
¶ Returns or sets the collision shape type.
-------------------------------------
Getter Method
Signature
CollisionShape()
Returns: Return type: NXOpen.Mechatronics.CollisionSensorBuilderCollisionShapeTypes
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
CollisionShape(collisionShape)
Parameters: collisionShape ( NXOpen.Mechatronics.CollisionSensorBuilderCollisionShapeTypes
) –New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Geometry¶
-
CollisionSensorBuilder.
Geometry
¶ Returns the geometries.
This can be a
NXOpen.Assemblies.ComponentAssembly
,NXOpen.Point
, 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¶
-
CollisionSensorBuilder.
HighlightOnCollision
¶ Returns or sets the option of highlight on collision.
If the highlight is true, then the sensor will be highlighted when it is collided or triggered during simulation.
-------------------------------------
Getter Method
Signature
HighlightOnCollision()
Returns: Return type: bool New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
HighlightOnCollision(highlight)
Parameters: highlight (bool) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Name¶
-
CollisionSensorBuilder.
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”)
ShapeProperties¶
-
CollisionSensorBuilder.
ShapeProperties
¶ Returns or sets the trigger shape option.
-------------------------------------
Getter Method
Signature
ShapeProperties()
Returns: Return type: NXOpen.Mechatronics.CollisionSensorBuilderShapePropertiesOption
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
ShapeProperties(shapeProperties)
Parameters: shapeProperties ( NXOpen.Mechatronics.CollisionSensorBuilderShapePropertiesOption
) –New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
SetGeometry¶
-
CollisionSensorBuilder.
SetGeometry
¶ Sets the geometries.
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¶
-
CollisionSensorBuilder.
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.