SpecialPiercingInsertBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SpecialPiercingInsertBuilder Class

class `NXOpen.Tooling.``SpecialPiercingInsertBuilder`

  Bases: `NXOpen.Builder`

  Creates special piercing insert for progressive die.

  No entity is returned. To create a new instance of this class, use `NXOpen.Tooling.ProgressiveDieManager.CreateSpecialPiercingInsertBuilder()`

  Default values.

  Property | Value
  --- | ---
  BoundBox | BoundedBlock
  EndLimit.Value | 0 (millimeters part), 0 (inches part)
  InsertPosition | Bottom
  NormalBbpslug | Fillet
  NormalCavity | TaperAngle
  NormalClearance | 0.05
  NormalDsslug | Fillet
  NormalOffsetSide | DieSide
  NormalSlugPara1 | 3
  NormalSlugPara2 | -3
  NormalSlugPara3 | 2
  NormalSlugPara4 | 3
  OffsetLinearDimension.Value | 3 (millimeters part), 0.12 (inches part)
  ParentPart | ProjectDie
  PlateClearanceFirst | 0
  PlateClearanceFourth | 0
  PlateClearanceSecond | 0
  PlateClearanceThird | 0
  PunchOrDie | Punch
  RenameComponent | 0
  SlugHoleHeightLinearDimension.Value | 100 (millimeters part), 4 (inches part)
  StandardOrUserDefined | Standard
  StartLimit.Value | 0 (millimeters part), 0 (inches part)
  UsePlateClearanceFirst | 0
  UsePlateClearanceFourth | 0
  UsePlateClearanceSecond | 0
  UsePlateClearanceThird | 0

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
BoundBox | Returns or sets the block or cylinder
BoxPosition | Returns or sets the position of csys for box.
EndLimit | Returns the end limit
InsertPosition | Returns or sets the reverse direction
Is3DCurves | Returns or sets the result whether the curves is three dimensional
NormalBbpslug | Returns or sets the bottom plate slug type for normal pierce design.
NormalCavity | Returns or sets the cavity type for normal pierce design.
NormalClearance | Returns or sets the clearance value for normal pierce design.
NormalDsslug | Returns or sets the die shoe slug type for normal pierce design.
NormalOffsetSide | Returns or sets the offset side option for normal pierce design.
NormalSlugPara1 | Returns or sets the H value of slug hole for normal pierce design.
NormalSlugPara2 | Returns or sets the A value of slug hole for normal pierce design.
NormalSlugPara3 | Returns or sets the C1 value of slug hole for normal pierce design.
NormalSlugPara4 | Returns or sets the C2 value of slug hole for normal pierce design.
OffsetLinearDimension | Returns the offset linear dimension
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
ParentPart | Returns or sets the parent part
ParentPartName | Returns or sets the parent part name to create insert.
PlateClearanceFirst | Returns or sets the plate clearance first
PlateClearanceFourth | Returns or sets the plate clearance fourth
PlateClearanceSecond | Returns or sets the plate clearance second
PlateClearanceThird | Returns or sets the plate clearance third
PunchOrDie | Returns or sets the punch or die
RadialOffset | Returns the radial offset value for cylinder box
RenameComponent | Returns or sets the rename component
SelectCurves | Returns the select curves
SelectEdges | Returns the select curve
SelectFace | Returns the select face
SelectInsert | Returns the select insert
SelectVector | Returns or sets the select vector
SlugHoleHeightLinearDimension | Returns the slug hole height linear dimension
StandardOrUserDefined | Returns or sets the standard or user defined
StartLimit | Returns the start limit
Tag | Returns the Tag for this object.
Type | Returns or sets the type
UsePlateClearanceFirst | Returns or sets the use plate clearance first
UsePlateClearanceFourth | Returns or sets the use plate clearance fourth
UsePlateClearanceSecond | Returns or sets the use plate clearance second
UsePlateClearanceThird | Returns or sets the use plate clearance third
WizardType | Returns or sets the wizard type

# Methods

