FlatPatternBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FlatPatternBuilder Class

class `NXOpen.Features.SheetMetal.``FlatPatternBuilder`

  Bases: `NXOpen.Features.SheetMetal.SheetmetalBaseBuilder`

  Represents a Flat Pattern feature builder.

  To create a new instance of this class, use `NXOpen.Features.SheetMetal.SheetmetalManager.CreateFlatPatternBuilder()`

  Default values.

  Property | Value
  --- | ---
  Associative | true
  InnerCornerTreatment.TreatmentType | None
  InnerCornerTreatment.UseGlobal | 1
  InnerCornerTreatment.Value.Value | 0 (millimeters part), 0 (inches part)

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AddedGeometry | Returns the added geometry selection
Associative | Returns or sets the setting which decides whether the flattened solid will be associative to parent body.
FixAtTimestamp | Returns or sets the setting which decides whether the flattened solid will be fixed at timestamp.
FlatPatternViewName | Returns the flat pattern view name string
HoleTreatment | Returns the hole treatment object ** This is applicable to flat pattern features created in NX12 and later release.
InnerCornerTreatment | Returns the inner corner treatment corner object
Orientation | Returns or sets the option which decides if the flattened solid will be transformed to Absolute CSYS.
OrientationCsys | Returns or sets the orientation csys ** This is applicable to flat pattern features created (or renewed) in NX12 and later release.
OuterCornerTreatment | Returns the outer corner treatment corner object
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
ReferenceVertex | Returns or sets the end of the edge where the tangent will define the x axis for flat as solid.
ShowInteriorFeatureCurves | Returns or sets the show interior feature curves toggle value
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TransformToAbsoluteCsys | Returns or sets the flag which decides if the flattened solid will be transformed to Absolute CSYS.
UpwardFace | Returns the upward face selection
XAxisEdge | Returns the x axis edge selection.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GenerateMoldLines | Set the flag to generate inner and outer mold lines for flat pattern features created before NX11.
GetApplicationContext | Get the application context.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetApplicationContext | Set the application context.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## AddedGeometry

`FlatPatternBuilder.``AddedGeometry`

  Returns the added geometry selection

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

  Getter Method

  Signature `AddedGeometry`

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

  New in version NX6.0.0.

  License requirements: None.

## Associative

`FlatPatternBuilder.``Associative`

  Returns or sets the setting which decides whether the flattened solid will be associative to parent body.

  ** This is applicable to flat pattern features created in NX12 and later release. ** Cannot change during feature edit if the feature was created as non associative.

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

  Getter Method

  Signature `Associative`

  Returns: | True = Feature is associative, False = Feature is not associative.
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Associative`

  Parameters: | associative (bool) – True = Feature is associative, False = Feature is not associative.

  New in version NX12.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## FixAtTimestamp

`FlatPatternBuilder.``FixAtTimestamp`

  Returns or sets the setting which decides whether the flattened solid will be fixed at timestamp.

  ** This is applicable to flat pattern features created in NX12 and later release. ** Cannot change during feature edit if the feature was created as fixed at timestamp.

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

  Getter Method

  Signature `FixAtTimestamp`

  Returns: | True = Fix at Timestamp, False = Do not Fix at Timestamp.
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FixAtTimestamp`

  Parameters: | fixAtTimestamp (bool) – True = Fix at Timestamp, False = Do not Fix at Timestamp.

  New in version NX12.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## FlatPatternViewName

`FlatPatternBuilder.``FlatPatternViewName`

  Returns the flat pattern view name string

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

  Getter Method

  Signature `FlatPatternViewName`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

## HoleTreatment

