ToolPathTiltBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ToolPathTiltBuilder Class

class `NXOpen.CAM.``ToolPathTiltBuilder`

  Bases: `NXOpen.Builder`

  Represents a Tool Path Tilt Builder

  To create a new instance of this class, use `NXOpen.CAM.CAMSetup.CreateToolPathTiltBuilder()`

  New in version NX7.5.2.

# Properties

Property | Description
--- | ---
FanDistance | Returns the fan distance
MaintainTilt | Returns or sets the maintain tilt
MaxMaintainTiltDistance | Returns the max maintain tilt distance
MaxTiltAngle | Returns or sets the maximum tilt angle
MinHolderClearance | Returns the minimum holder clearance
MinNeckClearance | Returns the minimum neck clearance
MinSafeClearance | Returns the minimum safeclearance
MinShankClearance | Returns the minimum shank clearance
PreferredTiltAngle | Returns or sets the preferred tilt angle
Tag | Returns the Tag for this object.
TiltAvoidance | Returns the avoidance builder
TiltClearance | Returns the clearance builder
TiltMachine | Returns the machine builder
TiltTilting | Returns the tilting builder
ToolAxisChange | Returns or sets the tool axis change

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## FanDistance

`ToolPathTiltBuilder.``FanDistance`

  Returns the fan distance

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

  Getter Method

  Signature `FanDistance`

  Returns: | the fan distance value
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX7.5.2.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltAvoidance.FanDistance()` instead.

  License requirements: None.

## MaintainTilt

`ToolPathTiltBuilder.``MaintainTilt`

  Returns or sets the maintain tilt

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

  Getter Method

  Signature `MaintainTilt`

  Returns: | the value of maintain tilt
  Return type: | bool

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltAvoidance.MaintainTilt()` instead.

  License requirements: None.

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

  Setter Method

  Signature `MaintainTilt`

  Parameters: | maintainTilt (bool) – the value of maintain tilt

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltAvoidance.MaintainTilt()` instead.

  License requirements: None.

## MaxMaintainTiltDistance

`ToolPathTiltBuilder.``MaxMaintainTiltDistance`

  Returns the max maintain tilt distance

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

  Getter Method

  Signature `MaxMaintainTiltDistance`

  Returns: | the max maintain tilt distance
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltAvoidance.MaxMaintainTiltDistance()` instead.

  License requirements: None.

## MaxTiltAngle

`ToolPathTiltBuilder.``MaxTiltAngle`

  Returns or sets the maximum tilt angle

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

  Getter Method

  Signature `MaxTiltAngle`

  Returns: | the value of maximal tilt angle
  Return type: | float

  New in version NX7.5.2.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltMachine.MaxTiltAngle()` instead.

  License requirements: None.

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

  Setter Method

  Signature `MaxTiltAngle`

  Parameters: | maxTiltangle (float) – the value of maximal tilt angle

  New in version NX7.5.2.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltMachine.MaxTiltAngle()` instead.

  License requirements: None.

## MinHolderClearance

`ToolPathTiltBuilder.``MinHolderClearance`

  Returns the minimum holder clearance

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

  Getter Method

  Signature `MinHolderClearance`

  Returns: | the minimum holder clearance value
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX8.0.0.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltClearance.MinHolderClearance()` instead.

  License requirements: None.

## MinNeckClearance

`ToolPathTiltBuilder.``MinNeckClearance`

  Returns the minimum neck clearance

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

  Getter Method

  Signature `MinNeckClearance`

  Returns: | the minimum neck clearance value
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX8.0.0.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltClearance.MinNeckClearance()` instead.

  License requirements: None.

## MinSafeClearance

`ToolPathTiltBuilder.``MinSafeClearance`

  Returns the minimum safeclearance

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

  Getter Method

  Signature `MinSafeClearance`

  Returns: | the minimum safeclearance value
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX7.5.2.

  Deprecated since version NX8.0.0: Use `NXOpen.CAM.ToolPathTiltBuilder.MinHolderClearance()` instead.

  License requirements: None.

## MinShankClearance

`ToolPathTiltBuilder.``MinShankClearance`

  Returns the minimum shank clearance

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

  Getter Method

  Signature `MinShankClearance`

  Returns: | the minimum shank clearance value
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX8.0.0.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltClearance.MinShankClearance()` instead.

  License requirements: None.

## PreferredTiltAngle

`ToolPathTiltBuilder.``PreferredTiltAngle`

  Returns or sets the preferred tilt angle

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

  Getter Method

  Signature `PreferredTiltAngle`

  Returns: | the value of preferred tilt angle
  Return type: | float

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltAvoidance.PreferredTiltAngle()` instead.

  License requirements: None.

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

  Setter Method

  Signature `PreferredTiltAngle`

  Parameters: | preferredAngle (float) – the value of preferred tilt angle

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltAvoidance.PreferredTiltAngle()` instead.

  License requirements: None.

## TiltAvoidance

`ToolPathTiltBuilder.``TiltAvoidance`

  Returns the avoidance builder

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

  Getter Method

  Signature `TiltAvoidance`

  Returns: | the avoidance builder
  Return type: | `NXOpen.CAM.ToolPathTiltAvoidance`

  New in version NX9.0.0.

  License requirements: None.

## TiltClearance

`ToolPathTiltBuilder.``TiltClearance`

  Returns the clearance builder

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

  Getter Method

  Signature `TiltClearance`

  Returns: | the clearance builder
  Return type: | `NXOpen.CAM.ToolPathTiltClearance`

  New in version NX9.0.0.

  License requirements: None.

## TiltMachine

`ToolPathTiltBuilder.``TiltMachine`

  Returns the machine builder

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

  Getter Method

  Signature `TiltMachine`

  Returns: | the machine builder
  Return type: | `NXOpen.CAM.ToolPathTiltMachine`

  New in version NX9.0.0.

  License requirements: None.

## TiltTilting

`ToolPathTiltBuilder.``TiltTilting`

  Returns the tilting builder

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

  Getter Method

  Signature `TiltTilting`

  Returns: | the tilting builder
  Return type: | `NXOpen.CAM.ToolPathTiltTilting`

  New in version NX9.0.0.

  License requirements: None.

## ToolAxisChange

`ToolPathTiltBuilder.``ToolAxisChange`

  Returns or sets the tool axis change

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

  Getter Method

  Signature `ToolAxisChange`

  Returns: | the value of toolaxis change
  Return type: | float

  New in version NX7.5.2.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltMachine.MaxToolAxisChange()` instead.

  License requirements: None.

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

  Setter Method

  Signature `ToolAxisChange`

  Parameters: | toolaxisChange (float) – the value of maximum tool axis change

  New in version NX7.5.2.

  Deprecated since version NX9.0.0: Use `NXOpen.CAM.ToolPathTiltMachine.MaxToolAxisChange()` instead.

  License requirements: None.

# Method Detail

## Validate

`ToolPathTiltBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.