Method | Description
--- | ---
AddInsertPartIntoAssembly | Add insert part into assembly.
CalculateBoxSize | Calculate box size and set directions, edge length, lower point position.
Commit | Commits any edits that have been applied to the builder.
CreateDatumPlane | The create datum plane
CreateIntersect | Create intersect.
CreateKFBoundBox | Create bound box.
CreateOffsetDatumPlane | Create offset datum plane
DeleteSelectedInsertAndWaveLinkedSource | Delete selected insert and wave linked source 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.
GetCorrectEdgeInNewPart | Get correct edge in new part
GetCorrectFacesOfExtractRegionFeature | Get correct faces of extrac region feature.
GetHoleBoundaryFaceAndCreatePatchOpenings | Get hole boundary face and create patch openings.
GetObject | Returns the object currently being edited by this builder.
GetProfile | Get profiles
GetWaveLinkedCurves | Get wave linked curves
SetBoxMatrixAndPosition | Sets box csys matrix.
SetWCSForSpecialPiercingInsert | Set work coordinate system for special piercing insert
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
SuppressAllFeatureAfter | Suppress child feature.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.
WaveFacesAndFillHole | Wave faces and fill hole
WaveFacesOfSelectedCurves | Wave faces of selected curves
WaveIntersectBodyToNewDieInsertPart | Wave intersect body to new die insert part.
WaveSelectedCurves | Wave selected curves

# Enumerations

SpecialPiercingInsertBuilderBoundBoxType Enumeration | Specifies the bounded box type block or cylinder.
SpecialPiercingInsertBuilderInsertPositionTypes Enumeration | Specifies the position of piercing inserts, for EDW only
SpecialPiercingInsertBuilderNormalBottomBackingPlateSlugType Enumeration | Specifies the type of bottom plate slug.
SpecialPiercingInsertBuilderNormalCavityType Enumeration | Specifies the type of cavity.
SpecialPiercingInsertBuilderNormalDieShoeSlugType Enumeration | Specifies the type of die shoe slug.
SpecialPiercingInsertBuilderNormalOffsetSideType Enumeration | Specifies the offset side of normal pierce insert design.
SpecialPiercingInsertBuilderParentPartTypes Enumeration | Specifies the parent part type.
SpecialPiercingInsertBuilderPunchOrDieTypes Enumeration | Specifies the parent part type.
SpecialPiercingInsertBuilderStandardOrUserDefinedTypes Enumeration | Specifies the parent part type.
SpecialPiercingInsertBuilderTypes Enumeration | Specifies the parent part type.

# Property Detail

## BoundBox

`SpecialPiercingInsertBuilder.``BoundBox`

  Returns or sets the block or cylinder

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

  Getter Method

  Signature `BoundBox`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BoundBox`

  Parameters: | boundBoxType (`NXOpen.Tooling.SpecialPiercingInsertBuilderBoundBoxType`) –

  New in version NX11.0.0.

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

## BoxPosition

`SpecialPiercingInsertBuilder.``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”)

## EndLimit

`SpecialPiercingInsertBuilder.``EndLimit`

  Returns the end limit

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

  Getter Method

  Signature `EndLimit`

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

  New in version NX11.0.0.

  License requirements: None.

## InsertPosition

`SpecialPiercingInsertBuilder.``InsertPosition`

  Returns or sets the reverse direction

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

  Getter Method

  Signature `InsertPosition`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `InsertPosition`

  Parameters: | insertPosition (`NXOpen.Tooling.SpecialPiercingInsertBuilderInsertPositionTypes`) –

  New in version NX8.0.0.

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

## Is3DCurves

`SpecialPiercingInsertBuilder.``Is3DCurves`

  Returns or sets the result whether the curves is three dimensional

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

  Getter Method

  Signature `Is3DCurves`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Is3DCurves`

  Parameters: | is3DCurves (bool) –

  New in version NX9.0.0.

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

## NormalBbpslug

`SpecialPiercingInsertBuilder.``NormalBbpslug`

  Returns or sets the bottom plate slug type for normal pierce design.

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

  Getter Method

  Signature `NormalBbpslug`

  Returns: | Indicates bottom plate slug type for normal pierce design
  Return type: | `NXOpen.Tooling.SpecialPiercingInsertBuilderNormalBottomBackingPlateSlugType`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NormalBbpslug`

  Parameters: | normalBbpslug (`NXOpen.Tooling.SpecialPiercingInsertBuilderNormalBottomBackingPlateSlugType`) – Indicates bottom plate slug type for normal pierce design

  New in version NX11.0.0.

  License requirements: None.

