NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAM::CollisionPairBuilder Class Reference

Represents a NXOpen::CAM::CollisionPairBuilder
To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateCollisionPairBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::CollisionPairBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Filter { FilterComponent, FilterClass, FilterComponentParent }
 the collision selection filter value More...
 

Public Member Functions

double CollisionClearance ()
 Returns the collision clearance
Created in NX6.0.0. More...
 
bool CollisionEnable ()
 Returns the collision enable
Created in NX6.0.0. More...
 
NXOpen::CAM::CollisionPairBuilder::Filter FirstObjectFilter ()
 Returns the first collision selection filter
Created in NX6.0.0. More...
 
NXString FirstObjectName ()
 Returns the first collision selection name
Created in NX6.0.0. More...
 
NXOpen::CAM::CollisionPairBuilder::Filter SecondObjectFilter ()
 Returns the second collision selection filter
Created in NX6.0.0. More...
 
NXString SecondObjectName ()
 Returns the second collision selection name
Created in NX6.0.0. More...
 
void SetCollisionClearance (double collisionClearance)
 Sets the collision clearance
Created in NX6.0.0. More...
 
void SetCollisionEnable (bool collisionEnable)
 Sets the collision enable
Created in NX6.0.0. More...
 
void SetFirstObjectFilter (NXOpen::CAM::CollisionPairBuilder::Filter filter)
 Sets the first collision selection filter
Created in NX6.0.0. More...
 
void SetFirstObjectName (const NXString &name)
 Sets the first collision selection name
Created in NX6.0.0. More...
 
void SetFirstObjectName (const char *name)
 Sets the first collision selection name
Created in NX6.0.0. More...
 
void SetSecondObjectFilter (NXOpen::CAM::CollisionPairBuilder::Filter filter)
 Sets the second collision selection filter
Created in NX6.0.0. More...
 
void SetSecondObjectName (const NXString &name)
 Sets the second collision selection name
Created in NX6.0.0. More...
 
void SetSecondObjectName (const char *name)
 Sets the second collision selection name
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::CAM::CollisionPairBuilder
To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateCollisionPairBuilder

Created in NX6.0.0.


Member Enumeration Documentation

the collision selection filter value

Enumerator
FilterComponent 

component filter

FilterClass 

class filter

FilterComponentParent 

component parent filter

Member Function Documentation

double NXOpen::CAM::CollisionPairBuilder::CollisionClearance ( )

Returns the collision clearance
Created in NX6.0.0.



License requirements : None

bool NXOpen::CAM::CollisionPairBuilder::CollisionEnable ( )

Returns the collision enable
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::CollisionPairBuilder::Filter NXOpen::CAM::CollisionPairBuilder::FirstObjectFilter ( )

Returns the first collision selection filter
Created in NX6.0.0.



License requirements : None

NXString NXOpen::CAM::CollisionPairBuilder::FirstObjectName ( )

Returns the first collision selection name
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::CollisionPairBuilder::Filter NXOpen::CAM::CollisionPairBuilder::SecondObjectFilter ( )

Returns the second collision selection filter
Created in NX6.0.0.



License requirements : None

NXString NXOpen::CAM::CollisionPairBuilder::SecondObjectName ( )

Returns the second collision selection name
Created in NX6.0.0.



License requirements : None

void NXOpen::CAM::CollisionPairBuilder::SetCollisionClearance ( double  collisionClearance)

Sets the collision clearance
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
collisionClearancecollisionclearance
void NXOpen::CAM::CollisionPairBuilder::SetCollisionEnable ( bool  collisionEnable)

Sets the collision enable
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
collisionEnablecollisionenable
void NXOpen::CAM::CollisionPairBuilder::SetFirstObjectFilter ( NXOpen::CAM::CollisionPairBuilder::Filter  filter)

Sets the first collision selection filter
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
filterfilter
void NXOpen::CAM::CollisionPairBuilder::SetFirstObjectName ( const NXString name)

Sets the first collision selection name
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
namename
void NXOpen::CAM::CollisionPairBuilder::SetFirstObjectName ( const char *  name)

Sets the first collision selection name
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
namename
void NXOpen::CAM::CollisionPairBuilder::SetSecondObjectFilter ( NXOpen::CAM::CollisionPairBuilder::Filter  filter)

Sets the second collision selection filter
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
filterfilter
void NXOpen::CAM::CollisionPairBuilder::SetSecondObjectName ( const NXString name)

Sets the second collision selection name
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
namename
void NXOpen::CAM::CollisionPairBuilder::SetSecondObjectName ( const char *  name)

Sets the second collision selection name
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
namename

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.