NcmScEngRetBuilder Class¶
-
class
NXOpen.CAM.
NcmScEngRetBuilder
¶ 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 |
HelicalRampAngle | Returns or sets the engage/retract ramp angle for helical moves |
HelicalRampAngleBuilder | Returns the helical ramp angle builder |
LengthBuilder | Returns the engage/retract length builder |
LinearExtensionBuilder | Returns the engage/retract linear extension builder |
MeasureFrom | Returns or sets the height or length from which engage linear/helical/plunge is measured |
Plane | Returns or sets the engage/retract plane |
RadiusBuilder | Returns the engage/retract radius builder |
RampAngle | Returns or sets the engage/retract ramp angle |
SwingAngle | Returns or sets the engage/retract swing angle |
Tag | Returns the Tag for this object. |
UseEffectDist | Returns or sets the engage/retract use effective distance |
Vector | Returns or sets the engage/retract vector |
Methods¶
Method | Description |
---|---|
GetPoints | Gets engage/retract points |
SetPoints | Sets engage/retract points |
Enumerations¶
NcmScEngRetBuilderEngRetTypes Enumeration | Available types for engage/retract in surface contouring |
NcmScEngRetBuilderMeasureFromTypes Enumeration | Available types for the Height or Length from which the linear/helical/plunge engage or linear/plunge retract is measured in Surface Contour Milling |
Property Detail¶
ArcAngle¶
-
NcmScEngRetBuilder.
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(newValue)
Parameters: newValue (float) – the arc angle New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
DiameterBuilder¶
-
NcmScEngRetBuilder.
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¶
-
NcmScEngRetBuilder.
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¶
-
NcmScEngRetBuilder.
EngRetType
¶ Returns or sets the type of engage/retract
-------------------------------------
Getter Method
Signature
EngRetType()
Returns: the current value Return type: NXOpen.CAM.NcmScEngRetBuilderEngRetTypes
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EngRetType(newValue)
Parameters: newValue ( NXOpen.CAM.NcmScEngRetBuilderEngRetTypes
) – the new valueNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
ExtendAfterArc¶
-
NcmScEngRetBuilder.
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¶
-
NcmScEngRetBuilder.
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¶
-
NcmScEngRetBuilder.
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.
HelicalRampAngle¶
-
NcmScEngRetBuilder.
HelicalRampAngle
¶ Returns or sets the engage/retract ramp angle for helical moves
-------------------------------------
Getter Method
Signature
HelicalRampAngle()
Returns: the ramp angle Return type: float New in version NX5.0.0.
Deprecated since version NX8.0.0: Use
CAM.NcmScEngRetBuilder.HelicalRampAngleBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
HelicalRampAngle(newValue)
Parameters: newValue (float) – the ramp angle New in version NX5.0.0.
Deprecated since version NX8.0.0: Use
CAM.NcmScEngRetBuilder.HelicalRampAngleBuilder
instead.License requirements: cam_base (“CAM BASE”)
HelicalRampAngleBuilder¶
-
NcmScEngRetBuilder.
HelicalRampAngleBuilder
¶ Returns the helical ramp angle builder
-------------------------------------
Getter Method
Signature
HelicalRampAngleBuilder()
Returns: The component builder Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX8.0.0.
License requirements: None.
LengthBuilder¶
-
NcmScEngRetBuilder.
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.
LinearExtensionBuilder¶
-
NcmScEngRetBuilder.
LinearExtensionBuilder
¶ Returns the engage/retract linear extension builder
-------------------------------------
Getter Method
Signature
LinearExtensionBuilder()
Returns: The component builder Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX5.0.0.
Deprecated since version NX9.0.0: For engage, use
CAM.NcmScEngRetBuilder.ExtendBeforeArc
. For retract, useCAM.NcmScEngRetBuilder.ExtendAfterArc
.License requirements: None.
MeasureFrom¶
-
NcmScEngRetBuilder.
MeasureFrom
¶ Returns or sets the height or length from which engage linear/helical/plunge is measured
-------------------------------------
Getter Method
Signature
MeasureFrom()
Returns: the current value Return type: NXOpen.CAM.NcmScEngRetBuilderMeasureFromTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MeasureFrom(newValue)
Parameters: newValue ( NXOpen.CAM.NcmScEngRetBuilderMeasureFromTypes
) – the new valueNew in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
Plane¶
-
NcmScEngRetBuilder.
Plane
¶ Returns or sets the engage/retract plane
-------------------------------------
Getter Method
Signature
Plane()
Returns: the engage/retract plane, entity type can be XFORM or PLANE Return type: NXOpen.Plane
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Plane(plane)
Parameters: plane ( NXOpen.Plane
) – the engage/retract planeNew in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
RadiusBuilder¶
-
NcmScEngRetBuilder.
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¶
-
NcmScEngRetBuilder.
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(newValue)
Parameters: newValue (float) – the ramp angle New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
SwingAngle¶
-
NcmScEngRetBuilder.
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(newValue)
Parameters: newValue (float) – the swing angle New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
UseEffectDist¶
-
NcmScEngRetBuilder.
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(newValue)
Parameters: newValue (bool) – New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
Vector¶
-
NcmScEngRetBuilder.
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(vector)
Parameters: vector ( NXOpen.SmartObject
) – the engage/retract vectorNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
GetPoints¶
-
NcmScEngRetBuilder.
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¶
-
NcmScEngRetBuilder.
SetPoints
¶ Sets engage/retract points
Signature
SetPoints(points)
Parameters: points (list of NXOpen.Point
) – Array of pointsNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)