NXOpen::CAM::NcmScEngRetBuilder Class Reference

Represents a builder for an inheritable double value in of a CAM.CAMObject
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::NcmScEngRetBuilder:

Public Types
enum	EngRetTypes {   EngRetTypesSameAsDefault, EngRetTypesSameAsEngage, EngRetTypesLinear, EngRetTypesLinearAlongVector,   EngRetTypesLinearNormalToPart, EngRetTypesArcParallelToToolAxis, EngRetTypesArcNormalToToolAxis, EngRetTypesArcTangentToApproach,   EngRetTypesArcNormalToPart, EngRetTypesHelicalClw, EngRetTypesHelicalCclw, EngRetTypesPlungeLift,   EngRetTypesNone, EngRetTypesPoints, EngRetTypesSmooth }
	Available types for engage/retract in surface contouring. More...
enum	MeasureFromTypes { MeasureFromTypesDistance, MeasureFromTypesPlane }
	Available types for the Height or Length from which the linear/helical/plunge engage or linear/plunge retract is measured in Surface Contour Milling Created in NX7.5.0. More...

Public Member Functions
double	ArcAngle ()
	Returns the engage/retract arc angle Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilder *	DiameterBuilder ()
	Returns the engage/retract diameter builder Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilder *	EffectDistBuilder ()
	Returns the engage/retract effect dist builder (inheritable tool dep) Created in NX5.0.0.
NXOpen::CAM::NcmScEngRetBuilder::EngRetTypes	EngRetType ()
	Returns the type of engage/retract Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilder *	ExtendAfterArc ()
	Returns the linear extension after arc engage/retract Created in NX9.0.0.
NXOpen::CAM::InheritableToolDepBuilder *	ExtendBeforeArc ()
	Returns the linear extension before arc engage/retract Created in NX9.0.0.
void	GetPoints (std::vector< NXOpen::Point * > &points)
	Gets engage/retract points Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilder *	HeightBuilder ()
	Returns the engage/retract height builder Created in NX5.0.0.
double	HelicalRampAngle ()
	Returns the engage/retract ramp angle for helical moves
NXOpen::CAM::InheritableDoubleBuilder *	HelicalRampAngleBuilder ()
	Returns the helical ramp angle builder Created in NX8.0.0.
NXOpen::CAM::InheritableToolDepBuilder *	LengthBuilder ()
	Returns the engage/retract length builder Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilder *	LinearExtensionBuilder ()
	Returns the engage/retract linear extension builder
NXOpen::CAM::NcmScEngRetBuilder::MeasureFromTypes	MeasureFrom ()
	Returns the height or length from which engage linear/helical/plunge is measured Created in NX7.5.0.
NXOpen::Plane *	Plane ()
	Returns the engage/retract plane Created in NX7.5.0.
NXOpen::CAM::InheritableToolDepBuilder *	RadiusBuilder ()
	Returns the engage/retract radius builder Created in NX5.0.0.
double	RampAngle ()
	Returns the engage/retract ramp angle Created in NX5.0.0.
void	SetArcAngle (double newValue)
	Sets the engage/retract arc angle Created in NX5.0.0.
void	SetEngRetType (NXOpen::CAM::NcmScEngRetBuilder::EngRetTypes newValue)
	Sets the type of engage/retract Created in NX5.0.0.
void	SetHelicalRampAngle (double newValue)
	Sets the engage/retract ramp angle for helical moves
void	SetMeasureFrom (NXOpen::CAM::NcmScEngRetBuilder::MeasureFromTypes newValue)
	Sets the height or length from which engage linear/helical/plunge is measured Created in NX7.5.0.
void	SetPlane (NXOpen::Plane *plane)
	Sets the engage/retract plane Created in NX7.5.0.
void	SetPoints (const std::vector< NXOpen::Point * > &points)
	Sets engage/retract points Created in NX5.0.0.
