dtk_picture.hpp

Go to the documentation of this file.

#ifndef __DTK_PICTURE_HPP__
#define __DTK_PICTURE_HPP__
 
#include "def/define.h"
 
//! \ingroup base_types
//! \class Dtk_picture
//! \brief This class defines a picture
//!
//!    This class defines a picture
#include "util/BaseTypes/dtk_transfo.hpp"
#include "util/BaseTypes/dtk_pnt.hpp"
#include "util/BaseTypes/dtk_object.hpp"
#include "util/error_dtk.hpp"
#include "util/util_ptr_dtk.hpp"
#include "util/util_stl_dtk.hpp"
 
class Dtk_Object;
enum Dtk_PictureType
{
     DTK_PICTURE_UNKNOWN,
    DTK_PICTURE_RGB24,
    DTK_PICTURE_RGBA32,
     DTK_PICTURE_JPG,
     DTK_PICTURE_BMP,
     DTK_PICTURE_PNG,
     DTK_PICTURE_CGM,
    DTK_PICTURE_GIF,
    DTK_PICTURE_TIFF,
    DTK_PICTURE_ICO,
    DTK_PICTURE_PS,
    DTK_PICTURE_SVG,
    DTK_PICTURE_OLE,
     DTK_PICTURE_WMF,
     DTK_PICTURE_EMF,
     DTK_PICTURE_TGA
};
class Dtk_picture : public Dtk_Object
{
 
protected:
    enum {
        _typeID = DTK_TYPE_PICTURE
    };
     Dtk_InfoPtr        m_Info;
     Dtk_tab<char> _file;
    Dtk_Size_t _pixel_width;
    Dtk_Size_t _pixel_height;
     double _scale_x;
     double _scale_y;
     double _metric_width;
     double _metric_height;
    Dtk_pnt _origin;
     Dtk_PictureType _type;
 
private:
    friend class Dtk_SmartPtr<Dtk_picture>;
     inline virtual Dtk_Object* Clone() { return new Dtk_picture( *this ); }
public:
 
    //downcasting
    int DtkDynamicType(const int& inId);
    static Dtk_picture* DtkDynamicCast(Dtk_Object * s);
 
    Dtk_picture ();
    ~Dtk_picture ();
    Dtk_picture(const Dtk_picture & );
    Dtk_picture( Dtk_picture && ) DTK_NOEXCEPT;
     Dtk_picture& operator=( const Dtk_picture& s );
     Dtk_picture& operator=( Dtk_picture&& s ) DTK_NOEXCEPT;
 
     Dtk_InfoPtr get_info() const;
     Dtk_InfoPtr& info();
 
    //! \brief Retrieves the binary file
    //! \return the binary file
    inline Dtk_tab<char> & File() { return this->_file; }
    inline const Dtk_tab<char> & File() const { return this->_file; }
    //! \brief Retrieves the file type
    //! \return the absolute file type
    inline Dtk_PictureType & FileType() { return this->_type; }
    inline Dtk_PictureType FileType() const { return this->_type; }
    //! \brief Retrieves the width (in pixels)
    //! \return the width (in pixels)
    inline Dtk_Size_t &PixelWidth() { return this->_pixel_width; }
    inline Dtk_Size_t PixelWidth() const { return this->_pixel_width; }
 
    //! \brief Retrieves the height (in pixels)
    //! \return the height (in pixels)
    inline Dtk_Size_t &PixelHeight() { return this->_pixel_height; }
    inline Dtk_Size_t PixelHeight() const { return this->_pixel_height; }
 
    //! \brief Retrieves the width (in mm)
    //! \return the width (in mm)
    inline double &MetricWidth() { return this->_metric_width; }
    inline double MetricWidth() const { return this->_metric_width; }
    //! \brief Retrieves the height (in mm)
    //! \return the height (in mm)
    inline double &MetricHeight() { return this->_metric_height; }
    inline double MetricHeight() const { return this->_metric_height; }
    //! \brief Retrieves the origin (in mm)
    //! \return the origin (in mm)
    inline Dtk_pnt &Origin() { return this->_origin; }
    inline const Dtk_pnt &Origin() const { return this->_origin; }
 
    //! \brief Retrieves the X scale factor
    //! \return the X scale factor
    inline double &ScaleX() { return this->_scale_x; }
    inline double ScaleX() const { return this->_scale_x; }
    //! \brief Retrieves the Y scale factor
    //! \return the Y scale factor
    inline double &ScaleY() { return this->_scale_y; }
    inline double ScaleY() const { return this->_scale_y; }
    
     //!\brief copy
     //! \deprecated Use Dtk_picture::Dtk_picture(const Dtk_picture &) instead
     SetAsDeprecated( "2026.4", "Use Dtk_picture::Dtk_picture(const Dtk_picture &) instead" )
    void _Copy(const Dtk_picture * s);
 
     //! \Transform{inTransfo}
     Dtk_ErrorStatus Transform( const Dtk_transfo &inTransfo );
};
 
 
#endif