OGRE: Ogre::Font Class Reference

List of all members.


Public Types
typedef Ogre::uint32	CodePoint
typedef Ogre::FloatRect	UVRect
typedef std::pair < CodePoint, CodePoint >	CodePointRange
	A range of code points, inclusive on both ends.
typedef std::vector < CodePointRange >	CodePointRangeList
enum	LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING }
	Enum identifying the loading state of the resource. More...
Public Member Functions
	Font (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)
	Constructor.
virtual	~Font ()
void	setType (FontType ftype)
	Sets the type of font.
FontType	getType (void) const
	Gets the type of font.
void	setSource (const String &source)
	Sets the source of the font.
const String &	getSource (void) const
	Gets the source this font (either an image or a truetype font).
void	setTrueTypeSize (Real ttfSize)
	Sets the size of a truetype font (only required for FT_TRUETYPE).
void	setTrueTypeResolution (uint ttfResolution)
	Gets the resolution (dpi) of the font used to generate the texture (only required for FT_TRUETYPE).
Real	getTrueTypeSize (void) const
	Gets the point size of the font used to generate the texture.
uint	getTrueTypeResolution (void) const
	Gets the resolution (dpi) of the font used to generate the texture.
int	getTrueTypeMaxBearingY () const
	Gets the maximum baseline distance of all glyphs used in the texture.
const UVRect &	getGlyphTexCoords (CodePoint id) const
	Returns the texture coordinates of the associated glyph.
void	setGlyphTexCoords (CodePoint id, Real u1, Real v1, Real u2, Real v2, Real textureAspect)
	Sets the texture coordinates of a glyph.
Real	getGlyphAspectRatio (CodePoint id) const
	Gets the aspect ratio (width / height) of this character.
void	setGlyphAspectRatio (CodePoint id, Real ratio)
	Sets the aspect ratio (width / height) of this character.
const GlyphInfo &	getGlyphInfo (CodePoint id) const
	Gets the information available for a glyph corresponding to a given code point, or throws an exception if it doesn't exist;.
void	addCodePointRange (const CodePointRange &range)
	Adds a range of code points to the list of code point ranges to generate glyphs for, if this is a truetype based font.
void	clearCodePointRanges ()
	Clear the list of code point ranges.
const CodePointRangeList &	getCodePointRangeList () const
	Get a const reference to the list of code point ranges to be used to generate glyphs from a truetype font.
const MaterialPtr &	getMaterial () const
	Gets the material generated for this font, as a weak reference.
const MaterialPtr &	getMaterial ()
	Gets the material generated for this font, as a weak reference.
void	setAntialiasColour (bool enabled)
	Sets whether or not the colour of this font is antialiased as it is generated from a true type font.
bool	getAntialiasColour (void) const
	Gets whether or not the colour of this font is antialiased as it is generated from a true type font.
void	loadResource (Resource *resource)
	Implementation of ManualResourceLoader::loadResource, called when the Texture that this font creates needs to (re)load.
virtual void	prepare ()
	Prepares the resource for load, if it is not already.
virtual void	load (bool backgroundThread=false)
	Loads the resource, if it is not already.
virtual void	reload (void)
	Reloads the resource, if it is already loaded.
virtual bool	isReloadable (void) const
	Returns true if the Resource is reloadable, false otherwise.
virtual bool	isManuallyLoaded (void) const
	Is this resource manually loaded?
virtual void	unload (void)
	Unloads the resource; this is not permanent, the resource can be reloaded later if required.
virtual size_t	getSize (void) const
	Retrieves info about the size of the resource.
virtual void	touch (void)
	'Touches' the resource to indicate it has been used.
virtual const String &	getName (void) const
	Gets resource name.
virtual ResourceHandle	getHandle (void) const
virtual bool	isPrepared (void) const
	Returns true if the Resource has been prepared, false otherwise.
virtual bool	isLoaded (void) const
	Returns true if the Resource has been loaded, false otherwise.
virtual bool	isLoading () const
	Returns whether the resource is currently in the process of background loading.
