vpFont Class Reference

#include <vpFont.h>

Public Member Functions
	vpFont (unsigned int height=16)
	~vpFont ()
bool	drawText (vpImage< unsigned char > &I, const std::string &text, const vpImagePoint &position, unsigned char color) const
bool	drawText (vpImage< unsigned char > &I, const std::string &text, const vpImagePoint &position, unsigned char color, unsigned char background) const
bool	drawText (vpImage< vpRGBa > &I, const std::string &text, const vpImagePoint &position, const vpColor &color) const
bool	drawText (vpImage< vpRGBa > &I, const std::string &text, const vpImagePoint &position, const vpColor &color, const vpColor &background) const
unsigned int	getHeight () const
bool	setHeight (unsigned int height)

Detailed Description

Font drawing functions for image.

Examples:

testGenericTracker.cpp, and testImageDraw.cpp.

Definition at line 55 of file vpFont.h.

Constructor & Destructor Documentation

vpFont::vpFont

(

unsigned int

height = 16

)

Creates a new Font class with given height.

Note

The font supports ASCII characters only. It was generated on the base of the generic monospace font from Gdiplus.

Parameters

[in]

height

: Initial font height value in pixels. By default it is equal to 16 pixels.

Definition at line 1940 of file vpFont.cpp.

vpFont::~vpFont

(

)

Destructor.

Definition at line 1947 of file vpFont.cpp.

Member Function Documentation

bool vpFont::drawText	(	vpImage< unsigned char > &	I,
		const std::string &	text,
		const vpImagePoint &	position,
		unsigned char	color
	)		const

Draws a text at the image.

Parameters

[in,out]	I	: Image where we draw text.
[in]	text	: A text to draw.
[in]	position	: A position to draw text.
[in]	color	: A color of the text.

Returns

A result of the operation.

Examples:

testGenericTracker.cpp, and testImageDraw.cpp.

Definition at line 1962 of file vpFont.cpp.

bool vpFont::drawText	(	vpImage< unsigned char > &	I,
		const std::string &	text,
		const vpImagePoint &	position,
		unsigned char	color,
		unsigned char	background
	)		const

Draws a text at the image. Fills the text background by given color.

Parameters

[in,out]	I	: Image where we draw text.
[in]	text	: A text to draw.
[in]	position	: A position to draw text.
[in]	color	: A color of the text.
[in]	background	: Background color.

Returns

a result of the operation.

Definition at line 1979 of file vpFont.cpp.

bool vpFont::drawText	(	vpImage< vpRGBa > &	I,
		const std::string &	text,
		const vpImagePoint &	position,
		const vpColor &	color
	)		const

Draws a text at the image.

Parameters

[in,out]	I	: Image where we draw text.
[in]	text	: A text to draw.
[in]	position	: A position to draw text.
[in]	color	: A color of the text.

Returns

A result of the operation.

Definition at line 1995 of file vpFont.cpp.

bool vpFont::drawText	(	vpImage< vpRGBa > &	I,
		const std::string &	text,
		const vpImagePoint &	position,
		const vpColor &	color,
		const vpColor &	background
	)		const

Draws a text at the image. Fills the text background by given color.

Parameters

[in,out]	I	: Image where we draw text.
[in]	text	: A text to draw.
[in]	position	: A position to draw text.
[in]	color	: A color of the text.
[in]	background	: Background color.

Returns

a result of the operation.

Definition at line 2012 of file vpFont.cpp.

unsigned int vpFont::getHeight

(

)

const

Gets height of the font in pixels.

Returns

Current height of the font.

Definition at line 2023 of file vpFont.cpp.

bool vpFont::setHeight

(

unsigned int

height

)

Sets a new height value to font.

Parameters

[in]

height

: A new height value in pixels.

Returns

A result of the operation.

Definition at line 2035 of file vpFont.cpp.