NcmEngRetBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# NcmEngRetBuilder Class

class `NXOpen.CAM.``NcmEngRetBuilder`

  Bases: `NXOpen.TaggedObject`

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

  CAMObject .. versionadded:: NX9.0.3

# Properties

Property | Description
--- | ---
EngageRetractType | Returns or sets the type of engage/retract
HeightBuilder | Returns the engage/retract height builder
LengthBuilder | Returns the engage/retract length builder
RampAngle | Returns or sets the engage/retract ramp angle
SafeClearanceBuilder | Returns the engage/retract safe clearance builder
SwingAngle | Returns or sets the engage/retract swing angle
Tag | Returns the Tag for this object.

# Methods

# Enumerations

NcmEngRetBuilderEngageRetractTypes Enumeration | Available types for engage/retract in surface contouring

# Property Detail

## EngageRetractType

`NcmEngRetBuilder.``EngageRetractType`

  Returns or sets the type of engage/retract

  `-------------------------------------`

  Getter Method

  Signature `EngageRetractType`

  Returns: | the current value
  Return type: | `NXOpen.CAM.NcmEngRetBuilderEngageRetractTypes`

  New in version NX9.0.3.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EngageRetractType`

  Parameters: | newValue (`NXOpen.CAM.NcmEngRetBuilderEngageRetractTypes`) – the new value

  New in version NX9.0.3.

  License requirements: cam_base (“CAM BASE”)

## HeightBuilder

`NcmEngRetBuilder.``HeightBuilder`

  Returns the engage/retract height builder

  `-------------------------------------`

  Getter Method

  Signature `HeightBuilder`

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

  New in version NX9.0.3.

  License requirements: None.

## LengthBuilder

`NcmEngRetBuilder.``LengthBuilder`

  Returns the engage/retract length builder

  `-------------------------------------`

  Getter Method

  Signature `LengthBuilder`

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

  New in version NX9.0.3.

  License requirements: None.

## RampAngle

`NcmEngRetBuilder.``RampAngle`

  Returns or sets the engage/retract ramp angle

  `-------------------------------------`

  Getter Method

  Signature `RampAngle`

  Returns: | the ramp angle
  Return type: | float

  New in version NX9.0.3.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RampAngle`

  Parameters: | newValue (float) – the ramp angle

  New in version NX9.0.3.

  License requirements: cam_base (“CAM BASE”)

## SafeClearanceBuilder

`NcmEngRetBuilder.``SafeClearanceBuilder`

  Returns the engage/retract safe clearance builder

  `-------------------------------------`

  Getter Method

  Signature `SafeClearanceBuilder`

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

  New in version NX9.0.3.

  License requirements: None.

## SwingAngle

`NcmEngRetBuilder.``SwingAngle`

  Returns or sets the engage/retract swing angle

  `-------------------------------------`

  Getter Method

  Signature `SwingAngle`

  Returns: | the swing angle
  Return type: | float

  New in version NX9.0.3.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SwingAngle`

  Parameters: | newValue (float) – the swing angle

  New in version NX9.0.3.

  License requirements: cam_base (“CAM BASE”)