syBR Engine: syBR::Game::GUIFont Class Reference

List of all members.


Public Member Functions
	GUIFont (const std::string &name, Core::Logger *pLogger)
	Constructor.
virtual	~GUIFont ()
	Destructor.
bool	load ()
	Load font descriptor and the associated texture.
void	render (const std::string &text, const Ogre::Vector2 &position, float size, const Ogre::ColourValue &color, std::vector< GUIManager::Quad > &renderList)
	Render some text.
Private Attributes
Core::Logger *	m_pLogger
	Pointer to the logger to be used.
bool	m_loaded
	Indicates if the font is already loaded.
std::string	m_name
	Name.
std::string	m_textureName
	Texture name.
FontDescriptor	m_descriptor
	Font descriptor.
CharacterDescriptor	m_characters [CHARACTER_COUNT]
	Characters descriptors.
Classes
struct	CharacterDescriptor
	Structure used internally to describe a font character. More...
struct	FontDescriptor
	Structure used internally to describle a font. More...

Detailed Description

It loads a bitmap font descriptor from Bitmap Font Generator (visit www.AngelCode.com) and allows to retrieve rendering informations for each character in the font.

Constructor & Destructor Documentation

syBR::Game::GUIFont::GUIFont	(	const std::string &	name,
		Core::Logger *	pLogger
	)

Constructor.

Parameters:

	name	Name of the widget
	pLogger	Pointer to the instance of the logger to use

syBR::Game::GUIFont::~GUIFont ( ) [virtual]

Destructor.

Release used resources.

Member Function Documentation

bool syBR::Game::GUIFont::load ( )

Load font descriptor and the associated texture.

Returns:

One of these:

true in case of success
false otherwise

void syBR::Game::GUIFont::render	(	const std::string &	text,
		const Ogre::Vector2 &	position,
		float	size,
		const Ogre::ColourValue &	color,
		std::vector< GUIManager::Quad > &	renderList
	)

Render some text.

Parameters:

	text	Text to render
	position	Top left position of the text in Ogre coordinates
	size	Size factor (1.0 to use normal size)
	color	Color of the text
	renderList	List of renderables where all the renderables needed to render the requested text will be pushed back

Member Data Documentation