virtual LoadingState	getLoadingState () const
	Returns the current loading state.
virtual bool	isBackgroundLoaded (void) const
	Returns whether this Resource has been earmarked for background loading.
virtual void	setBackgroundLoaded (bool bl)
	Tells the resource whether it is background loaded or not.
virtual void	escalateLoading ()
	Escalates the loading of a background loaded resource.
virtual void	addListener (Listener *lis)
	Register a listener on this resource.
virtual void	removeListener (Listener *lis)
	Remove a listener on this resource.
virtual const String &	getGroup (void)
	Gets the group which this resource is a member of.
virtual void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource.
virtual ResourceManager *	getCreator (void)
	Gets the manager which created this resource.
virtual const String &	getOrigin (void) const
	Get the origin of this resource, e.g.
virtual void	_notifyOrigin (const String &origin)
	Notify this resource of it's origin.
virtual size_t	getStateCount () const
	Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.
virtual void	_dirtyState ()
	Manually mark the state of this resource as having been changed.
virtual void	_fireBackgroundLoadingComplete (void)
	Firing of background loading complete event.
virtual void	_fireBackgroundPreparingComplete (void)
	Firing of background preparing complete event.
ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class.
const ParamDictionary *	getParamDictionary (void) const
const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object.
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method.
virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method.
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method.
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
virtual void	prepareResource (Resource *resource)
	Called when a resource wishes to load.
Static Public Member Functions
static void	cleanupDictionary ()
	Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
Protected Types
typedef std::map < CodePoint, GlyphInfo >	CodePointMap
	Map from unicode code point to texture coordinates.
typedef std::list < Listener * >	ListenerList
Protected Member Functions
void	createTextureFromFont (void)
	Internal method for loading from ttf.
virtual void	loadImpl ()
	Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.
virtual void	unloadImpl ()
	Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.
size_t	calculateSize (void) const
	Calculate the size of a resource; this will only be called after 'load'.
virtual void	preLoadImpl (void)
	Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
virtual void	postLoadImpl (void)
	Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
virtual void	preUnloadImpl (void)
	Internal hook to perform actions before the unload process.
virtual void	postUnloadImpl (void)
	Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
virtual void	prepareImpl (void)
	Internal implementation of the meat of the 'prepare' action.
virtual void	unprepareImpl (void)
	Internal function for undoing the 'prepare' action.
virtual void	queueFireBackgroundLoadingComplete (void)
	Queue the firing of background loading complete event.
virtual void	queueFireBackgroundPreparingComplete (void)
	Queue the firing of background preparing complete event.
bool	createParamDictionary (const String &className)
	Internal method for creating a parameter dictionary for the class, if it does not already exist.
Protected Attributes
FontType	mType
	The type of font.
String	mSource
	Source of the font (either an image name or a truetype font).
Real	mTtfSize
	Size of the truetype font, in points.
uint	mTtfResolution
	Resolution (dpi) of truetype font.
int	mTtfMaxBearingY
	Max distance to baseline of this (truetype) font.
CodePointMap	mCodePointMap
MaterialPtr	mpMaterial
	The material which is generated for this font.
TexturePtr	mTexture
	Texture pointer.
bool	mAntialiasColour
	for TRUE_TYPE font only
CodePointRangeList	mCodePointRangeList
	Range of code points to generate glyphs for (truetype only).
ResourceManager *	mCreator
	Creator.
String	mName
	Unique name of the resource.
String	mGroup
	The name of the resource group.
ResourceHandle	mHandle
	Numeric handle for more efficient look up than name.
AtomicScalar < LoadingState >	mLoadingState
	Is the resource currently loaded?
volatile bool	mIsBackgroundLoaded
	Is this resource going to be background loaded? Only applicable for multithreaded.
size_t	mSize
	The size of the resource in bytes.
bool	mIsManual
	Is this file manually loaded?
String	mOrigin
	Origin of this resource (e.g. script name) - optional.
ManualResourceLoader *	mLoader
	Optional manual loader; if provided, data is loaded from here instead of a file.
size_t	mStateCount
	State count, the number of times this resource has changed state.
