NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::NcmClearanceBuilder Class Reference

Represents a CAM::NcmClearanceBuilder. More...

Inheritance diagram for NXOpen::CAM::NcmClearanceBuilder:
NXOpen::TaggedObject

List of all members.

Public Types

enum  ClearanceTypes {
  ClearanceTypesUseCommon, ClearanceTypesNone, ClearanceTypesAutomatic, ClearanceTypesPlane,
  ClearanceTypesPoint, ClearanceTypesCylinder, ClearanceTypesSphere, ClearanceTypesBoundingBox,
  ClearanceTypesBoundingCylinder
}
 the types available for clearance More...

Public Member Functions

NXOpen::NXObjectAxis ()
 Returns the clearance cylinder axis
Created in NX5.0.0.
double BoundingBoxClearance ()
 Returns the distance for bounding box clearance
Created in NX5.0.0.
NXOpen::CAM::NcmClearanceBuilder::ClearanceTypes ClearanceType ()
 Returns the clearance type
Created in NX5.0.0.
NXOpen::NXObjectPlaneXform ()
 Returns the clearance plane,plane entity type covers Xform and Plane
Created in NX5.0.0.
NXOpen::NXObjectPoint ()
 Returns the point for clearance types point, cylinder and sphere
Created in NX5.0.0.
double Radius ()
 Returns the clearance cylinder and sphere radius
Created in NX5.0.0.
double SafeDistance ()
 Returns the safe distance for automatic clearance
Created in NX5.0.0.
void SetAxis (NXOpen::NXObject *axis)
 Sets the clearance cylinder axis
Created in NX5.0.0.
void SetBoundingBoxClearance (double boundingBoxClearance)
 Sets the distance for bounding box clearance
Created in NX5.0.0.
void SetClearanceType (NXOpen::CAM::NcmClearanceBuilder::ClearanceTypes clearanceType)
 Sets the clearance type
Created in NX5.0.0.
void SetPlaneXform (NXOpen::NXObject *plane)
 Sets the clearance plane,plane entity type covers Xform and Plane
Created in NX5.0.0.
void SetPoint (NXOpen::NXObject *point)
 Sets the point for clearance types point, cylinder and sphere
Created in NX5.0.0.
void SetRadius (double radius)
 Sets the clearance cylinder and sphere radius
Created in NX5.0.0.
void SetSafeDistance (double newValue)
 Sets the safe distance for automatic clearance
Created in NX5.0.0.

Detailed Description

Represents a CAM::NcmClearanceBuilder.


Created in NX5.0.0.


Member Enumeration Documentation

the types available for clearance

Enumerator:
ClearanceTypesUseCommon 

inherited from common or parent

ClearanceTypesNone 

clearance turned off

ClearanceTypesAutomatic 

automatic with distance for planar operations

ClearanceTypesPlane 

clearance plane

ClearanceTypesPoint 

clearance point

ClearanceTypesCylinder 

clearance cylinder

ClearanceTypesSphere 

clearance sphere

ClearanceTypesBoundingBox 

clearance box

ClearanceTypesBoundingCylinder 

clearance bounding cylinder


Member Function Documentation

Returns the clearance cylinder axis
Created in NX5.0.0.



License requirements : None

Returns the distance for bounding box clearance
Created in NX5.0.0.



License requirements : None

Returns the clearance type
Created in NX5.0.0.



License requirements : None

Returns the clearance plane,plane entity type covers Xform and Plane
Created in NX5.0.0.



License requirements : None

Returns the point for clearance types point, cylinder and sphere
Created in NX5.0.0.



License requirements : None

Returns the clearance cylinder and sphere radius
Created in NX5.0.0.



License requirements : None

Returns the safe distance for automatic clearance
Created in NX5.0.0.



License requirements : None

Sets the clearance cylinder axis
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
axisaxis
void NXOpen::CAM::NcmClearanceBuilder::SetBoundingBoxClearance ( double  boundingBoxClearance)

Sets the distance for bounding box clearance
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
boundingBoxClearanceboundingboxclearance

Sets the clearance type
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
clearanceTypeclearancetype

Sets the clearance plane,plane entity type covers Xform and Plane
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
planeentity type can be XFORM or PLANE

Sets the point for clearance types point, cylinder and sphere
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
pointpoint

Sets the clearance cylinder and sphere radius
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
radiusradius

Sets the safe distance for automatic clearance
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue

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