NcmPlanarEngRetBuilder Class

class NXOpen.CAM.NcmPlanarEngRetBuilder

Bases: NXOpen.TaggedObject

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

CAMObject .. versionadded:: NX5.0.0

Properties

Property	Description
ArcAngle	Returns or sets the engage/retract arc angle
DiameterBuilder	Returns the engage/retract diameter builder
EffectDistBuilder	Returns the engage/retract effect dist builder (inheritable tool dep)
EngRetType	Returns or sets the type of engage/retract
ExtendAfterArc	Returns the linear extension after arc engage/retract
ExtendBeforeArc	Returns the linear extension before arc engage/retract
HeightBuilder	Returns the engage/retract height builder
HeightFrom	Returns or sets the height from which engage helical/ramp/plunge is measured
HelicalRampAngleBuilder	Returns the helical ramp angle builder of Helical and Ramp on Shape type of Engages
IfEngageDoesNotFit	Returns or sets the type to handle area if engage does not fit
IgnoreBlankOnTrimSide	Returns or sets the flag whether to ignore blank outside trim boundaries
LengthBuilder	Returns the engage/retract length builder
MaxWidthBuilder	Returns the engage/retract max width builder (inheritable tool dep)
MinClearanceBuilder	Returns the engage/retract min clearance builder
MinRampLengthBuilder	Returns the engage/retract minimum ramp length builder (inheritable tool dep)
MinimumClearance	Returns or sets the minimum clearance
Plane	Returns or sets the engage/retract plane,plane entity type covers Xform and Plane
RadiusBuilder	Returns the engage/retract radius builder
RampAngle	Returns or sets the engage/retract ramp angle
StartAtArcCenter	Returns or sets the engage/retract start at arc center
SwingAngle	Returns or sets the engage/retract swing angle
Tag	Returns the Tag for this object.
Trim	Returns or sets the engage/retract trim
UseEffectDist	Returns or sets the engage/retract use effective distance
UseMaxWidth	Returns or sets the engage/retract use max width
Vector	Returns or sets the engage/retract vector

Methods

Method	Description
GetPoints	Gets engage/retract points
SetPoints	Sets engage/retract points

Enumerations

NcmPlanarEngRetBuilderEngRetTypes Enumeration	Available types for engage/retract in Planar Milling
NcmPlanarEngRetBuilderIfEngageDoesNotFitTypes Enumeration	Available types to handle area if engage does not fit
NcmPlanarEngRetBuilderMeasureHeightFrom Enumeration	Available types for the Height From which engage helical/ramp/plunge is measured in Planar Milling
NcmPlanarEngRetBuilderMinClearanceTypes Enumeration	Available types for the Minimum Clearance

Property Detail

ArcAngle

NcmPlanarEngRetBuilder.ArcAngle

Returns or sets the engage/retract arc angle

-------------------------------------

Getter Method

Signature ArcAngle

Returns:the arc angle Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ArcAngle

Parameters:newValue (float) – the arc angle

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

DiameterBuilder

NcmPlanarEngRetBuilder.DiameterBuilder

Returns the engage/retract diameter builder

-------------------------------------

Getter Method

Signature DiameterBuilder

Returns:The component builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

EffectDistBuilder

NcmPlanarEngRetBuilder.EffectDistBuilder

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

-------------------------------------

Getter Method

Signature EffectDistBuilder

Returns:The effective distance builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

EngRetType

NcmPlanarEngRetBuilder.EngRetType

Returns or sets the type of engage/retract

-------------------------------------

Getter Method

Signature EngRetType

Returns:the current value Return type:NXOpen.CAM.NcmPlanarEngRetBuilderEngRetTypes

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature EngRetType

Parameters:newValue (NXOpen.CAM.NcmPlanarEngRetBuilderEngRetTypes) – the new value

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

ExtendAfterArc

NcmPlanarEngRetBuilder.ExtendAfterArc

Returns the linear extension after arc engage/retract

-------------------------------------

Getter Method

Signature ExtendAfterArc

Returns:The component builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX9.0.0.

License requirements: None.

ExtendBeforeArc

NcmPlanarEngRetBuilder.ExtendBeforeArc

Returns the linear extension before arc engage/retract

-------------------------------------

Getter Method

Signature ExtendBeforeArc

Returns:The component builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX9.0.0.

License requirements: None.

HeightBuilder

NcmPlanarEngRetBuilder.HeightBuilder

Returns the engage/retract height builder

-------------------------------------

Getter Method

Signature HeightBuilder

Returns:The component builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

HeightFrom

NcmPlanarEngRetBuilder.HeightFrom

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

-------------------------------------

Getter Method

Signature HeightFrom

Returns:the current value Return type:NXOpen.CAM.NcmPlanarEngRetBuilderMeasureHeightFrom

New in version NX7.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature HeightFrom

Parameters:newValue (NXOpen.CAM.NcmPlanarEngRetBuilderMeasureHeightFrom) – the new value

New in version NX7.0.0.

License requirements: cam_base (“CAM BASE”)

HelicalRampAngleBuilder

NcmPlanarEngRetBuilder.HelicalRampAngleBuilder

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

-------------------------------------

Getter Method

Signature HelicalRampAngleBuilder

Returns:The component builder Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX8.0.0.

License requirements: None.

IfEngageDoesNotFit

NcmPlanarEngRetBuilder.IfEngageDoesNotFit

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

-------------------------------------

Getter Method

