Bial::Circle Class Reference

#include <DrawCircle.hpp>

Inheritance diagram for Bial::Circle:

Collaboration diagram for Bial::Circle:

Public Member Functions
	Circle (const Vector< float > &center, const float radius=1.0, const Color color=Color(1), const bool filled=true)
	Basic Constructor. More...
template<class D >
void	Draw (Image< D > &img) const
	Draws 2D circle in input image. More...
template<class D >
void	Draw (Image< D > &img, const Vector< float > &displacement) const
	Draws 2D circle 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 circle information to stream. More...
Public Member Functions inherited from Bial::Figure< Circle >
	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 >	center
float	radius
bool	filled
Public Attributes inherited from Bial::Figure< Circle >
Color	color
	The color of the figure. More...

Protected Member Functions
template<class D >
void	PlotPixels (Image< D > &img, const Vector< float > &displacement, const int dx, const int dy) const
	Plot 8 pixels based on calculated displacement. More...

Detailed Description

Definition at line 24 of file DrawCircle.hpp.

Constructor & Destructor Documentation

Bial::Circle::Circle	(	const Vector< float > &	center,
		const float	radius = 1.0,
		const Color	color = Color(1),
		const bool	filled = true
	)

Basic Constructor.

Date

2014/Dec/06

Version

1.0.00

Parameters

radius	Radius of the circle
color	The color of the circle.
filled	Whether circle is filled or not.

Returns

none.

Warning

Only availble to 2D images

Member Function Documentation

template<class D >

void Bial::Circle::Draw

(

Image< D > &

img

)

const

Draws 2D circle in input image.

Date

2014/Dec/06

Version

1.0.00

Parameters

img

An image.

Returns

none.

Warning

circle displacement (center) is set to the center of the image.

template<class D >

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

Draws 2D circle in input image.

Date

2014/Dec/06

Version

1.0.00

Parameters

img	An image.
displacement	Center of the circle.

Returns

none.

Warning

none.

Vector< Vector< int > > Bial::Circle::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::Circle::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 D >

void Bial::Circle::PlotPixels ( Image< D > &  img, const Vector< float > &  displacement, const int  dx, const int  dy  ) const

protected

Plot 8 pixels based on calculated displacement.

Date

2014/Dec/06

Version

1.0.00

Parameters

img	An image.
displacement	Center of the circle.
dx	horizontal displacement of the pixel
dy	vertical displacement of the pixel

Returns

none.

Warning

none.

template<class O >

void Bial::Circle::Print

(

O &

os

)

const

Prints circle information to stream.

Date

2014/Dec/06

Version

1.0.00

Parameters

os	an output stream.

Returns

none.

Warning

none.

Member Data Documentation

Vector< float > Bial::Circle::center

Definition at line 26 of file DrawCircle.hpp.

bool Bial::Circle::filled

Definition at line 28 of file DrawCircle.hpp.

float Bial::Circle::radius

Definition at line 27 of file DrawCircle.hpp.

---

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

• bial/inc/DrawCircle.hpp