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

Inheritance diagram for NXOpen::CAM::NcmPlanarEngRetBuilder:

Public Types
enum	EngRetTypes { EngRetTypesSameAsDefault, EngRetTypesSameAsClosed, EngRetTypesSameAsEngage, EngRetTypesHelical, EngRetTypesRampOnShape, EngRetTypesZigzagRamp, EngRetTypesLinear, EngRetTypesArc, EngRetTypesArcParallelToToolAxis, EngRetTypesArcNormalToToolAxis, EngRetTypesArcNormalToPart, EngRetTypesHighSpeedArc, EngRetTypesPoints, EngRetTypesPlungeLift, EngRetTypesAlongVector, EngRetTypesAngAngPlane, EngRetTypesVectorPlane, EngRetTypesNone, EngRetTypesLinearRelativeCut, EngRetTypesSmooth }
	Available types for engage/retract in Planar Milling. More...

enum	IfEngageDoesNotFitTypes { IfEngageDoesNotFitTypesPlunge, IfEngageDoesNotFitTypesSkip }
	Available types to handle area if engage does not fit. More...

enum	MeasureHeightFrom { MeasureHeightFromCurrentLevel, MeasureHeightFromPreviousLevel, MeasureHeightFromPlane }
	Available types for the Height From which engage helical/ramp/plunge is measured in Planar Milling. More...

enum	MinClearanceTypes { MinClearanceTypesNone, MinClearanceTypesExtendAndTrim, MinClearanceTypesExtendOnly, MinClearanceTypesSameAsOpenEngage, MinClearanceTypesSameAsRetract }
	Available types for the Minimum Clearance. More...

Public Member Functions
double	ArcAngle ()
	Returns the engage/retract arc angle Created in NX5.0.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	DiameterBuilder ()
	Returns the engage/retract diameter builder Created in NX5.0.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	EffectDistBuilder ()
	Returns the engage/retract effect dist builder (inheritable tool dep) Created in NX5.0.0. More...

NXOpen::CAM::NcmPlanarEngRetBuilder::EngRetTypes	EngRetType ()
	Returns the type of engage/retract Created in NX5.0.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	ExtendAfterArc ()
	Returns the linear extension after arc engage/retract Created in NX9.0.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	ExtendBeforeArc ()
	Returns the linear extension before arc engage/retract Created in NX9.0.0. More...

void	GetPoints (std::vector< NXOpen::Point * > &points)
	Gets engage/retract points Created in NX5.0.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	HeightBuilder ()
	Returns the engage/retract height builder Created in NX5.0.0. More...

NXOpen::CAM::NcmPlanarEngRetBuilder::MeasureHeightFrom	HeightFrom ()
	Returns the height from which engage helical/ramp/plunge is measured Created in NX7.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	HelicalRampAngleBuilder ()
	Returns the helical ramp angle builder of Helical and Ramp on Shape type of Engages Created in NX8.0.0. More...

NXOpen::CAM::NcmPlanarEngRetBuilder::IfEngageDoesNotFitTypes	IfEngageDoesNotFit ()
	Returns the type to handle area if engage does not fit Created in NX12.0.0. More...

bool	IgnoreBlankOnTrimSide ()
	Returns the flag whether to ignore blank outside trim boundaries Created in NX8.5.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	LengthBuilder ()
	Returns the engage/retract length builder Created in NX5.0.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	MaxWidthBuilder ()
	Returns the engage/retract max width builder (inheritable tool dep) Created in NX5.0.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	MinClearanceBuilder ()
	Returns the engage/retract min clearance builder Created in NX5.0.0. More...

NXOpen::CAM::NcmPlanarEngRetBuilder::MinClearanceTypes	MinimumClearance ()
	Returns the minimum clearance Created in NX10.0.3. More...

NXOpen::CAM::InheritableToolDepBuilder *	MinRampLengthBuilder ()
	Returns the engage/retract minimum ramp length builder (inheritable tool dep) Created in NX5.0.0. More...

NXOpen::SmartObject *	Plane ()
	Returns the engage/retract plane,plane entity type covers Xform and Plane Created in NX5.0.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	RadiusBuilder ()
	Returns the engage/retract radius builder Created in NX5.0.0. More...

double	RampAngle ()
	Returns the engage/retract ramp angle Created in NX5.0.0. More...

void	SetArcAngle (double newValue)
	Sets the engage/retract arc angle Created in NX5.0.0. More...

void	SetEngRetType (NXOpen::CAM::NcmPlanarEngRetBuilder::EngRetTypes newValue)
	Sets the type of engage/retract Created in NX5.0.0. More...

void	SetHeightFrom (NXOpen::CAM::NcmPlanarEngRetBuilder::MeasureHeightFrom newValue)
	Sets the height from which engage helical/ramp/plunge is measured Created in NX7.0.0. More...

void	SetIfEngageDoesNotFit (NXOpen::CAM::NcmPlanarEngRetBuilder::IfEngageDoesNotFitTypes newValue)
	Sets the type to handle area if engage does not fit Created in NX12.0.0. More...

void	SetIgnoreBlankOnTrimSide (bool newValue)
	Sets the flag whether to ignore blank outside trim boundaries Created in NX8.5.0. More...

void	SetMinimumClearance (NXOpen::CAM::NcmPlanarEngRetBuilder::MinClearanceTypes newValue)
	Sets the minimum clearance Created in NX10.0.3. More...

void	SetPlane (NXOpen::SmartObject *plane)
	Sets the engage/retract plane,plane entity type covers Xform and Plane Created in NX5.0.0. More...

void	SetPoints (const std::vector< NXOpen::Point * > &points)
	Sets engage/retract points Created in NX5.0.0. More...

void	SetRampAngle (double newValue)
	Sets the engage/retract ramp angle Created in NX5.0.0. More...

void	SetStartAtArcCenter (bool newValue)
	Sets the engage/retract start at arc center Created in NX5.0.0. More...

void	SetSwingAngle (double newValue)
	Sets the engage/retract swing angle Created in NX5.0.0. More...

void	SetTrim (bool newValue)
	Sets the engage/retract trim More...

void	SetUseEffectDist (bool newValue)
	Sets the engage/retract use effective distance Created in NX5.0.0. More...

void	SetUseMaxWidth (bool newValue)
	Sets the engage/retract use max width Created in NX5.0.0. More...

void	SetVector (NXOpen::SmartObject *vector)
	Sets the engage/retract vector Created in NX5.0.0. More...

bool	StartAtArcCenter ()
	Returns the engage/retract start at arc center Created in NX5.0.0. More...

double	SwingAngle ()
	Returns the engage/retract swing angle Created in NX5.0.0. More...

bool	Trim ()
	Returns the engage/retract trim More...

bool	UseEffectDist ()
	Returns the engage/retract use effective distance Created in NX5.0.0. More...

bool	UseMaxWidth ()
	Returns the engage/retract use max width Created in NX5.0.0. More...

NXOpen::SmartObject *	Vector ()
	Returns the engage/retract vector Created in NX5.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 builder for an inheritable double value in of a CAM.CAMObject
Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::NcmPlanarEngRetBuilder::EngRetTypes

Available types for engage/retract in Planar Milling.

Enumerator
EngRetTypesSameAsDefault	Same as Default (Inherit)
EngRetTypesSameAsClosed	Same as Closed Engage (from open)
EngRetTypesSameAsEngage	Same as (Open) Engage (from retract)
EngRetTypesHelical	Helical Ramp.
EngRetTypesRampOnShape	Ramp on shape.
EngRetTypesZigzagRamp	ZigZag Ramp.
EngRetTypesLinear	Linear.
EngRetTypesArc	Arc.
EngRetTypesArcParallelToToolAxis	Arc - Parallel to Tool Axis.
EngRetTypesArcNormalToToolAxis	Arc - Normal to Tool Axis.
EngRetTypesArcNormalToPart	Arc - Normal to Part.
EngRetTypesHighSpeedArc	High Speed Arcs.
EngRetTypesPoints	to-from points
EngRetTypesPlungeLift	Plunge Engage/Lift Retract.
EngRetTypesAlongVector	Vector Dist.
EngRetTypesAngAngPlane	Linear to plane.
EngRetTypesVectorPlane	Vector to plane.
EngRetTypesNone	None.
EngRetTypesLinearRelativeCut	Linear relative to cut direction.
EngRetTypesSmooth	Smooth.

enum NXOpen::CAM::NcmPlanarEngRetBuilder::IfEngageDoesNotFitTypes

Available types to handle area if engage does not fit.

Enumerator
IfEngageDoesNotFitTypesPlunge	Plunge.
IfEngageDoesNotFitTypesSkip	Skip.

enum NXOpen::CAM::NcmPlanarEngRetBuilder::MeasureHeightFrom

Available types for the Height From which engage helical/ramp/plunge is measured in Planar Milling.

Enumerator
MeasureHeightFromCurrentLevel	Measure from current level.
MeasureHeightFromPreviousLevel	Measure from previous level.
MeasureHeightFromPlane	Measure from user-defined plane.

enum NXOpen::CAM::NcmPlanarEngRetBuilder::MinClearanceTypes

Available types for the Minimum Clearance.

Enumerator
MinClearanceTypesNone	None.
MinClearanceTypesExtendAndTrim	Extend and trim.
MinClearanceTypesExtendOnly	Extend only.
MinClearanceTypesSameAsOpenEngage	Same as open engage.
MinClearanceTypesSameAsRetract	Same as retract.

Member Function Documentation

double NXOpen::CAM::NcmPlanarEngRetBuilder::ArcAngle ( )

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

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::DiameterBuilder ( )

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

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::EffectDistBuilder ( )

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

License requirements : None

NXOpen::CAM::NcmPlanarEngRetBuilder::EngRetTypes NXOpen::CAM::NcmPlanarEngRetBuilder::EngRetType ( )

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

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::ExtendAfterArc ( )

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

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::ExtendBeforeArc ( )

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

License requirements : None

void NXOpen::CAM::NcmPlanarEngRetBuilder::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::NcmPlanarEngRetBuilder::HeightBuilder ( )

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

License requirements : None

NXOpen::CAM::NcmPlanarEngRetBuilder::MeasureHeightFrom NXOpen::CAM::NcmPlanarEngRetBuilder::HeightFrom ( )

Returns the height from which engage helical/ramp/plunge is measured
Created in NX7.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::HelicalRampAngleBuilder ( )

Returns the helical ramp angle builder of Helical and Ramp on Shape type of Engages
Created in NX8.0.0.

License requirements : None

NXOpen::CAM::NcmPlanarEngRetBuilder::IfEngageDoesNotFitTypes NXOpen::CAM::NcmPlanarEngRetBuilder::IfEngageDoesNotFit ( )

Returns the type to handle area if engage does not fit
Created in NX12.0.0.

License requirements : None

bool NXOpen::CAM::NcmPlanarEngRetBuilder::IgnoreBlankOnTrimSide ( )

Returns the flag whether to ignore blank outside trim boundaries
Created in NX8.5.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::LengthBuilder ( )

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

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::MaxWidthBuilder ( )

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

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::MinClearanceBuilder ( )

Returns the engage/retract min clearance builder
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::NcmPlanarEngRetBuilder::MinClearanceTypes NXOpen::CAM::NcmPlanarEngRetBuilder::MinimumClearance ( )

Returns the minimum clearance
Created in NX10.0.3.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::MinRampLengthBuilder ( )

Returns the engage/retract minimum ramp length builder (inheritable tool dep)
Created in NX5.0.0.

License requirements : None

NXOpen::SmartObject* NXOpen::CAM::NcmPlanarEngRetBuilder::Plane ( )

Returns the engage/retract plane,plane entity type covers Xform and Plane
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmPlanarEngRetBuilder::RadiusBuilder ( )

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

License requirements : None

double NXOpen::CAM::NcmPlanarEngRetBuilder::RampAngle ( )

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

License requirements : None

void NXOpen::CAM::NcmPlanarEngRetBuilder::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::NcmPlanarEngRetBuilder::SetEngRetType ( NXOpen::CAM::NcmPlanarEngRetBuilder::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::NcmPlanarEngRetBuilder::SetHeightFrom ( NXOpen::CAM::NcmPlanarEngRetBuilder::MeasureHeightFrom newValue )

Sets the height from which engage helical/ramp/plunge is measured
Created in NX7.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue the new value

void NXOpen::CAM::NcmPlanarEngRetBuilder::SetIfEngageDoesNotFit ( NXOpen::CAM::NcmPlanarEngRetBuilder::IfEngageDoesNotFitTypes newValue )

Sets the type to handle area if engage does not fit
Created in NX12.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue newvalue

void NXOpen::CAM::NcmPlanarEngRetBuilder::SetIgnoreBlankOnTrimSide ( bool newValue )

Sets the flag whether to ignore blank outside trim boundaries
Created in NX8.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue newvalue

void NXOpen::CAM::NcmPlanarEngRetBuilder::SetMinimumClearance ( NXOpen::CAM::NcmPlanarEngRetBuilder::MinClearanceTypes newValue )

Sets the minimum clearance
Created in NX10.0.3.

License requirements : cam_base ("CAM BASE")

Parameters

newValue the new value

void NXOpen::CAM::NcmPlanarEngRetBuilder::SetPlane ( NXOpen::SmartObject * plane )

Sets the engage/retract plane,plane entity type covers Xform and Plane
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

plane the engage/retract plane

void NXOpen::CAM::NcmPlanarEngRetBuilder::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::NcmPlanarEngRetBuilder::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::NcmPlanarEngRetBuilder::SetStartAtArcCenter ( bool newValue )

Sets the engage/retract start at arc center
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue the start at arc center

void NXOpen::CAM::NcmPlanarEngRetBuilder::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::NcmPlanarEngRetBuilder::SetTrim ( bool newValue )

Sets the engage/retract trim

Deprecated:: Deprecated in NX10.0.3.

Use NXOpen::CAM::NcmPlanarEngRetBuilder::MinimumClearance instead.

Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue newvalue

void NXOpen::CAM::NcmPlanarEngRetBuilder::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::NcmPlanarEngRetBuilder::SetUseMaxWidth ( bool newValue )

Sets the engage/retract use max width
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

newValue newvalue

void NXOpen::CAM::NcmPlanarEngRetBuilder::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

bool NXOpen::CAM::NcmPlanarEngRetBuilder::StartAtArcCenter ( )

Returns the engage/retract start at arc center
Created in NX5.0.0.

License requirements : None

double NXOpen::CAM::NcmPlanarEngRetBuilder::SwingAngle ( )

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

License requirements : None

bool NXOpen::CAM::NcmPlanarEngRetBuilder::Trim ( )

Returns the engage/retract trim

Deprecated:: Deprecated in NX10.0.3.

Use NXOpen::CAM::NcmPlanarEngRetBuilder::MinimumClearance instead.

Created in NX5.0.0.

License requirements : None

bool NXOpen::CAM::NcmPlanarEngRetBuilder::UseEffectDist ( )

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

License requirements : None

bool NXOpen::CAM::NcmPlanarEngRetBuilder::UseMaxWidth ( )

Returns the engage/retract use max width
Created in NX5.0.0.

License requirements : None

NXOpen::SmartObject* NXOpen::CAM::NcmPlanarEngRetBuilder::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_NcmPlanarEngRetBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation