Polygon Crucher SDK - Documentation
Documentation
Loading...
Searching...
No Matches
CSceneExportOptions Class Reference

This class is used to provide some specific options when exporting a 3D scene. More...

Detailed Description

This class is used to provide some specific options when exporting a 3D scene.

#include <Io3dmgr.h>

Inheritance diagram for CSceneExportOptions:
CIoOptions

Public Member Functions

 CSceneExportOptions (unsigned int flags=SCENE_EXPORT_DEFAULT)
 
bool Delete ()
 
CXString GetUniqueTextureFilename (const CXString &fullTexturePath, const CXString &suffix=CXString(), bool fileMustNotExist=false)
 Return a name that comply the io specification (name limit, encoding...). The name is always different than the input name, but this can be a file already existing unless fileMustNotExist = true.
 
- Public Member Functions inherited from CIoOptions
 CIoOptions (bool isLoading)
 
void SetFlag (IoOptionsFlags flag, bool set)
 
bool IsFlagSet (IoOptionsFlags flag) const
 
CCustomDataGetParserOptions ()
 
const CCustomDataGetParserOptions () const
 
void AddLogInfo (IoLogInfo::loglevel level, const CXString &txt)
 
void AddLogInfo (IoLogInfo::loglevel level, unsigned int errorCode, LPCTSTR filename=NULL)
 

Static Public Member Functions

static CSceneExportOptionsCreate (unsigned int flags=SCENE_EXPORT_DEFAULT)
 Create and allocate a CSceneExportOptions that can be deleted using Delete(). Use xNew internally.
 

Public Attributes

longuint flags
 
int ptsLimit
 
int faceLimit
 Max number of point & face supported by the I/O.
 
Data used internally (filled by the parsers and option dialogs)
unsigned int swapmode
 
UP_AXIS_MODE axismode
 
longuint neededflags
 Fill by the parser. A combination of SCENE_EXPORT_FLAGS that are absolutely required.
 
longuint defaultflags
 Fill by the parser. A combination of SCENE_EXPORT_FLAGS that could be used or are better to use, but are not mandatory.
 
UNIT_MODE targetunit
 define the I/O required unit
 
The following options are used when a name SCENE_EXPORT_MAKE_UNIQUE_NAME is defined
unsigned int nameLimit
 Default: 0 (inactive). Max number of characters for node names. Use SCENE_OPTIONS_MAKE_NAME to define the limit.
 
unsigned int materialNameLimit
 Default: 0 (inactive). Max number of characters for node names. Use SCENE_OPTIONS_MAKE_NAME to define the limit.
 
xStringEncoding nameEncoding
 Default: xStringDefaultEncoding. Force name to have a specific encoding which guarantee that the texture name (for example ASCII text) will be the same that the file name (which is by default Unicode). Use xStringDefaultEncoding to keep default (unicode)
 
CXString filename
 The output filename.
 
The following options are used when copying the texture files to a given location (SCENE_EXPORT_COPY_TEXTURES must be set)
CXString texturePath
 To be defined. Target path for texture unless textureLocalPathOnly is set to true. In that case, texture are made local to the target scene path.
 
bool textureLocalPathOnly
 Default: false. Textures are made local to the target scene path. texturePath is ignored.
 
unsigned int textureNameLimit
 Default: 0 (inactive). Max number of characters for filename (ie textures when moved). Use SCENE_OPTIONS_MAKE_NAME to define the limit.
 
xStringEncoding textureNameEncoding
 Default: xStringDefaultEncoding. Force texture name to have a specific encoding which guarantee that the texture name (for example ASCII text) will be the same that the file name (which is by default Unicode). Use xStringDefaultEncoding to keep default (unicode)
 
Information about the InitExport process which prepares the scene provided to C3DIo::Save before exportation
CXString previousFilename
 The original file path of the scene, which can differs if the file is converted.
 
bool saveInDifferentPath
 Simple way to know if the saved scene is saved in a different location than the original file. That can be helpful to prevent overwrite some original files.
 
bool saveInDifferentFormat
 Simple way to know if the saved scene is saved in a different location than the original file. That can be helpful to prevent overwrite some original files.
 

Additional Inherited Members

- Public Types inherited from CIoOptions
enum  IoOptionsFlags {
  IOOPTIONS_NONE = 0x00 , IOOPTIONS_LOAD = 0x01 , IOOPTIONS_SHOWALLDLGOPTIONS = 0x02 , IOOPTIONS_ALLOW_GLOBALOPTIONS = 0x04 ,
  IOOPTIONS_GLOBAL_PREFS = 0xFFFF0000 , IOOPTIONS_GLOBAL_SHOWLOG = 0x00010000
}
 

Member Data Documentation

◆ flags

longuint CSceneExportOptions::flags

User control on exportation Combination of SCENE_EXPORT_FLAGS provided by the caller.
It is used to prepare the scene to be saved. Ie if caller set SCENE_EXPORT_GLOBAL_COORDINATES | SCENE_EXPORT_TRIANGULATE then a triangulated scene with global coordinates will be saved.
When calling C3DIo::Save with options not NULL, provided flags are used completed with the parser specified neededflags


The documentation for this class was generated from the following file: