NXOpen::CAM::TurnEngageRetractBuilder Class Reference

Represents a first plunge Builder
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::TurnEngageRetractBuilder:

Public Types
enum	AutoOptions {   AutoOptionsUserDefinedValues, AutoOptionsAutomaticValues, AutoOptionsClearWallsByAngleAndDistance, AutoOptionsWithdraw,   AutoOptionsWithdrawByDistance, AutoOptionsClearWalls, AutoOptionsClearWallsByDistance, AutoOptionsSameAsPlungeRetract }
	The auto engage retract options Created in NX6.0.0. More...
enum	DirectEngageRetractModes { DirectEngageRetractModesNone, DirectEngageRetractModesToOrFromTrimPointOnly, DirectEngageRetractModesAlways }
	the direct engage/retact mode options Created in NX10.0.2. More...
enum	ExtendMethods { ExtendMethodsDistance, ExtendMethodsToBlank }
	the extend method options Created in NX7.5.0. More...
enum	Types {   TypesAutoCircular, TypesAutoLinear, TypesDelta, TypesAngleAndDistance,   TypesRelativeLinear, TypesFromAPoint, TypesTwoCircles, TypesTwoPointTangent,   TypesSameAsEngage }
	The engage retract type Created in NX6.0.0. More...

Public Member Functions
double	Angle ()
	Returns the Angle Created in NX6.0.0. More...
NXOpen::CAM::TurnEngageRetractBuilder::AutoOptions	AutomaticOption ()
	Returns the Auto Engage(Retract) Option Created in NX6.0.0. More...
double	DeltaXc ()
	Returns the Delta XC Created in NX6.0.0. More...
double	DeltaYc ()
	Returns the Delta YC Created in NX6.0.0. More...
NXOpen::CAM::TurnEngageRetractBuilder::DirectEngageRetractModes	DirectEngageRetractMode ()
	Returns the direct engage/retract mode Created in NX10.0.2. More...
bool	DirectTrimPoint ()
	Returns the Direct engage to(retract from) trim point More...
double	Distance ()
	Returns the Distance Created in NX6.0.0. More...
NXOpen::CAM::TurnEngageRetractBuilder::Types	EngageRetractType ()
	Returns the Engage(Retract) Type Created in NX6.0.0. More...
double	ExtendDistance ()
	Returns the Extend Distance Created in NX6.0.0. More...
NXOpen::CAM::TurnEngageRetractBuilder::ExtendMethods	ExtendMethod ()
	Returns the Extend Method Created in NX7.5.0. More...
double	FirstRadius ()
	Returns the First Radius Created in NX6.0.0. More...
bool	IgnoreWorkpiece ()
	Returns the Ignore Workpiece Created in NX9.0.0. More...
NXOpen::Point *	Point ()
	Returns the point Created in NX6.0.0. More...
double	Radius ()
	Returns the Radius Created in NX6.0.0. More...
double	SafeDistance ()
	Returns the Safe Distance Created in NX6.0.0. More...
double	SecondRadius ()
	Returns the Second Radius Created in NX6.0.0. More...
void	SetAngle (double angle)
	Sets the Angle Created in NX6.0.0. More...
void	SetAutomaticOption (NXOpen::CAM::TurnEngageRetractBuilder::AutoOptions engageRetractOption)
	Sets the Auto Engage(Retract) Option Created in NX6.0.0. More...
void	SetDeltaXc (double xc)
	Sets the Delta XC Created in NX6.0.0. More...
void	SetDeltaYc (double yc)
	Sets the Delta YC Created in NX6.0.0. More...
void	SetDirectEngageRetractMode (NXOpen::CAM::TurnEngageRetractBuilder::DirectEngageRetractModes directEngageRetractMode)
	Sets the direct engage/retract mode Created in NX10.0.2. More...
void	SetDirectTrimPoint (bool directTrimPoint)
	Sets the Direct engage to(retract from) trim point More...
void	SetDistance (double distance)
	Sets the Distance Created in NX6.0.0. More...
void	SetEngageRetractType (NXOpen::CAM::TurnEngageRetractBuilder::Types engageRetractType)
	Sets the Engage(Retract) Type Created in NX6.0.0. More...
void	SetExtendDistance (double extendDistance)
	Sets the Extend Distance Created in NX6.0.0. More...
void	SetExtendMethod (NXOpen::CAM::TurnEngageRetractBuilder::ExtendMethods newValue)
	Sets the Extend Method Created in NX7.5.0. More...
void	SetFirstRadius (double firstRadius)
	Sets the First Radius Created in NX6.0.0. More...
