NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::STLCreator Class Reference

Represents a NXOpen::STLCreator to be used when exporting the STL Data This class is created using NXOpen::DexManager . More...

Inheritance diagram for NXOpen::STLCreator:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  OutputTypeEnum { OutputTypeEnumBinary, OutputTypeEnumText }
 Options for outputing solid bodies to STL. More...
 
enum  SheetBodyExportOptionEnum { SheetBodyExportOptionEnumIndividualSheets, SheetBodyExportOptionEnumJoinSheets }
 Options for choosing sheet bodies export option. More...
 

Public Member Functions

double AdjacencyTol ()
 Returns the adjacency tol - tolerance for adjacency
Created in NX11.0.0. More...
 
double AngularTol ()
 Returns the angular tol - tolerance for angular
Created in NX11.0.0. More...
 
bool AutoNormalGen ()
 Returns the Auto Normal Gen - if set to true will generate auto normals
Created in NX11.0.0. More...
 
double ChordalTol ()
 Returns the chordal tol - the distance between a chord of the tessellation and the true surface
Created in NX11.0.0. More...
 
bool ErrorMessageDisplay ()
 Returns the Error Message Display - if set to true will will display error messages
Created in NX11.0.0. More...
 
NXOpen::SelectNXObjectListExportSelectionBlock ()
 Returns the export selection block - the object selection will be done by this block. More...
 
NXString HeaderInfo ()
 Returns the header info - STL header information
Created in NX11.0.0. More...
 
int NormalDirectionIndicator ()
 Returns the normal direction indicator - STL normal direction indicator
Created in NX11.0.0. More...
 
bool NormalDisplay ()
 Returns the Normal Display - if set to true will display normal
Created in NX11.0.0. More...
 
NXString OutputFile ()
 Returns the output file - the exported data will be written to file specified
Created in NX11.0.0. More...
 
NXOpen::STLCreator::OutputTypeEnum OutputType ()
 Returns the output type - this will decide if output type should be binary or text
Created in NX11.0.0. More...
 
NXOpen::SelectNXObjectListReferenceSurfaceSelectionBlock ()
 Returns the reference surface selection - the object selection will be done by this block. More...
 
bool ReverseNormalDirection ()
 Returns the Reverse Normal Direction - if set to true will will reverse normal direction
Created in NX11.0.0. More...
 
void SetAdjacencyTol (double adjacencyTol)
 Sets the adjacency tol - tolerance for adjacency
Created in NX11.0.0. More...
 
void SetAngularTol (double angularTol)
 Sets the angular tol - tolerance for angular
Created in NX11.0.0. More...
 
void SetAutoNormalGen (bool autoNormalGen)
 Sets the Auto Normal Gen - if set to true will generate auto normals
Created in NX11.0.0. More...
 
void SetChordalTol (double chordalTol)
 Sets the chordal tol - the distance between a chord of the tessellation and the true surface
Created in NX11.0.0. More...
 
void SetErrorMessageDisplay (bool errorMessageDisplay)
 Sets the Error Message Display - if set to true will will display error messages
Created in NX11.0.0. More...
 
void SetHeaderInfo (const NXString &headerInfo)
 Sets the header info - STL header information
Created in NX11.0.0. More...
 
void SetHeaderInfo (const char *headerInfo)
 Sets the header info - STL header information
Created in NX11.0.0. More...
 
void SetNormalDirectionIndicator (int normalDirectionIndicator)
 Sets the normal direction indicator - STL normal direction indicator
Created in NX11.0.0. More...
 
void SetNormalDisplay (bool normalDisplay)
 Sets the Normal Display - if set to true will display normal
Created in NX11.0.0. More...
 
void SetOutputFile (const NXString &filename)
 Sets the output file - the exported data will be written to file specified
Created in NX11.0.0. More...
 
void SetOutputFile (const char *filename)
 Sets the output file - the exported data will be written to file specified
Created in NX11.0.0. More...
 
void SetOutputType (NXOpen::STLCreator::OutputTypeEnum outputType)
 Sets the output type - this will decide if output type should be binary or text
Created in NX11.0.0. More...
 
void SetReverseNormalDirection (bool reverseNormalDirection)
 Sets the Reverse Normal Direction - if set to true will will reverse normal direction
Created in NX11.0.0. More...
 
void SetSheetBodyExportOption (NXOpen::STLCreator::SheetBodyExportOptionEnum sheetBodyExportOption)
 Sets the Sheet Body Export Option - indicates whether sheet bodies will be joined or faceted as individual sheets
Created in NX11.0.0. More...
 
void SetTriangleDisplay (bool triangleDisplay)
 Sets the Triangle Display - if set to true will will display triangles
Created in NX11.0.0. More...
 
NXOpen::STLCreator::SheetBodyExportOptionEnum SheetBodyExportOption ()
 Returns the Sheet Body Export Option - indicates whether sheet bodies will be joined or faceted as individual sheets
Created in NX11.0.0. More...
 
bool TriangleDisplay ()
 Returns the Triangle Display - if set to true will will display triangles
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::STLCreator to be used when exporting the STL Data This class is created using NXOpen::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


Created in NX11.0.0.

Member Enumeration Documentation

Options for outputing solid bodies to STL.

Enumerator
OutputTypeEnumBinary 

output type binary

OutputTypeEnumText 

output type text

Options for choosing sheet bodies export option.

Enumerator
SheetBodyExportOptionEnumIndividualSheets 

facet as individual sheets

SheetBodyExportOptionEnumJoinSheets 

attempt to join sheet bodies

Member Function Documentation

double NXOpen::STLCreator::AdjacencyTol ( )

Returns the adjacency tol - tolerance for adjacency
Created in NX11.0.0.



License requirements : None

double NXOpen::STLCreator::AngularTol ( )

