NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::WavefrontObjImporter Class Reference

Represents a NXOpen::WavefrontObjImporter to be used when importing OBJ Data This class is created using NXOpen::DexManager . More...

Inheritance diagram for NXOpen::WavefrontObjImporter:
NXOpen::DexBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  GroupsEnum { GroupsEnumNodeNames, GroupsEnumAssembly, GroupsEnumOff }
 how to interpret the OBJ groups More...
 
enum  MessageEnum {
  MessageEnumNone, MessageEnumInformational, MessageEnumWarning, MessageEnumError,
  MessageEnumDebug, MessageEnumAll
}
 Messages output when opening the file. More...
 
enum  UnitsEnum {
  UnitsEnumMillimeters, UnitsEnumInches, UnitsEnumMeters, UnitsEnumCentimeters,
  UnitsEnumFeet, UnitsEnumMicrons
}
 Units of the the OBJ file. More...
 

Public Member Functions

bool Cleanup ()
 Returns the option to clean up all mesh defects on import
Created in NX12.0.1. More...
 
bool FileOpenFlag ()
 Returns the file open flag - set this to false if doing file import
Created in NX11.0.0. More...
 
NXOpen::WavefrontObjImporter::GroupsEnum ImportGroups ()
 Returns the method of interpreting OBJ groups
Created in NX11.0.0. More...
 
NXOpen::WavefrontObjImporter::UnitsEnum ImportUnits ()
 Returns the units to convert from when loading Obj files
Created in NX11.0.0. More...
 
NXString InputFile ()
 Returns the input file - name of a file which is being imported
Created in NX11.0.0. More...
 
NXOpen::WavefrontObjImporter::MessageEnum Messages ()
 Returns the message level for syslog messages when loading Obj files
Created in NX11.0.0. More...
 
bool ReverseNames ()
 Returns the ReverseNames - if set to true then group names will be processed right-to-left
Created in NX11.0.0. More...
 
void SetCleanup (bool cleanup)
 Sets the option to clean up all mesh defects on import
Created in NX12.0.1. More...
 
void SetFileOpenFlag (bool doingFileOpen)
 Sets the file open flag - set this to false if doing file import
Created in NX11.0.0. More...
 
void SetImportGroups (NXOpen::WavefrontObjImporter::GroupsEnum importGroups)
 Sets the method of interpreting OBJ groups
Created in NX11.0.0. More...
 
void SetImportUnits (NXOpen::WavefrontObjImporter::UnitsEnum importUnits)
 Sets the units to convert from when loading Obj files
Created in NX11.0.0. More...
 
void SetInputFile (const NXString &filename)
 Sets the input file - name of a file which is being imported
Created in NX11.0.0. More...
 
void SetInputFile (const char *filename)
 Sets the input file - name of a file which is being imported
Created in NX11.0.0. More...
 
void SetMessages (NXOpen::WavefrontObjImporter::MessageEnum messages)
 Sets the message level for syslog messages when loading Obj files
Created in NX11.0.0. More...
 
void SetReverseNames (bool reverseNames)
 Sets the ReverseNames - if set to true then group names will be processed right-to-left
Created in NX11.0.0. More...
 
void SetShowInformationWindowFlag (bool doingInformationWindow)
 Sets the information flag - set this to true to display info in window
Created in NX11.0.0. More...
 
bool ShowInformationWindowFlag ()
 Returns the information flag - set this to true to display info in window
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::DexBuilder
bool ProcessHoldFlag ()
 Returns the process hold flag - set to true if user wants to wait until transaltion process gets completed
Created in NX8.0.0. More...
 
void SetProcessHoldFlag (bool doingFileSave)
 Sets the process hold flag - set to true if user wants to wait until transaltion process gets completed
Created in NX8.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::WavefrontObjImporter to be used when importing OBJ 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::CreateWavefrontObjImporter
Default values.

Property Value

ImportGroups

NodeNames

ImportUnits

Millimeters

Messages

None

ReverseNames

0

ShowInformationWindowFlag

0


Created in NX11.0.0.

Member Enumeration Documentation

how to interpret the OBJ groups

Enumerator
GroupsEnumNodeNames 

node names

