ReliefDesignBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ReliefDesignBuilder Class

class `NXOpen.Tooling.``ReliefDesignBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Tooling.ReliefDesignBuilder` Relief Design is to cut relief pocket for forming region .

  To create a new instance of this class, use `NXOpen.Tooling.ReliefDesignCollection.CreateReliefDesignBuilder()`

  Default values.

  Property | Value
  --- | ---
  Clearance | 0.1
  CreateEditMethod | BBox
  CreateLocation | 1
  DeleteMethod | DeleteSelectedInstance
  HideReliefStatus | 0
  NumberOfCopy | 1
  ReliefHeight.Value | 5 (millimeters part), 1 (inches part)
  ReliefRadius.Value | 1 (millimeters part), 0.1 (inches part)

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
Clearance | Returns or sets the clearance of KF bounding box.
Clearance1 | Returns the first clearance to create handle to control -X direction clearance.
Clearance2 | Returns the second clearance to create handle to control -Y direction clearance.
Clearance3 | Returns the third clearance to create handle to control -Z direction clearance.
Clearance4 | Returns the fourth clearance to create handle to control +X direction clearance.
Clearance5 | Returns the fifth clearance to create handle to control +Y direction clearance.
Clearance6 | Returns the sixth clearance to create handle to control +Z direction clearance.
CopyRelief | Returns the relief used to copy.
CreateEditMethod | Returns or sets the create and edit method.
CreateLocation | Returns or sets the location option to create relief, true: create relief at the location of forming region, false: create relief at the next station(offset one pitch).
CurveSuperSelect | Returns the sketched curve profile used for creating or editing user defined relief.
DeleteMethod | Returns or sets the delete method.
HideReliefStatus | Returns or sets the option to hide (true) or show (false) the relief.
NumberOfCopy | Returns or sets the number of relief to be copied.
Pitch | Returns or sets the pitch.
ReliefFace | Returns the face used to create bounding box or wave to workpart as reference for creating user defined relief.
ReliefHeight | Returns the relief height.
ReliefRadius | Returns the relief radius.
ReliefStart | Returns the extrude start of the user defined relief.
SelectionReliefToEdit | Returns the selected relief to edit.
Tag | Returns the Tag for this object.
Type | Returns or sets the type of relief design.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
DeleteLinkedFace | Delete the linked face feature.
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.
SetFaces | Sets the face occurrences into builder attribute.
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.
WaveFaces | Wave face to work part for creating user defined relief as reference.

# Enumerations

ReliefDesignBuilderMethod Enumeration | The relief design creation method.
ReliefDesignBuilderMethodOfDelete Enumeration | The relief design delete method.
ReliefDesignBuilderTypes Enumeration | The relief design type.

# Property Detail

## Clearance

`ReliefDesignBuilder.``Clearance`

  Returns or sets the clearance of KF bounding box.

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

  Getter Method

  Signature `Clearance`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Clearance`

  Parameters: | clearance (float) –

  New in version NX7.5.0.

  License requirements: None.

## Clearance1

`ReliefDesignBuilder.``Clearance1`

  Returns the first clearance to create handle to control -X direction clearance.

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

  Getter Method

  Signature `Clearance1`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## Clearance2

`ReliefDesignBuilder.``Clearance2`

  Returns the second clearance to create handle to control -Y direction clearance.

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

  Getter Method

  Signature `Clearance2`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## Clearance3

`ReliefDesignBuilder.``Clearance3`

  Returns the third clearance to create handle to control -Z direction clearance.

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

  Getter Method

  Signature `Clearance3`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## Clearance4

`ReliefDesignBuilder.``Clearance4`

  Returns the fourth clearance to create handle to control +X direction clearance.

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

  Getter Method

  Signature `Clearance4`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## Clearance5

`ReliefDesignBuilder.``Clearance5`

  Returns the fifth clearance to create handle to control +Y direction clearance.

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

  Getter Method

  Signature `Clearance5`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## Clearance6

`ReliefDesignBuilder.``Clearance6`

  Returns the sixth clearance to create handle to control +Z direction clearance.

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

  Getter Method

  Signature `Clearance6`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## CopyRelief

`ReliefDesignBuilder.``CopyRelief`

  Returns the relief used to copy.

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

  Getter Method

  Signature `CopyRelief`

  Returns: |
  Return type: | `NXOpen.SelectBodyList`

  New in version NX7.5.0.

  License requirements: None.

## CreateEditMethod

`ReliefDesignBuilder.``CreateEditMethod`

  Returns or sets the create and edit method.

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

  Getter Method

  Signature `CreateEditMethod`

  Returns: |
  Return type: | `NXOpen.Tooling.ReliefDesignBuilderMethod`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateEditMethod`

  Parameters: | createEditMethod (`NXOpen.Tooling.ReliefDesignBuilderMethod`) –

  New in version NX7.5.0.

  License requirements: None.

