Represents a Tool Path Editor Builder  <br> To create a new instance of this class, use @link CAM::Operation::CreateToolPathEditorBuilder  CAM::Operation::CreateToolPathEditorBuilder @endlink  <br>

Default values. More...

Inheritance diagram for NXOpen::CAM::ToolPathEditorBuilder:

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::Axis *	ExtendDirection ()
	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::NXObject *	GougeCheckClearancePlane ()
	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::NXObject *	PermanentBoundary ()
	Returns the permanent boundary Created in NX6.0.0.

NXOpen::Point *	ReferencePoint ()
	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::Point *	ToPoint ()
	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::NXObject *	TrimClearancePlane ()
	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::Axis *	TrimDirection ()
	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::NXObject *	TrimLine ()
	Returns the trim line Created in NX6.0.0.

NXOpen::NXObject *	TrimPlane ()
	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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Tool Path Editor Builder  <br> To create a new instance of this class, use @link CAM::Operation::CreateToolPathEditorBuilder  CAM::Operation::CreateToolPathEditorBuilder @endlink  <br>

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

enum NXOpen::CAM::ToolPathEditorBuilder::ClearanceMethodType

Clearance Method Type.

Enumerator:

ClearanceMethodTypeSpecify	specify
ClearanceMethodTypeUseOperation	use operation

enum NXOpen::CAM::ToolPathEditorBuilder::ConnectionMethodType

Connection Method Type.

Enumerator:

ConnectionMethodTypeClearancePlane	clearance plane
ConnectionMethodTypeDirect	direct

enum NXOpen::CAM::ToolPathEditorBuilder::ExtendMethodType

Extend Method Type.

Enumerator:

ExtendMethodTypeLinear	linear
ExtendMethodTypeArc	arc
ExtendMethodTypeLinearArc	linear arc
ExtendMethodTypeArcLinear	arc linear
ExtendMethodTypeLinearArcLinear	linear arc linear

enum NXOpen::CAM::ToolPathEditorBuilder::MotionMethodType

Motion Method Type.

Enumerator:

MotionMethodTypeDelta	delta
MotionMethodTypeToAPoint	to apoint

enum NXOpen::CAM::ToolPathEditorBuilder::TrimGeometryType

Trim Geometry Type.

Enumerator:

TrimGeometryTypePlane	plane
TrimGeometryTypeLineInView	line in view
TrimGeometryTypeBoundary	boundary
TrimGeometryTypePermanentBoundary	permanent boundary

enum NXOpen::CAM::ToolPathEditorBuilder::TrimSideType

Trim Side Type.

Enumerator:

TrimSideTypeOutside	outside
TrimSideTypeInside	inside

Member Function Documentation

double NXOpen::CAM::ToolPathEditorBuilder::ArcAngle ( )

Returns the arc angle
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::ToolPathEditorBuilder::ArcRadius ( )

Returns the arc radius
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::ToolPathEditorBuilder::DeltaXC ( )

Returns the delta xc
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::ToolPathEditorBuilder::DeltaYC ( )

Returns the delta yc
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::ToolPathEditorBuilder::DeltaZC ( )

Returns the delta zc
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::ToolPathEditorBuilder::Extend ( )

Extend
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::Axis* NXOpen::CAM::ToolPathEditorBuilder::ExtendDirection ( )

Returns the extend direction
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::ToolPathEditorBuilder::ExtendMethodType NXOpen::CAM::ToolPathEditorBuilder::ExtendMethod ( )

Returns the extend method
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::ToolPathEditorBuilder::FirstLinearDistance ( )

Returns the first linear distance
Created in NX6.0.0.

License requirements : None

int NXOpen::CAM::ToolPathEditorBuilder::GetNumberOfGouges ( )

Get number of gouges.

Returns: Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::ToolPathEditorBuilder::GougeCheck ( )

Gouge check
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::ToolPathEditorBuilder::ClearanceMethodType NXOpen::CAM::ToolPathEditorBuilder::GougeCheckClearanceMethod ( )

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

License requirements : None

NXOpen::NXObject* NXOpen::CAM::ToolPathEditorBuilder::GougeCheckClearancePlane ( )

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

License requirements : None

bool NXOpen::CAM::ToolPathEditorBuilder::HolderCheck ( )

