A class with encapsulated a font loaded from disk with a given size. More...

Public Types
enum	TextAlignement { AlignLeft, AlignCenter, AlignRight, AlignJustify }

Public Member Functions
	~DtFont ()
	DTOR.
const std::string &	fontName () const
	Get the name.
bool	attachFile (const char *fontFilePath)
	Attach auxilliary file to font e.g font metrics.
void	setFreeTypeLoadFlags (unsigned int flags)
	Set the FreeType load flags.
bool	setCharacterMap (unsigned int encoding)
	Set the FreeType characte encoding map.
const unsigned int *	characterMaps ()
	Get the list of character maps.
unsigned int	characterMapCount () const
	Get the number of charater maps.
const DtFreeTypeFace &	freeTypeFace () const
bool	setFaceSize (const unsigned int size)
unsigned int	faceSize () const
float	globalAscender () const
float	globalDescender () const
float	lineHeight () const
DtBoundingBox	calculateBoundingBox (const DtPen &pen, const DtUnicode &string, unsigned int pos=0, int len=-1)
	Calculate the bounding box for a string.
Dt2dPoint	calculateGlyphSize (const DtPen &pen, const DtUnicode &string, unsigned int pos=0, int len=-1)
	Calculate the bounding box for a string.
float	calculateAdvance (const DtPen &pen, const DtUnicode &string, unsigned int pos=0, int len=-1)
void	releaseResources ()
bool	isValid () const
	Returns true if this font is valid (has a character map)
bool	checkError () const
	Asks the private implementation to see if there is an error with the font.
DtGlyph *	findOrLoadGlyphForRendering (DtGlyphRenderer &renderer, const unsigned int characterCode, bool characterCodeIsIndex=false)
	Returns the glyph to render given the character code.
DtGlyph *	findOrLoadGlyph (const unsigned int chr)
	Load the glyph, or return null if the glyph is not loaded.
unsigned int	indexInFont (const unsigned int characterCode) const
	Returns the absolute index of the font in the font set given the font character.
Dt2dPoint	calculateKerning (unsigned int index1, unsigned int index2)

Protected Member Functions
	DtFont (DtFontManager &fm, const std::string &fontFilePath)
	CTOR create and load a font.

Protected Attributes
FontPrivate *	myImpl
	Internal FTGL FTFont implementation object. For private use only.

Friends
class	DtFontManager

Detailed Description

A class with encapsulated a font loaded from disk with a given size.

Member Enumeration Documentation

enum makVrv::DtFont::TextAlignement

Enumerator:

AlignLeft
AlignCenter
AlignRight
AlignJustify

Constructor & Destructor Documentation

makVrv::DtFont::~DtFont ( )

DTOR.

makVrv::DtFont::DtFont	(	DtFontManager &	fm,
		const std::string &	fontFilePath
	)

protected

CTOR create and load a font.

Member Function Documentation

const std::string& makVrv::DtFont::fontName ( ) const

Get the name.

bool makVrv::DtFont::attachFile ( const char * fontFilePath )

Attach auxilliary file to font e.g font metrics.

void makVrv::DtFont::setFreeTypeLoadFlags ( unsigned int flags )

Set the FreeType load flags.

bool makVrv::DtFont::setCharacterMap ( unsigned int encoding )

Set the FreeType characte encoding map.

const unsigned int* makVrv::DtFont::characterMaps ( )

Get the list of character maps.

unsigned int makVrv::DtFont::characterMapCount ( ) const

Get the number of charater maps.

const DtFreeTypeFace& makVrv::DtFont::freeTypeFace ( ) const

bool makVrv::DtFont::setFaceSize ( const unsigned int size )

unsigned int makVrv::DtFont::faceSize ( ) const

float makVrv::DtFont::globalAscender ( ) const

float makVrv::DtFont::globalDescender ( ) const

float makVrv::DtFont::lineHeight ( ) const

DtBoundingBox makVrv::DtFont::calculateBoundingBox	(	const DtPen &	pen,
		const DtUnicode &	string,
		unsigned int	pos = `0`,
		int	len = `-1`
	)

Calculate the bounding box for a string.

Dt2dPoint makVrv::DtFont::calculateGlyphSize	(	const DtPen &	pen,
		const DtUnicode &	string,
		unsigned int	pos = `0`,
		int	len = `-1`
	)

Calculate the bounding box for a string.

float makVrv::DtFont::calculateAdvance	(	const DtPen &	pen,
		const DtUnicode &	string,
		unsigned int	pos = `0`,
		int	len = `-1`
	)

void makVrv::DtFont::releaseResources ( )

bool makVrv::DtFont::isValid ( ) const

Returns true if this font is valid (has a character map)

bool makVrv::DtFont::checkError ( ) const

Asks the private implementation to see if there is an error with the font.

DtGlyph* makVrv::DtFont::findOrLoadGlyphForRendering	(	DtGlyphRenderer &	renderer,
		const unsigned int	characterCode,
		bool	characterCodeIsIndex = `false`
	)

Returns the glyph to render given the character code.

If characterCodeIsIndex is true then the character code given is an index into the font, not the character code itself

DtGlyph* makVrv::DtFont::findOrLoadGlyph ( const unsigned int chr )

Load the glyph, or return null if the glyph is not loaded.

unsigned int makVrv::DtFont::indexInFont ( const unsigned int characterCode ) const

Returns the absolute index of the font in the font set given the font character.

Internally used to map character font to its index

Dt2dPoint makVrv::DtFont::calculateKerning	(	unsigned int	index1,
		unsigned int	index2
	)

Friends And Related Function Documentation

friend class DtFontManager

friend

Member Data Documentation

FontPrivate* makVrv::DtFont::myImpl

protected

Internal FTGL FTFont implementation object. For private use only.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvGraphics/DtFont.h

Public Types

Public Member Functions

Protected Member Functions