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

Represents a Tool Path Editor Builder
To create a new instance of this class, use CAM::Operation::CreateToolPathEditorBuilder
Default values. More...

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

List of all members.

Public Types

enum  ClearanceMethodType { ClearanceMethodTypeSpecify, ClearanceMethodTypeUseOperation }
 Clearance Method Type. More...
enum  ConnectionMethodType { ConnectionMethodTypeClearancePlane, ConnectionMethodTypeDirect }
 Connection Method Type. More...
enum  ExtendMethodType {
  ExtendMethodTypeLinear, ExtendMethodTypeArc, ExtendMethodTypeLinearArc, ExtendMethodTypeArcLinear,
  ExtendMethodTypeLinearArcLinear
}
 Extend Method Type. More...
enum  MotionMethodType { MotionMethodTypeDelta, MotionMethodTypeToAPoint }
 Motion Method Type. More...
enum  TrimGeometryType { TrimGeometryTypePlane, TrimGeometryTypeLineInView, TrimGeometryTypeBoundary, TrimGeometryTypePermanentBoundary }
 Trim Geometry Type. More...
enum  TrimSideType { TrimSideTypeOutside, TrimSideTypeInside }
 Trim Side Type. More...

Public Member Functions

double ArcAngle ()
 Returns the arc angle
Created in NX6.0.0.
double ArcRadius ()
 Returns the arc radius
Created in NX6.0.0.
double DeltaXC ()
 Returns the delta xc
Created in NX6.0.0.
double DeltaYC ()
 Returns the delta yc
Created in NX6.0.0.
double DeltaZC ()
 Returns the delta zc
Created in NX6.0.0.
void Extend ()
 Extend
Created in NX6.0.0.
NXOpen::AxisExtendDirection ()
 Returns the extend direction
Created in NX6.0.0.
NXOpen::CAM::ToolPathEditorBuilder::ExtendMethodType ExtendMethod ()
 Returns the extend method
Created in NX6.0.0.
double FirstLinearDistance ()
 Returns the first linear distance
Created in NX6.0.0.
int GetNumberOfGouges ()
 Get number of gouges.
void GougeCheck ()
 Gouge check
Created in NX6.0.0.
NXOpen::CAM::ToolPathEditorBuilder::ClearanceMethodType GougeCheckClearanceMethod ()
 Returns the gouge check clearance plane method
Created in NX6.0.0.
NXOpen::NXObjectGougeCheckClearancePlane ()
 Returns the clearance plane,plane entity type covers Xform and Plane
Created in NX6.0.0.
bool HolderCheck ()
 Returns the holder check
Created in NX6.0.0.
NXOpen::CAM::ToolPathEditorBuilder::MotionMethodType MotionMethod ()
 Returns the motion method
Created in NX6.0.0.
void Move ()
 Move
Created in NX6.0.0.
bool MoveStartPoint ()
 Returns the move start point
Created in NX6.0.0.
void MoveToClearancePlane ()
 Move to clearance plane
Created in NX6.0.0.
NXOpen::NXObjectPermanentBoundary ()
 Returns the permanent boundary
Created in NX6.0.0.
NXOpen::PointReferencePoint ()
 Returns the reference point
Created in NX6.0.0.
void Reverse ()
 Reverse
Created in NX6.0.0.
double SecondLinearDistance ()
 Returns the second linear distance
Created in NX6.0.0.
void SelectAllGouges ()
 Select all gouges
Created in NX6.0.0.
void SelectNextGouge ()
 Select next gouge
Created in NX6.0.0.
void SelectPreviousGouge ()
 Select previous gouge
Created in NX6.0.0.
void SetArcAngle (double angle)
 Sets the arc angle
Created in NX6.0.0.
void SetArcRadius (double radius)
 Sets the arc radius
Created in NX6.0.0.
void SetDeltaXC (double deltaXC)
 Sets the delta xc
Created in NX6.0.0.
void SetDeltaYC (double deltaYC)
 Sets the delta yc
Created in NX6.0.0.
void SetDeltaZC (double deltaZC)
 Sets the delta zc
Created in NX6.0.0.
void SetExtendDirection (NXOpen::Axis *direction)
 Sets the extend direction
Created in NX6.0.0.
void SetExtendMethod (NXOpen::CAM::ToolPathEditorBuilder::ExtendMethodType motionMethod)
 Sets the extend method
Created in NX6.0.0.
void SetFirstLinearDistance (double distance)
 Sets the first linear distance
Created in NX6.0.0.
void SetGougeCheckClearanceMethod (NXOpen::CAM::ToolPathEditorBuilder::ClearanceMethodType method)
 Sets the gouge check clearance plane method
Created in NX6.0.0.
void SetGougeCheckClearancePlane (NXOpen::NXObject *clearancePlane)
 Sets the clearance plane,plane entity type covers Xform and Plane
Created in NX6.0.0.
void SetHolderCheck (bool transformCircles)
 Sets the holder check