void	SetIgnoreWorkpiece (bool ignoreWorkpiece)
	Sets the Ignore Workpiece Created in NX9.0.0. More...
void	SetPoint (NXOpen::Point *turnPoint)
	Sets the point Created in NX6.0.0. More...
void	SetRadius (double radius)
	Sets the Radius Created in NX6.0.0. More...
void	SetSafeDistance (double safeDistance)
	Sets the Safe Distance Created in NX6.0.0. More...
void	SetSecondRadius (double secondRadius)
	Sets the Second Radius Created in NX6.0.0. More...
void	SetTangentialExtension (bool tangentialExtension)
	Sets the Tangential Extension Created in NX6.0.0. More...
bool	TangentialExtension ()
	Returns the Tangential Extension Created in NX6.0.0. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a first plunge Builder
Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::TurnEngageRetractBuilder::AutoOptions

The auto engage retract options
Created in NX6.0.0.

Enumerator
AutoOptionsUserDefinedValues	User Defined Values.
AutoOptionsAutomaticValues	Automatic Values.
AutoOptionsClearWallsByAngleAndDistance	Clear Walls by Angle and Distance.
AutoOptionsWithdraw	Withdraw.
AutoOptionsWithdrawByDistance	Withdraw by Distance.
AutoOptionsClearWalls	Clear Walls.
AutoOptionsClearWallsByDistance	Clear Walls by Distance.
AutoOptionsSameAsPlungeRetract	Same as Plunge Retract.

enum NXOpen::CAM::TurnEngageRetractBuilder::DirectEngageRetractModes

the direct engage/retact mode options
Created in NX10.0.2.

Enumerator
DirectEngageRetractModesNone	Direct engage/retract mode: None.
DirectEngageRetractModesToOrFromTrimPointOnly	Direct engage/retract mode: To/from trim point only.
DirectEngageRetractModesAlways	Direct engage/retract mode: Always.

enum NXOpen::CAM::TurnEngageRetractBuilder::ExtendMethods

the extend method options
Created in NX7.5.0.

Enumerator
ExtendMethodsDistance	Extend by distance.
ExtendMethodsToBlank	Extend to blank.

enum NXOpen::CAM::TurnEngageRetractBuilder::Types

The engage retract type
Created in NX6.0.0.

Enumerator
TypesAutoCircular	Auto Circular.
TypesAutoLinear	Auto Linear.
TypesDelta	Delta.
TypesAngleAndDistance	Angle and Distance.
TypesRelativeLinear	Relative Linear.
TypesFromAPoint	From a Point.
TypesTwoCircles	Two Circles.
TypesTwoPointTangent	Two Point Tangent.
TypesSameAsEngage	Same as Engage.

Member Function Documentation

double NXOpen::CAM::TurnEngageRetractBuilder::Angle

(

)

Returns the Angle
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::TurnEngageRetractBuilder::AutoOptions NXOpen::CAM::TurnEngageRetractBuilder::AutomaticOption

(

)

Returns the Auto Engage(Retract) Option
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnEngageRetractBuilder::DeltaXc

(

)

Returns the Delta XC
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnEngageRetractBuilder::DeltaYc

(

)

Returns the Delta YC
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::TurnEngageRetractBuilder::DirectEngageRetractModes NXOpen::CAM::TurnEngageRetractBuilder::DirectEngageRetractMode

(

)

Returns the direct engage/retract mode
Created in NX10.0.2.

License requirements : None

bool NXOpen::CAM::TurnEngageRetractBuilder::DirectTrimPoint

(

)

Returns the Direct engage to(retract from) trim point

Deprecated:

Deprecated in NX10.0.2.

Use CAM::TurnEngageRetractBuilder::DirectEngageRetractMode and CAM::TurnEngageRetractBuilder::SetDirectEngageRetractMode instead.

Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnEngageRetractBuilder::Distance

(

)

Returns the Distance
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::TurnEngageRetractBuilder::Types NXOpen::CAM::TurnEngageRetractBuilder::EngageRetractType

(

)

Returns the Engage(Retract) Type
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnEngageRetractBuilder::ExtendDistance

(

)

Returns the Extend Distance
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::TurnEngageRetractBuilder::ExtendMethods NXOpen::CAM::TurnEngageRetractBuilder::ExtendMethod

(

)

Returns the Extend Method
Created in NX7.5.0.

License requirements : None

double NXOpen::CAM::TurnEngageRetractBuilder::FirstRadius

(

)