ListenerList	mListenerList
String	mParamDictName
	Class name for this instance to be used as a lookup (must be initialised by subclasses).
Static Protected Attributes
static CmdType	msTypeCmd
static CmdSource	msSourceCmd
static CmdSize	msSizeCmd
static CmdResolution	msResolutionCmd
static CmdCodePoints	msCodePointsCmd
static ParamDictionaryMap	msDictionary
	Dictionary of parameters.
Classes
class	CmdCodePoints
	Command object for Font - see ParamCommand. More...
class	CmdResolution
	Command object for Font - see ParamCommand. More...
class	CmdSize
	Command object for Font - see ParamCommand. More...
class	CmdSource
	Command object for Font - see ParamCommand. More...
class	CmdType
	Command object for Font - see ParamCommand. More...
struct	GlyphInfo
	Information about the position and size of a glyph in a texture. More...

Detailed Description

Member Typedef Documentation

typedef Ogre::uint32 Ogre::Font::CodePoint

Definition at line 121 of file OgreFont.h.

typedef Ogre::FloatRect Ogre::Font::UVRect

Definition at line 122 of file OgreFont.h.

typedef std::pair<CodePoint, CodePoint> Ogre::Font::CodePointRange

A range of code points, inclusive on both ends.

Definition at line 137 of file OgreFont.h.

typedef std::vector<CodePointRange> Ogre::Font::CodePointRangeList

Definition at line 138 of file OgreFont.h.

typedef std::map<CodePoint, GlyphInfo> Ogre::Font::CodePointMap [protected]

Map from unicode code point to texture coordinates.

Definition at line 141 of file OgreFont.h.

typedef std::list<Listener*> Ogre::Resource::ListenerList [protected, inherited]

Definition at line 148 of file OgreResource.h.

Member Enumeration Documentation

enum Ogre::Resource::LoadingState [inherited]

Enum identifying the loading state of the resource.

Enumerator:

LOADSTATE_UNLOADED	Not loaded.
LOADSTATE_LOADING	Loading is in progress.
LOADSTATE_LOADED	Fully loaded.
LOADSTATE_UNLOADING	Currently unloading.
LOADSTATE_PREPARED	Fully prepared.
LOADSTATE_PREPARING	Preparing is in progress.

Definition at line 109 of file OgreResource.h.

Constructor & Destructor Documentation

Ogre::Font::Font	(	ResourceManager *	creator,
		const String &	name,
		ResourceHandle	handle,
		const String &	group,
		bool	isManual = `false`,
		ManualResourceLoader *	loader = `0`
	)

Constructor.

See also:: Resource

virtual Ogre::Font::~Font ( ) [virtual]

Member Function Documentation

void Ogre::Font::createTextureFromFont ( void ) [protected]

Internal method for loading from ttf.

virtual void Ogre::Font::loadImpl ( ) [protected, virtual]

Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.

Implements Ogre::Resource.

virtual void Ogre::Font::unloadImpl ( ) [protected, virtual]

Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.

Implements Ogre::Resource.

size_t Ogre::Font::calculateSize ( void ) const [protected, virtual]

Calculate the size of a resource; this will only be called after 'load'.

Implements Ogre::Resource.

Definition at line 164 of file OgreFont.h.

void Ogre::Font::setType ( FontType ftype )

Sets the type of font.

Must be set before loading.

FontType Ogre::Font::getType ( void ) const

Gets the type of font.

void Ogre::Font::setSource ( const String & source )

Sets the source of the font.

Remarks:: If you have created a font of type FT_IMAGE, this method tells the Font which image to use as the source for the characters. So the parameter should be the name of an appropriate image file. Note that when using an image as a font source, you will also need to tell the font where each character is located using setGlyphTexCoords (for each character).

: If you have created a font of type FT_TRUETYPE, this method tells the Font which .ttf file to use to generate the text. You will also need to call setTrueTypeSize and setTrueTypeResolution, and call addCodePointRange as many times as required to define the range of glyphs you want to be available.

Parameters:

source

An image file or a truetype font, depending on the type of this font

