cgrw.hpp

Go to the documentation of this file.

/**********************************************************
CGRW.HPP
***********************************************************/
#ifndef _CGRW_HPP_
#define _CGRW_HPP_
#include "util/util_stl_dtk.hpp"
#include "util/BaseTypes/dtk_rgb.hpp"
#include "util/util_ent_dtk.hpp"
#include "util/util_ptr_dtk.hpp"
#include "util/util_mesh_dtk.hpp"
 
     //! \defgroup cgrw_utils cgr Write Util Functions
     //! \brief.
 
     class Dtk_mesh_instance;
 
 
     //! \class Dtk_mesh_asm_node
     //! \brief This class gathers asm node related datas. 
     class Dtk_mesh_asm_node
     {
     protected:
          int                                id;
          Dtk_tab<Dtk_mesh_instance*>        inst;
          Dtk_RGB                            node_color;
          Dtk_MaterialPtr                            material;
          Dtk_RenderInfosPtr                    render;
          Dtk_PhysicalMaterialInfosPtr     phys_mat;
 
     public:
 
          //! \brief Used to store global computed bounding box
          Dtk_bounding_box                   BB;
 
          //! \brief Default constructor
          Dtk_mesh_asm_node();
          //! \brief Default destructor
          ~Dtk_mesh_asm_node();
 
          //! \brief Return the nb of instances in the current node
          Dtk_Size_t             get_nb_instances();
          //! \brief Return the i-th instance
          Dtk_mesh_instance* get_instance(int i);
          //! \brief Add an asm instance to the current asm node
          int                    add_asm_instance(Dtk_mesh_asm_node* inMeshAsm, Dtk_transfo* inTransfo);
          //! \brief Add an Dtk_mesh in Dtk_mesh_asm_node in the current asm node
          int                    add_mesh(Dtk_MeshPtr mesh);
          //! \brief Add an Dtk_AxisSystemPtr in Dtk_mesh_asm_node in the current asm node
          int                    add_axis_system(Dtk_AxisSystemPtr inAxisSystem);
          //! \brief Set an Id
          void                set_id(int inId);
 
          //! \brief Set an material
          //! \deprecated use set_render_infos instead
          SetAsDeprecated( "2026.4", "Use set_render_infos instead." )
          void                set_material(Dtk_MaterialPtr inMaterial);
 
          //! \brief Set an render
          void                set_render_infos(Dtk_RenderInfosPtr inRender);
 
          //! \brief Get an Id
          int                    get_id();
 
          //! \brief Get an material
          //! \deprecated use get_render_infos instead
          SetAsDeprecated( "2026.4", "Use get_render_infos instead." )
          Dtk_MaterialPtr        get_material();
 
          //! \brief Get an material
          Dtk_RenderInfosPtr     get_render_infos();
 
          //! \brief Compute Bounding Boxes
          //! \deprecated use ComputeBBs instead
          SetAsDeprecated( "2026.4", "Use ComputeBBs instead." )
          Dtk_status            cgrw_ComputeBBs();
 
          //! \brief Compute Bounding Boxes
          Dtk_ErrorStatus       ComputeBBs();
 
          //! \brief set color on Dtk_mesh_asm_node
          void set_color(Dtk_RGB& inColor);
 
          //! \brief get color on Dtk_mesh_asm_node
          Dtk_RGB get_color();
     };
 
 
     //! \class WriteOptions 
     //! \brief This class provides several options to tunes cgr Writter.\n
     //! It must be provided to cgr::cgrw_InitWrite method.
     //! \code
     //! //...
     //! \endcode
     class WriteOptions
     {
     protected:
          Dtk_UChar8  _FileRelease;
     public:
          //! \BaseConstructor
          WriteOptions() :_FileRelease(14) {}
 
          //! \BaseDestructor
          ~WriteOptions() {}
 
          //! \brief Sets the release for the written files.
          //! \brief the valid versions are 14 and 19.
          //! \param [in] inRelease : The file release.
          inline void SetFileRelease(const Dtk_UInt32 inRelease)
          {
               switch (inRelease)
               {
               case 19:
                    _FileRelease = (Dtk_UChar8)inRelease; return;
               case 14:
               default:
                    _FileRelease = 14; return;
               }
          }
          //! \brief Retrieve the Written file release.
          inline Dtk_UInt32 GetFileRelease() const { return _FileRelease; }
     };
 
     //! \ingroup cgrw_utils
     //! \brief Initialize the Cgr Writer  
     //! \return DTK_NOERROR if it is ok DTK_ISERROR else.
     //! \remark This is the first function called for the writer.
     //! \param [in] inFileWritten : File to write
     //! \param [in] inLogFile : Log file
     //! \param [in] inLicFct : Licence fuction or Null
     //! \param [in] inLicFile : Datakit Licence file or Null
     //! \param [in] inOptions : Options (release,...)
     int cgrw_InitWrite(Dtk_string inFileWritten, Dtk_string inLogFile, Licence_dtk inLicFct, Dtk_string inLicenceFile, const WriteOptions & inOptions = WriteOptions());
 
     //! \ingroup cgrw_utils
     //! \brief Write a mesh assembly
     //! \return DTK_NOERROR if it is ok DTK_ISERROR else.
     //! \deprecated use cgrw_WriteMeshAsmNode instead
     SetAsDeprecated( "2026.4", "Use cgrw_WriteMeshAsmNode instead." )
     Dtk_status cgrw_WriteMeshAsm(Dtk_mesh_asm_node * inRoot);
 
     //! \ingroup cgrw_utils
     //! \brief Write a mesh assembly
     //! \return dtkNoError if it is ok, dtkError else.
     Dtk_ErrorStatus cgrw_WriteMeshAsmNode(Dtk_mesh_asm_node * inRoot);
 
     //! \ingroup cgrw_utils
     //! \brief Free the Cgr Writer  
     //! \return DTK_NOERROR if it is ok DTK_ISERROR else.
     //! \remark used at the last function used for the writer.
     int cgrw_EndWrite();
     //! \ingroup cgrw_utils
     //! \brief write material
     //! \param [bool] inVal
     //!
     //! SetCfgCgrWriteMaterial(const Dtk_bool &inVal);
     //! \endcode
     void SetCfgCgrWriteMaterial(const Dtk_bool &inVal);
 
#endif