STLCreator Class¶
-
class
NXOpen.
STLCreator
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.STLCreator
to be used when exporting the STL Data This class is created usingNXOpen.DexManager
.NULL object will be returned from Commit() To create a new instance of this class, use
NXOpen.DexManager.CreateStlCreator()
Default values.
Property Value AdjacencyTol 0.058 AngularTol 18.0 AutoNormalGen 0 ChordalTol 0.058 ErrorMessageDisplay 0 NormalDisplay 0 OutputType Binary ReverseNormalDirection 0 SheetBodyExportOption IndividualSheets TriangleDisplay 0 New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
AdjacencyTol | Returns or sets the adjacency tol - tolerance for adjacency |
AngularTol | Returns or sets the angular tol - tolerance for angular |
AutoNormalGen | Returns or sets the Auto Normal Gen - if set to true will generate auto normals |
ChordalTol | Returns or sets the chordal tol - the distance between a chord of the tessellation and the true surface |
ErrorMessageDisplay | Returns or sets the Error Message Display - if set to true will will display error messages |
ExportSelectionBlock | Returns the export selection block - the object selection will be done by this block. |
HeaderInfo | Returns or sets the header info - STL header information |
NormalDirectionIndicator | Returns or sets the normal direction indicator - STL normal direction indicator |
NormalDisplay | Returns or sets the Normal Display - if set to true will display normal |
OutputFile | Returns or sets the output file - the exported data will be written to file specified |
OutputType | Returns or sets the output type - this will decide if output type should be binary or text |
ReferenceSurfaceSelectionBlock | Returns the reference surface selection - the object selection will be done by this block. |
ReverseNormalDirection | Returns or sets the Reverse Normal Direction - if set to true will will reverse normal direction |
SheetBodyExportOption | Returns or sets the Sheet Body Export Option - indicates whether sheet bodies will be joined or faceted as individual sheets |
Tag | Returns the Tag for this object. |
TriangleDisplay | Returns or sets the Triangle Display - if set to true will will display triangles |
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¶
STLCreatorOutputTypeEnum Enumeration | Options for outputing solid bodies to STL |
STLCreatorSheetBodyExportOptionEnum Enumeration | Options for choosing sheet bodies export option |
Property Detail¶
AdjacencyTol¶
-
STLCreator.
AdjacencyTol
¶ Returns or sets the adjacency tol - tolerance for adjacency
-------------------------------------
Getter Method
Signature
AdjacencyTol
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AdjacencyTol
Parameters: adjacencyTol (float) – New in version NX11.0.0.
License requirements: None.
AngularTol¶
-
STLCreator.
AngularTol
¶ Returns or sets the angular tol - tolerance for angular
-------------------------------------
Getter Method
Signature
AngularTol
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngularTol
Parameters: angularTol (float) – New in version NX11.0.0.
License requirements: None.
AutoNormalGen¶
-
STLCreator.
AutoNormalGen
¶ Returns or sets the Auto Normal Gen - if set to true will generate auto normals
-------------------------------------
Getter Method
Signature
AutoNormalGen
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutoNormalGen
Parameters: autoNormalGen (bool) – New in version NX11.0.0.
License requirements: None.
ChordalTol¶
-
STLCreator.
ChordalTol
¶ Returns or sets the chordal tol - the distance between a chord of the tessellation and the true surface
-------------------------------------
Getter Method
Signature
ChordalTol
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ChordalTol
Parameters: chordalTol (float) – New in version NX11.0.0.
License requirements: None.
ErrorMessageDisplay¶
-
STLCreator.
ErrorMessageDisplay
¶ Returns or sets the Error Message Display - if set to true will will display error messages
-------------------------------------
Getter Method
Signature
ErrorMessageDisplay
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ErrorMessageDisplay
Parameters: errorMessageDisplay (bool) – New in version NX11.0.0.
License requirements: None.
ExportSelectionBlock¶
-
STLCreator.
ExportSelectionBlock
¶ Returns the export selection block - the object selection will be done by this block.
-------------------------------------
Getter Method
Signature
ExportSelectionBlock
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX11.0.0.
License requirements: None.
HeaderInfo¶
-
STLCreator.
HeaderInfo
¶ Returns or sets the header info - STL header information
-------------------------------------
Getter Method
Signature
HeaderInfo
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HeaderInfo
Parameters: headerInfo (str) – New in version NX11.0.0.
License requirements: None.
NormalDirectionIndicator¶
-
STLCreator.
NormalDirectionIndicator
¶ Returns or sets the normal direction indicator - STL normal direction indicator
-------------------------------------
Getter Method
Signature
NormalDirectionIndicator
Returns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NormalDirectionIndicator
Parameters: normalDirectionIndicator (int) – New in version NX11.0.0.
License requirements: None.
NormalDisplay¶
-
STLCreator.
NormalDisplay
¶ Returns or sets the Normal Display - if set to true will display normal
-------------------------------------
Getter Method
Signature
NormalDisplay
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NormalDisplay
Parameters: normalDisplay (bool) – New in version NX11.0.0.
License requirements: None.
OutputFile¶
-
STLCreator.
OutputFile
¶ Returns or sets the output file - the exported data will be written to file specified
-------------------------------------
Getter Method
Signature
OutputFile
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputFile
Parameters: filename (str) – New in version NX11.0.0.
License requirements: None.
OutputType¶
-
STLCreator.
OutputType
¶ Returns or sets the output type - this will decide if output type should be binary or text
-------------------------------------
Getter Method
Signature
OutputType
Returns: Return type: NXOpen.STLCreatorOutputTypeEnum
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputType
Parameters: outputType ( NXOpen.STLCreatorOutputTypeEnum
) –New in version NX11.0.0.
License requirements: None.
ReferenceSurfaceSelectionBlock¶
-
STLCreator.
ReferenceSurfaceSelectionBlock
¶ Returns the reference surface selection - the object selection will be done by this block.
-------------------------------------
Getter Method
Signature
ReferenceSurfaceSelectionBlock
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX11.0.0.
License requirements: None.
ReverseNormalDirection¶
-
STLCreator.
ReverseNormalDirection
¶ Returns or sets the Reverse Normal Direction - if set to true will will reverse normal direction
-------------------------------------
Getter Method
Signature
ReverseNormalDirection
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseNormalDirection
Parameters: reverseNormalDirection (bool) – New in version NX11.0.0.
License requirements: None.
SheetBodyExportOption¶
-
STLCreator.
SheetBodyExportOption
¶ Returns or sets the Sheet Body Export Option - indicates whether sheet bodies will be joined or faceted as individual sheets
-------------------------------------
Getter Method
Signature
SheetBodyExportOption
Returns: Return type: NXOpen.STLCreatorSheetBodyExportOptionEnum
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SheetBodyExportOption
Parameters: sheetBodyExportOption ( NXOpen.STLCreatorSheetBodyExportOptionEnum
) –New in version NX11.0.0.
License requirements: None.
TriangleDisplay¶
-
STLCreator.
TriangleDisplay
¶ Returns or sets the Triangle Display - if set to true will will display triangles
-------------------------------------
Getter Method
Signature
TriangleDisplay
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TriangleDisplay
Parameters: triangleDisplay (bool) – New in version NX11.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
STLCreator.
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.