## NormalCavity

`SpecialPiercingInsertBuilder.``NormalCavity`

  Returns or sets the cavity type for normal pierce design.

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

  Getter Method

  Signature `NormalCavity`

  Returns: | Indicates the cavity type for normal pierce design
  Return type: | `NXOpen.Tooling.SpecialPiercingInsertBuilderNormalCavityType`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NormalCavity`

  Parameters: | normalCavity (`NXOpen.Tooling.SpecialPiercingInsertBuilderNormalCavityType`) – Indicates the cavity type for normal pierce design

  New in version NX11.0.0.

  License requirements: None.

## NormalClearance

`SpecialPiercingInsertBuilder.``NormalClearance`

  Returns or sets the clearance value for normal pierce design.

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

  Getter Method

  Signature `NormalClearance`

  Returns: | Indicates the clearance value for normal pierce design
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NormalClearance`

  Parameters: | normalClearance (float) – Indicates the clearance value for normal pierce design

  New in version NX11.0.0.

  License requirements: None.

## NormalDsslug

`SpecialPiercingInsertBuilder.``NormalDsslug`

  Returns or sets the die shoe slug type for normal pierce design.

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

  Getter Method

  Signature `NormalDsslug`

  Returns: | Indicates die shoe slug type for normal pierce design
  Return type: | `NXOpen.Tooling.SpecialPiercingInsertBuilderNormalDieShoeSlugType`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NormalDsslug`

  Parameters: | normalDsslug (`NXOpen.Tooling.SpecialPiercingInsertBuilderNormalDieShoeSlugType`) – Indicates die shoe slug type for normal pierce design

  New in version NX11.0.0.

  License requirements: None.

## NormalOffsetSide

`SpecialPiercingInsertBuilder.``NormalOffsetSide`

  Returns or sets the offset side option for normal pierce design.

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

  Getter Method

  Signature `NormalOffsetSide`

  Returns: | Indicates the offset side option for normal pierce design
  Return type: | `NXOpen.Tooling.SpecialPiercingInsertBuilderNormalOffsetSideType`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NormalOffsetSide`

  Parameters: | normalOffsetSide (`NXOpen.Tooling.SpecialPiercingInsertBuilderNormalOffsetSideType`) – Indicates the offset side option for normal pierce design

  New in version NX11.0.0.

  License requirements: None.

## NormalSlugPara1

`SpecialPiercingInsertBuilder.``NormalSlugPara1`

  Returns or sets the H value of slug hole for normal pierce design.

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

  Getter Method

  Signature `NormalSlugPara1`

  Returns: | Indicates the H value of slug hole for normal pierce design
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NormalSlugPara1`

  Parameters: | normalSlugPara1 (float) – Indicates the H value of slug hole for normal pierce design

  New in version NX11.0.0.

  License requirements: None.

## NormalSlugPara2

`SpecialPiercingInsertBuilder.``NormalSlugPara2`

  Returns or sets the A value of slug hole for normal pierce design.

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

  Getter Method

  Signature `NormalSlugPara2`

  Returns: | Indicates A value of slug hole for normal pierce design
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NormalSlugPara2`

  Parameters: | normalSlugPara2 (float) – Indicates A value of slug hole for normal pierce design

  New in version NX11.0.0.

  License requirements: None.

## NormalSlugPara3

`SpecialPiercingInsertBuilder.``NormalSlugPara3`

  Returns or sets the C1 value of slug hole for normal pierce design.

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

  Getter Method

  Signature `NormalSlugPara3`

  Returns: | Indicates C1 value of slug hole for normal pierce design
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NormalSlugPara3`

  Parameters: | normalSlugPara3 (float) – Indicates C1 value of slug hole for normal pierce design

  New in version NX11.0.0.

  License requirements: None.

## NormalSlugPara4

`SpecialPiercingInsertBuilder.``NormalSlugPara4`

  Returns or sets the C2 value of slug hole for normal pierce design.

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

  Getter Method

  Signature `NormalSlugPara4`

  Returns: | Indicates the C2 value of slug hole for normal pierce design
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NormalSlugPara4`

  Parameters: | normalSlugPara4 (float) – Indicates the C2 value of slug hole for normal pierce design

  New in version NX11.0.0.

  License requirements: None.

## OffsetLinearDimension

`SpecialPiercingInsertBuilder.``OffsetLinearDimension`

  Returns the offset linear dimension

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

  Getter Method

  Signature `OffsetLinearDimension`

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

  New in version NX11.0.0.

  License requirements: None.

## OffsetValueLinearDimensionNegativeX

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

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

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

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

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

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

## ParentPart

`SpecialPiercingInsertBuilder.``ParentPart`

  Returns or sets the parent part

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

  Getter Method

  Signature `ParentPart`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ParentPart`

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

  New in version NX11.0.0.

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

## ParentPartName

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

## PlateClearanceFirst

`SpecialPiercingInsertBuilder.``PlateClearanceFirst`

  Returns or sets the plate clearance first

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

  Getter Method

  Signature `PlateClearanceFirst`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PlateClearanceFirst`

  Parameters: | plateClearanceFirst (float) –

  New in version NX11.0.0.

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

## PlateClearanceFourth

`SpecialPiercingInsertBuilder.``PlateClearanceFourth`

  Returns or sets the plate clearance fourth

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

  Getter Method

  Signature `PlateClearanceFourth`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PlateClearanceFourth`

  Parameters: | plateClearanceFourth (float) –

  New in version NX11.0.0.

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

## PlateClearanceSecond

`SpecialPiercingInsertBuilder.``PlateClearanceSecond`

  Returns or sets the plate clearance second

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

  Getter Method

  Signature `PlateClearanceSecond`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PlateClearanceSecond`

  Parameters: | plateClearanceSecond (float) –

  New in version NX11.0.0.

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

## PlateClearanceThird

`SpecialPiercingInsertBuilder.``PlateClearanceThird`

  Returns or sets the plate clearance third

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

  Getter Method

  Signature `PlateClearanceThird`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PlateClearanceThird`

  Parameters: | plateClearanceThird (float) –

  New in version NX11.0.0.

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

## PunchOrDie

`SpecialPiercingInsertBuilder.``PunchOrDie`

  Returns or sets the punch or die

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

  Getter Method

  Signature `PunchOrDie`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PunchOrDie`

  Parameters: | punchOrDie (`NXOpen.Tooling.SpecialPiercingInsertBuilderPunchOrDieTypes`) –

  New in version NX11.0.0.

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

## RadialOffset

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

## RenameComponent

`SpecialPiercingInsertBuilder.``RenameComponent`

  Returns or sets the rename component

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

  Getter Method

  Signature `RenameComponent`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RenameComponent`

  Parameters: | renameComponent (bool) –

  New in version NX11.0.0.

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

## SelectCurves

`SpecialPiercingInsertBuilder.``SelectCurves`

  Returns the select curves

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

  Getter Method

  Signature `SelectCurves`

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

  New in version NX11.0.0.

  License requirements: None.

## SelectEdges

`SpecialPiercingInsertBuilder.``SelectEdges`

  Returns the select curve

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

  Getter Method

  Signature `SelectEdges`

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

  New in version NX11.0.0.

  License requirements: None.

## SelectFace

`SpecialPiercingInsertBuilder.``SelectFace`

  Returns the select face

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

  Getter Method

  Signature `SelectFace`

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

  New in version NX11.0.0.

  License requirements: None.

## SelectInsert

`SpecialPiercingInsertBuilder.``SelectInsert`

  Returns the select insert

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

  Getter Method

  Signature `SelectInsert`

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

  New in version NX11.0.0.

  License requirements: None.

## SelectVector

`SpecialPiercingInsertBuilder.``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”)

## SlugHoleHeightLinearDimension

`SpecialPiercingInsertBuilder.``SlugHoleHeightLinearDimension`

  Returns the slug hole height linear dimension

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

  Getter Method

  Signature `SlugHoleHeightLinearDimension`

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

  New in version NX11.0.0.

  License requirements: None.

## StandardOrUserDefined

