FlatPatternSettings Class — NXOpen Python API Reference 12.0.0 documentation

# FlatPatternSettings Class

class `NXOpen.SheetMetal.``FlatPatternSettings`

  Bases: `NXOpen.TaggedObject`

  Provides access to object and callout properties for sheet-metal data in flat pattern views on drawings.

  The class is created upon a query to obtain the FlatPatternView object from either a view (style) or a part (preferences). This class is not created directly by the user.

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
GetFlatPatternAllCalloutTypeDisplay | Returns the dialog names, identifiers, and enabled status for all the available callout types.
GetFlatPatternAllObjectTypeDisplay | Returns the types, colors, fonts, widths, and enabled status for all the available object types.
GetFlatPatternCalloutTypeDisplay | Returns the display data for a callout type.
GetFlatPatternObjectTypeDisplay | Returns the display data for a flat pattern object type.
SetFlatPatternCalloutTypeDisplay | Sets the display data for a callout type.
SetFlatPatternObjectTypeDisplay | Sets the display data for a flat pattern object type.

# Enumerations

FlatPatternSettingsFlatPatternObjectType Enumeration | The members of the following enumerated type are used to identify object types to the FlatPatternView API.

# Structs

FlatPatternSettingsFlatPatternCalloutTypeDisplay_Struct Struct | The members of the following structure are the display data for a callout in a flat pattern drawing member view.
FlatPatternSettingsFlatPatternObjectTypeDisplay_Struct Struct | The members of the following structure are the display data for an object in a flat pattern drawing member view.

# Method Detail

## GetFlatPatternAllCalloutTypeDisplay

`FlatPatternSettings.``GetFlatPatternAllCalloutTypeDisplay`

  Returns the dialog names, identifiers, and enabled status for all the available callout types.

  Signature `GetFlatPatternAllCalloutTypeDisplay()`

  Returns: | Array of structures with the callout type display data.
  Return type: | list of `NXOpen.SheetMetal.FlatPatternSettingsFlatPatternCalloutTypeDisplay_Struct`

  New in version NX5.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## GetFlatPatternAllObjectTypeDisplay

`FlatPatternSettings.``GetFlatPatternAllObjectTypeDisplay`

  Returns the types, colors, fonts, widths, and enabled status for all the available object types.

  Signature `GetFlatPatternAllObjectTypeDisplay()`

  Returns: | Array of structures with the object type display data.
  Return type: | list of `NXOpen.SheetMetal.FlatPatternSettingsFlatPatternObjectTypeDisplay_Struct`

  New in version NX5.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## GetFlatPatternCalloutTypeDisplay

`FlatPatternSettings.``GetFlatPatternCalloutTypeDisplay`

  Returns the display data for a callout type.

  The name member of the `NXOpen.SheetMetal.FlatPatternSettingsFlatPatternCalloutTypeDisplay_Struct` is separately allocated from the callout_type argument string. In some cases the new string will contain an extended form of the callout_type passed in, and that form should be used for subsequent calls, without modification.

  Signature `GetFlatPatternCalloutTypeDisplay(calloutType)`

  Parameters: | calloutType (str) – The name of the callout type for which to get the display data.
  Returns: | The display data for the callout type.
  Return type: | `NXOpen.SheetMetal.FlatPatternSettingsFlatPatternCalloutTypeDisplay_Struct`

  New in version NX5.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## GetFlatPatternObjectTypeDisplay

`FlatPatternSettings.``GetFlatPatternObjectTypeDisplay`

  Returns the display data for a flat pattern object type.

  Signature `GetFlatPatternObjectTypeDisplay(objectType)`

  Parameters: | objectType (`NXOpen.SheetMetal.FlatPatternSettingsFlatPatternObjectType`) – The object type for which to return the display data.
  Returns: | The display data for the flat pattern object type.
  Return type: | `NXOpen.SheetMetal.FlatPatternSettingsFlatPatternObjectTypeDisplay_Struct`

  New in version NX5.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## SetFlatPatternCalloutTypeDisplay

`FlatPatternSettings.``SetFlatPatternCalloutTypeDisplay`

  Sets the display data for a callout type.

  Signature `SetFlatPatternCalloutTypeDisplay(calloutType, displayData)`

  Parameters:

  - calloutType (str) – The name of the callout type for which to set the display data.
  - displayData (`NXOpen.SheetMetal.FlatPatternSettingsFlatPatternCalloutTypeDisplay_Struct`) – The display data for the callout type.

  New in version NX5.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## SetFlatPatternObjectTypeDisplay

`FlatPatternSettings.``SetFlatPatternObjectTypeDisplay`

  Sets the display data for a flat pattern object type.

  Signature `SetFlatPatternObjectTypeDisplay(objectType, displayData)`

  Parameters:

  - objectType (`NXOpen.SheetMetal.FlatPatternSettingsFlatPatternObjectType`) – The object type for which to get the display data.
  - displayData (`NXOpen.SheetMetal.FlatPatternSettingsFlatPatternObjectTypeDisplay_Struct`) – The display data for the flat pattern object type.

  New in version NX5.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)