FormingInsertBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FormingInsertBuilder Class

class `NXOpen.Tooling.``FormingInsertBuilder`

  Bases: `NXOpen.Builder`

  Progressive Die Wizard builder to design forming punch and die insert

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

  Default values.

  Property | Value
  --- | ---
  AngleToleranceValue | 45
  BlankPosition | PunchPlate
  BlankType | Standard
  BottomPlateClearance | 0
  DesignOption | FormingPunch
  DiePlateClearance | 0
  HeightValue.Value | 0 (millimeters part), 0 (inches part)
  ParentPart | DieBase
  PunchPlateClearance | 0
  SameWithPlate | 0
  StripperPlateClearance | 0
  TangentEdgeAngle | 0
  TraverseInteriorEdges | 0
  UseBottomPlateClearance | 0
  UseDiePlateClearance | 0
  UsePunchPlateClearance | 0
  UseStripperPlateClearance | 0

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
AngleToleranceValue | Returns or sets the tangent edge angle tolerance value of forming region.
BlankPosition | Returns or sets the blank position in punch plate or stripper plate.
BlankProfile | Returns the blank profile to extrude the punch or die.
BlankType | Returns or sets the blank type for punch or die.
BottomPlateClearance | Returns or sets the clearance value of bottom backing plate .
BoundaryFaces | Returns the boundary faces of forming region.
DesignOption | Returns or sets the design option to design punch or die.
DiePlateClearance | Returns or sets the clearance value of die plate.
HeightValue | Returns the height value of blank.
LowerValue | Returns the lower value of blank.
ParentPart | Returns or sets the parent part to create blank.
ParentPartName | Returns or sets the parent part name to create blank.
PunchOrDieToEdit | Returns the punch or die to edit
PunchPlateClearance | Returns or sets the clearance value of punch plate .
RenameComponent | Returns or sets the option whether rename component.
ReverseDirection | Returns or sets the option to reverse trim direction.
SameWithPlate | Returns or sets the punch same with plate
SeedFace | Returns the seed face of forming region.
SelectFormingFaces | Returns the forming faces of forming region.
StripperPlateClearance | Returns or sets the option to use the stripper plate clearance.
Tag | Returns the Tag for this object.
TangentEdgeAngle | Returns or sets the tangent edge angle of forming region.
TraverseInteriorEdges | Returns or sets the indication to traverse interior edges of forming region.
UseBottomPlateClearance | Returns or sets the option to use bottom backing plate clearance.
UseDiePlateClearance | Returns or sets the option to use die plate clearance.
UsePunchPlateClearance | Returns or sets the option to use punch plate clearance.
UseStripperPlateClearance | Returns or sets the option to use stripper plate clearance.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateNewComponent | Create new component.
DeletePunchOrDieComponent | The action to delete the selected punch or die component
Destroy | Deletes the builder, and cleans up any objects created by the builder.
ExtractFormingRegion | Extract forming region.
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.
ReverseTrimDirection | Reverse trim direction.
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.

# Enumerations

FormingInsertBuilderBlankPositions Enumeration | Specifies the blank position.
FormingInsertBuilderBlankTypes Enumeration | Specifies the blank type.
FormingInsertBuilderDesignOptions Enumeration | Specifies the design type.
FormingInsertBuilderParentTypes Enumeration | Specifies the parent part type.

# Property Detail

## AngleToleranceValue

`FormingInsertBuilder.``AngleToleranceValue`

  Returns or sets the tangent edge angle tolerance value of forming region.

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

  Getter Method

  Signature `AngleToleranceValue`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AngleToleranceValue`

  Parameters: | angleToleranceValue (float) –

  New in version NX7.5.0.

  License requirements: None.

## BlankPosition

`FormingInsertBuilder.``BlankPosition`

  Returns or sets the blank position in punch plate or stripper plate.

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

  Getter Method

  Signature `BlankPosition`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `BlankPosition`

  Parameters: | blankPosition (`NXOpen.Tooling.FormingInsertBuilderBlankPositions`) –

  New in version NX7.5.0.

  License requirements: None.

## BlankProfile

`FormingInsertBuilder.``BlankProfile`

  Returns the blank profile to extrude the punch or die.

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

  Getter Method

  Signature `BlankProfile`

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

  New in version NX7.5.0.

  License requirements: None.

## BlankType

`FormingInsertBuilder.``BlankType`

  Returns or sets the blank type for punch or die.

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

  Getter Method

  Signature `BlankType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `BlankType`

  Parameters: | blankType (`NXOpen.Tooling.FormingInsertBuilderBlankTypes`) –

  New in version NX7.5.0.

  License requirements: None.