`FlatPatternBuilder.``HoleTreatment`

  Returns the hole treatment object ** This is applicable to flat pattern features created in NX12 and later release.

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

  Getter Method

  Signature `HoleTreatment`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.HoleTreatmentBuilder`

  New in version NX12.0.0.

  License requirements: None.

## InnerCornerTreatment

`FlatPatternBuilder.``InnerCornerTreatment`

  Returns the inner corner treatment corner object

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

  Getter Method

  Signature `InnerCornerTreatment`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.CornerTreatmentBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Orientation

`FlatPatternBuilder.``Orientation`

  Returns or sets the option which decides if the flattened solid will be transformed to Absolute CSYS.

  ** This flag will only be used if the Upward face belongs to a formed sheet metal body. ** If a face from a flat solid is selected, this value will be ignored. ** This is applicable to flat solid / flat pattern features created (or renewed) to NX12 and later release.

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

  Getter Method

  Signature `Orientation`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.FlatSolidBuilderOrientationType`

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Orientation`

  Parameters: | orientation (`NXOpen.Features.SheetMetal.FlatSolidBuilderOrientationType`) –

  New in version NX12.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## OrientationCsys

`FlatPatternBuilder.``OrientationCsys`

  Returns or sets the orientation csys ** This is applicable to flat pattern features created (or renewed) in NX12 and later release.

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

  Getter Method

  Signature `OrientationCsys`

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

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OrientationCsys`

  Parameters: | csys (`NXOpen.CoordinateSystem`) –

  New in version NX12.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## OuterCornerTreatment

`FlatPatternBuilder.``OuterCornerTreatment`

  Returns the outer corner treatment corner object

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

  Getter Method

  Signature `OuterCornerTreatment`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.CornerTreatmentBuilder`

  New in version NX6.0.0.

  License requirements: None.

## ReferenceVertex

`FlatPatternBuilder.``ReferenceVertex`

  Returns or sets the end of the edge where the tangent will define the x axis for flat as solid.

  This value will only ** be used when a face from a formed solid body is picked as Upward face. If a face from a flat solid is selected, ** this value will be ignored.

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

  Getter Method

  Signature `ReferenceVertex`

  Returns: | One of the end points of the reference edge.
  Return type: | `NXOpen.Point3d`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ReferenceVertex`

  Parameters: | vertex (`NXOpen.Point3d`) – One of the end points of the reference edge.

  New in version NX7.5.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## ShowInteriorFeatureCurves

`FlatPatternBuilder.``ShowInteriorFeatureCurves`

  Returns or sets the show interior feature curves toggle value

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

  Getter Method

  Signature `ShowInteriorFeatureCurves`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowInteriorFeatureCurves`

  Parameters: | showInteriorFeatureCurves (bool) –

  New in version NX6.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## TransformToAbsoluteCsys

`FlatPatternBuilder.``TransformToAbsoluteCsys`

  Returns or sets the flag which decides if the flattened solid will be transformed to Absolute CSYS.

  This flag will only be ** used if the Upward face belongs to a formed sheet metal body. If a face from a flat solid is selected, ** this value will be ignored. ** This is applicable to flat solid / flat pattern features created before NX12 release and not yet renewed. ** The API can not be deprecated because it is required to edit features created before NX12 release. ** But user should modify automation programs written before NX12 and replace use this option with the orientation option, ** before using the program to create new features in NX12 or later.

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

  Getter Method

  Signature `TransformToAbsoluteCsys`

  Returns: | True = Transform to ABS, False = Do not transform to ABS.
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TransformToAbsoluteCsys`

  Parameters: | transformFlag (bool) – True = Transform to ABS, False = Do not transform to ABS.

  New in version NX7.5.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## UpwardFace

`FlatPatternBuilder.``UpwardFace`

  Returns the upward face selection

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

  Getter Method

  Signature `UpwardFace`

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

  New in version NX6.0.0.

  License requirements: None.

## XAxisEdge

`FlatPatternBuilder.``XAxisEdge`

  Returns the x axis edge selection.

  This edge selection is necessary when a face from a formed ** solid body is picked as Upward face. If a face from a flat solid is selected, ** this value will be ignored.

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

  Getter Method

  Signature `XAxisEdge`

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

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## GenerateMoldLines

`FlatPatternBuilder.``GenerateMoldLines`

  Set the flag to generate inner and outer mold lines for flat pattern features created before NX11.

  Signature `GenerateMoldLines()`

  New in version NX11.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## Validate

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