GroupsEnumAssembly 

assembly

GroupsEnumOff 

off

Messages output when opening the file.

Enumerator
MessageEnumNone 

none

MessageEnumInformational 

informational

MessageEnumWarning 

warning

MessageEnumError 

error

MessageEnumDebug 

debug

MessageEnumAll 

all

Units of the the OBJ file.

Enumerator
UnitsEnumMillimeters 

millimeters

UnitsEnumInches 

inches

UnitsEnumMeters 

meters

UnitsEnumCentimeters 

centimeters

UnitsEnumFeet 

feet

UnitsEnumMicrons 

microns

Member Function Documentation

bool NXOpen::WavefrontObjImporter::Cleanup ( )

Returns the option to clean up all mesh defects on import
Created in NX12.0.1.



License requirements : None

bool NXOpen::WavefrontObjImporter::FileOpenFlag ( )

Returns the file open flag - set this to false if doing file import
Created in NX11.0.0.



License requirements : None

NXOpen::WavefrontObjImporter::GroupsEnum NXOpen::WavefrontObjImporter::ImportGroups ( )

Returns the method of interpreting OBJ groups
Created in NX11.0.0.



License requirements : None

NXOpen::WavefrontObjImporter::UnitsEnum NXOpen::WavefrontObjImporter::ImportUnits ( )

Returns the units to convert from when loading Obj files
Created in NX11.0.0.



License requirements : None

NXString NXOpen::WavefrontObjImporter::InputFile ( )

Returns the input file - name of a file which is being imported
Created in NX11.0.0.



License requirements : None

NXOpen::WavefrontObjImporter::MessageEnum NXOpen::WavefrontObjImporter::Messages ( )

Returns the message level for syslog messages when loading Obj files
Created in NX11.0.0.



License requirements : None

bool NXOpen::WavefrontObjImporter::ReverseNames ( )

Returns the ReverseNames - if set to true then group names will be processed right-to-left
Created in NX11.0.0.



License requirements : None

void NXOpen::WavefrontObjImporter::SetCleanup ( bool  cleanup)

Sets the option to clean up all mesh defects on import
Created in NX12.0.1.



License requirements : None

Parameters
cleanupcleanup
void NXOpen::WavefrontObjImporter::SetFileOpenFlag ( bool  doingFileOpen)

Sets the file open flag - set this to false if doing file import
Created in NX11.0.0.



License requirements : None

Parameters
doingFileOpendoingfileopen
void NXOpen::WavefrontObjImporter::SetImportGroups ( NXOpen::WavefrontObjImporter::GroupsEnum  importGroups)

Sets the method of interpreting OBJ groups
Created in NX11.0.0.



License requirements : None

Parameters
importGroupsimportgroups
void NXOpen::WavefrontObjImporter::SetImportUnits ( NXOpen::WavefrontObjImporter::UnitsEnum  importUnits)

Sets the units to convert from when loading Obj files
Created in NX11.0.0.



License requirements : None

Parameters
importUnitsimportunits
void NXOpen::WavefrontObjImporter::SetInputFile ( const NXString filename)

Sets the input file - name of a file which is being imported
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::WavefrontObjImporter::SetInputFile ( const char *  filename)

Sets the input file - name of a file which is being imported
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::WavefrontObjImporter::SetMessages ( NXOpen::WavefrontObjImporter::MessageEnum  messages)

Sets the message level for syslog messages when loading Obj files
Created in NX11.0.0.



License requirements : None

Parameters
messagesmessages
void NXOpen::WavefrontObjImporter::SetReverseNames ( bool  reverseNames)

Sets the ReverseNames - if set to true then group names will be processed right-to-left
Created in NX11.0.0.



License requirements : None

Parameters
reverseNamesreversenames
void NXOpen::WavefrontObjImporter::SetShowInformationWindowFlag ( bool  doingInformationWindow)

Sets the information flag - set this to true to display info in window
Created in NX11.0.0.



License requirements : None

Parameters
doingInformationWindowdoinginformationwindow
bool NXOpen::WavefrontObjImporter::ShowInformationWindowFlag ( )

Returns the information flag - set this to true to display info in window
Created in NX11.0.0.



License requirements : None


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