DieInsertBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DieInsertBuilder Class

class `NXOpen.Tooling.``DieInsertBuilder`

  Bases: `NXOpen.Builder`

  Represents die insert builder.

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

  Default values.

  Property | Value
  --- | ---
  BoundingBoxType | Block
  ConceptDesign | 0
  DieInsertType | DieInsert
  InsertMode | StandardInsert
  Position | Bottom
  RenameDialog | 0
  UserDefinedDieInsertClearance | 0
  UserDefinedDieInsertHeight.Value | 0 (millimeters part), 0 (inches part)
  WithoutFalseBody | 0

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
BoundingBoxType | Returns or sets the bounding box type
BoxPosition | Returns or sets the position of csys for box.
ConceptDesign | Returns or sets the value indicating if the design is for a concept.
DieInsertType | Returns or sets the die insert type.
DieStandardInsertInstance | Returns or sets the die standard insert instance.
InsertMode | Returns or sets the insert mode
NewPartNames | Returns or sets the new component names.
OffsetValueLinearDimensionNegativeX | Returns the offset value linear dimension negative x
OffsetValueLinearDimensionNegativeY | Returns the offset value linear dimension negative y
OffsetValueLinearDimensionNegativeZ | Returns the offset value linear dimension negative z
OffsetValueLinearDimensionPositiveX | Returns the offset value linear dimension positive x
OffsetValueLinearDimensionPositiveY | Returns the offset value linear dimension positive y
OffsetValueLinearDimensionPositiveZ | Returns the offset value linear dimension positive z
ParentPartName | Returns or sets the parent part name to create insert.
Position | Returns or sets the die insert position.
RadialOffset | Returns the radial offset value for cylinder box
RenameDialog | Returns or sets the rename dialog option for normal pierce design.
SelectDieInsertOutline | Returns the select die insert outline
SelectScrap | Returns the select scraps for pierce insert design.
SelectUserDefinedDieInsertForEdit | Returns the select user defined insert to edit
SelectVector | Returns or sets the select vector
Tag | Returns the Tag for this object.
UserDefinedDieInsertClearance | Returns or sets the user defined die insert clearance
UserDefinedDieInsertHeight | Returns the user defined die insert height
WithoutFalseBody | Returns or sets the option of whether to create false body for die or backing insert.

# Methods

Method | Description
--- | ---
AddDieInsertPart | Add die insert or backing insert part into assembly when creating user defined insert datum plane
CalculateBoxSize | Calculate box size and set directions, edge length, lower point position.
Commit | Commits any edits that have been applied to the builder.
CreateUserDefinedDieInsert | Create user defined die insert or backing insert for selected scraps when creating die insert by user defined type
CreateUserDefinedInsertDatumPlane | Create datum plane for user defined die or backing insert outline.
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.
SetManipulatorToMatrixAndPosition | Sets box csys matrix.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
StandardDieInsert | Insert the standard die by invoking standard part management dialog
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

DieInsertBuilderBoundingBoxTypeItems Enumeration | Specifies the bounding box type.
DieInsertBuilderDieInsertTypeItems Enumeration | Specifies the type of insert.
DieInsertBuilderInsertModeItems Enumeration | Specifies the insert mode for die.
DieInsertBuilderPositionItems Enumeration | Specifies the position of piercing inserts, for EDW only

# Property Detail

## BoundingBoxType

`DieInsertBuilder.``BoundingBoxType`

  Returns or sets the bounding box type

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

  Getter Method

  Signature `BoundingBoxType`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BoundingBoxType`

  Parameters: | boundingBoxType (`NXOpen.Tooling.DieInsertBuilderBoundingBoxTypeItems`) –

  New in version NX11.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## BoxPosition

`DieInsertBuilder.``BoxPosition`

  Returns or sets the position of csys for box.

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

  Getter Method

  Signature `BoxPosition`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BoxPosition`

  Parameters: | csysOrigin (`NXOpen.Point3d`) –

  New in version NX11.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## ConceptDesign

`DieInsertBuilder.``ConceptDesign`

  Returns or sets the value indicating if the design is for a concept.

  True indicates it is a concept design.

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

  Getter Method

  Signature `ConceptDesign`

  Returns: | Indicates whether it is a concept design
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ConceptDesign`

  Parameters: | conceptDesign (bool) – Indicates whether it is a concept design

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## DieInsertType

`DieInsertBuilder.``DieInsertType`

  Returns or sets the die insert type.

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

  Getter Method

  Signature `DieInsertType`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DieInsertType`

  Parameters: | dieInsertType (`NXOpen.Tooling.DieInsertBuilderDieInsertTypeItems`) –

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## DieStandardInsertInstance

