STLImporter Class — NXOpen Python API Reference 12.0.0 documentation

# STLImporter Class

class `NXOpen.``STLImporter`

  Bases: `NXOpen.Importer`

  Used to import an STL file into the work part.

  To obtain an instance of this class use `ImportManager.CreateStlImporter()`.

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AngularTolerance | Returns or sets the angular tolerance.
DisplayInformation | Returns or sets the Display Information flag.
FileFormat | Returns or sets the file format.
FileName | Returns or sets the name of the file containing the data to import.
FileUnits | Returns or sets the file units.
HideSmoothEdges | Returns or sets the Hide Smooth Edges flag.
Tag | Returns the Tag for this object.

# 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.
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

STLImporterAngularToleranceType Enumeration | Specifies the angular tolerance.
STLImporterFileFormatType Enumeration | Specifies the STL file format.
STLImporterFileUnitsType Enumeration | Specifies the STL file units.

# Property Detail

## AngularTolerance

`STLImporter.``AngularTolerance`

  Returns or sets the angular tolerance.

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

  Getter Method

  Signature `AngularTolerance`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngularTolerance`

  Parameters: | angularTolerance (`NXOpen.STLImporterAngularToleranceType`) –

  New in version NX5.0.0.

  License requirements: None.

## DisplayInformation

`STLImporter.``DisplayInformation`

  Returns or sets the Display Information flag.

  True if the Display Information flag is on.

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

  Getter Method

  Signature `DisplayInformation`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DisplayInformation`

  Parameters: | displayInformation (bool) –

  New in version NX5.0.0.

  License requirements: None.

## FileFormat

`STLImporter.``FileFormat`

  Returns or sets the file format.

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

  Getter Method

  Signature `FileFormat`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FileFormat`

  Parameters: | fileFormat (`NXOpen.STLImporterFileFormatType`) –

  New in version NX5.0.0.

  License requirements: None.

## FileUnits

`STLImporter.``FileUnits`

  Returns or sets the file units.

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

  Getter Method

  Signature `FileUnits`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FileUnits`

  Parameters: | fileUnits (`NXOpen.STLImporterFileUnitsType`) –

  New in version NX5.0.0.

  License requirements: None.

## HideSmoothEdges

`STLImporter.``HideSmoothEdges`

  Returns or sets the Hide Smooth Edges flag.

  True if the Hide Smooth Edges flag is on.

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

  Getter Method

  Signature `HideSmoothEdges`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HideSmoothEdges`

  Parameters: | hideSmoothEdges (bool) –

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## Validate

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