## CreateLocation

`ReliefDesignBuilder.``CreateLocation`

  Returns or sets the location option to create relief, true: create relief at the location of forming region, false: create relief at the next station(offset one pitch).

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

  Getter Method

  Signature `CreateLocation`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateLocation`

  Parameters: | createLocation (bool) –

  New in version NX7.5.0.

  License requirements: None.

## CurveSuperSelect

`ReliefDesignBuilder.``CurveSuperSelect`

  Returns the sketched curve profile used for creating or editing user defined relief.

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

  Getter Method

  Signature `CurveSuperSelect`

  Returns: |
  Return type: | `NXOpen.Section`

  New in version NX7.5.0.

  License requirements: None.

## DeleteMethod

`ReliefDesignBuilder.``DeleteMethod`

  Returns or sets the delete method.

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

  Getter Method

  Signature `DeleteMethod`

  Returns: |
  Return type: | `NXOpen.Tooling.ReliefDesignBuilderMethodOfDelete`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DeleteMethod`

  Parameters: | deleteMethod (`NXOpen.Tooling.ReliefDesignBuilderMethodOfDelete`) –

  New in version NX7.5.0.

  License requirements: None.

## HideReliefStatus

`ReliefDesignBuilder.``HideReliefStatus`

  Returns or sets the option to hide (true) or show (false) the relief.

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

  Getter Method

  Signature `HideReliefStatus`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `HideReliefStatus`

  Parameters: | hideReliefStatus (bool) –

  New in version NX7.5.0.

  License requirements: None.

## NumberOfCopy

`ReliefDesignBuilder.``NumberOfCopy`

  Returns or sets the number of relief to be copied.

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

  Getter Method

  Signature `NumberOfCopy`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfCopy`

  Parameters: | numberOfCopy (int) –

  New in version NX7.5.0.

  License requirements: None.

## Pitch

`ReliefDesignBuilder.``Pitch`

  Returns or sets the pitch.

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

  Getter Method

  Signature `Pitch`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Pitch`

  Parameters: | pitch (float) –

  New in version NX7.5.0.

  License requirements: None.

## ReliefFace

`ReliefDesignBuilder.``ReliefFace`

  Returns the face used to create bounding box or wave to workpart as reference for creating user defined relief.

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

  Getter Method

  Signature `ReliefFace`

  Returns: |
  Return type: | `NXOpen.ScCollector`

  New in version NX7.5.0.

  License requirements: None.

## ReliefHeight

`ReliefDesignBuilder.``ReliefHeight`

  Returns the relief height.

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

  Getter Method

  Signature `ReliefHeight`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## ReliefRadius

`ReliefDesignBuilder.``ReliefRadius`

  Returns the relief radius.

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

  Getter Method

  Signature `ReliefRadius`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## ReliefStart

`ReliefDesignBuilder.``ReliefStart`

  Returns the extrude start of the user defined relief.

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

  Getter Method

  Signature `ReliefStart`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## SelectionReliefToEdit

`ReliefDesignBuilder.``SelectionReliefToEdit`

  Returns the selected relief to edit.

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

  Getter Method

  Signature `SelectionReliefToEdit`

  Returns: |
  Return type: | `NXOpen.SelectNXObject`

  New in version NX7.5.0.

  License requirements: None.

## Type

`ReliefDesignBuilder.``Type`

  Returns or sets the type of relief design.

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

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Tooling.ReliefDesignBuilderTypes`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Tooling.ReliefDesignBuilderTypes`) –

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## DeleteLinkedFace

`ReliefDesignBuilder.``DeleteLinkedFace`

  Delete the linked face feature.

  Signature `DeleteLinkedFace()`

  New in version NX7.5.0.

  License requirements: None.

## SetFaces

`ReliefDesignBuilder.``SetFaces`

  Sets the face occurrences into builder attribute.

  Signature `SetFaces(faceOccs)`

  Parameters: | faceOccs (list of `NXOpen.Face`) – array of face occurrences

  New in version NX7.5.0.

  License requirements: None.

## Validate

`ReliefDesignBuilder.``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.

## WaveFaces

`ReliefDesignBuilder.``WaveFaces`

  Wave face to work part for creating user defined relief as reference.

  Signature `WaveFaces()`

  New in version NX7.5.0.

  License requirements: None.