dtk_graphical.hpp

Go to the documentation of this file.

#ifndef __UTIL_DTK_GRAPH_HPP__
#define __UTIL_DTK_GRAPH_HPP__
#include "def/define.h"
#include "util/BaseTypes/dtk_object.hpp"
#include "util/dtk_maindoc.hpp"
#include "util/error_dtk.hpp"
#include "util/util_draw_ptr_dtk.hpp"
#include "util/util_stl_dtk.hpp"
 
 
class Dtk_GraphicalData;
 
typedef Dtk_SmartPtr<Dtk_GraphicalData>          Dtk_GraphicalDataPtr;
 
 
/////////////////////////////////////////////////////////////////////////////
//! \ingroup DtkAPIGroup
//! \class Dtk_GraphicalData 
//! \brief This is the Dtk_GraphicalData Class.\n
//! The Dtk_GraphicalDataPtr object is used to store preview data 
//! It contains graphical information.\n
 
 
 
 
class Dtk_GraphicalData : public Dtk_Object
{
public:
 
 
protected:
     enum
     {
          _typeID = DTK_TYPE_GRAPHICAL_DATA
     };
     struct Dtk_Handle;
     std::unique_ptr<Dtk_Handle> _Private;
 
     //! \sa Create(const Dtk_GraphicalData &)
     Dtk_GraphicalData( const Dtk_GraphicalData& );
     Dtk_GraphicalData( Dtk_GraphicalData&& ) DTK_NOEXCEPT;
 
     //! \sa CreateMetaData
     //! \sa CreateParameterMetaData
     Dtk_GraphicalData();
 
     //! \BaseDestructor 
     virtual ~Dtk_GraphicalData();
     friend class Dtk_SmartPtr<Dtk_GraphicalData>;
 
public:
     //! \brief Create a Dtk_GraphicalDataPtr.
     //! \return the constructed Dtk_GraphicalDataPtr.
     static Dtk_GraphicalDataPtr Create();
     //! \\CreateCopy{in}
     static Dtk_GraphicalDataPtr Create( Dtk_GraphicalData const& in );
 
     //! \DtkDynamicType
     inline Dtk_Int32 DtkDynamicType( const Dtk_Int32 &inId )
     {
          if( inId == _typeID ) return 1;
          return Dtk_Object::DtkDynamicType( inId );
     }
 
     //! \DtkDynamicCast
     static Dtk_GraphicalData* DtkDynamicCast( Dtk_Object *s )
     {
          if( s->DtkDynamicType( _typeID ) ) return static_cast< Dtk_GraphicalData* >( s );
          return NULL;
     }
 
 
     //! \brief Set Drawings
     DtkErrorStatus SetDrawings( Dtk_tab<Dtk_DrawingPtr> inDrawings );
     //! \brief Add One Drawing
     DtkErrorStatus AddDrawing( Dtk_DrawingPtr inDrawing );
     //! \brief Get Number of Drawing
     Dtk_Size_t GetNumDrawings();
     //! \brief Get Number of Drawing
     Dtk_DrawingPtr GetDrawing( Dtk_Size_t inNum);
     //! \brief Get Drawings
     Dtk_tab<Dtk_DrawingPtr> GetDrawings( );
 
     //! \brief Set Meshes
     DtkErrorStatus SetMeshes( Dtk_tab<Dtk_MeshPtr> inMeshes );
     //! \brief Add One Mesh
     DtkErrorStatus AddMesh( Dtk_MeshPtr inMesh );
     //! \brief Get Number of Meshes
     Dtk_Size_t GetNumMeshes();
     //! \brief Get Number of Drawing
     Dtk_MeshPtr GetMesh( Dtk_Size_t inNum );
     //! \brief Get Meshes
     Dtk_tab<Dtk_MeshPtr> GetMeshes();
 
     //! \brief Get Default Camera
     Dtk_CameraPtr GetDefaultCamera();
     //! \brief Set Default Camera
     DtkErrorStatus SetDefaultCamera(Dtk_CameraPtr inDefaultCamera);
 
 
 
};
 
#endif