Represents a builder for an inheritable double value in of a CAM. More...

Inheritance diagram for NXOpen.CAM.NcmScEngRetBuilder:

Public Types
enum	EngRetTypes { SameAsDefault, SameAsEngage, Linear, LinearAlongVector, LinearNormalToPart, ArcParallelToToolAxis, ArcNormalToToolAxis, ArcTangentToApproach, ArcNormalToPart, HelicalClw, HelicalCclw, PlungeLift, None, Points, Smooth }
	Available types for engage/retract in surface contouring More...

enum	MeasureFromTypes { Distance, Plane }
	Available types for the Height or Length from which the linear/helical/plunge engage or linear/plunge retract is measured in Surface Contour Milling More...

Public Member Functions
unsafe void	GetPoints (out NXOpen.Point[] points)
	Gets engage/retract points More...

unsafe void	SetPoints (NXOpen.Point[] points)
	Sets engage/retract points More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe double	ArcAngle `[get, set]`
	Returns or sets the engage/retract arc angle More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	DiameterBuilder `[get]`
	Returns the engage/retract diameter builder More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	EffectDistBuilder `[get]`
	Returns the engage/retract effect dist builder (inheritable tool dep) More...

unsafe NXOpen.CAM.NcmScEngRetBuilder.EngRetTypes	EngRetType `[get, set]`
	Returns or sets the type of engage/retract More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	ExtendAfterArc `[get]`
	Returns the linear extension after arc engage/retract More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	ExtendBeforeArc `[get]`
	Returns the linear extension before arc engage/retract More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	HeightBuilder `[get]`
	Returns the engage/retract height builder More...

unsafe double	HelicalRampAngle `[get, set]`
	Returns or sets the engage/retract ramp angle for helical moves More...

unsafe NXOpen.CAM.InheritableDoubleBuilder	HelicalRampAngleBuilder `[get]`
	Returns the helical ramp angle builder More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	LengthBuilder `[get]`
	Returns the engage/retract length builder More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	LinearExtensionBuilder `[get]`
	Returns the engage/retract linear extension builder More...

unsafe NXOpen.CAM.NcmScEngRetBuilder.MeasureFromTypes	MeasureFrom `[get, set]`
	Returns or sets the height or length from which engage linear/helical/plunge is measured More...

unsafe NXOpen.Plane	Plane `[get, set]`
	Returns or sets the engage/retract plane More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	RadiusBuilder `[get]`
	Returns the engage/retract radius builder More...

unsafe double	RampAngle `[get, set]`
	Returns or sets the engage/retract ramp angle More...

unsafe double	SwingAngle `[get, set]`
	Returns or sets the engage/retract swing angle More...

unsafe bool	UseEffectDist `[get, set]`
	Returns or sets the engage/retract use effective distance More...

unsafe NXOpen.Direction	Vector `[get, set]`
	Returns or sets the engage/retract vector More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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.NcmScEngRetBuilder.EngRetTypes

Available types for engage/retract in surface contouring

Enumerator
SameAsDefault	Same as Default
SameAsEngage	Same as Engage (only for retract)
Linear	Linear
LinearAlongVector	Linear - Along Vector
LinearNormalToPart	Linear - Normal to Part
ArcParallelToToolAxis	Arc - Parallel to Tool Axis
ArcNormalToToolAxis	Arc - Normal to Tool Axis
ArcTangentToApproach	Arc - Tangent to Approach
ArcNormalToPart	Arc - Normal to Part
HelicalClw	Helical Clockwise
HelicalCclw	Helical Counter Clockwise
PlungeLift	Plunge Engage/Lift Retract
None	None
Points	to-from point
Smooth	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

Enumerator
Distance	Measure from distance
Plane	Measure from user-defined plane

Member Function Documentation

unsafe void NXOpen.CAM.NcmScEngRetBuilder.GetPoints ( out NXOpen.Point[] points )

inline

Gets engage/retract points

Created in NX5.0.0

License requirements: None.

Parameters

points Array of points

unsafe void NXOpen.CAM.NcmScEngRetBuilder.SetPoints ( NXOpen.Point[] points )

inline

Sets engage/retract points

Created in NX5.0.0

License requirements: cam_base ("CAM BASE")

Parameters

points Array of points

Property Documentation

unsafe double NXOpen.CAM.NcmScEngRetBuilder.ArcAngle

getset

Returns or sets the engage/retract arc angle

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmScEngRetBuilder.DiameterBuilder

get

Returns the engage/retract diameter builder

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmScEngRetBuilder.EffectDistBuilder

get

Returns the engage/retract effect dist builder (inheritable tool dep)

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CAM.NcmScEngRetBuilder.EngRetTypes NXOpen.CAM.NcmScEngRetBuilder.EngRetType

getset

Returns or sets the type of engage/retract

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmScEngRetBuilder.ExtendAfterArc

get

Returns the linear extension after arc engage/retract

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmScEngRetBuilder.ExtendBeforeArc

get

Returns the linear extension before arc engage/retract

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmScEngRetBuilder.HeightBuilder

get

Returns the engage/retract height builder

Created in NX5.0.0

License requirements: None.

unsafe double NXOpen.CAM.NcmScEngRetBuilder.HelicalRampAngle

getset

Returns or sets the engage/retract ramp angle for helical moves

Created in NX5.0.0

Deprecated in NX8.0.0. Use CAM.NcmScEngRetBuilder.HelicalRampAngleBuilder instead.

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.InheritableDoubleBuilder NXOpen.CAM.NcmScEngRetBuilder.HelicalRampAngleBuilder

get

Returns the helical ramp angle builder

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmScEngRetBuilder.LengthBuilder

get

Returns the engage/retract length builder

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmScEngRetBuilder.LinearExtensionBuilder

get

Returns the engage/retract linear extension builder

Created in NX5.0.0

Deprecated in NX9.0.0. For engage, use CAM.NcmScEngRetBuilder.ExtendBeforeArc . For retract, use CAM.NcmScEngRetBuilder.ExtendAfterArc .

License requirements: None.

unsafe NXOpen.CAM.NcmScEngRetBuilder.MeasureFromTypes NXOpen.CAM.NcmScEngRetBuilder.MeasureFrom

getset

Returns or sets the height or length from which engage linear/helical/plunge is measured

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.Plane NXOpen.CAM.NcmScEngRetBuilder.Plane

getset

Returns or sets the engage/retract plane

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmScEngRetBuilder.RadiusBuilder

get

Returns the engage/retract radius builder

Created in NX5.0.0

License requirements: None.

unsafe double NXOpen.CAM.NcmScEngRetBuilder.RampAngle

getset

Returns or sets the engage/retract ramp angle

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe double NXOpen.CAM.NcmScEngRetBuilder.SwingAngle

getset

Returns or sets the engage/retract swing angle

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe bool NXOpen.CAM.NcmScEngRetBuilder.UseEffectDist

getset

Returns or sets the engage/retract use effective distance

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.Direction NXOpen.CAM.NcmScEngRetBuilder.Vector

getset

Returns or sets the engage/retract vector

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

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

CAM_NcmScEngRetBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation