DirectUnfoldBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DirectUnfoldBuilder Class

class `NXOpen.Tooling.``DirectUnfoldBuilder`

  Bases: `NXOpen.Builder`

  The builder contains all inputs for direct unfolding.

  They are: name of current design part name of bodies in current part planar faces for auto-recogniton …

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

  Default values.

  Property | Value
  --- | ---
  Angle1 | 30
  Angle2 | 30
  Angle3 | 30
  Angle4 | 30
  Angle5 | 30
  Angle6 | 30
  CurBodies | None
  DefineNeutralFactor.BendDevelopedLength | 0
  DefineNeutralFactor.NeutralFactor | 0.40
  DefineNeutralFactor.NeutralFactorFormula | General
  DefineNeutralFactor.PartMaterial | 08
  DesignSequence | 0
  DevLength (deprecated) | 0
  InterRenameComp | 0
  Materials (deprecated) | Steel
  NumBends | Two
  NumInter | 1
  OrientPitch | 0
  Pitch | 0
  StartStation | 2

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AdditionalBendFaces | Returns the additional bend faces
Angle1 | Returns or sets the first angle of prebend.
Angle2 | Returns or sets the second angle of prebend.
Angle3 | Returns or sets the third angle of prebend.
Angle4 | Returns or sets the fourth angle of prebend.
Angle5 | Returns or sets the fifth angle of prebend.
Angle6 | Returns or sets the sixth angle of prebend.
CurBodies | Returns or sets the current body list.
DefineNeutralFactor | Returns the define neutral factor builder which contains new neutral factor, part material and bend developed length
DesignSequence | Returns or sets the design sequence.
DevLength | Returns or sets the operations to developed length of a bend.
EditOption | Returns or sets the edit intermediate stage option.
InterNamingRule | Returns or sets the naming rule of intermediate stages.
InterRenameComp | Returns or sets the switch of rename components.
InterStage | Returns the intermediate stages selected as the reference of insert.
KFactor | Returns or sets the operations of k factor for a single bend.
Materials | Returns or sets the materials available in PDW.
NumBends | Returns or sets the number of bends.
NumInter | Returns or sets the number of intermediate stages.
OrientPitch | Returns or sets the orientation of pitch.
Pitch | Returns or sets the pitch.
SelPlanarFaces | Returns the planar faces selected as the start of automatic recognition.
SelectBend | Returns the selection list that stores bend faces.
StartStation | Returns or sets the start station.
Tag | Returns the Tag for this object.
UnfoldType | Returns or sets the type of direct unfold, the name get_type has been used

# 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.
KByMaterial | Evaluates K factors for every bend by giving material, radius of the bend and thickenss of the part.
LoadDatabase | Opens process_data Speadsheet in PDW.
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

DirectUnfoldBuilderBend Enumeration | The number of children bends in defining prebend.
DirectUnfoldBuilderBodyList Enumeration | The name list of bodies in current part.
DirectUnfoldBuilderMatType Enumeration | The material database defined in PDW.
DirectUnfoldBuilderTypes Enumeration | Specifies the option of direct unfold type

# Property Detail

## AdditionalBendFaces

`DirectUnfoldBuilder.``AdditionalBendFaces`

  Returns the additional bend faces

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

  Getter Method

  Signature `AdditionalBendFaces`

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

  New in version NX11.0.0.

  License requirements: None.

## Angle1

`DirectUnfoldBuilder.``Angle1`

  Returns or sets the first angle of prebend.

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

  Getter Method

  Signature `Angle1`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Angle1`

  Parameters: | angle1 (float) –

  New in version NX6.0.0.

  License requirements: None.

## Angle2

`DirectUnfoldBuilder.``Angle2`

  Returns or sets the second angle of prebend.

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

  Getter Method

  Signature `Angle2`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Angle2`

  Parameters: | angle2 (float) –

  New in version NX6.0.0.

  License requirements: None.

## Angle3

`DirectUnfoldBuilder.``Angle3`

  Returns or sets the third angle of prebend.

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

  Getter Method

  Signature `Angle3`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Angle3`

  Parameters: | angle3 (float) –

  New in version NX6.0.0.

  License requirements: None.

## Angle4

`DirectUnfoldBuilder.``Angle4`

  Returns or sets the fourth angle of prebend.

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

  Getter Method

  Signature `Angle4`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Angle4`

  Parameters: | angle4 (float) –

  New in version NX6.0.0.

  License requirements: None.

## Angle5

`DirectUnfoldBuilder.``Angle5`

  Returns or sets the fifth angle of prebend.

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

  Getter Method

  Signature `Angle5`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Angle5`

  Parameters: | angle5 (float) –

  New in version NX6.0.0.

  License requirements: None.

## Angle6

`DirectUnfoldBuilder.``Angle6`

  Returns or sets the sixth angle of prebend.

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

  Getter Method

  Signature `Angle6`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Angle6`

  Parameters: | angle6 (float) –

  New in version NX6.0.0.

  License requirements: None.

## CurBodies

`DirectUnfoldBuilder.``CurBodies`

  Returns or sets the current body list.

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

  Getter Method

  Signature `CurBodies`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CurBodies`

  Parameters: | curBodies (`NXOpen.Tooling.DirectUnfoldBuilderBodyList`) –

  New in version NX6.0.0.

  License requirements: None.

## DefineNeutralFactor

`DirectUnfoldBuilder.``DefineNeutralFactor`

  Returns the define neutral factor builder which contains new neutral factor, part material and bend developed length

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

  Getter Method

  Signature `DefineNeutralFactor`

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

  New in version NX10.0.0.

  License requirements: None.

## DesignSequence

`DirectUnfoldBuilder.``DesignSequence`

  Returns or sets the design sequence.

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

  Getter Method

  Signature `DesignSequence`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DesignSequence`

  Parameters: | designSequence (int) –

  New in version NX7.5.0.

  License requirements: None.

