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

Inheritance diagram for NXOpen.CAM.NcmPlanarEngRetBuilder:

Public Types
enum	EngRetTypes { SameAsDefault, SameAsClosed, SameAsEngage, Helical, RampOnShape, ZigzagRamp, Linear, Arc, ArcParallelToToolAxis, ArcNormalToToolAxis, ArcNormalToPart, HighSpeedArc, Points, PlungeLift, AlongVector, AngAngPlane, VectorPlane, None, LinearRelativeCut, Smooth }
	Available types for engage/retract in Planar Milling More...

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

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

enum	MinClearanceTypes { None, ExtendAndTrim, ExtendOnly, SameAsOpenEngage, SameAsRetract }
	Available types for the Minimum Clearance 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.NcmPlanarEngRetBuilder.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 NXOpen.CAM.NcmPlanarEngRetBuilder.MeasureHeightFrom	HeightFrom `[get, set]`
	Returns or sets the height from which engage helical/ramp/plunge is measured More...

unsafe NXOpen.CAM.InheritableDoubleBuilder	HelicalRampAngleBuilder `[get]`
	Returns the helical ramp angle builder of Helical and Ramp on Shape type of Engages More...

unsafe NXOpen.CAM.NcmPlanarEngRetBuilder.IfEngageDoesNotFitTypes	IfEngageDoesNotFit `[get, set]`
	Returns or sets the type to handle area if engage does not fit More...

unsafe bool	IgnoreBlankOnTrimSide `[get, set]`
	Returns or sets the flag whether to ignore blank outside trim boundaries More...

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

unsafe NXOpen.CAM.InheritableToolDepBuilder	MaxWidthBuilder `[get]`
	Returns the engage/retract max width builder (inheritable tool dep) More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	MinClearanceBuilder `[get]`
	Returns the engage/retract min clearance builder More...

unsafe NXOpen.CAM.NcmPlanarEngRetBuilder.MinClearanceTypes	MinimumClearance `[get, set]`
	Returns or sets the minimum clearance More...

unsafe NXOpen.CAM.InheritableToolDepBuilder	MinRampLengthBuilder `[get]`
	Returns the engage/retract minimum ramp length builder (inheritable tool dep) 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 bool	StartAtArcCenter `[get, set]`
	Returns or sets the engage/retract start at arc center More...

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

unsafe bool	Trim `[get, set]`
	Returns or sets the engage/retract trim More...

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

unsafe bool	UseMaxWidth `[get, set]`
	Returns or sets the engage/retract use max width 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.NcmPlanarEngRetBuilder.EngRetTypes

Available types for engage/retract in Planar Milling

Enumerator
SameAsDefault	Same as Default (Inherit)
SameAsClosed	Same as Closed Engage (from open)
SameAsEngage	Same as (Open) Engage (from retract)
Helical	Helical Ramp
RampOnShape	Ramp on shape
ZigzagRamp	ZigZag Ramp
Linear	Linear
Arc	Arc
ArcParallelToToolAxis	Arc - Parallel to Tool Axis
ArcNormalToToolAxis	Arc - Normal to Tool Axis
ArcNormalToPart	Arc - Normal to Part
HighSpeedArc	High Speed Arcs
Points	to-from points
PlungeLift	Plunge Engage/Lift Retract
AlongVector	Vector Dist
AngAngPlane	Linear to plane
VectorPlane	Vector to plane
None	None
LinearRelativeCut	Linear relative to cut direction
Smooth	Smooth

enum NXOpen.CAM.NcmPlanarEngRetBuilder.IfEngageDoesNotFitTypes

Available types to handle area if engage does not fit

Enumerator
Plunge	Plunge
Skip	Skip

enum NXOpen.CAM.NcmPlanarEngRetBuilder.MeasureHeightFrom

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

Enumerator
CurrentLevel	Measure from current level
PreviousLevel	Measure from previous level
Plane	Measure from user-defined plane

enum NXOpen.CAM.NcmPlanarEngRetBuilder.MinClearanceTypes

