colladaw.hpp

Go to the documentation of this file.

#ifndef __COLLADAW_HPP__
#define __COLLADAW_HPP__
#include "def/define.h"
#include "util/error_dtk.hpp"
#include "util/util_ptr_dtk.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/BaseTypes/dtk_transfo.hpp"
 
//! \brief Exported APIs for Collada (.dae) Write Library
namespace Colladaw 
{
    //! \class WriteOptions 
    //! \brief This class provides several options to tune Collada Writer.\n
    //! It must be provided to Colladaw::InitWrite method.
    //! \code
    //! //...
    //! Dtk_string LogFile = L"MyLogFile.log";
    //! Colladaw::WriteOptions ColladaOptions;
    //! Dtk_ErrorStatus err = Colladaw::InitWrite( LogFile, ColladaOptions);
    //! //...
    //! \endcode
    class WriteOptions
    {
    protected:
 
    public:
        //! \BaseConstructor
        WriteOptions() {ConvertRenderInfos = DTK_TRUE; ReverseTransparency = DTK_FALSE; NoInstanceNode = DTK_TRUE; Version = 141;}
 
        //! \BaseDestructor
        ~WriteOptions() {}
 
        Dtk_bool ConvertRenderInfos;
        Dtk_bool ReverseTransparency;
        Dtk_bool NoInstanceNode;
        Dtk_UInt32 Version;
    };
 
    //! \brief Initialize the Collada 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 Collada 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
    //! \return dtkNoError if it is OK.
    //! \remark This function is used to write entities (only Dtk_MeshPtr ) .
    //! \remark The entity is stored in current node .
    Dtk_ErrorStatus WriteEntity(const Dtk_EntityPtr& inEntity);
 
    //! \brief Write the entity provided in parameter in a node. 
    //! \param [in] inEntity : The Entity to be written
    //! \param [out] outID : The ID of the written entity
    //! \return dtkNoError if it is OK.
    //! \remark This function is used to write entities (only Dtk_MeshPtr) .
    //! \remark The entity is stored in current node .
    Dtk_ErrorStatus WriteEntity(const Dtk_EntityPtr& inEntity, Dtk_ID &outID);
 
    //! \brief Initialize a node. 
    //! \param [in] inNodeName : The name of the node
    //! \param [in] inTransfo : The matrix of the node
    //! \param [in] inInfo : The infos (attributes) of the node
    //! \param [out] outID : The identifier of the node
    //! \return dtkNoError if it is OK.
    //! \remark The node is set as current node children .
    //! \remark To close the node you will need to call EndNode() function .
    DtkErrorStatus InitNode(Dtk_string& inNodeName, const Dtk_transfo& inTransfo, Dtk_InfoPtr &inInfo, Dtk_ID &outID);
 
    //! \brief Initialize a node. 
    //! \param [in] inNodeName : The name of the node
    //! \param [in] inTransfo : The matrix of the node
    //! \return dtkNoError if it is OK.
    //! \remark The node is set as current node children .
    //! \remark To close the node you will need to call EndNode() function .
    DtkErrorStatus InitNode(Dtk_string& inNodeName, const Dtk_transfo& inTransfo = Dtk_transfo());
 
    //! \brief End the node. 
    //! \return dtkNoError if it is OK.
    DtkErrorStatus EndNode();
 
    //! \brief Reinstanciate a node. 
    //! \param [in] inID : A unique identifier of the node to be reinstanciated
    //! \return dtkNoError if it is OK.
    DtkErrorStatus ReinstanciatePrototype(Dtk_ID inID);
 
}
 
#endif