## BottomPlateClearance

`FormingInsertBuilder.``BottomPlateClearance`

  Returns or sets the clearance value of bottom backing plate .

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

  Getter Method

  Signature `BottomPlateClearance`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `BottomPlateClearance`

  Parameters: | bottomPlateClr (float) –

  New in version NX7.5.0.

  License requirements: None.

## BoundaryFaces

`FormingInsertBuilder.``BoundaryFaces`

  Returns the boundary faces of forming region.

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

  Getter Method

  Signature `BoundaryFaces`

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

  New in version NX7.5.0.

  License requirements: None.

## DesignOption

`FormingInsertBuilder.``DesignOption`

  Returns or sets the design option to design punch or die.

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

  Getter Method

  Signature `DesignOption`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DesignOption`

  Parameters: | designOption (`NXOpen.Tooling.FormingInsertBuilderDesignOptions`) –

  New in version NX7.5.0.

  License requirements: None.

## DiePlateClearance

`FormingInsertBuilder.``DiePlateClearance`

  Returns or sets the clearance value of die plate.

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

  Getter Method

  Signature `DiePlateClearance`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DiePlateClearance`

  Parameters: | diePlateClr (float) –

  New in version NX7.5.0.

  License requirements: None.

## HeightValue

`FormingInsertBuilder.``HeightValue`

  Returns the height value of blank.

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

  Getter Method

  Signature `HeightValue`

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

  New in version NX7.5.0.

  License requirements: None.

## LowerValue

`FormingInsertBuilder.``LowerValue`

  Returns the lower value of blank.

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

  Getter Method

  Signature `LowerValue`

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

  New in version NX7.5.0.

  License requirements: None.

## ParentPart

`FormingInsertBuilder.``ParentPart`

  Returns or sets the parent part to create blank.

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

  Getter Method

  Signature `ParentPart`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ParentPart`

  Parameters: | parentPart (`NXOpen.Tooling.FormingInsertBuilderParentTypes`) –

  New in version NX7.5.0.

  License requirements: None.

## ParentPartName

`FormingInsertBuilder.``ParentPartName`

  Returns or sets the parent part name to create blank.

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

  Getter Method

  Signature `ParentPartName`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ParentPartName`

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

  New in version NX7.5.0.

  License requirements: None.

## PunchOrDieToEdit

`FormingInsertBuilder.``PunchOrDieToEdit`

  Returns the punch or die to edit

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

  Getter Method

  Signature `PunchOrDieToEdit`

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

  New in version NX7.5.0.

  License requirements: None.

## PunchPlateClearance

`FormingInsertBuilder.``PunchPlateClearance`

  Returns or sets the clearance value of punch plate .

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

  Getter Method

  Signature `PunchPlateClearance`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PunchPlateClearance`

  Parameters: | punchPlateClr (float) –

  New in version NX7.5.0.

  License requirements: None.

## RenameComponent

`FormingInsertBuilder.``RenameComponent`

  Returns or sets the option whether rename component.

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

  Getter Method

  Signature `RenameComponent`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RenameComponent`

  Parameters: | renameComponent (bool) –

  New in version NX8.5.0.

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

## ReverseDirection

`FormingInsertBuilder.``ReverseDirection`

  Returns or sets the option to reverse trim direction.

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

  Getter Method

  Signature `ReverseDirection`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ReverseDirection`

  Parameters: | reverseDirection (bool) –

  New in version NX7.5.0.

  License requirements: None.

## SameWithPlate

`FormingInsertBuilder.``SameWithPlate`

  Returns or sets the punch same with plate

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

  Getter Method

  Signature `SameWithPlate`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SameWithPlate`

  Parameters: | sameWithPlate (bool) –

  New in version NX7.5.0.

  License requirements: None.

