DATAKIT API  V2025.1
Objw::WriteOptions Class Reference

This class provides several options to tune Obj Writer.
It must be provided to Objw::InitWrite method. More...

Public Types

enum  FileEncoding { UTF8, UTF8BOM }
 

Public Member Functions

 WriteOptions ()
 Base constructor. More...
 
 ~WriteOptions ()
 Destructor. More...
 

Data Fields

FileEncoding m_FileEncoding
 Use of FileEncoding. More...
 
bool m_UseRender
 Use of Dtk_RGB or Dtk_RenderInfos. More...
 

Detailed Description

This class provides several options to tune Obj Writer.
It must be provided to Objw::InitWrite method.

//...
Dtk_string LogFile = L"MyLogFile.log";
Objw::WriteOptions ObjOptions;
Dtk_ErrorStatus err = Objw::InitWrite( LogFile, ObjOptions);
//...

Member Enumeration Documentation

◆ FileEncoding

Enumerator
UTF8 
UTF8BOM 
24  {
25  UTF8,
26  UTF8BOM
27  };

Constructor & Destructor Documentation

◆ WriteOptions()

Objw::WriteOptions::WriteOptions ( )

Base constructor.

33 :m_UseRender( false ), m_FileEncoding( UTF8 ){}

◆ ~WriteOptions()

Objw::WriteOptions::~WriteOptions ( )

Destructor.

36 {}

Field Documentation

◆ m_FileEncoding

FileEncoding Objw::WriteOptions::m_FileEncoding

Use of FileEncoding.

◆ m_UseRender

bool Objw::WriteOptions::m_UseRender
Dtk_string
This is a high level string class.
Definition: dtk_string.hpp:58
Objw::WriteOptions::m_UseRender
bool m_UseRender
Use of Dtk_RGB or Dtk_RenderInfos.
Definition: objw.hpp:29
Objw::WriteOptions
This class provides several options to tune Obj Writer. It must be provided to Objw::InitWrite method...
Definition: objw.hpp:18
Objw::InitWrite
DtkErrorStatus InitWrite(const Dtk_string &inOutputFile, const Dtk_string &inLogFile, WriteOptions &inOptions)
Initialize the Obj Writer
Dtk_ErrorStatus
Dtk_ErrorStatus
Definition: error_dtk.hpp:6
Objw::WriteOptions::UTF8BOM
@ UTF8BOM
Definition: objw.hpp:26
Objw::WriteOptions::UTF8
@ UTF8
Definition: objw.hpp:25
Objw::WriteOptions::m_FileEncoding
FileEncoding m_FileEncoding
Use of FileEncoding.
Definition: objw.hpp:31