Returns the First Radius
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::TurnEngageRetractBuilder::IgnoreWorkpiece

(

)

Returns the Ignore Workpiece
Created in NX9.0.0.

License requirements : None

NXOpen::Point* NXOpen::CAM::TurnEngageRetractBuilder::Point

(

)

Returns the point
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnEngageRetractBuilder::Radius

(

)

Returns the Radius
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnEngageRetractBuilder::SafeDistance

(

)

Returns the Safe Distance
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnEngageRetractBuilder::SecondRadius

(

)

Returns the Second Radius
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::TurnEngageRetractBuilder::SetAngle

(

double

angle

)

Sets the Angle
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

angle

the Angle value

void NXOpen::CAM::TurnEngageRetractBuilder::SetAutomaticOption

(

NXOpen::CAM::TurnEngageRetractBuilder::AutoOptions

engageRetractOption

)

Sets the Auto Engage(Retract) Option
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

engageRetractOption

the Auto Engage(Retract) Option value

void NXOpen::CAM::TurnEngageRetractBuilder::SetDeltaXc

(

double

xc

)

Sets the Delta XC
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

xc	the Delta XC value

void NXOpen::CAM::TurnEngageRetractBuilder::SetDeltaYc

(

double

yc

)

Sets the Delta YC
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

yc	the Delta YC value

void NXOpen::CAM::TurnEngageRetractBuilder::SetDirectEngageRetractMode

(

NXOpen::CAM::TurnEngageRetractBuilder::DirectEngageRetractModes

directEngageRetractMode

)

Sets the direct engage/retract mode
Created in NX10.0.2.

License requirements : cam_base ("CAM BASE")

Parameters

directEngageRetractMode

direct engage/retract mode value

void NXOpen::CAM::TurnEngageRetractBuilder::SetDirectTrimPoint

(

bool

directTrimPoint

)

Sets the Direct engage to(retract from) trim point

Deprecated:

Deprecated in NX10.0.2.

Use CAM::TurnEngageRetractBuilder::DirectEngageRetractMode and CAM::TurnEngageRetractBuilder::SetDirectEngageRetractMode instead.

Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

directTrimPoint

the Direct engage to(retract from) trim point

void NXOpen::CAM::TurnEngageRetractBuilder::SetDistance

(

double

distance

)

Sets the Distance
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

distance

the Distance value

void NXOpen::CAM::TurnEngageRetractBuilder::SetEngageRetractType

(

NXOpen::CAM::TurnEngageRetractBuilder::Types

engageRetractType

)

Sets the Engage(Retract) Type
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

engageRetractType

the Engage(Retract) Type value

void NXOpen::CAM::TurnEngageRetractBuilder::SetExtendDistance

(

double

extendDistance

)

Sets the Extend Distance
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

extendDistance

the Extend Distance value

void NXOpen::CAM::TurnEngageRetractBuilder::SetExtendMethod

(

NXOpen::CAM::TurnEngageRetractBuilder::ExtendMethods

newValue

)

Sets the Extend Method
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue

the Extend Method value

void NXOpen::CAM::TurnEngageRetractBuilder::SetFirstRadius

(

double

firstRadius

)

Sets the First Radius
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

firstRadius

the First Radius value

void NXOpen::CAM::TurnEngageRetractBuilder::SetIgnoreWorkpiece

(

bool

ignoreWorkpiece

)

Sets the Ignore Workpiece
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

ignoreWorkpiece

the Ignore Workpiece

void NXOpen::CAM::TurnEngageRetractBuilder::SetPoint

(

NXOpen::Point *

turnPoint

)

Sets the point
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

turnPoint

the point value

void NXOpen::CAM::TurnEngageRetractBuilder::SetRadius

(

double

radius

)

Sets the Radius
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

radius

the Radius value

void NXOpen::CAM::TurnEngageRetractBuilder::SetSafeDistance

(

double

safeDistance

)

Sets the Safe Distance
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

safeDistance

the Safe Distance value

void NXOpen::CAM::TurnEngageRetractBuilder::SetSecondRadius

(

double

secondRadius

)

Sets the Second Radius
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

secondRadius

the Second Radius value

void NXOpen::CAM::TurnEngageRetractBuilder::SetTangentialExtension

(

bool

tangentialExtension

)

Sets the Tangential Extension
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

tangentialExtension

the Tangential Extension

bool NXOpen::CAM::TurnEngageRetractBuilder::TangentialExtension

(

)

Returns the Tangential Extension
Created in NX6.0.0.

License requirements : None

---

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

• CAM_TurnEngageRetractBuilder.hxx