Bial::Box Class Reference

Box Figure class. More...

#include <DrawBox.hpp>

Inheritance diagram for Bial::Box:

Collaboration diagram for Bial::Box:

Public Member Functions
	Box (const Vector< float > &low_coord, const Vector< float > &size, const Color color=Color(1), const bool filled=true)
	Basic Constructor. More...
template<class D >
void	Draw (Image< D > &img) const
	Draws n-dimensional box in input image. More...
template<class D >
void	Draw (Image< D > &img, const Vector< float > &displacement) const
	Draws n-dimensional box in input image. More...
Vector< Vector< int > >	Pixels () const
	Returns a vector with coordinates of the pixels from this Figure. More...
Vector< Vector< int > >	Pixels (const Vector< float > &displacement) const
	Returns a vector with coordinates of the pixels from this figure. More...
template<class O >
void	Print (O &os) const
	Prints box information to stream. More...
Public Member Functions inherited from Bial::Figure< Box >
	Figure (const Color &color)
	Basic Constructor. More...
void	Draw (Image< D > &img)
	Draws figure in input image. More...
void	Draw (Image< D > &img, const Vector< float > &displacement) const
	Draws n-dimensional figure in input image. More...
Vector< Vector< int > >	Pixels () const
	Returns a vector with coordinates of the pixels from this Figure. More...
Vector< Vector< int > >	Pixels (const Vector< float > &displacement) const
	Returns a vector with coordinates of the pixels from this figure. More...
void	Print (O &os) const
	Prints figure information to stream. More...

Public Attributes
Vector< float >	low_coord
	Lower coordinates of box. More...
Vector< float >	size
	Size of box. More...
bool	filled
	Weather or not box is filled. More...
Public Attributes inherited from Bial::Figure< Box >
Color	color
	The color of the figure. More...

Detailed Description

Box Figure class.

Definition at line 27 of file DrawBox.hpp.

Constructor & Destructor Documentation

Bial::Box::Box	(	const Vector< float > &	low_coord,
		const Vector< float > &	size,
		const Color	color = Color(1),
		const bool	filled = true
	)

Basic Constructor.

Date

2014/Mar/17

Parameters

low_coord	Lower coordinate value of each side.
size	Side of each box side.
color	The color of the box.
filled	Whether box is filled or not.

Returns

none.

Warning

Zero is assigned to all elements. Pixel dimensions are set to 1.0. Channels are set to unknown type

Member Function Documentation

template<class D >

void Bial::Box::Draw

(

Image< D > &

img

)

const

Draws n-dimensional box in input image.

Date

2014/Mar/18

Parameters

img

An image.

Returns

none.

Warning

none.

template<class D >

void Bial::Box::Draw	(	Image< D > &	img,
		const Vector< float > &	displacement
	)		const

Draws n-dimensional box in input image.

Date

2014/Mar/17

Parameters

img	An image.
displacement	Displacement from low coordinate to start drawing.

Returns

none.

Warning

none.

Vector< Vector< int > > Bial::Box::Pixels

(

)

const

Returns a vector with coordinates of the pixels from this Figure.

Date

2015/Jul/07

Parameters

none.

Returns

Vector with pixels.

Warning

none.

Vector< Vector< int > > Bial::Box::Pixels

(

const Vector< float > &

displacement

)

const

Returns a vector with coordinates of the pixels from this figure.

Date

2015/Jul/07

Parameters

displacement

Displacement from low coordinate of the figure.

Returns

Vector with pixels.

Warning

none.

template<class O >

void Bial::Box::Print

(

O &

os

)

const

Prints box information to stream.

Date

2014/Mar/18

Parameters

os	an output stream.

Returns

none.

Warning

none.

Member Data Documentation

bool Bial::Box::filled

Weather or not box is filled.

Definition at line 36 of file DrawBox.hpp.

Vector< float > Bial::Box::low_coord

Lower coordinates of box.

Definition at line 32 of file DrawBox.hpp.

Vector< float > Bial::Box::size

Size of box.

Definition at line 34 of file DrawBox.hpp.

---

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

• bial/inc/DrawBox.hpp