`DieInsertBuilder.``DieStandardInsertInstance`

  Returns or sets the die standard insert instance.

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

  Getter Method

  Signature `DieStandardInsertInstance`

  Returns: | Retruns the die standard insert instance
  Return type: | `NXOpen.TaggedObject`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DieStandardInsertInstance`

  Parameters: | dieStandardInsertInstance (`NXOpen.TaggedObject`) – Specifies the die standard insert instance

  New in version NX11.0.0.

  License requirements: None.

## InsertMode

`DieInsertBuilder.``InsertMode`

  Returns or sets the insert mode

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

  Getter Method

  Signature `InsertMode`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `InsertMode`

  Parameters: | insertMode (`NXOpen.Tooling.DieInsertBuilderInsertModeItems`) –

  New in version NX11.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## NewPartNames

`DieInsertBuilder.``NewPartNames`

  Returns or sets the new component names.

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

  Getter Method

  Signature `NewPartNames`

  Returns: | Retruns the new component names
  Return type: | str

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NewPartNames`

  Parameters: | newPartNames (str) – Specifies the new component names

  New in version NX11.0.0.

  License requirements: None.

## OffsetValueLinearDimensionNegativeX

`DieInsertBuilder.``OffsetValueLinearDimensionNegativeX`

  Returns the offset value linear dimension negative x

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

  Getter Method

  Signature `OffsetValueLinearDimensionNegativeX`

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

  New in version NX11.0.0.

  License requirements: None.

## OffsetValueLinearDimensionNegativeY

`DieInsertBuilder.``OffsetValueLinearDimensionNegativeY`

  Returns the offset value linear dimension negative y

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

  Getter Method

  Signature `OffsetValueLinearDimensionNegativeY`

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

  New in version NX11.0.0.

  License requirements: None.

## OffsetValueLinearDimensionNegativeZ

`DieInsertBuilder.``OffsetValueLinearDimensionNegativeZ`

  Returns the offset value linear dimension negative z

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

  Getter Method

  Signature `OffsetValueLinearDimensionNegativeZ`

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

  New in version NX11.0.0.

  License requirements: None.

## OffsetValueLinearDimensionPositiveX

`DieInsertBuilder.``OffsetValueLinearDimensionPositiveX`

  Returns the offset value linear dimension positive x

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

  Getter Method

  Signature `OffsetValueLinearDimensionPositiveX`

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

  New in version NX11.0.0.

  License requirements: None.

## OffsetValueLinearDimensionPositiveY

`DieInsertBuilder.``OffsetValueLinearDimensionPositiveY`

  Returns the offset value linear dimension positive y

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

  Getter Method

  Signature `OffsetValueLinearDimensionPositiveY`

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

  New in version NX11.0.0.

  License requirements: None.

## OffsetValueLinearDimensionPositiveZ

`DieInsertBuilder.``OffsetValueLinearDimensionPositiveZ`

  Returns the offset value linear dimension positive z

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

  Getter Method

  Signature `OffsetValueLinearDimensionPositiveZ`

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

  New in version NX11.0.0.

  License requirements: None.

## ParentPartName

`DieInsertBuilder.``ParentPartName`

  Returns or sets the parent part name to create insert.

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

  Getter Method

  Signature `ParentPartName`

  Returns: | Retruns parent part name
  Return type: | str

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ParentPartName`

  Parameters: | parentPartName (str) – Specifies the parent part name

  New in version NX11.0.0.

  License requirements: None.

## Position

`DieInsertBuilder.``Position`

  Returns or sets the die insert position.

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

  Getter Method

  Signature `Position`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Position`

  Parameters: | position (`NXOpen.Tooling.DieInsertBuilderPositionItems`) –

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## RadialOffset

`DieInsertBuilder.``RadialOffset`

  Returns the radial offset value for cylinder box

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

  Getter Method

  Signature `RadialOffset`

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

  New in version NX11.0.0.

  License requirements: None.

## RenameDialog

`DieInsertBuilder.``RenameDialog`

  Returns or sets the rename dialog option for normal pierce design.

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

  Getter Method

  Signature `RenameDialog`

  Returns: | Indicates the rename dialog option for normal pierce design
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RenameDialog`

  Parameters: | renameDialog (bool) – Indicates the rename dialog option for normal pierce design

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## SelectDieInsertOutline

`DieInsertBuilder.``SelectDieInsertOutline`

  Returns the select die insert outline

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

  Getter Method

  Signature `SelectDieInsertOutline`

  Returns: | Indicates the profiles for user defined die or backing insert design
  Return type: | `NXOpen.Section`

  New in version NX11.0.0.

  License requirements: None.

## SelectScrap

`DieInsertBuilder.``SelectScrap`

  Returns the select scraps for pierce insert design.

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

  Getter Method

  Signature `SelectScrap`

  Returns: | the selected scraps for pierce insert design
  Return type: | `NXOpen.SelectBodyList`

  New in version NX11.0.0.

  License requirements: None.

## SelectUserDefinedDieInsertForEdit

`DieInsertBuilder.``SelectUserDefinedDieInsertForEdit`

  Returns the select user defined insert to edit

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

  Getter Method

  Signature `SelectUserDefinedDieInsertForEdit`

  Returns: | Indicates the selected user defined die insert to edit
  Return type: | `NXOpen.SelectBodyList`

  New in version NX11.0.0.

  License requirements: None.

## SelectVector

`DieInsertBuilder.``SelectVector`

  Returns or sets the select vector

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

  Getter Method

  Signature `SelectVector`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectVector`

  Parameters: | selectVector (`NXOpen.Direction`) –

  New in version NX11.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## UserDefinedDieInsertClearance

`DieInsertBuilder.``UserDefinedDieInsertClearance`

  Returns or sets the user defined die insert clearance

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

  Getter Method

  Signature `UserDefinedDieInsertClearance`

  Returns: | Indicates the false body clearance value of user defined die or backing insert
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UserDefinedDieInsertClearance`

  Parameters: | userDefinedDieInsertClearance (float) – Indicates the false body clearance value of user defined die or backing insert

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## UserDefinedDieInsertHeight

`DieInsertBuilder.``UserDefinedDieInsertHeight`

  Returns the user defined die insert height

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

  Getter Method

  Signature `UserDefinedDieInsertHeight`

  Returns: | Indicates the height value of user defined die or backing insert
  Return type: | `NXOpen.Expression`

  New in version NX11.0.0.

  License requirements: None.

## WithoutFalseBody

`DieInsertBuilder.``WithoutFalseBody`

  Returns or sets the option of whether to create false body for die or backing insert.

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

  Getter Method

  Signature `WithoutFalseBody`

  Returns: | Indicates whether to create false body
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WithoutFalseBody`

  Parameters: | withoutFalseBody (bool) – Indicates whether to create false body

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

# Method Detail

## AddDieInsertPart

`DieInsertBuilder.``AddDieInsertPart`

  Add die insert or backing insert part into assembly when creating user defined insert datum plane

  Signature `AddDieInsertPart()`

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## CalculateBoxSize

`DieInsertBuilder.``CalculateBoxSize`

  Calculate box size and set directions, edge length, lower point position.

  Signature `CalculateBoxSize()`

  New in version NX11.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## CreateUserDefinedDieInsert

`DieInsertBuilder.``CreateUserDefinedDieInsert`

  Create user defined die insert or backing insert for selected scraps when creating die insert by user defined type

  Signature `CreateUserDefinedDieInsert()`

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## CreateUserDefinedInsertDatumPlane

`DieInsertBuilder.``CreateUserDefinedInsertDatumPlane`

  Create datum plane for user defined die or backing insert outline.

  Signature `CreateUserDefinedInsertDatumPlane()`

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## SetManipulatorToMatrixAndPosition

`DieInsertBuilder.``SetManipulatorToMatrixAndPosition`

  Sets box csys matrix.

  Signature `SetManipulatorToMatrixAndPosition(matrix, position)`

  Parameters:

  - matrix (`NXOpen.Matrix3x3`) –
  - position (`NXOpen.Point3d`) –

  New in version NX11.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## StandardDieInsert

`DieInsertBuilder.``StandardDieInsert`

  Insert the standard die by invoking standard part management dialog

  Signature `StandardDieInsert()`

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## Validate

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