NXTo2dCreator Class — NXOpen Python API Reference 12.0.0 documentation

# NXTo2dCreator Class

class `NXOpen.``NXTo2dCreator`

  Bases: `NXOpen.DexBuilder`

  Represents a `NXOpen.NXTo2dCreator` to be used when exporting the 2D Data This class is created using `NXOpen.DexManager`.

  NULL object will be returned from Commit(). The workpart should be present in the session before calling commit(). To create a new instance of this class, use `NXOpen.DexManager.CreateNxto2dCreator()`

  Default values.

  Property | Value
  --- | ---
  ExportData | ModelData
  ExportFrom | DisplayPart
  FacetBodies | 0
  Jama | 0
  MaxLineThickness | 0
  MaxSystem3DModelSpace | 0
  MaxSystemPointRes | 0
  MaxUser3DModelSpace | 0
  MaxUserPointRes | 0
  OutputFileType | NXPartFile
  OutputTo | Modeling
  OverlappingEntities | 0
  ProcessHoldFlag | 0
  SpCurveTolerance | 0.058

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
DrawingName | Returns or sets the drawing Name - name of drawing to export
ExportData | Returns or sets the export data - export model data or drawings
ExportFrom | Returns or sets the export from - this option will determine if data from display part or existing part is exported
ExportSelectionBlock | Returns the export selection block - the object selection will be done by this block.
FacetBodies | Returns or sets the facet bodies - if set to true facet bodies will be exported to 2d part
IgesSettingsFile | Returns or sets the nxto2d settings file - settings file to read default otions for iges
InputFile | Returns or sets the input file - name of file which is being exported
Jama | Returns or sets the jama - if set to true the exported data will be Japanese Automotive compliant
MaxLineThickness | Returns or sets the max line thickness - maximum line thickness in resulting iges file
MaxSystem3DModelSpace | Returns or sets the sys defmaxThreeDmdl space - if set to true then system defined maximum 3D model space will be used
MaxSystemPointRes | Returns or sets the sys defidentical point resolution - if set to true then system defined tolerance will be used to find identical points
MaxUser3DModelSpace | Returns or sets the maxThree dmdl space - if not using system defined maximum 3D model space then specifiy the new value
MaxUserPointRes | Returns or sets the identical point resolution - if not using system defined tolerance for identical points then specify new value
Nxto2dSettingsFile | Returns or sets the nxto2d settings file - settings file to read default otions for nxto2d
OutputFile | Returns or sets the output file - the name of nx/iges/dxf/dwg file where output is being written
OutputFileType | Returns or sets the output file type - output file format
OutputTo | Returns or sets the output to - where to put data in model world or drawing
OverlappingEntities | Returns or sets the overlapping entities - if set to true, the overlpping entities will be removed
ProcessHoldFlag | Returns or sets the process hold flag - set to true if user wants to wait until transaltion process gets completed
SpCurveTolerance | Returns or sets the sp curve tolerance
Tag | Returns the Tag for this object.
ViewName | Returns or sets the View Name - name of view to export

# 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.
SaveIgesSettings | Saves the save settings - this will save iges the settings to a file sepcified
SaveNxto2dSettings | Returns the save settings - this will save nxto2d the settings to a file sepcified
SetDrawingArray | Sets the drawing - sets the list of drawings to translate
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

NXTo2dCreatorExportDataOption Enumeration | Export Data Option
NXTo2dCreatorExportFromOption Enumeration | Export From Option
NXTo2dCreatorOutputAsOption Enumeration | Output As Option
NXTo2dCreatorOutputToOption Enumeration | Output To Option

# Property Detail

## DrawingName

`NXTo2dCreator.``DrawingName`

  Returns or sets the drawing Name - name of drawing to export

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

  Getter Method

  Signature `DrawingName`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DrawingName`

  Parameters: | drawingName (str) –

  New in version NX6.0.0.

  License requirements: None.

## ExportData

`NXTo2dCreator.``ExportData`

  Returns or sets the export data - export model data or drawings

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

  Getter Method

  Signature `ExportData`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ExportData`

  Parameters: | exportData (`NXOpen.NXTo2dCreatorExportDataOption`) –

  New in version NX6.0.0.

  License requirements: None.

## ExportFrom

`NXTo2dCreator.``ExportFrom`

  Returns or sets the export from - this option will determine if data from display part or existing part is exported

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

  Getter Method

  Signature `ExportFrom`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ExportFrom`

  Parameters: | exportFrom (`NXOpen.NXTo2dCreatorExportFromOption`) –

  New in version NX6.0.0.

  License requirements: None.

## ExportSelectionBlock

`NXTo2dCreator.``ExportSelectionBlock`

  Returns the export selection block - the object selection will be done by this block.

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

  Getter Method

  Signature `ExportSelectionBlock`

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

  New in version NX6.0.0.

  License requirements: None.

## FacetBodies

`NXTo2dCreator.``FacetBodies`

  Returns or sets the facet bodies - if set to true facet bodies will be exported to 2d part

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

  Getter Method

  Signature `FacetBodies`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FacetBodies`

  Parameters: | facetBodies (bool) –

  New in version NX6.0.0.

  License requirements: None.

## IgesSettingsFile