Returns the holder check
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::ToolPathEditorBuilder::MotionMethodType NXOpen::CAM::ToolPathEditorBuilder::MotionMethod ( )

Returns the motion method
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::ToolPathEditorBuilder::Move ( )

Move
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::ToolPathEditorBuilder::MoveStartPoint ( )

Returns the move start point
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::ToolPathEditorBuilder::MoveToClearancePlane ( )

Move to clearance plane
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::NXObject* NXOpen::CAM::ToolPathEditorBuilder::PermanentBoundary ( )

Returns the permanent boundary
Created in NX6.0.0.

License requirements : None

NXOpen::Point* NXOpen::CAM::ToolPathEditorBuilder::ReferencePoint ( )

Returns the reference point
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::ToolPathEditorBuilder::Reverse ( )

Reverse
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

double NXOpen::CAM::ToolPathEditorBuilder::SecondLinearDistance ( )

Returns the second linear distance
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::ToolPathEditorBuilder::SelectAllGouges ( )

Select all gouges
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::ToolPathEditorBuilder::SelectNextGouge ( )

Select next gouge
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::ToolPathEditorBuilder::SelectPreviousGouge ( )

Select previous gouge
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::ToolPathEditorBuilder::SetArcAngle ( double angle )

Sets the arc angle
Created in NX6.0.0.

License requirements : None

Parameters

angle angle

void NXOpen::CAM::ToolPathEditorBuilder::SetArcRadius ( double radius )

Sets the arc radius
Created in NX6.0.0.

License requirements : None

Parameters

radius radius

void NXOpen::CAM::ToolPathEditorBuilder::SetDeltaXC ( double deltaXC )

Sets the delta xc
Created in NX6.0.0.

License requirements : None

Parameters

deltaXC deltaxc

void NXOpen::CAM::ToolPathEditorBuilder::SetDeltaYC ( double deltaYC )

Sets the delta yc
Created in NX6.0.0.

License requirements : None

Parameters

deltaYC deltayc

void NXOpen::CAM::ToolPathEditorBuilder::SetDeltaZC ( double deltaZC )

Sets the delta zc
Created in NX6.0.0.

License requirements : None

Parameters

deltaZC deltazc

void NXOpen::CAM::ToolPathEditorBuilder::SetExtendDirection ( NXOpen::Axis * direction )

Sets the extend direction
Created in NX6.0.0.

License requirements : None

Parameters

direction direction

void NXOpen::CAM::ToolPathEditorBuilder::SetExtendMethod ( NXOpen::CAM::ToolPathEditorBuilder::ExtendMethodType motionMethod )

Sets the extend method
Created in NX6.0.0.

License requirements : None

Parameters

motionMethod motionmethod

void NXOpen::CAM::ToolPathEditorBuilder::SetFirstLinearDistance ( double distance )

Sets the first linear distance
Created in NX6.0.0.

License requirements : None

Parameters

distance distance

void NXOpen::CAM::ToolPathEditorBuilder::SetGougeCheckClearanceMethod ( NXOpen::CAM::ToolPathEditorBuilder::ClearanceMethodType method )

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

License requirements : None

Parameters

method method

void NXOpen::CAM::ToolPathEditorBuilder::SetGougeCheckClearancePlane ( NXOpen::NXObject * clearancePlane )

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

License requirements : None

Parameters

clearancePlane clearanceplane

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

Sets the holder check
Created in NX6.0.0.

License requirements : None

Parameters

transformCircles transformcircles

void NXOpen::CAM::ToolPathEditorBuilder::SetMotionMethod ( NXOpen::CAM::ToolPathEditorBuilder::MotionMethodType motionMethod )

Sets the motion method
Created in NX6.0.0.

License requirements : None

Parameters

motionMethod motionmethod

void NXOpen::CAM::ToolPathEditorBuilder::SetMoveStartPoint ( bool moveStartPoint )

Sets the move start point
Created in NX6.0.0.

License requirements : None

Parameters

moveStartPoint movestartpoint

void NXOpen::CAM::ToolPathEditorBuilder::SetPermanentBoundary ( NXOpen::NXObject * bnd )

Sets the permanent boundary
Created in NX6.0.0.

License requirements : None

Parameters

bnd bnd

void NXOpen::CAM::ToolPathEditorBuilder::SetReferencePoint ( NXOpen::Point * refPoint )