Available types for the Minimum Clearance

Enumerator
None	None
ExtendAndTrim	Extend and trim
ExtendOnly	Extend only
SameAsOpenEngage	Same as open engage
SameAsRetract	Same as retract

Member Function Documentation

unsafe void NXOpen.CAM.NcmPlanarEngRetBuilder.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.NcmPlanarEngRetBuilder.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.NcmPlanarEngRetBuilder.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.NcmPlanarEngRetBuilder.DiameterBuilder

get

Returns the engage/retract diameter builder

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmPlanarEngRetBuilder.EffectDistBuilder

get

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

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CAM.NcmPlanarEngRetBuilder.EngRetTypes NXOpen.CAM.NcmPlanarEngRetBuilder.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.NcmPlanarEngRetBuilder.ExtendAfterArc

get

Returns the linear extension after arc engage/retract

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmPlanarEngRetBuilder.ExtendBeforeArc

get

Returns the linear extension before arc engage/retract

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmPlanarEngRetBuilder.HeightBuilder

get

Returns the engage/retract height builder

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CAM.NcmPlanarEngRetBuilder.MeasureHeightFrom NXOpen.CAM.NcmPlanarEngRetBuilder.HeightFrom

getset

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

Created in NX7.0.0

License requirements to get this property: None.

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

unsafe NXOpen.CAM.InheritableDoubleBuilder NXOpen.CAM.NcmPlanarEngRetBuilder.HelicalRampAngleBuilder

get

Returns the helical ramp angle builder of Helical and Ramp on Shape type of Engages

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.CAM.NcmPlanarEngRetBuilder.IfEngageDoesNotFitTypes NXOpen.CAM.NcmPlanarEngRetBuilder.IfEngageDoesNotFit

getset

Returns or sets the type to handle area if engage does not fit

Created in NX12.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.CAM.NcmPlanarEngRetBuilder.IgnoreBlankOnTrimSide

getset

Returns or sets the flag whether to ignore blank outside trim boundaries

Created in NX8.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.NcmPlanarEngRetBuilder.LengthBuilder

get

Returns the engage/retract length builder

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmPlanarEngRetBuilder.MaxWidthBuilder

get

Returns the engage/retract max width builder (inheritable tool dep)

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmPlanarEngRetBuilder.MinClearanceBuilder

get

Returns the engage/retract min clearance builder

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CAM.NcmPlanarEngRetBuilder.MinClearanceTypes NXOpen.CAM.NcmPlanarEngRetBuilder.MinimumClearance

getset

Returns or sets the minimum clearance

Created in NX10.0.3

License requirements to get this property: None.

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

unsafe NXOpen.CAM.InheritableToolDepBuilder NXOpen.CAM.NcmPlanarEngRetBuilder.MinRampLengthBuilder

get

Returns the engage/retract minimum ramp length builder (inheritable tool dep)

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.Plane NXOpen.CAM.NcmPlanarEngRetBuilder.Plane

getset

Returns or sets the engage/retract plane

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.NcmPlanarEngRetBuilder.RadiusBuilder

get

Returns the engage/retract radius builder

Created in NX5.0.0

License requirements: None.

unsafe double NXOpen.CAM.NcmPlanarEngRetBuilder.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 bool NXOpen.CAM.NcmPlanarEngRetBuilder.StartAtArcCenter

getset

Returns or sets the engage/retract start at arc center

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.NcmPlanarEngRetBuilder.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.NcmPlanarEngRetBuilder.Trim

getset

Returns or sets the engage/retract trim

Created in NX5.0.0

Deprecated in NX10.0.3. Use NXOpen.CAM.NcmPlanarEngRetBuilder.MinimumClearance instead.

License requirements to get this property: None.

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

unsafe bool NXOpen.CAM.NcmPlanarEngRetBuilder.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 bool NXOpen.CAM.NcmPlanarEngRetBuilder.UseMaxWidth

getset

Returns or sets the engage/retract use max width

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.NcmPlanarEngRetBuilder.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_NcmPlanarEngRetBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation