objw.hpp

Go to the documentation of this file.

#ifndef _OBJW_HPP_
#define _OBJW_HPP_
//! \brief Exported APIs for Obj (.obj) Write Library
namespace Objw 
{
 
    //! \class WriteOptions 
    //! \brief This class provides several options to tune Obj Writer.\n
    //! It must be provided to Objw::InitWrite method.
    //! \code
    //! //...
    //! Dtk_string LogFile = L"MyLogFile.log";
    //! Objw::WriteOptions ObjOptions;
    //! Dtk_ErrorStatus err = Objw::InitWrite( LogFile, ObjOptions);
    //! //...
    //! \endcode
    class WriteOptions
    {
    protected:
 
    public:
          // Supported file encoding
          enum FileEncoding
          {
               UTF8,
               UTF8BOM
          };
          //! Use of Dtk_RGB or Dtk_RenderInfos
          bool m_UseRender;
          //! Use of FileEncoding
          FileEncoding m_FileEncoding;
        //! \BaseConstructor
        WriteOptions():m_UseRender( false ), m_FileEncoding( UTF8 ){}
 
        //! \BaseDestructor
        ~WriteOptions() {}
 
    };
 
    //! \brief Initialize the Obj Writer  
    //! \return dtkNoError if it is OK.
    //! \param [in] inOutputFile : Output file name
    //! \param [in] inLogFile : Log file
    //! \param [in] inOptions : Options
    //! \remark This function is the first call for the writer, it must me called after Dtk_API::StartAPI(...)
    DtkErrorStatus InitWrite(const Dtk_string& inOutputFile, const Dtk_string& inLogFile, WriteOptions& inOptions);
 
    //! \brief Creation of the output file and free the Obj Writer  
    //! \return dtkNoError if it is OK.
    //! \remark used as the last function used for the writer.
    DtkErrorStatus EndWrite();
 
    //! \brief Write the entity provided in parameter in a node. 
    //! \param [in] inEntity : The Entity to be written
     //! \param [in] inMat : The matrice that needs to be applied before the writing
    //! \return dtkNoError if it is OK.
    //! \remark This function is used to write entities (only Dtk_MeshPtr ) .
    Dtk_ErrorStatus WriteEntity(const Dtk_EntityPtr& inEntity, Dtk_transfo inMat = Dtk_transfo());
 
}
 
#endif