DATAKIT API  V2025.1
Dtk_picture Class Reference

This class defines a picture. More...

+ Inheritance diagram for Dtk_picture:

Public Member Functions

void _Copy (const Dtk_picture *s)
 copy More...
 
 Dtk_picture ()
 
 Dtk_picture (const Dtk_picture &inToBeCopied)
 
int DtkDynamicType (const int &inId)
 
virtual void dump (FILE *file=stdout)
 
Dtk_tab< char > & File ()
 Retrieves the binary file. More...
 
const Dtk_tab< char > & File () const
 
Dtk_PictureTypeFileType ()
 Retrieves the file type. More...
 
Dtk_PictureType FileType () const
 
Dtk_InfoPtr get_info () const
 
virtual Dtk_Size_t GetSize () const
 
Dtk_InfoPtrinfo ()
 
double & MetricHeight ()
 Retrieves the height (in mm) More...
 
double MetricHeight () const
 
double & MetricWidth ()
 Retrieves the width (in mm) More...
 
double MetricWidth () const
 
Dtk_pntOrigin ()
 Retrieves the origin (in mm) More...
 
const Dtk_pntOrigin () const
 
Dtk_Size_tPixelHeight ()
 Retrieves the height (in pixels) More...
 
Dtk_Size_t PixelHeight () const
 
Dtk_Size_tPixelWidth ()
 Retrieves the width (in pixels) More...
 
Dtk_Size_t PixelWidth () const
 
double & ScaleX ()
 Retrieves the X scale factor. More...
 
double ScaleX () const
 
double & ScaleY ()
 Retrieves the Y scale factor. More...
 
double ScaleY () const
 
Dtk_ErrorStatus Transform (const Dtk_transfo &inTransfo)
 Applies a transformation matrix to the entity. //! More...
 
 ~Dtk_picture ()
 

Static Public Member Functions

static Dtk_pictureDtkDynamicCast (Dtk_Object *s)
 

Protected Types

enum  { _typeID = DTK_TYPE_PICTURE }
 

Protected Member Functions

void _copy (const Dtk_Object &s)
 
void _init ()
 
void _reset ()
 

Protected Attributes

Dtk_tab< char > _file
 
double _metric_height
 
double _metric_width
 
Dtk_pnt _origin
 
Dtk_Size_t _pixel_height
 
Dtk_Size_t _pixel_width
 
double _scale_x
 
double _scale_y
 
Dtk_PictureType _type
 
unsigned long count_
 
Dtk_InfoPtr m_Info
 

Friends

class Dtk_SmartPtr< Dtk_picture >
 

Detailed Description

This class defines a picture.

This class defines a picture

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 
48  {
50  };

Constructor & Destructor Documentation

◆ Dtk_picture() [1/2]

Dtk_picture::Dtk_picture ( )

◆ ~Dtk_picture()

Dtk_picture::~Dtk_picture ( )

◆ Dtk_picture() [2/2]

Dtk_picture::Dtk_picture ( const Dtk_picture inToBeCopied)

Member Function Documentation

◆ _copy()

void Dtk_Object::_copy ( const Dtk_Object s)
protectedinherited

◆ _Copy()

void Dtk_picture::_Copy ( const Dtk_picture s)

copy

◆ _init()

void Dtk_Object::_init ( )
protectedinherited

◆ _reset()

void Dtk_Object::_reset ( )
protectedinherited

◆ DtkDynamicCast()

static Dtk_picture* Dtk_picture::DtkDynamicCast ( Dtk_Object s)
static

◆ DtkDynamicType()

int Dtk_picture::DtkDynamicType ( const int &  inId)
virtual

Implements Dtk_Object.

◆ dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout)
virtualinherited

◆ File() [1/2]

Dtk_tab<char>& Dtk_picture::File ( )

Retrieves the binary file.

Returns
the binary file
83 { return this->_file; }

◆ File() [2/2]

const Dtk_tab<char>& Dtk_picture::File ( ) const
84 { return this->_file; }

◆ FileType() [1/2]

Dtk_PictureType& Dtk_picture::FileType ( )

Retrieves the file type.

Returns
the absolute file type
87 { return this->_type; }

◆ FileType() [2/2]

Dtk_PictureType Dtk_picture::FileType ( ) const
88 { return this->_type; }

◆ get_info()

Dtk_InfoPtr Dtk_picture::get_info ( ) const

◆ GetSize()

◆ info()

Dtk_InfoPtr& Dtk_picture::info ( )

◆ MetricHeight() [1/2]