`SpecialPiercingInsertBuilder.``StandardOrUserDefined`

  Returns or sets the standard or user defined

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

  Getter Method

  Signature `StandardOrUserDefined`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StandardOrUserDefined`

  Parameters: | standardOrUserDefined (`NXOpen.Tooling.SpecialPiercingInsertBuilderStandardOrUserDefinedTypes`) –

  New in version NX11.0.0.

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

## StartLimit

`SpecialPiercingInsertBuilder.``StartLimit`

  Returns the start limit

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

  Getter Method

  Signature `StartLimit`

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

  New in version NX11.0.0.

  License requirements: None.

## Type

`SpecialPiercingInsertBuilder.``Type`

  Returns or sets the type

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

  Getter Method

  Signature `Type`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

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

  New in version NX11.0.0.

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

## UsePlateClearanceFirst

`SpecialPiercingInsertBuilder.``UsePlateClearanceFirst`

  Returns or sets the use plate clearance first

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

  Getter Method

  Signature `UsePlateClearanceFirst`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePlateClearanceFirst`

  Parameters: | usePlateClearanceFirst (bool) –

  New in version NX11.0.0.

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

## UsePlateClearanceFourth

`SpecialPiercingInsertBuilder.``UsePlateClearanceFourth`

  Returns or sets the use plate clearance fourth

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

  Getter Method

  Signature `UsePlateClearanceFourth`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePlateClearanceFourth`

  Parameters: | usePlateClearanceFourth (bool) –

  New in version NX11.0.0.

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

## UsePlateClearanceSecond

`SpecialPiercingInsertBuilder.``UsePlateClearanceSecond`

  Returns or sets the use plate clearance second

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

  Getter Method

  Signature `UsePlateClearanceSecond`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePlateClearanceSecond`

  Parameters: | usePlateClearanceSecond (bool) –

  New in version NX11.0.0.

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

## UsePlateClearanceThird

`SpecialPiercingInsertBuilder.``UsePlateClearanceThird`

  Returns or sets the use plate clearance third

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

  Getter Method

  Signature `UsePlateClearanceThird`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePlateClearanceThird`

  Parameters: | usePlateClearanceThird (bool) –

  New in version NX11.0.0.

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

## WizardType

`SpecialPiercingInsertBuilder.``WizardType`

  Returns or sets the wizard type

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

  Getter Method

  Signature `WizardType`

  Returns: |
  Return type: | int

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WizardType`

  Parameters: | wizardType (int) –

  New in version NX9.0.0.

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

# Method Detail

## AddInsertPartIntoAssembly

`SpecialPiercingInsertBuilder.``AddInsertPartIntoAssembly`

  Add insert part into assembly.

  Signature `AddInsertPartIntoAssembly(parentPart, templatePartName, origin)`

  Parameters:

  - parentPart (`NXOpen.NXObject`) –
  - templatePartName (str) –
  - origin (`NXOpen.Point3d`) –

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

  New in version NX11.0.0.

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

## CalculateBoxSize

`SpecialPiercingInsertBuilder.``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”)

## CreateDatumPlane

`SpecialPiercingInsertBuilder.``CreateDatumPlane`

  The create datum plane

  Signature `CreateDatumPlane()`

  New in version NX11.0.0.

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

## CreateIntersect

`SpecialPiercingInsertBuilder.``CreateIntersect`

  Create intersect.

  Signature `CreateIntersect(targetBody, bodyOfKFBoundBox)`

  Parameters:

  - targetBody (`NXOpen.NXObject`) –
  - bodyOfKFBoundBox (`NXOpen.NXObject`) –

  New in version NX11.0.0.

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

## CreateKFBoundBox

`SpecialPiercingInsertBuilder.``CreateKFBoundBox`

  Create bound box.

  Signature `CreateKFBoundBox(wcsMatrix, clearance, faces)`

  Parameters:

  - wcsMatrix (`NXOpen.Matrix3x3`) –
  - clearance (list of float) –
  - faces (list of `NXOpen.NXObject`) –

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

  New in version NX11.0.0.

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

## CreateOffsetDatumPlane

`SpecialPiercingInsertBuilder.``CreateOffsetDatumPlane`

  Create offset datum plane

  Signature `CreateOffsetDatumPlane()`

  New in version NX11.0.0.

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

## DeleteSelectedInsertAndWaveLinkedSource

`SpecialPiercingInsertBuilder.``DeleteSelectedInsertAndWaveLinkedSource`

  Delete selected insert and wave linked source feature.

  Signature `DeleteSelectedInsertAndWaveLinkedSource()`

  New in version NX11.0.0.

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

## GetCorrectEdgeInNewPart

`SpecialPiercingInsertBuilder.``GetCorrectEdgeInNewPart`

  Get correct edge in new part

  Signature `GetCorrectEdgeInNewPart(partTag, sourceEdge)`

  Parameters:

  - partTag (`NXOpen.Part`) –
  - sourceEdge (`NXOpen.Edge`) –

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

  New in version NX11.0.0.

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

## GetCorrectFacesOfExtractRegionFeature

`SpecialPiercingInsertBuilder.``GetCorrectFacesOfExtractRegionFeature`

  Get correct faces of extrac region feature.

  Signature `GetCorrectFacesOfExtractRegionFeature()`

  Returns: |
  Return type: | list of `NXOpen.Face`

  New in version NX11.0.0.

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

## GetHoleBoundaryFaceAndCreatePatchOpenings

`SpecialPiercingInsertBuilder.``GetHoleBoundaryFaceAndCreatePatchOpenings`

  Get hole boundary face and create patch openings.

  Signature `GetHoleBoundaryFaceAndCreatePatchOpenings(edges)`

  Parameters: | edges (list of `NXOpen.NXObject`) –
  Returns: |
  Return type: | `NXOpen.NXObject`

  New in version NX11.0.0.

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

## GetProfile

`SpecialPiercingInsertBuilder.``GetProfile`

  Get profiles

  Signature `GetProfile(sectionTag)`

  Parameters: | sectionTag (`NXOpen.Section`) –
  Returns: |
  Return type: | list of `NXOpen.Curve`

  New in version NX11.0.0.

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

## GetWaveLinkedCurves

`SpecialPiercingInsertBuilder.``GetWaveLinkedCurves`

  Get wave linked curves

  Signature `GetWaveLinkedCurves()`

  Returns: |
  Return type: | list of `NXOpen.Curve`

  New in version NX11.0.0.

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

## SetBoxMatrixAndPosition

`SpecialPiercingInsertBuilder.``SetBoxMatrixAndPosition`

  Sets box csys matrix.

  Signature `SetBoxMatrixAndPosition(matrix, position)`

  Parameters:

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

  New in version NX11.0.0.

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

## SetWCSForSpecialPiercingInsert

`SpecialPiercingInsertBuilder.``SetWCSForSpecialPiercingInsert`

  Set work coordinate system for special piercing insert

  Signature `SetWCSForSpecialPiercingInsert(needPrecisionValue)`

  Parameters: | needPrecisionValue (bool) –

  New in version NX11.0.0.

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

## SuppressAllFeatureAfter

`SpecialPiercingInsertBuilder.``SuppressAllFeatureAfter`

  Suppress child feature.

  Signature `SuppressAllFeatureAfter(featureTag, suppressChildren)`

  Parameters:

  - featureTag (`NXOpen.NXObject`) –
  - suppressChildren (bool) –

  New in version NX11.0.0.

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

## Validate

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

## WaveFacesAndFillHole

`SpecialPiercingInsertBuilder.``WaveFacesAndFillHole`

  Wave faces and fill hole

  Signature `WaveFacesAndFillHole(rootPart, instanceTag)`

  Parameters:

  - rootPart (`NXOpen.Part`) –
  - instanceTag (`NXOpen.NXObject`) –

  New in version NX11.0.0.

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

## WaveFacesOfSelectedCurves

`SpecialPiercingInsertBuilder.``WaveFacesOfSelectedCurves`

  Wave faces of selected curves

  Signature `WaveFacesOfSelectedCurves(rootPart, instanceTag)`

  Parameters:

  - rootPart (`NXOpen.Part`) –
  - instanceTag (`NXOpen.NXObject`) –

  New in version NX11.0.0.

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

## WaveIntersectBodyToNewDieInsertPart

`SpecialPiercingInsertBuilder.``WaveIntersectBodyToNewDieInsertPart`

  Wave intersect body to new die insert part.

  Signature `WaveIntersectBodyToNewDieInsertPart(bodies)`

  Parameters: | bodies (list of `NXOpen.NXObject`) –

  New in version NX11.0.0.

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

## WaveSelectedCurves

`SpecialPiercingInsertBuilder.``WaveSelectedCurves`

  Wave selected curves

  Signature `WaveSelectedCurves()`

  New in version NX11.0.0.

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