CEGUI::FontGlyph Class Reference

internal class representing a single font glyph. More...

Inheritance diagram for CEGUI::FontGlyph:

Collaboration diagram for CEGUI::FontGlyph:

Public Member Functions
	FontGlyph (float advance=0.0f, Image *image=0, bool valid=false)
	Constructor.
Image *	getImage () const
	Return the CEGUI::Image object rendered for this glyph.
Sizef	getSize (float x_scale, float y_scale) const
	Return the scaled pixel size of the glyph.
float	getWidth (float x_scale) const
	Return the scaled width of the glyph.
float	getHeight (float y_scale) const
	Return the scaled height of the glyph.
float	getRenderedAdvance (float x_scale) const
	Return the rendered advance value for this glyph. More...
float	getAdvance (float x_scale=1.0) const
	Return the horizontal advance value for the glyph. More...
void	setAdvance (float advance)
	Set the horizontal advance value for the glyph.
void	setImage (Image *image)
	Set the CEGUI::Image object rendered for this glyph.
void	setValid (bool valid)
	mark the FontGlyph as valid
bool	isValid () const
	return whether the FontGlyph is marked as valid

Detailed Description

internal class representing a single font glyph.

For TrueType fonts initially all FontGlyph's are empty (getImage() will return 0), but they are filled by demand.

Member Function Documentation

float CEGUI::FontGlyph::getAdvance ( float  x_scale = 1.0 ) const

inline

Return the horizontal advance value for the glyph.

The returned value is the number of pixels the pen should move horizontally to position itself ready to render the next glyph. This is not always the same as the glyph image width or rendererd advance, since it allows for horizontal overhangs.

float CEGUI::FontGlyph::getRenderedAdvance ( float  x_scale ) const

inline

Return the rendered advance value for this glyph.

The rendered advance value is the total number of pixels from the current pen position that will be occupied by this glyph when rendered.