double& Dtk_picture::MetricHeight ( )

Retrieves the height (in mm)

Returns
the height (in mm)
105 { return this->_metric_height; }

◆ MetricHeight() [2/2]

double Dtk_picture::MetricHeight ( ) const
106 { return this->_metric_height; }

◆ MetricWidth() [1/2]

double& Dtk_picture::MetricWidth ( )

Retrieves the width (in mm)

Returns
the width (in mm)
101 { return this->_metric_width; }

◆ MetricWidth() [2/2]

double Dtk_picture::MetricWidth ( ) const
102 { return this->_metric_width; }

◆ Origin() [1/2]

Dtk_pnt& Dtk_picture::Origin ( )

Retrieves the origin (in mm)

Returns
the origin (in mm)
109 { return this->_origin; }

◆ Origin() [2/2]

const Dtk_pnt& Dtk_picture::Origin ( ) const
110 { return this->_origin; }

◆ PixelHeight() [1/2]

Dtk_Size_t& Dtk_picture::PixelHeight ( )

Retrieves the height (in pixels)

Returns
the height (in pixels)
96 { return this->_pixel_height; }

◆ PixelHeight() [2/2]

Dtk_Size_t Dtk_picture::PixelHeight ( ) const
97 { return this->_pixel_height; }

◆ PixelWidth() [1/2]

Dtk_Size_t& Dtk_picture::PixelWidth ( )

Retrieves the width (in pixels)

Returns
the width (in pixels)
91 { return this->_pixel_width; }

◆ PixelWidth() [2/2]

Dtk_Size_t Dtk_picture::PixelWidth ( ) const
92 { return this->_pixel_width; }

◆ ScaleX() [1/2]

double& Dtk_picture::ScaleX ( )

Retrieves the X scale factor.

Returns
the X scale factor
114 { return this->_scale_x; }

◆ ScaleX() [2/2]

double Dtk_picture::ScaleX ( ) const
115 { return this->_scale_x; }

◆ ScaleY() [1/2]

double& Dtk_picture::ScaleY ( )

Retrieves the Y scale factor.

Returns
the Y scale factor
118 { return this->_scale_y; }

◆ ScaleY() [2/2]

double Dtk_picture::ScaleY ( ) const
119 { return this->_scale_y; }

◆ Transform()

Dtk_ErrorStatus Dtk_picture::Transform ( const Dtk_transfo inTransfo)

Applies a transformation matrix to the entity. //!

Parameters
inTransfoThe transformation matrix to apply.

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_picture >

friend class Dtk_SmartPtr< Dtk_picture >
friend

Field Documentation

◆ _file

Dtk_tab<char> Dtk_picture::_file
protected

◆ _metric_height

double Dtk_picture::_metric_height
protected

◆ _metric_width

double Dtk_picture::_metric_width
protected

◆ _origin

Dtk_pnt Dtk_picture::_origin
protected

◆ _pixel_height

Dtk_Size_t Dtk_picture::_pixel_height
protected

◆ _pixel_width

Dtk_Size_t Dtk_picture::_pixel_width
protected

◆ _scale_x

double Dtk_picture::_scale_x
protected

◆ _scale_y

double Dtk_picture::_scale_y
protected

◆ _type

Dtk_PictureType Dtk_picture::_type
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited

◆ m_Info

Dtk_InfoPtr Dtk_picture::m_Info
protected
Dtk_picture::_pixel_width
Dtk_Size_t _pixel_width
Definition: dtk_picture.hpp:54
Dtk_picture::_pixel_height
Dtk_Size_t _pixel_height
Definition: dtk_picture.hpp:55
Dtk_picture::_type
Dtk_PictureType _type
Definition: dtk_picture.hpp:53
Dtk_picture::_scale_y
double _scale_y
Definition: dtk_picture.hpp:57
DTK_TYPE_PICTURE
@ DTK_TYPE_PICTURE
Definition: define.h:594
Dtk_picture::_metric_height
double _metric_height
Definition: dtk_picture.hpp:59
Dtk_picture::_scale_x
double _scale_x
Definition: dtk_picture.hpp:56
Dtk_picture::_origin
Dtk_pnt _origin
Definition: dtk_picture.hpp:60
Dtk_picture::_typeID
@ _typeID
Definition: dtk_picture.hpp:49
Dtk_picture::_metric_width
double _metric_width
Definition: dtk_picture.hpp:58
Dtk_picture::_file
Dtk_tab< char > _file
Definition: dtk_picture.hpp:52