`NXTo2dCreator.``IgesSettingsFile`

  Returns or sets the nxto2d settings file - settings file to read default otions for iges

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

  Getter Method

  Signature `IgesSettingsFile`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IgesSettingsFile`

  Parameters: | filename (str) –

  New in version NX6.0.0.

  License requirements: None.

## InputFile

`NXTo2dCreator.``InputFile`

  Returns or sets the input file - name of file which is being exported

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

  Getter Method

  Signature `InputFile`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `InputFile`

  Parameters: | filename (str) –

  New in version NX6.0.0.

  License requirements: None.

## Jama

`NXTo2dCreator.``Jama`

  Returns or sets the jama - if set to true the exported data will be Japanese Automotive compliant

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

  Getter Method

  Signature `Jama`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Jama`

  Parameters: | jama (bool) –

  New in version NX6.0.0.

  License requirements: None.

## MaxLineThickness

`NXTo2dCreator.``MaxLineThickness`

  Returns or sets the max line thickness - maximum line thickness in resulting iges file

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

  Getter Method

  Signature `MaxLineThickness`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaxLineThickness`

  Parameters: | maxLineThickness (float) –

  New in version NX6.0.0.

  License requirements: None.

## MaxSystem3DModelSpace

`NXTo2dCreator.``MaxSystem3DModelSpace`

  Returns or sets the sys defmaxThreeDmdl space - if set to true then system defined maximum 3D model space will be used

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

  Getter Method

  Signature `MaxSystem3DModelSpace`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaxSystem3DModelSpace`

  Parameters: | maxSystem3DModelSpace (bool) –

  New in version NX6.0.0.

  License requirements: None.

## MaxSystemPointRes

`NXTo2dCreator.``MaxSystemPointRes`

  Returns or sets the sys defidentical point resolution - if set to true then system defined tolerance will be used to find identical points

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

  Getter Method

  Signature `MaxSystemPointRes`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaxSystemPointRes`

  Parameters: | maxSystemPointRes (bool) –

  New in version NX6.0.0.

  License requirements: None.

## MaxUser3DModelSpace

`NXTo2dCreator.``MaxUser3DModelSpace`

  Returns or sets the maxThree dmdl space - if not using system defined maximum 3D model space then specifiy the new value

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

  Getter Method

  Signature `MaxUser3DModelSpace`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaxUser3DModelSpace`

  Parameters: | maxUser3DModelSpace (float) –

  New in version NX6.0.0.

  License requirements: None.

## MaxUserPointRes

`NXTo2dCreator.``MaxUserPointRes`

  Returns or sets the identical point resolution - if not using system defined tolerance for identical points then specify new value

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

  Getter Method

  Signature `MaxUserPointRes`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaxUserPointRes`

  Parameters: | maxUserPointRes (float) –

  New in version NX6.0.0.

  License requirements: None.

## Nxto2dSettingsFile

`NXTo2dCreator.``Nxto2dSettingsFile`

  Returns or sets the nxto2d settings file - settings file to read default otions for nxto2d

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

  Getter Method

  Signature `Nxto2dSettingsFile`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Nxto2dSettingsFile`

  Parameters: | filename (str) –

  New in version NX6.0.0.

  License requirements: None.

## OutputFile

`NXTo2dCreator.``OutputFile`

  Returns or sets the output file - the name of nx/iges/dxf/dwg file where output is being written

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

  Getter Method

  Signature `OutputFile`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputFile`

  Parameters: | filename (str) –

  New in version NX6.0.0.

  License requirements: None.

## OutputFileType

`NXTo2dCreator.``OutputFileType`

  Returns or sets the output file type - output file format

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

  Getter Method

  Signature `OutputFileType`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputFileType`

  Parameters: | outputFileType (`NXOpen.NXTo2dCreatorOutputAsOption`) –

  New in version NX6.0.0.

  License requirements: None.

## OutputTo

`NXTo2dCreator.``OutputTo`

  Returns or sets the output to - where to put data in model world or drawing

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

  Getter Method

  Signature `OutputTo`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputTo`

  Parameters: | outputTo (`NXOpen.NXTo2dCreatorOutputToOption`) –

  New in version NX6.0.0.

  License requirements: None.

## OverlappingEntities

`NXTo2dCreator.``OverlappingEntities`

  Returns or sets the overlapping entities - if set to true, the overlpping entities will be removed

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

  Getter Method

  Signature `OverlappingEntities`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OverlappingEntities`

  Parameters: | overlappingEntities (bool) –

  New in version NX6.0.0.

  License requirements: None.

## SpCurveTolerance

`NXTo2dCreator.``SpCurveTolerance`

  Returns or sets the sp curve tolerance

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

  Getter Method

  Signature `SpCurveTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SpCurveTolerance`

  Parameters: | spCurveTolerance (float) –

  New in version NX6.0.0.

  License requirements: None.

## ViewName

`NXTo2dCreator.``ViewName`

  Returns or sets the View Name - name of view to export

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

  Getter Method

  Signature `ViewName`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ViewName`

  Parameters: | viewName (str) –

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## SaveIgesSettings

`NXTo2dCreator.``SaveIgesSettings`

  Saves the save settings - this will save iges the settings to a file sepcified

  Signature `SaveIgesSettings(filename)`

  Parameters: | filename (str) –

  New in version NX6.0.0.

  License requirements: None.

## SaveNxto2dSettings

`NXTo2dCreator.``SaveNxto2dSettings`

  Returns the save settings - this will save nxto2d the settings to a file sepcified

  Signature `SaveNxto2dSettings(filename)`

  Parameters: | filename (str) –

  New in version NX6.0.0.

  License requirements: None.

## SetDrawingArray

`NXTo2dCreator.``SetDrawingArray`

  Sets the drawing - sets the list of drawings to translate

  Signature `SetDrawingArray(objects)`

  Parameters: | objects (list of `NXOpen.TaggedObject`) – items in list

  New in version NX6.0.0.

  License requirements: None.

## Validate

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