Created in NX6.0.0.
void SetMotionMethod (NXOpen::CAM::ToolPathEditorBuilder::MotionMethodType motionMethod)
 Sets the motion method
Created in NX6.0.0.
void SetMoveStartPoint (bool moveStartPoint)
 Sets the move start point
Created in NX6.0.0.
void SetPermanentBoundary (NXOpen::NXObject *bnd)
 Sets the permanent boundary
Created in NX6.0.0.
void SetReferencePoint (NXOpen::Point *refPoint)
 Sets the reference point
Created in NX6.0.0.
void SetSecondLinearDistance (double distance)
 Sets the second linear distance
Created in NX6.0.0.
void SetToPoint (NXOpen::Point *toPoint)
 Sets the to point
Created in NX6.0.0.
void SetTransformCircles (bool transformCircles)
 Sets the transform circles
Created in NX6.0.0.
void SetTrimClearanceMethod (NXOpen::CAM::ToolPathEditorBuilder::ClearanceMethodType clrMethod)
 Sets the trimming clearance plane method
Created in NX6.0.0.
void SetTrimClearancePlane (NXOpen::NXObject *plane)
 Sets the trimming clearance plane,plane entity type covers Xform and Plane
Created in NX6.0.0.
void SetTrimConnectionMethod (NXOpen::CAM::ToolPathEditorBuilder::ConnectionMethodType connMethod)
 Sets the trimming connection method
Created in NX6.0.0.
void SetTrimDirection (NXOpen::Axis *dir)
 Sets the normal to the trim line
Created in NX6.0.0.
void SetTrimGeometry (NXOpen::CAM::ToolPathEditorBuilder::TrimGeometryType geomType)
 Sets the trim geometry type
Created in NX6.0.0.
void SetTrimLine (NXOpen::NXObject *line)
 Sets the trim line
Created in NX6.0.0.
void SetTrimPlane (NXOpen::NXObject *plane)
 Sets the trim plane,plane entity type covers Xform and Plane
Created in NX6.0.0.
void SetTrimSide (NXOpen::CAM::ToolPathEditorBuilder::TrimSideType side)
 Sets the side to trim
Created in NX6.0.0.
NXOpen::PointToPoint ()
 Returns the to point
Created in NX6.0.0.
bool TransformCircles ()
 Returns the transform circles
Created in NX6.0.0.
void Trim ()
 Trim
Created in NX6.0.0.
NXOpen::CAM::ToolPathEditorBuilder::ClearanceMethodType TrimClearanceMethod ()
 Returns the trimming clearance plane method
Created in NX6.0.0.
NXOpen::NXObjectTrimClearancePlane ()
 Returns the trimming clearance plane,plane entity type covers Xform and Plane
Created in NX6.0.0.
NXOpen::CAM::ToolPathEditorBuilder::ConnectionMethodType TrimConnectionMethod ()
 Returns the trimming connection method
Created in NX6.0.0.
NXOpen::AxisTrimDirection ()
 Returns the normal to the trim line
Created in NX6.0.0.
NXOpen::CAM::ToolPathEditorBuilder::TrimGeometryType TrimGeometry ()
 Returns the trim geometry type
Created in NX6.0.0.
NXOpen::NXObjectTrimLine ()
 Returns the trim line
Created in NX6.0.0.
NXOpen::NXObjectTrimPlane ()
 Returns the trim plane,plane entity type covers Xform and Plane
Created in NX6.0.0.
NXOpen::CAM::ToolPathEditorBuilder::TrimSideType TrimSide ()
 Returns the side to trim
Created in NX6.0.0.

Detailed Description

Represents a Tool Path Editor Builder
To create a new instance of this class, use CAM::Operation::CreateToolPathEditorBuilder
Default values.

Property Value

DeltaXC

0

DeltaYC

0

DeltaZC

0

ExtendMethod

Linear

GougeCheckClearanceMethod

Specify

HolderCheck

1

MotionMethod

Delta

MoveStartPoint

1

TransformCircles

0


Created in NX6.0.0.


Member Enumeration Documentation

Clearance Method Type.

Enumerator:
ClearanceMethodTypeSpecify 

specify

ClearanceMethodTypeUseOperation 

use operation

Connection Method Type.

Enumerator:
ConnectionMethodTypeClearancePlane 

clearance plane

ConnectionMethodTypeDirect 

direct

Extend Method Type.

Enumerator:
ExtendMethodTypeLinear 

linear

ExtendMethodTypeArc 

arc

ExtendMethodTypeLinearArc 

linear arc

ExtendMethodTypeArcLinear 

arc linear

ExtendMethodTypeLinearArcLinear 

linear arc linear

Motion Method Type.

Enumerator:
MotionMethodTypeDelta 

delta

MotionMethodTypeToAPoint 

to apoint

Trim Geometry Type.

Enumerator:
TrimGeometryTypePlane 

plane

TrimGeometryTypeLineInView 

line in view

TrimGeometryTypeBoundary 

boundary

TrimGeometryTypePermanentBoundary 

permanent boundary

Trim Side Type.