const String& Ogre::Font::getSource ( void ) const

Gets the source this font (either an image or a truetype font).

void Ogre::Font::setTrueTypeSize ( Real ttfSize )

Sets the size of a truetype font (only required for FT_TRUETYPE).

Parameters:

ttfSize

The size of the font in points. Note that the size of the font does not affect how big it is on the screen, just how large it is in the texture and thus how detailed it is.

void Ogre::Font::setTrueTypeResolution ( uint ttfResolution )

Gets the resolution (dpi) of the font used to generate the texture (only required for FT_TRUETYPE).

Parameters:

ttfResolution

The resolution in dpi

Real Ogre::Font::getTrueTypeSize ( void ) const

Gets the point size of the font used to generate the texture.

Remarks:: Only applicable for FT_TRUETYPE Font objects. Note that the size of the font does not affect how big it is on the screen, just how large it is in the texture and thus how detailed it is.

uint Ogre::Font::getTrueTypeResolution ( void ) const

Gets the resolution (dpi) of the font used to generate the texture.

Remarks:: Only applicable for FT_TRUETYPE Font objects.

int Ogre::Font::getTrueTypeMaxBearingY ( ) const

Gets the maximum baseline distance of all glyphs used in the texture.

Remarks:: Only applicable for FT_TRUETYPE Font objects. The baseline is the vertical origin of horizontal based glyphs. The bearingY attribute is the distance from the baseline (origin) to the top of the glyph's bounding box.

Note:: This value is only available after the font has been loaded.

const UVRect& Ogre::Font::getGlyphTexCoords ( CodePoint id ) const

Returns the texture coordinates of the associated glyph.

Remarks:: Parameter is a short to allow both ASCII and wide chars.

Parameters:

The code point (unicode)

Returns:: A rectangle with the UV coordinates, or null UVs if the code point was not present

Definition at line 243 of file OgreFont.h.

void Ogre::Font::setGlyphTexCoords	(	CodePoint	id,
		Real	u1,
		Real	v1,
		Real	u2,
		Real	v2,
		Real	textureAspect
	)

Sets the texture coordinates of a glyph.

Remarks:: You only need to call this if you're setting up a font loaded from a texture manually.

Note:: Also sets the aspect ratio (width / height) of this character. textureAspect is the width/height of the texture (may be non-square)

Definition at line 264 of file OgreFont.h.

References Ogre::TRect< T >::left.

Real Ogre::Font::getGlyphAspectRatio ( CodePoint id ) const

Gets the aspect ratio (width / height) of this character.

Definition at line 285 of file OgreFont.h.

void Ogre::Font::setGlyphAspectRatio	(	CodePoint	id,
		Real	ratio
	)

Sets the aspect ratio (width / height) of this character.

Remarks:: You only need to call this if you're setting up a font loaded from a texture manually.

Definition at line 302 of file OgreFont.h.

const GlyphInfo& Ogre::Font::getGlyphInfo ( CodePoint id ) const

Gets the information available for a glyph corresponding to a given code point, or throws an exception if it doesn't exist;.

void Ogre::Font::addCodePointRange ( const CodePointRange & range )

Adds a range of code points to the list of code point ranges to generate glyphs for, if this is a truetype based font.

Remarks:: In order to save texture space, only the glyphs which are actually needed by the application are generated into the texture. Before this object is loaded you must call this method as many times as necessary to define the code point range that you need.

Definition at line 324 of file OgreFont.h.

void Ogre::Font::clearCodePointRanges ( )

Clear the list of code point ranges.

Definition at line 331 of file OgreFont.h.

const CodePointRangeList& Ogre::Font::getCodePointRangeList ( ) const

Get a const reference to the list of code point ranges to be used to generate glyphs from a truetype font.

Definition at line 338 of file OgreFont.h.

const MaterialPtr& Ogre::Font::getMaterial ( ) const

Gets the material generated for this font, as a weak reference.

Remarks:: This will only be valid after the Font has been loaded.

Definition at line 346 of file OgreFont.h.

