TurnEngageRetractBuilder Class

class NXOpen.CAM.TurnEngageRetractBuilder

Bases: NXOpen.TaggedObject

Represents a first plunge Builder

New in version NX6.0.0.

Properties

Property	Description
Angle	Returns or sets the Angle
AutomaticOption	Returns or sets the Auto Engage(Retract) Option
DeltaXc	Returns or sets the Delta XC
DeltaYc	Returns or sets the Delta YC
DirectEngageRetractMode	Returns or sets the direct engage/retract mode
DirectTrimPoint	Returns or sets the Direct engage to(retract from) trim point
Distance	Returns or sets the Distance
EngageRetractType	Returns or sets the Engage(Retract) Type
ExtendDistance	Returns or sets the Extend Distance
ExtendMethod	Returns or sets the Extend Method
FirstRadius	Returns or sets the First Radius
IgnoreWorkpiece	Returns or sets the Ignore Workpiece
Point	Returns or sets the point
Radius	Returns or sets the Radius
SafeDistance	Returns or sets the Safe Distance
SecondRadius	Returns or sets the Second Radius
Tag	Returns the Tag for this object.
TangentialExtension	Returns or sets the Tangential Extension

Methods

Enumerations

TurnEngageRetractBuilderAutoOptions Enumeration	The auto engage retract options
TurnEngageRetractBuilderDirectEngageRetractModes Enumeration	the direct engage/retact mode options
TurnEngageRetractBuilderExtendMethods Enumeration	the extend method options
TurnEngageRetractBuilderTypes Enumeration	The engage retract type

Property Detail

Angle

TurnEngageRetractBuilder.Angle

Returns or sets the Angle

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

Getter Method

Signature Angle

Returns:the Angle value Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Angle

Parameters:angle (float) – the Angle value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

AutomaticOption

TurnEngageRetractBuilder.AutomaticOption

Returns or sets the Auto Engage(Retract) Option

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

Getter Method

Signature AutomaticOption

Returns:the Auto Engage(Retract) Option value Return type:NXOpen.CAM.TurnEngageRetractBuilderAutoOptions

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature AutomaticOption

Parameters:engageRetractOption (NXOpen.CAM.TurnEngageRetractBuilderAutoOptions) – the Auto Engage(Retract) Option value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

DeltaXc

TurnEngageRetractBuilder.DeltaXc

Returns or sets the Delta XC

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

Getter Method

Signature DeltaXc

Returns:the Delta XC value Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DeltaXc

Parameters:xc (float) – the Delta XC value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

DeltaYc

TurnEngageRetractBuilder.DeltaYc

Returns or sets the Delta YC

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

Getter Method

Signature DeltaYc

Returns:the Delta YC value Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DeltaYc

Parameters:yc (float) – the Delta YC value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

DirectEngageRetractMode

TurnEngageRetractBuilder.DirectEngageRetractMode

Returns or sets the direct engage/retract mode

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

Getter Method

Signature DirectEngageRetractMode

Returns:direct engage/retract mode value Return type:NXOpen.CAM.TurnEngageRetractBuilderDirectEngageRetractModes

New in version NX10.0.2.

License requirements: None.

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

Setter Method

Signature DirectEngageRetractMode

Parameters:directEngageRetractMode (NXOpen.CAM.TurnEngageRetractBuilderDirectEngageRetractModes) – direct engage/retract mode value

New in version NX10.0.2.

License requirements: cam_base (“CAM BASE”)

DirectTrimPoint

TurnEngageRetractBuilder.DirectTrimPoint

Returns or sets the Direct engage to(retract from) trim point

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

Getter Method

Signature DirectTrimPoint

Returns:the Direct engage to(retract from) trim point Return type:bool

New in version NX6.0.0.

Deprecated since version NX10.0.2: Use CAM.TurnEngageRetractBuilder.DirectEngageRetractMode`() instead.

License requirements: None.

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

Setter Method

Signature DirectTrimPoint

Parameters:directTrimPoint (bool) – the Direct engage to(retract from) trim point

New in version NX6.0.0.

Deprecated since version NX10.0.2: Use CAM.TurnEngageRetractBuilder.DirectEngageRetractMode`() instead.

License requirements: cam_base (“CAM BASE”)

Distance

TurnEngageRetractBuilder.Distance

Returns or sets the Distance

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

Getter Method

Signature Distance

Returns:the Distance value Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Distance

Parameters:distance (float) – the Distance value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

EngageRetractType

TurnEngageRetractBuilder.EngageRetractType

Returns or sets the Engage(Retract) Type

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

Getter Method

Signature EngageRetractType

Returns:the Engage(Retract) Type value Return type:NXOpen.CAM.TurnEngageRetractBuilderTypes

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature EngageRetractType

Parameters:engageRetractType (NXOpen.CAM.TurnEngageRetractBuilderTypes) – the Engage(Retract) Type value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

ExtendDistance

TurnEngageRetractBuilder.ExtendDistance

Returns or sets the Extend Distance

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

Getter Method

Signature ExtendDistance

Returns:the Extend Distance value Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ExtendDistance

Parameters:extendDistance (float) – the Extend Distance value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

ExtendMethod

TurnEngageRetractBuilder.ExtendMethod

Returns or sets the Extend Method

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

Getter Method

Signature ExtendMethod

Returns:the Extend Method value Return type:NXOpen.CAM.TurnEngageRetractBuilderExtendMethods

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ExtendMethod

Parameters:newValue (NXOpen.CAM.TurnEngageRetractBuilderExtendMethods) – the Extend Method value

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

FirstRadius

TurnEngageRetractBuilder.FirstRadius

Returns or sets the First Radius

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

Getter Method

Signature FirstRadius

Returns:the First Radius value Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature FirstRadius

Parameters:firstRadius (float) – the First Radius value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

IgnoreWorkpiece

TurnEngageRetractBuilder.IgnoreWorkpiece

Returns or sets the Ignore Workpiece

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

Getter Method

Signature IgnoreWorkpiece

Returns:the Ignore Workpiece Return type:bool

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature IgnoreWorkpiece

Parameters:ignoreWorkpiece (bool) – the Ignore Workpiece

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

Point

TurnEngageRetractBuilder.Point

Returns or sets the point

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

Getter Method

Signature Point

Returns:the point value Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Point

Parameters:turnPoint (NXOpen.Point) – the point value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

Radius

TurnEngageRetractBuilder.Radius

Returns or sets the Radius

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

Getter Method

Signature Radius

Returns:the Radius value Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Radius

Parameters:radius (float) – the Radius value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

SafeDistance

TurnEngageRetractBuilder.SafeDistance

Returns or sets the Safe Distance

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

Getter Method

Signature SafeDistance

Returns:the Safe Distance value Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature SafeDistance

Parameters:safeDistance (float) – the Safe Distance value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

SecondRadius

TurnEngageRetractBuilder.SecondRadius

Returns or sets the Second Radius

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

Getter Method

Signature SecondRadius

Returns:the Second Radius value Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature SecondRadius

Parameters:secondRadius (float) – the Second Radius value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

TangentialExtension

TurnEngageRetractBuilder.TangentialExtension

Returns or sets the Tangential Extension

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

Getter Method

Signature TangentialExtension

Returns:the Tangential Extension Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature TangentialExtension

Parameters:tangentialExtension (bool) – the Tangential Extension

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)