Signature IfEngageDoesNotFit

Returns: Return type:NXOpen.CAM.NcmPlanarEngRetBuilderIfEngageDoesNotFitTypes

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IfEngageDoesNotFit

Parameters:newValue (NXOpen.CAM.NcmPlanarEngRetBuilderIfEngageDoesNotFitTypes) –

New in version NX12.0.0.

License requirements: cam_base (“CAM BASE”)

IgnoreBlankOnTrimSide

NcmPlanarEngRetBuilder.IgnoreBlankOnTrimSide

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

-------------------------------------

Getter Method

Signature IgnoreBlankOnTrimSide

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IgnoreBlankOnTrimSide

Parameters:newValue (bool) –

New in version NX8.5.0.

License requirements: cam_base (“CAM BASE”)

LengthBuilder

NcmPlanarEngRetBuilder.LengthBuilder

Returns the engage/retract length builder

-------------------------------------

Getter Method

Signature LengthBuilder

Returns:The component builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

MaxWidthBuilder

NcmPlanarEngRetBuilder.MaxWidthBuilder

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

-------------------------------------

Getter Method

Signature MaxWidthBuilder

Returns:The max width builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

MinClearanceBuilder

NcmPlanarEngRetBuilder.MinClearanceBuilder

Returns the engage/retract min clearance builder

-------------------------------------

Getter Method

Signature MinClearanceBuilder

Returns:The component builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

MinRampLengthBuilder

NcmPlanarEngRetBuilder.MinRampLengthBuilder

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

-------------------------------------

Getter Method

Signature MinRampLengthBuilder

Returns:The minimum ramp length builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

MinimumClearance

NcmPlanarEngRetBuilder.MinimumClearance

Returns or sets the minimum clearance

-------------------------------------

Getter Method

Signature MinimumClearance

Returns:the current value Return type:NXOpen.CAM.NcmPlanarEngRetBuilderMinClearanceTypes

New in version NX10.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature MinimumClearance

Parameters:newValue (NXOpen.CAM.NcmPlanarEngRetBuilderMinClearanceTypes) – the new value

New in version NX10.0.3.

License requirements: cam_base (“CAM BASE”)

Plane

NcmPlanarEngRetBuilder.Plane

Returns or sets the engage/retract plane,plane entity type covers Xform and Plane

-------------------------------------

Getter Method

Signature Plane

Returns:the engage/retract plane, entity type can be XFORM or PLANE Return type:NXOpen.SmartObject

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Plane

Parameters:plane (NXOpen.SmartObject) – the engage/retract plane

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

RadiusBuilder

NcmPlanarEngRetBuilder.RadiusBuilder

Returns the engage/retract radius builder

-------------------------------------

Getter Method

Signature RadiusBuilder

Returns:The component builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

RampAngle

NcmPlanarEngRetBuilder.RampAngle

Returns or sets the engage/retract ramp angle

-------------------------------------

Getter Method

Signature RampAngle

Returns:the ramp angle Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RampAngle

Parameters:newValue (float) – the ramp angle

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

StartAtArcCenter

NcmPlanarEngRetBuilder.StartAtArcCenter

Returns or sets the engage/retract start at arc center

-------------------------------------

Getter Method

Signature StartAtArcCenter

Returns:the start at arc center Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature StartAtArcCenter

Parameters:newValue (bool) – the start at arc center

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

SwingAngle

NcmPlanarEngRetBuilder.SwingAngle

Returns or sets the engage/retract swing angle

-------------------------------------

Getter Method

Signature SwingAngle

Returns:the swing angle Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SwingAngle

Parameters:newValue (float) – the swing angle

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Trim

NcmPlanarEngRetBuilder.Trim

Returns or sets the engage/retract trim

-------------------------------------

Getter Method

Signature Trim

Returns: Return type:bool

New in version NX5.0.0.

Deprecated since version NX10.0.3: Use NXOpen.CAM.NcmPlanarEngRetBuilder.MinimumClearance() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature Trim

Parameters:newValue (bool) –

New in version NX5.0.0.

Deprecated since version NX10.0.3: Use NXOpen.CAM.NcmPlanarEngRetBuilder.MinimumClearance() instead.

License requirements: cam_base (“CAM BASE”)

UseEffectDist

NcmPlanarEngRetBuilder.UseEffectDist

Returns or sets the engage/retract use effective distance

-------------------------------------

Getter Method

Signature UseEffectDist

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UseEffectDist

Parameters:newValue (bool) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

UseMaxWidth

NcmPlanarEngRetBuilder.UseMaxWidth

Returns or sets the engage/retract use max width

-------------------------------------

Getter Method

Signature UseMaxWidth

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UseMaxWidth

Parameters:newValue (bool) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Vector

NcmPlanarEngRetBuilder.Vector

Returns or sets the engage/retract vector

-------------------------------------

Getter Method

Signature Vector

Returns:the engage/retract vector Return type:NXOpen.SmartObject

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Vector

Parameters:vector (NXOpen.SmartObject) – the engage/retract vector

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

GetPoints

NcmPlanarEngRetBuilder.GetPoints

Gets engage/retract points

Signature GetPoints()

Returns:Array of points Return type:list of NXOpen.Point

New in version NX5.0.0.

License requirements: None.

SetPoints

NcmPlanarEngRetBuilder.SetPoints

Sets engage/retract points

Signature SetPoints(points)

Parameters:points (list of NXOpen.Point) – Array of points

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)