Sets the reference point
Created in NX6.0.0.

License requirements : None

Parameters

refPoint refpoint

void NXOpen::CAM::ToolPathEditorBuilder::SetSecondLinearDistance ( double distance )

Sets the second linear distance
Created in NX6.0.0.

License requirements : None

Parameters

distance distance

void NXOpen::CAM::ToolPathEditorBuilder::SetToPoint ( NXOpen::Point * toPoint )

Sets the to point
Created in NX6.0.0.

License requirements : None

Parameters

toPoint topoint

void NXOpen::CAM::ToolPathEditorBuilder::SetTransformCircles ( bool transformCircles )

Sets the transform circles
Created in NX6.0.0.

License requirements : None

Parameters

transformCircles transformcircles

void NXOpen::CAM::ToolPathEditorBuilder::SetTrimClearanceMethod ( NXOpen::CAM::ToolPathEditorBuilder::ClearanceMethodType clrMethod )

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

License requirements : None

Parameters

clrMethod clrmethod

void NXOpen::CAM::ToolPathEditorBuilder::SetTrimClearancePlane ( NXOpen::NXObject * plane )

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

License requirements : None

Parameters

plane plane

void NXOpen::CAM::ToolPathEditorBuilder::SetTrimConnectionMethod ( NXOpen::CAM::ToolPathEditorBuilder::ConnectionMethodType connMethod )

Sets the trimming connection method
Created in NX6.0.0.

License requirements : None

Parameters

connMethod connmethod

void NXOpen::CAM::ToolPathEditorBuilder::SetTrimDirection ( NXOpen::Axis * dir )

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

License requirements : None

Parameters

dir dir

void NXOpen::CAM::ToolPathEditorBuilder::SetTrimGeometry ( NXOpen::CAM::ToolPathEditorBuilder::TrimGeometryType geomType )

Sets the trim geometry type
Created in NX6.0.0.

License requirements : None

Parameters

geomType geomtype

void NXOpen::CAM::ToolPathEditorBuilder::SetTrimLine ( NXOpen::NXObject * line )

Sets the trim line
Created in NX6.0.0.

License requirements : None

Parameters

line line

void NXOpen::CAM::ToolPathEditorBuilder::SetTrimPlane ( NXOpen::NXObject * plane )

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

License requirements : None

Parameters

plane plane

void NXOpen::CAM::ToolPathEditorBuilder::SetTrimSide ( NXOpen::CAM::ToolPathEditorBuilder::TrimSideType side )

Sets the side to trim
Created in NX6.0.0.

License requirements : None

Parameters

side side

NXOpen::Point* NXOpen::CAM::ToolPathEditorBuilder::ToPoint ( )

Returns the to point
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::ToolPathEditorBuilder::TransformCircles ( )

Returns the transform circles
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::ToolPathEditorBuilder::Trim ( )

Trim
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::ToolPathEditorBuilder::ClearanceMethodType NXOpen::CAM::ToolPathEditorBuilder::TrimClearanceMethod ( )

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

License requirements : None

NXOpen::NXObject* NXOpen::CAM::ToolPathEditorBuilder::TrimClearancePlane ( )

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

License requirements : None

NXOpen::CAM::ToolPathEditorBuilder::ConnectionMethodType NXOpen::CAM::ToolPathEditorBuilder::TrimConnectionMethod ( )

Returns the trimming connection method
Created in NX6.0.0.

License requirements : None

NXOpen::Axis* NXOpen::CAM::ToolPathEditorBuilder::TrimDirection ( )

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

License requirements : None

NXOpen::CAM::ToolPathEditorBuilder::TrimGeometryType NXOpen::CAM::ToolPathEditorBuilder::TrimGeometry ( )

Returns the trim geometry type
Created in NX6.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::CAM::ToolPathEditorBuilder::TrimLine ( )

Returns the trim line
Created in NX6.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::CAM::ToolPathEditorBuilder::TrimPlane ( )

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

License requirements : None

NXOpen::CAM::ToolPathEditorBuilder::TrimSideType NXOpen::CAM::ToolPathEditorBuilder::TrimSide ( )

Returns the side to trim
Created in NX6.0.0.

License requirements : None

The documentation for this class was generated from the following file:

CAM_ToolPathEditorBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation