Companion::Draw::Drawable Class Reference

#include <Drawable.h>

Inheritance diagram for Companion::Draw::Drawable:

Public Member Functions
virtual void	Draw (cv::Mat image)=0
virtual void	Ratio (int cWidth, int cHeight, int nWidth, int nHeight)=0
virtual cv::Rect	CutArea ()=0
virtual int	OriginX ()=0
virtual int	OriginY ()=0
virtual void	MoveOrigin (int x, int y)=0
virtual void	Color (const cv::Scalar &color)=0
virtual const cv::Scalar &	Color () const =0
virtual int	Thickness () const =0
virtual void	Thickness (int thickness)=0

Detailed Description

Abstract class for a drawable object.

Author

Andreas Sekulski, Dimitri Kotlovsky

Member Function Documentation

Color() [1/2]

virtual void Companion::Draw::Drawable::Color ( const cv::Scalar &  color )

pure virtual

Set drawable color.

Parameters

color

Drawable color to set.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

Color() [2/2]

virtual const cv::Scalar& Companion::Draw::Drawable::Color ( ) const

pure virtual

Get the color of the drawable.

Returns

Drawable color.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

CutArea()

virtual cv::Rect Companion::Draw::Drawable::CutArea ( )

pure virtual

Get cut area around this drawable.

Returns

Cut area around this drawable as a cv::Rect.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

Draw()

virtual void Companion::Draw::Drawable::Draw ( cv::Mat  image )

pure virtual

Draw this drawable object to the given image.

Parameters

image

Image on which to draw the object.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

MoveOrigin()

virtual void Companion::Draw::Drawable::MoveOrigin ( int  x, int  y  )

pure virtual

Move the drawable object's origin.

Parameters

x	Relative distance to move the origin on the x axis.
y	Relative distance to move the origin on the y axis.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

OriginX()

virtual int Companion::Draw::Drawable::OriginX ( )

pure virtual

Obtain the origin's x coordinate.

Returns

X coordinate of the drawable object's origin.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

OriginY()

virtual int Companion::Draw::Drawable::OriginY ( )

pure virtual

Obtain the origin's y coordinate.

Returns

Y coordinate of the drawable object's origin.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

Ratio()

virtual void Companion::Draw::Drawable::Ratio ( int  cWidth, int  cHeight, int  nWidth, int  nHeight  )

pure virtual

Scale this drawable from the current image dimensions to new image dimensions.

Parameters

cWidth	Current image width.
cHeight	Current image height.
nWidth	New image width.
nHeight	New image height.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

Thickness() [1/2]

virtual int Companion::Draw::Drawable::Thickness ( ) const

pure virtual

Get thickness of this drawable.

Returns

Drawable thickness.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

Thickness() [2/2]

virtual void Companion::Draw::Drawable::Thickness ( int  thickness )

pure virtual

Set thickness of the drawable.

Parameters

thickness

Drawable thickness.

Implemented in Companion::Draw::Frame, and Companion::Draw::Line.

---

The documentation for this class was generated from the following file:

• Drawable.h