void	SetRampAngle (double newValue)
	Sets the engage/retract ramp angle Created in NX5.0.0.
void	SetSwingAngle (double newValue)
	Sets the engage/retract swing angle Created in NX5.0.0.
void	SetUseEffectDist (bool newValue)
	Sets the engage/retract use effective distance Created in NX5.0.0.
void	SetVector (NXOpen::SmartObject *vector)
	Sets the engage/retract vector Created in NX5.0.0.
double	SwingAngle ()
	Returns the engage/retract swing angle Created in NX5.0.0.
bool	UseEffectDist ()
	Returns the engage/retract use effective distance Created in NX5.0.0.
NXOpen::SmartObject *	Vector ()
	Returns the engage/retract vector Created in NX5.0.0.
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 builder for an inheritable double value in of a CAM.CAMObject
Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::NcmScEngRetBuilder::EngRetTypes

Available types for engage/retract in surface contouring.

Enumerator:

EngRetTypesSameAsDefault	Same as Default.
EngRetTypesSameAsEngage	Same as Engage (only for retract)
EngRetTypesLinear	Linear.
EngRetTypesLinearAlongVector	Linear - Along Vector.
EngRetTypesLinearNormalToPart	Linear - Normal to Part.
EngRetTypesArcParallelToToolAxis	Arc - Parallel to Tool Axis.
EngRetTypesArcNormalToToolAxis	Arc - Normal to Tool Axis.
EngRetTypesArcTangentToApproach	Arc - Tangent to Approach.
EngRetTypesArcNormalToPart	Arc - Normal to Part.
EngRetTypesHelicalClw	Helical Clockwise.
EngRetTypesHelicalCclw	Helical Counter Clockwise.
EngRetTypesPlungeLift	Plunge Engage/Lift Retract.
EngRetTypesNone	None.
EngRetTypesPoints	to-from point
EngRetTypesSmooth	Smooth connections.

enum NXOpen::CAM::NcmScEngRetBuilder::MeasureFromTypes

Available types for the Height or Length from which the linear/helical/plunge engage or linear/plunge retract is measured in Surface Contour Milling
Created in NX7.5.0.

Enumerator:

MeasureFromTypesDistance	Measure from distance.
MeasureFromTypesPlane	Measure from user-defined plane.

Member Function Documentation

double NXOpen::CAM::NcmScEngRetBuilder::ArcAngle

(

)

Returns the engage/retract arc angle
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScEngRetBuilder::DiameterBuilder

(

)

Returns the engage/retract diameter builder
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScEngRetBuilder::EffectDistBuilder

(

)

Returns the engage/retract effect dist builder (inheritable tool dep)
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::NcmScEngRetBuilder::EngRetTypes NXOpen::CAM::NcmScEngRetBuilder::EngRetType

(

)

Returns the type of engage/retract
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScEngRetBuilder::ExtendAfterArc

(

)

Returns the linear extension after arc engage/retract
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScEngRetBuilder::ExtendBeforeArc

(

)

Returns the linear extension before arc engage/retract
Created in NX9.0.0.

License requirements : None

void NXOpen::CAM::NcmScEngRetBuilder::GetPoints

(

std::vector< NXOpen::Point * > &

points

)

Gets engage/retract points
Created in NX5.0.0.

License requirements : None

Parameters

points

Array of points

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScEngRetBuilder::HeightBuilder

(

)

Returns the engage/retract height builder
Created in NX5.0.0.

License requirements : None

double NXOpen::CAM::NcmScEngRetBuilder::HelicalRampAngle

(

)

Returns the engage/retract ramp angle for helical moves

Deprecated:

Deprecated in NX8.0.0.

Use CAM::NcmScEngRetBuilder::HelicalRampAngleBuilder instead.

Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::NcmScEngRetBuilder::HelicalRampAngleBuilder

(

)

Returns the helical ramp angle builder
Created in NX8.0.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScEngRetBuilder::LengthBuilder

(

)

Returns the engage/retract length builder
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScEngRetBuilder::LinearExtensionBuilder

(

)

Returns the engage/retract linear extension builder

Deprecated:

Deprecated in NX9.0.0.

For engage, use CAM::NcmScEngRetBuilder::ExtendBeforeArc . For retract, use CAM::NcmScEngRetBuilder::ExtendAfterArc .

Created in NX5.0.0.

License requirements : None

NXOpen::CAM::NcmScEngRetBuilder::MeasureFromTypes NXOpen::CAM::NcmScEngRetBuilder::MeasureFrom

(

)

Returns the height or length from which engage linear/helical/plunge is measured
Created in NX7.5.0.

License requirements : None

NXOpen::Plane* NXOpen::CAM::NcmScEngRetBuilder::Plane

(

)

Returns the engage/retract plane
Created in NX7.5.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScEngRetBuilder::RadiusBuilder

(

)

Returns the engage/retract radius builder
Created in NX5.0.0.

License requirements : None

double NXOpen::CAM::NcmScEngRetBuilder::RampAngle

(

)

Returns the engage/retract ramp angle
Created in NX5.0.0.

License requirements : None

void NXOpen::CAM::NcmScEngRetBuilder::SetArcAngle

(

double

newValue

)

Sets the engage/retract arc angle
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue

the arc angle

void NXOpen::CAM::NcmScEngRetBuilder::SetEngRetType

(

NXOpen::CAM::NcmScEngRetBuilder::EngRetTypes

newValue

)

Sets the type of engage/retract
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue

the new value

void NXOpen::CAM::NcmScEngRetBuilder::SetHelicalRampAngle

(

double

newValue

)

Sets the engage/retract ramp angle for helical moves

Deprecated:

Deprecated in NX8.0.0.

Use CAM::NcmScEngRetBuilder::HelicalRampAngleBuilder instead.

Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue

the ramp angle

void NXOpen::CAM::NcmScEngRetBuilder::SetMeasureFrom

(

NXOpen::CAM::NcmScEngRetBuilder::MeasureFromTypes

newValue

)

Sets the height or length from which engage linear/helical/plunge is measured
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue

the new value

void NXOpen::CAM::NcmScEngRetBuilder::SetPlane

(

NXOpen::Plane *

plane

)

Sets the engage/retract plane
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

plane

the engage/retract plane

void NXOpen::CAM::NcmScEngRetBuilder::SetPoints

(

const std::vector< NXOpen::Point * > &

points

)

Sets engage/retract points
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

points

Array of points

void NXOpen::CAM::NcmScEngRetBuilder::SetRampAngle

(

double

newValue

)

Sets the engage/retract ramp angle
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue

the ramp angle

void NXOpen::CAM::NcmScEngRetBuilder::SetSwingAngle

(

double

newValue

)

Sets the engage/retract swing angle
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue

the swing angle

void NXOpen::CAM::NcmScEngRetBuilder::SetUseEffectDist

(

bool

newValue

)

Sets the engage/retract use effective distance
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue

newvalue

void NXOpen::CAM::NcmScEngRetBuilder::SetVector

(

NXOpen::SmartObject *

vector

)

Sets the engage/retract vector
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

vector

the engage/retract vector

double NXOpen::CAM::NcmScEngRetBuilder::SwingAngle

(

)

Returns the engage/retract swing angle
Created in NX5.0.0.

License requirements : None

bool NXOpen::CAM::NcmScEngRetBuilder::UseEffectDist

(

)

Returns the engage/retract use effective distance
Created in NX5.0.0.

License requirements : None

NXOpen::SmartObject* NXOpen::CAM::NcmScEngRetBuilder::Vector

(

)

Returns the engage/retract vector
Created in NX5.0.0.

License requirements : None

---

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

• CAM_NcmScEngRetBuilder.hxx