Returns the angular tol - tolerance for angular
Created in NX11.0.0.



License requirements : None

bool NXOpen::STLCreator::AutoNormalGen ( )

Returns the Auto Normal Gen - if set to true will generate auto normals
Created in NX11.0.0.



License requirements : None

double NXOpen::STLCreator::ChordalTol ( )

Returns the chordal tol - the distance between a chord of the tessellation and the true surface
Created in NX11.0.0.



License requirements : None

bool NXOpen::STLCreator::ErrorMessageDisplay ( )

Returns the Error Message Display - if set to true will will display error messages
Created in NX11.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::STLCreator::ExportSelectionBlock ( )

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


Created in NX11.0.0.

License requirements : None

NXString NXOpen::STLCreator::HeaderInfo ( )

Returns the header info - STL header information
Created in NX11.0.0.



License requirements : None

int NXOpen::STLCreator::NormalDirectionIndicator ( )

Returns the normal direction indicator - STL normal direction indicator
Created in NX11.0.0.



License requirements : None

bool NXOpen::STLCreator::NormalDisplay ( )

Returns the Normal Display - if set to true will display normal
Created in NX11.0.0.



License requirements : None

NXString NXOpen::STLCreator::OutputFile ( )

Returns the output file - the exported data will be written to file specified
Created in NX11.0.0.



License requirements : None

NXOpen::STLCreator::OutputTypeEnum NXOpen::STLCreator::OutputType ( )

Returns the output type - this will decide if output type should be binary or text
Created in NX11.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::STLCreator::ReferenceSurfaceSelectionBlock ( )

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


Created in NX11.0.0.

License requirements : None

bool NXOpen::STLCreator::ReverseNormalDirection ( )

Returns the Reverse Normal Direction - if set to true will will reverse normal direction
Created in NX11.0.0.



License requirements : None

void NXOpen::STLCreator::SetAdjacencyTol ( double  adjacencyTol)

Sets the adjacency tol - tolerance for adjacency
Created in NX11.0.0.



License requirements : None

Parameters
adjacencyToladjacencytol
void NXOpen::STLCreator::SetAngularTol ( double  angularTol)

Sets the angular tol - tolerance for angular
Created in NX11.0.0.



License requirements : None

Parameters
angularTolangulartol
void NXOpen::STLCreator::SetAutoNormalGen ( bool  autoNormalGen)

Sets the Auto Normal Gen - if set to true will generate auto normals
Created in NX11.0.0.



License requirements : None

Parameters
autoNormalGenautonormalgen
void NXOpen::STLCreator::SetChordalTol ( double  chordalTol)

Sets the chordal tol - the distance between a chord of the tessellation and the true surface
Created in NX11.0.0.



License requirements : None

Parameters
chordalTolchordaltol
void NXOpen::STLCreator::SetErrorMessageDisplay ( bool  errorMessageDisplay)

Sets the Error Message Display - if set to true will will display error messages
Created in NX11.0.0.



License requirements : None

Parameters
errorMessageDisplayerrormessagedisplay
void NXOpen::STLCreator::SetHeaderInfo ( const NXString headerInfo)

Sets the header info - STL header information
Created in NX11.0.0.



License requirements : None

Parameters
headerInfoheaderinfo
void NXOpen::STLCreator::SetHeaderInfo ( const char *  headerInfo)

Sets the header info - STL header information
Created in NX11.0.0.



License requirements : None

Parameters
headerInfoheaderinfo
void NXOpen::STLCreator::SetNormalDirectionIndicator ( int  normalDirectionIndicator)

Sets the normal direction indicator - STL normal direction indicator
Created in NX11.0.0.



License requirements : None

Parameters
normalDirectionIndicatornormaldirectionindicator
void NXOpen::STLCreator::SetNormalDisplay ( bool  normalDisplay)

Sets the Normal Display - if set to true will display normal
Created in NX11.0.0.



License requirements : None

Parameters
normalDisplaynormaldisplay
void NXOpen::STLCreator::SetOutputFile ( const NXString filename)

Sets the output file - the exported data will be written to file specified
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::STLCreator::SetOutputFile ( const char *  filename)

Sets the output file - the exported data will be written to file specified
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::STLCreator::SetOutputType ( NXOpen::STLCreator::OutputTypeEnum  outputType)

Sets the output type - this will decide if output type should be binary or text
Created in NX11.0.0.



License requirements : None

Parameters
outputTypeoutputtype
void NXOpen::STLCreator::SetReverseNormalDirection ( bool  reverseNormalDirection)

Sets the Reverse Normal Direction - if set to true will will reverse normal direction
Created in NX11.0.0.



License requirements : None

Parameters
reverseNormalDirectionreversenormaldirection
void NXOpen::STLCreator::SetSheetBodyExportOption ( NXOpen::STLCreator::SheetBodyExportOptionEnum  sheetBodyExportOption)

Sets the Sheet Body Export Option - indicates whether sheet bodies will be joined or faceted as individual sheets
Created in NX11.0.0.



License requirements : None

Parameters
sheetBodyExportOptionsheetbodyexportoption
void NXOpen::STLCreator::SetTriangleDisplay ( bool  triangleDisplay)

Sets the Triangle Display - if set to true will will display triangles
Created in NX11.0.0.



License requirements : None

Parameters
triangleDisplaytriangledisplay
NXOpen::STLCreator::SheetBodyExportOptionEnum NXOpen::STLCreator::SheetBodyExportOption ( )

Returns the Sheet Body Export Option - indicates whether sheet bodies will be joined or faceted as individual sheets
Created in NX11.0.0.



License requirements : None

bool NXOpen::STLCreator::TriangleDisplay ( )

Returns the Triangle Display - if set to true will will display triangles
Created in NX11.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.