ToolPathEditorBuilder Class

class NXOpen.CAM.ToolPathEditorBuilder

Bases: NXOpen.Builder

Represents a Tool Path Editor Builder

To create a new instance of this class, use NXOpen.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

New in version NX6.0.0.

Properties

Property Description
ArcAngle Returns or sets the arc angle
ArcRadius Returns or sets the arc radius
DeltaXC Returns or sets the delta xc
DeltaYC Returns or sets the delta yc
DeltaZC Returns or sets the delta zc
ExtendDirection Returns or sets the extend direction
ExtendMethod Returns or sets the extend method
FirstLinearDistance Returns or sets the first linear distance
GougeCheckClearanceMethod Returns or sets the gouge check clearance plane method
GougeCheckClearancePlane Returns or sets the clearance plane,plane entity type covers Xform and Plane
HolderCheck Returns or sets the holder check
MotionMethod Returns or sets the motion method
MoveStartPoint Returns or sets the move start point
PermanentBoundary Returns or sets the permanent boundary
ReferencePoint Returns or sets the reference point
SecondLinearDistance Returns or sets the second linear distance
Tag Returns the Tag for this object.
ToPoint Returns or sets the to point
TransformCircles Returns or sets the transform circles
TrimClearanceMethod Returns or sets the trimming clearance plane method
TrimClearancePlane Returns or sets the trimming clearance plane,plane entity type covers Xform and Plane
TrimConnectionMethod Returns or sets the trimming connection method
TrimDirection Returns or sets the normal to the trim line
TrimGeometry Returns or sets the trim geometry type
TrimLine Returns or sets the trim line
TrimPlane Returns or sets the trim plane,plane entity type covers Xform and Plane
TrimSide Returns or sets the side to trim

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.
Extend Extend
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetNumberOfGouges Get number of gouges
GetObject Returns the object currently being edited by this builder.
GougeCheck Gouge check
Move Move
MoveToClearancePlane Move to clearance plane
Reverse Reverse
SelectAllGouges Select all gouges
SelectNextGouge Select next gouge
SelectPreviousGouge Select previous gouge
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Trim Trim
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

ArcAngle

ToolPathEditorBuilder.ArcAngle

Returns or sets the arc angle

-------------------------------------

Getter Method

Signature ArcAngle

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ArcAngle

Parameters:angle (float) –

New in version NX6.0.0.

License requirements: None.

ArcRadius

ToolPathEditorBuilder.ArcRadius

Returns or sets the arc radius

-------------------------------------

Getter Method

Signature ArcRadius

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ArcRadius

Parameters:radius (float) –

New in version NX6.0.0.

License requirements: None.

DeltaXC

ToolPathEditorBuilder.DeltaXC

Returns or sets the delta xc

-------------------------------------

Getter Method

Signature DeltaXC

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DeltaXC

Parameters:deltaXC (float) –

New in version NX6.0.0.

License requirements: None.

DeltaYC

ToolPathEditorBuilder.DeltaYC

Returns or sets the delta yc

-------------------------------------

Getter Method

Signature DeltaYC

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DeltaYC

Parameters:deltaYC (float) –

New in version NX6.0.0.

License requirements: None.

DeltaZC

ToolPathEditorBuilder.DeltaZC

Returns or sets the delta zc

-------------------------------------

Getter Method

Signature DeltaZC

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DeltaZC

Parameters:deltaZC (float) –

New in version NX6.0.0.

License requirements: None.

ExtendDirection

ToolPathEditorBuilder.ExtendDirection

Returns or sets the extend direction

-------------------------------------

Getter Method

Signature ExtendDirection

Returns:
Return type:NXOpen.Axis

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ExtendDirection

Parameters:direction (NXOpen.Axis) –

New in version NX6.0.0.

License requirements: None.

ExtendMethod

ToolPathEditorBuilder.ExtendMethod

Returns or sets the extend method

-------------------------------------

Getter Method

Signature ExtendMethod

Returns:
Return type:NXOpen.CAM.ToolPathEditorBuilderExtendMethodType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ExtendMethod

Parameters:motionMethod (NXOpen.CAM.ToolPathEditorBuilderExtendMethodType) –

New in version NX6.0.0.

License requirements: None.

FirstLinearDistance

ToolPathEditorBuilder.FirstLinearDistance

Returns or sets the first linear distance

-------------------------------------

Getter Method

Signature FirstLinearDistance

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FirstLinearDistance

Parameters:distance (float) –

New in version NX6.0.0.

License requirements: None.

GougeCheckClearanceMethod

ToolPathEditorBuilder.GougeCheckClearanceMethod

Returns or sets the gouge check clearance plane method

-------------------------------------

Getter Method

Signature GougeCheckClearanceMethod

Returns:
Return type:NXOpen.CAM.ToolPathEditorBuilderClearanceMethodType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature GougeCheckClearanceMethod

Parameters:method (NXOpen.CAM.ToolPathEditorBuilderClearanceMethodType) –

New in version NX6.0.0.

License requirements: None.

GougeCheckClearancePlane

ToolPathEditorBuilder.GougeCheckClearancePlane

Returns or sets the clearance plane,plane entity type covers Xform and Plane

-------------------------------------

Getter Method

Signature GougeCheckClearancePlane

Returns:entity type can be XFORM or PLANE
Return type:NXOpen.NXObject

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature GougeCheckClearancePlane

Parameters:clearancePlane (NXOpen.NXObject) –

New in version NX6.0.0.

License requirements: None.

HolderCheck

ToolPathEditorBuilder.HolderCheck

Returns or sets the holder check

-------------------------------------

Getter Method

Signature HolderCheck

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature HolderCheck

Parameters:transformCircles (bool) –

New in version NX6.0.0.

License requirements: None.

MotionMethod

ToolPathEditorBuilder.MotionMethod

Returns or sets the motion method

-------------------------------------

Getter Method

Signature MotionMethod

Returns:
Return type:NXOpen.CAM.ToolPathEditorBuilderMotionMethodType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MotionMethod

Parameters:motionMethod (NXOpen.CAM.ToolPathEditorBuilderMotionMethodType) –

New in version NX6.0.0.

License requirements: None.

MoveStartPoint

ToolPathEditorBuilder.MoveStartPoint

Returns or sets the move start point

-------------------------------------

Getter Method

Signature MoveStartPoint

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MoveStartPoint

Parameters:moveStartPoint (bool) –

New in version NX6.0.0.

License requirements: None.

PermanentBoundary

ToolPathEditorBuilder.PermanentBoundary

Returns or sets the permanent boundary

-------------------------------------

Getter Method

Signature PermanentBoundary

Returns:
Return type:NXOpen.NXObject

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PermanentBoundary

Parameters:bnd (NXOpen.NXObject) –

New in version NX6.0.0.

License requirements: None.

ReferencePoint

ToolPathEditorBuilder.ReferencePoint

Returns or sets the reference point

-------------------------------------

Getter Method

Signature ReferencePoint

Returns:
Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ReferencePoint

Parameters:refPoint (NXOpen.Point) –

New in version NX6.0.0.

License requirements: None.

SecondLinearDistance

ToolPathEditorBuilder.SecondLinearDistance

Returns or sets the second linear distance

-------------------------------------

Getter Method

Signature SecondLinearDistance

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SecondLinearDistance

Parameters:distance (float) –

New in version NX6.0.0.

License requirements: None.

ToPoint

ToolPathEditorBuilder.ToPoint

Returns or sets the to point

-------------------------------------

Getter Method

Signature ToPoint

Returns:
Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ToPoint

Parameters:toPoint (NXOpen.Point) –

New in version NX6.0.0.

License requirements: None.

TransformCircles

ToolPathEditorBuilder.TransformCircles

Returns or sets the transform circles

-------------------------------------

Getter Method

Signature TransformCircles

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TransformCircles

Parameters:transformCircles (bool) –

New in version NX6.0.0.

License requirements: None.

TrimClearanceMethod

ToolPathEditorBuilder.TrimClearanceMethod

Returns or sets the trimming clearance plane method

-------------------------------------

Getter Method

Signature TrimClearanceMethod

Returns:
Return type:NXOpen.CAM.ToolPathEditorBuilderClearanceMethodType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimClearanceMethod

Parameters:clrMethod (NXOpen.CAM.ToolPathEditorBuilderClearanceMethodType) –

New in version NX6.0.0.

License requirements: None.

TrimClearancePlane

ToolPathEditorBuilder.TrimClearancePlane

Returns or sets the trimming clearance plane,plane entity type covers Xform and Plane

-------------------------------------

Getter Method

Signature TrimClearancePlane

Returns:entity type can be XFORM or PLANE
Return type:NXOpen.NXObject

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimClearancePlane

Parameters:plane (NXOpen.NXObject) –

New in version NX6.0.0.

License requirements: None.

TrimConnectionMethod

ToolPathEditorBuilder.TrimConnectionMethod

Returns or sets the trimming connection method

-------------------------------------

Getter Method

Signature TrimConnectionMethod

Returns:
Return type:NXOpen.CAM.ToolPathEditorBuilderConnectionMethodType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimConnectionMethod

Parameters:connMethod (NXOpen.CAM.ToolPathEditorBuilderConnectionMethodType) –

New in version NX6.0.0.

License requirements: None.

TrimDirection

ToolPathEditorBuilder.TrimDirection

Returns or sets the normal to the trim line

-------------------------------------

Getter Method

Signature TrimDirection

Returns:
Return type:NXOpen.Axis

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimDirection

Parameters:dir (NXOpen.Axis) –

New in version NX6.0.0.

License requirements: None.

TrimGeometry

ToolPathEditorBuilder.TrimGeometry

Returns or sets the trim geometry type

-------------------------------------

Getter Method

Signature TrimGeometry

Returns:
Return type:NXOpen.CAM.ToolPathEditorBuilderTrimGeometryType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimGeometry

Parameters:geomType (NXOpen.CAM.ToolPathEditorBuilderTrimGeometryType) –

New in version NX6.0.0.

License requirements: None.

TrimLine

ToolPathEditorBuilder.TrimLine

Returns or sets the trim line

-------------------------------------

Getter Method

Signature TrimLine

Returns:
Return type:NXOpen.NXObject

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimLine

Parameters:line (NXOpen.NXObject) –

New in version NX6.0.0.

License requirements: None.

TrimPlane

ToolPathEditorBuilder.TrimPlane

Returns or sets the trim plane,plane entity type covers Xform and Plane

-------------------------------------

Getter Method

Signature TrimPlane

Returns:entity type can be XFORM or PLANE
Return type:NXOpen.NXObject

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimPlane

Parameters:plane (NXOpen.NXObject) –

New in version NX6.0.0.

License requirements: None.

TrimSide

ToolPathEditorBuilder.TrimSide

Returns or sets the side to trim

-------------------------------------

Getter Method

Signature TrimSide

Returns:
Return type:NXOpen.CAM.ToolPathEditorBuilderTrimSideType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimSide

Parameters:side (NXOpen.CAM.ToolPathEditorBuilderTrimSideType) –

New in version NX6.0.0.

License requirements: None.

Method Detail

Extend

ToolPathEditorBuilder.Extend

Signature Extend()

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

GetNumberOfGouges

ToolPathEditorBuilder.GetNumberOfGouges

Get number of gouges

Signature GetNumberOfGouges()

Returns:
Return type:int

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

GougeCheck

ToolPathEditorBuilder.GougeCheck

Gouge check

Signature GougeCheck()

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

Move

ToolPathEditorBuilder.Move

Signature Move()

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

MoveToClearancePlane

ToolPathEditorBuilder.MoveToClearancePlane

Move to clearance plane

Signature MoveToClearancePlane()

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

Reverse

ToolPathEditorBuilder.Reverse

Signature Reverse()

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

SelectAllGouges

ToolPathEditorBuilder.SelectAllGouges

Select all gouges

Signature SelectAllGouges()

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

SelectNextGouge

ToolPathEditorBuilder.SelectNextGouge

Select next gouge

Signature SelectNextGouge()

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

SelectPreviousGouge

ToolPathEditorBuilder.SelectPreviousGouge

Select previous gouge

Signature SelectPreviousGouge()

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

Trim

ToolPathEditorBuilder.Trim

Signature Trim()

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

Validate

ToolPathEditorBuilder.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.