Enumerator:
TrimSideTypeOutside 

outside

TrimSideTypeInside 

inside


Member Function Documentation

Returns the arc angle
Created in NX6.0.0.



License requirements : None

Returns the arc radius
Created in NX6.0.0.



License requirements : None

Returns the delta xc
Created in NX6.0.0.



License requirements : None

Returns the delta yc
Created in NX6.0.0.



License requirements : None

Returns the delta zc
Created in NX6.0.0.



License requirements : None

Extend
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Returns the extend direction
Created in NX6.0.0.



License requirements : None

Returns the extend method
Created in NX6.0.0.



License requirements : None

Returns the first linear distance
Created in NX6.0.0.



License requirements : None

Get number of gouges.

Returns:

Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Gouge check
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Returns the gouge check clearance plane method
Created in NX6.0.0.



License requirements : None

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



License requirements : None

Returns the holder check
Created in NX6.0.0.



License requirements : None

Returns the motion method
Created in NX6.0.0.



License requirements : None

Move
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Returns the move start point
Created in NX6.0.0.



License requirements : None

Move to clearance plane
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Returns the permanent boundary
Created in NX6.0.0.



License requirements : None

Returns the reference point
Created in NX6.0.0.



License requirements : None

Reverse
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Returns the second linear distance
Created in NX6.0.0.



License requirements : None

Select all gouges
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Select next gouge
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Select previous gouge
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Sets the arc angle
Created in NX6.0.0.



License requirements : None

Parameters:
angleangle

Sets the arc radius
Created in NX6.0.0.



License requirements : None

Parameters:
radiusradius

Sets the delta xc
Created in NX6.0.0.



License requirements : None

Parameters:
deltaXCdeltaxc

Sets the delta yc
Created in NX6.0.0.



License requirements : None

Parameters:
deltaYCdeltayc

Sets the delta zc
Created in NX6.0.0.



License requirements : None

Parameters:
deltaZCdeltazc

Sets the extend direction
Created in NX6.0.0.



License requirements : None

Parameters:
directiondirection

Sets the extend method
Created in NX6.0.0.



License requirements : None

Parameters:
motionMethodmotionmethod

Sets the first linear distance
Created in NX6.0.0.



License requirements : None

Parameters:
distancedistance

Sets the gouge check clearance plane method
Created in NX6.0.0.



License requirements : None

Parameters:
methodmethod

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



License requirements : None

Parameters:
clearancePlaneclearanceplane
void NXOpen::CAM::ToolPathEditorBuilder::SetHolderCheck ( bool  transformCircles)

Sets the holder check
Created in NX6.0.0.



License requirements : None

Parameters:
transformCirclestransformcircles

Sets the motion method
Created in NX6.0.0.



License requirements : None

Parameters:
motionMethodmotionmethod

Sets the move start point
Created in NX6.0.0.



License requirements : None

Parameters:
moveStartPointmovestartpoint

Sets the permanent boundary
Created in NX6.0.0.



License requirements : None

Parameters:
bndbnd

Sets the reference point
Created in NX6.0.0.



License requirements : None

Parameters:
refPointrefpoint

Sets the second linear distance
Created in NX6.0.0.



License requirements : None

Parameters:
distancedistance

Sets the to point
Created in NX6.0.0.



License requirements : None

Parameters:
toPointtopoint

Sets the transform circles
Created in NX6.0.0.



License requirements : None

Parameters:
transformCirclestransformcircles

Sets the trimming clearance plane method
Created in NX6.0.0.



License requirements : None

Parameters:
clrMethodclrmethod

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



License requirements : None

Parameters:
planeplane

Sets the trimming connection method
Created in NX6.0.0.



License requirements : None

Parameters:
connMethodconnmethod

Sets the normal to the trim line
Created in NX6.0.0.



License requirements : None

Parameters:
dirdir

Sets the trim geometry type
Created in NX6.0.0.



License requirements : None

Parameters:
geomTypegeomtype

Sets the trim line
Created in NX6.0.0.



License requirements : None

Parameters:
lineline

Sets the trim plane,plane entity type covers Xform and Plane
Created in NX6.0.0.



License requirements : None

Parameters:
planeplane

Sets the side to trim
Created in NX6.0.0.



License requirements : None

Parameters:
sideside

Returns the to point
Created in NX6.0.0.



License requirements : None

Returns the transform circles
Created in NX6.0.0.



License requirements : None

Trim
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Returns the trimming clearance plane method
Created in NX6.0.0.



License requirements : None

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



License requirements : None

Returns the trimming connection method
Created in NX6.0.0.



License requirements : None

Returns the normal to the trim line
Created in NX6.0.0.



License requirements : None

Returns the trim geometry type
Created in NX6.0.0.



License requirements : None

Returns the trim line
Created in NX6.0.0.



License requirements : None

Returns the trim plane,plane entity type covers Xform and Plane
Created in NX6.0.0.



License requirements : None

Returns the side to trim
Created in NX6.0.0.



License requirements : None


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