## SeedFace

`FormingInsertBuilder.``SeedFace`

  Returns the seed face of forming region.

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

  Getter Method

  Signature `SeedFace`

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

  New in version NX7.5.0.

  License requirements: None.

## SelectFormingFaces

`FormingInsertBuilder.``SelectFormingFaces`

  Returns the forming faces of forming region.

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

  Getter Method

  Signature `SelectFormingFaces`

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

  New in version NX7.5.0.

  License requirements: None.

## StripperPlateClearance

`FormingInsertBuilder.``StripperPlateClearance`

  Returns or sets the option to use the stripper plate clearance.

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

  Getter Method

  Signature `StripperPlateClearance`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `StripperPlateClearance`

  Parameters: | stripperPlateClr (float) –

  New in version NX7.5.0.

  License requirements: None.

## TangentEdgeAngle

`FormingInsertBuilder.``TangentEdgeAngle`

  Returns or sets the tangent edge angle of forming region.

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

  Getter Method

  Signature `TangentEdgeAngle`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TangentEdgeAngle`

  Parameters: | tangentEdgeAngle (bool) –

  New in version NX7.5.0.

  License requirements: None.

## TraverseInteriorEdges

`FormingInsertBuilder.``TraverseInteriorEdges`

  Returns or sets the indication to traverse interior edges of forming region.

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

  Getter Method

  Signature `TraverseInteriorEdges`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TraverseInteriorEdges`

  Parameters: | traverseInteriorEdges (bool) –

  New in version NX7.5.0.

  License requirements: None.

## UseBottomPlateClearance

`FormingInsertBuilder.``UseBottomPlateClearance`

  Returns or sets the option to use bottom backing plate clearance.

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

  Getter Method

  Signature `UseBottomPlateClearance`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UseBottomPlateClearance`

  Parameters: | useBPClearance (bool) –

  New in version NX7.5.0.

  License requirements: None.

## UseDiePlateClearance

`FormingInsertBuilder.``UseDiePlateClearance`

  Returns or sets the option to use die plate clearance.

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

  Getter Method

  Signature `UseDiePlateClearance`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UseDiePlateClearance`

  Parameters: | useDPClearance (bool) –

  New in version NX7.5.0.

  License requirements: None.

## UsePunchPlateClearance

`FormingInsertBuilder.``UsePunchPlateClearance`

  Returns or sets the option to use punch plate clearance.

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

  Getter Method

  Signature `UsePunchPlateClearance`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePunchPlateClearance`

  Parameters: | usePPClearance (bool) –

  New in version NX7.5.0.

  License requirements: None.

## UseStripperPlateClearance

`FormingInsertBuilder.``UseStripperPlateClearance`

  Returns or sets the option to use stripper plate clearance.

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

  Getter Method

  Signature `UseStripperPlateClearance`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UseStripperPlateClearance`

  Parameters: | useSPClearance (bool) –

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## CreateNewComponent

`FormingInsertBuilder.``CreateNewComponent`

  Create new component.

  Signature `CreateNewComponent(parentTag, origin)`

  Parameters:

  - parentTag (`NXOpen.TaggedObject`) – the parent part
  - origin (`NXOpen.Point3d`) – the origin point to add

  Returns: | the new part instance
  Return type: | `NXOpen.TaggedObject`

  New in version NX7.5.0.

  License requirements: None.

## DeletePunchOrDieComponent

`FormingInsertBuilder.``DeletePunchOrDieComponent`

  The action to delete the selected punch or die component

  Signature `DeletePunchOrDieComponent()`

  New in version NX7.5.0.

  License requirements: None.

## ExtractFormingRegion

`FormingInsertBuilder.``ExtractFormingRegion`

  Extract forming region.

  Signature `ExtractFormingRegion()`

  New in version NX7.5.0.

  License requirements: None.

## ReverseTrimDirection

`FormingInsertBuilder.``ReverseTrimDirection`

  Reverse trim direction.

  Signature `ReverseTrimDirection()`

  New in version NX7.5.0.

  License requirements: None.

## Validate

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