const MaterialPtr& Ogre::Font::getMaterial ( )

Gets the material generated for this font, as a weak reference.

Remarks:: This will only be valid after the Font has been loaded.

Definition at line 354 of file OgreFont.h.

void Ogre::Font::setAntialiasColour ( bool enabled )

Sets whether or not the colour of this font is antialiased as it is generated from a true type font.

Remarks:: This is valid only for a FT_TRUETYPE font. If you are planning on using alpha blending to draw your font, then it is a good idea to set this to false (which is the default), otherwise the darkening of the font will combine with the fading out of the alpha around the edges and make your font look thinner than it should. However, if you intend to blend your font using a colour blending mode (add or modulate for example) then it's a good idea to set this to true, in order to soften your font edges.

Definition at line 369 of file OgreFont.h.

bool Ogre::Font::getAntialiasColour ( void ) const

Gets whether or not the colour of this font is antialiased as it is generated from a true type font.

Definition at line 377 of file OgreFont.h.

void Ogre::Font::loadResource ( Resource * resource ) [virtual]

Implementation of ManualResourceLoader::loadResource, called when the Texture that this font creates needs to (re)load.

Implements Ogre::ManualResourceLoader.

virtual void Ogre::Resource::preLoadImpl ( void ) [protected, virtual, inherited]

Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.

Note:: Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Definition at line 166 of file OgreResource.h.

virtual void Ogre::Resource::postLoadImpl ( void ) [protected, virtual, inherited]

Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.

Note:: Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Reimplemented in Ogre::Mesh.

Definition at line 173 of file OgreResource.h.

virtual void Ogre::Resource::preUnloadImpl ( void ) [protected, virtual, inherited]

Internal hook to perform actions before the unload process.

Note:: Mutex will have already been acquired by the unloading thread.

Definition at line 178 of file OgreResource.h.

virtual void Ogre::Resource::postUnloadImpl ( void ) [protected, virtual, inherited]

Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.

Note:: Mutex will have already been acquired by the unloading thread.

Definition at line 183 of file OgreResource.h.

virtual void Ogre::Resource::prepareImpl ( void ) [protected, virtual, inherited]

Internal implementation of the meat of the 'prepare' action.

Reimplemented in Ogre::Material, Ogre::Mesh, and Ogre::PatchMesh.

Definition at line 187 of file OgreResource.h.

virtual void Ogre::Resource::unprepareImpl ( void ) [protected, virtual, inherited]

Internal function for undoing the 'prepare' action.

Called when the load is completed, and when resources are unloaded when they are prepared but not yet loaded.

Reimplemented in Ogre::Material, and Ogre::Mesh.

Definition at line 192 of file OgreResource.h.

virtual void Ogre::Resource::queueFireBackgroundLoadingComplete ( void ) [protected, virtual, inherited]

Queue the firing of background loading complete event.

virtual void Ogre::Resource::queueFireBackgroundPreparingComplete ( void ) [protected, virtual, inherited]

Queue the firing of background preparing complete event.

virtual void Ogre::Resource::prepare ( ) [virtual, inherited]

Prepares the resource for load, if it is not already.

One can call prepare() before load(), but this is not required as load() will call prepare() itself, if needed. When OGRE_THREAD_SUPPORT==1 both load() and prepare() are thread-safe. When OGRE_THREAD_SUPPORT==2 however, only prepare() is thread-safe. The reason for this function is to allow a background thread to do some of the loading work, without requiring the whole render system to be thread-safe. The background thread would call prepare() while the main render loop would later call load(). So long as prepare() remains thread-safe, subclasses can arbitrarily split the work of loading a resource between load() and prepare(). It is best to try and do as much work in prepare(), however, since this will leave less work for the main render thread to do and thus increase FPS.

virtual void Ogre::Resource::load ( bool backgroundThread = false ) [virtual, inherited]

Loads the resource, if it is not already.

Remarks:: If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own.

Parameters:

backgroundThread

Indicates whether the caller of this method is the background resource loading thread.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::Resource::reload ( void ) [virtual, inherited]

Reloads the resource, if it is already loaded.