CollisionPairBuilder Class¶
-
class
NXOpen.CAM.
CollisionPairBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.CAM.CollisionPairBuilder
To create a new instance of this class, use
NXOpen.SIM.KinematicConfigurator.CreateCollisionPairBuilder()
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
CollisionClearance | Returns or sets the collision clearance |
CollisionEnable | Returns or sets the collision enable |
FirstObjectFilter | Returns or sets the first collision selection filter |
FirstObjectName | Returns or sets the first collision selection name |
SecondObjectFilter | Returns or sets the second collision selection filter |
SecondObjectName | Returns or sets the second collision selection name |
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¶
CollisionPairBuilderFilter Enumeration | the collision selection filter value |
Property Detail¶
CollisionClearance¶
-
CollisionPairBuilder.
CollisionClearance
¶ Returns or sets the collision clearance
-------------------------------------
Getter Method
Signature
CollisionClearance()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CollisionClearance(collisionClearance)
Parameters: collisionClearance (float) – New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
CollisionEnable¶
-
CollisionPairBuilder.
CollisionEnable
¶ Returns or sets the collision enable
-------------------------------------
Getter Method
Signature
CollisionEnable()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CollisionEnable(collisionEnable)
Parameters: collisionEnable (bool) – New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
FirstObjectFilter¶
-
CollisionPairBuilder.
FirstObjectFilter
¶ Returns or sets the first collision selection filter
-------------------------------------
Getter Method
Signature
FirstObjectFilter()
Returns: Return type: NXOpen.CAM.CollisionPairBuilderFilter
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FirstObjectFilter(filter)
Parameters: filter ( NXOpen.CAM.CollisionPairBuilderFilter
) –New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
FirstObjectName¶
-
CollisionPairBuilder.
FirstObjectName
¶ Returns or sets the first collision selection name
-------------------------------------
Getter Method
Signature
FirstObjectName()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FirstObjectName(name)
Parameters: name (str) – New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
SecondObjectFilter¶
-
CollisionPairBuilder.
SecondObjectFilter
¶ Returns or sets the second collision selection filter
-------------------------------------
Getter Method
Signature
SecondObjectFilter()
Returns: Return type: NXOpen.CAM.CollisionPairBuilderFilter
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SecondObjectFilter(filter)
Parameters: filter ( NXOpen.CAM.CollisionPairBuilderFilter
) –New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
SecondObjectName¶
-
CollisionPairBuilder.
SecondObjectName
¶ Returns or sets the second collision selection name
-------------------------------------
Getter Method
Signature
SecondObjectName()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SecondObjectName(name)
Parameters: name (str) – New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
Validate¶
-
CollisionPairBuilder.
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.