## DevLength

`DirectUnfoldBuilder.``DevLength`

  Returns or sets the operations to developed length of a bend.

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

  Getter Method

  Signature `DevLength`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: Use `Tooling.DefineNeutralFactorBuilder.BendDevelopedLength()` instead.

  License requirements: None.

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

  Setter Method

  Signature `DevLength`

  Parameters: | devLength (float) –

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: Use `Tooling.DefineNeutralFactorBuilder.BendDevelopedLength()` instead.

  License requirements: None.

## EditOption

`DirectUnfoldBuilder.``EditOption`

  Returns or sets the edit intermediate stage option.

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

  Getter Method

  Signature `EditOption`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `EditOption`

  Parameters: | editOption (int) –

  New in version NX7.5.0.

  License requirements: None.

## InterNamingRule

`DirectUnfoldBuilder.``InterNamingRule`

  Returns or sets the naming rule of intermediate stages.

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

  Getter Method

  Signature `InterNamingRule`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `InterNamingRule`

  Parameters: | interNamingRule (str) –

  New in version NX6.0.0.

  License requirements: None.

## InterRenameComp

`DirectUnfoldBuilder.``InterRenameComp`

  Returns or sets the switch of rename components.

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

  Getter Method

  Signature `InterRenameComp`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `InterRenameComp`

  Parameters: | interRenameComp (bool) –

  New in version NX6.0.0.

  License requirements: None.

## InterStage

`DirectUnfoldBuilder.``InterStage`

  Returns the intermediate stages selected as the reference of insert.

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

  Getter Method

  Signature `InterStage`

  Returns: |
  Return type: | `NXOpen.Assemblies.SelectComponent`

  New in version NX7.5.0.

  License requirements: None.

## KFactor

`DirectUnfoldBuilder.``KFactor`

  Returns or sets the operations of k factor for a single bend.

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

  Getter Method

  Signature `KFactor`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: Use `Tooling.DefineNeutralFactorBuilder.NeutralFactor()` instead.

  License requirements: None.

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

  Setter Method

  Signature `KFactor`

  Parameters: | kFactor (str) –

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: Use `Tooling.DefineNeutralFactorBuilder.NeutralFactor()` instead.

  License requirements: None.

## Materials

`DirectUnfoldBuilder.``Materials`

  Returns or sets the materials available in PDW.

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

  Getter Method

  Signature `Materials`

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

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: Use `Tooling.DefineNeutralFactorBuilder.PartMaterial()` instead.

  License requirements: None.

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

  Setter Method

  Signature `Materials`

  Parameters: | materials (`NXOpen.Tooling.DirectUnfoldBuilderMatType`) –

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: Use `Tooling.DefineNeutralFactorBuilder.PartMaterial()` instead.

  License requirements: None.

## NumBends

`DirectUnfoldBuilder.``NumBends`

  Returns or sets the number of bends.

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

  Getter Method

  Signature `NumBends`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumBends`

  Parameters: | numBends (`NXOpen.Tooling.DirectUnfoldBuilderBend`) –

  New in version NX6.0.0.

  License requirements: None.

## NumInter

`DirectUnfoldBuilder.``NumInter`

  Returns or sets the number of intermediate stages.

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

  Getter Method

  Signature `NumInter`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumInter`

  Parameters: | numInter (int) –

  New in version NX6.0.0.

  License requirements: None.

## OrientPitch

`DirectUnfoldBuilder.``OrientPitch`

  Returns or sets the orientation of pitch.

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

  Getter Method

  Signature `OrientPitch`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `OrientPitch`

  Parameters: | orientPitch (int) –

  New in version NX7.5.0.

  License requirements: None.

## Pitch

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

## SelPlanarFaces

`DirectUnfoldBuilder.``SelPlanarFaces`

  Returns the planar faces selected as the start of automatic recognition.

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

  Getter Method

  Signature `SelPlanarFaces`

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

  New in version NX6.0.0.

  License requirements: None.

## SelectBend

`DirectUnfoldBuilder.``SelectBend`

  Returns the selection list that stores bend faces.

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

  Getter Method

  Signature `SelectBend`

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

  New in version NX6.0.0.

  License requirements: None.

## StartStation

`DirectUnfoldBuilder.``StartStation`

  Returns or sets the start station.

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

  Getter Method

  Signature `StartStation`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `StartStation`

  Parameters: | startStation (int) –

  New in version NX7.5.0.

  License requirements: None.

## UnfoldType

`DirectUnfoldBuilder.``UnfoldType`

  Returns or sets the type of direct unfold, the name get_type has been used

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

  Getter Method

  Signature `UnfoldType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UnfoldType`

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

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## KByMaterial

`DirectUnfoldBuilder.``KByMaterial`

  Evaluates K factors for every bend by giving material, radius of the bend and thickenss of the part.

  Signature `KByMaterial()`

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: This functionality is no longer supported.

  License requirements: None.

## LoadDatabase

`DirectUnfoldBuilder.``LoadDatabase`

  Opens process_data Speadsheet in PDW.

  Signature `LoadDatabase()`

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: This functionality is no longer supported.

  License requirements: None.

## Validate

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