usdw.hpp

Go to the documentation of this file.

#ifndef _DTK_USDW_HPP
#define _DTK_USDW_HPP
 
#include "def/define.h"
#include "util/BaseTypes/dtk_rgb.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/BaseTypes/dtk_transfo.hpp"
#include "util/error_dtk.hpp"
#include "util/util_mesh_dtk.hpp"
 
//! \defgroup usdw_utils USD Write Util Functions
//! \brief.
 
namespace DtkUsd
{
     class USD_Writer_Private;
} // namespace DtkUsd
 
class WriterOptions
{
public:
     // Reserved for future ascii support; output is currently always binary in .usd
     Dtk_bool m_writeAscii{ DTK_FALSE };
 
     // Declares the unit of the coordinates passed to Writer: must match the actual values
     // 0.001 = mm (default), 0.0254 = inch, 0.01 = cm, 1.0 = m
     // This is NOT a conversion factor; the caller is responsible for consistency
     double m_publicMetersPerUnit{ 0.001 };
};
 
class Dtk_UsdWriter
{
public:
     //! \ingroup usdw_utils
     //! \brief Constructor: initialises the writer for a USD file
     //! \param [in]  inOutputFile  Path of the USD file to write (only .usd is supported)
     //! \param [in]  inOptions     Optional writer configuration
     //! \param [out] outErr dtkNoError on success
     Dtk_UsdWriter( const Dtk_string& inOutputFile, Dtk_ErrorStatus& outErr, const WriterOptions& inOptions );
 
     //! \ingroup usdw_utils
     //! \brief Reserved for future text support
     //! \param [in] inValue Kept for API compatibility; output is currently always binary in .usd
     void ConfigWriteAscii( Dtk_bool inValue );
 
     //! \ingroup usdw_utils
     //! \brief Destructor: flushes and closes the USD file
     ~Dtk_UsdWriter();
 
     //! \ingroup usdw_utils
     //! \brief Writes a mesh into the current instance node
     //! \param [in] inMesh  Mesh to write
     //! \return dtkNoError on success
     Dtk_ErrorStatus WriteMesh( const Dtk_MeshPtr& inMesh );
 
     //! \ingroup usdw_utils
     //! \brief Opens a new Xform instance node and pushes it onto the hierarchy stack
     //! \param [in]  inInstanceName  Prim name (invalid characters are replaced with '_')
     //! \param [in]  inProtoID       Prototype identifier for instancing. Pass -1 to disable instancing for this node
     //! \param [out] outIsNewInstance DTK_TRUE when the prim is created for the first time;
     //!                               DTK_FALSE when a inProtoID was already registered and a reference is emitted instead — 
     //!                                         in that case WriteMesh() calls inside this node are skipped
     //! \param [in]  inTrans         Transform matrix to apply on the prim (identity by default)
     //! \param [in]  inRgb           Display colour of the prim (unused by default)
     //! \param [in]  inMetaTab       Optional metadata attached to the prim
     //! \return dtkNoError on success.
     Dtk_ErrorStatus OpenInstance( const Dtk_string&             inInstanceName,
                                   Dtk_Int64                     inProtoID,
                                   Dtk_bool&                     outIsNewInstance,
                                   const Dtk_transfo&            inTrans    = Dtk_transfo(),
                                   const Dtk_RGB&                inRgb      = Dtk_RGB(),
                                   const Dtk_tab<Dtk_MetaDataPtr>& inMetaTab = Dtk_tab<Dtk_MetaDataPtr>() );
 
     //! \ingroup usdw_utils
     //! \brief Closes the last opened instance node
     //! Must be called once for every successful OpenInstance() call
     //! \return dtkNoError on success
     Dtk_ErrorStatus CloseLastInstance();
 
private:
     DtkUsd::USD_Writer_Private* _Private;
 
private:
     // Non-copyable
     Dtk_UsdWriter( const Dtk_UsdWriter& );
     Dtk_UsdWriter& operator=( const Dtk_UsdWriter& );
};
 
#endif // _DTK_USDW_HPP