# Ogre::Font Class Reference

Class representing a font in the system. More...

`#include <OgreFont.h>`

Inheritance diagram for Ogre::Font:

List of all members.

## 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.
std::pair< uint, uint > | StrBBox (const String &text, Real char_height, RenderWindow &window)
| Returns the size in pixels of a box that could contain the whole string.
void | getGlyphTexCoords (OgreChar id, Real &u1, Real &v1, Real &u2, Real &v2) const
| Returns the teture coordinates of the associated glyph.
void | setGlyphTexCoords (OgreChar id, Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates of a glyph.
Real | getGlyphAspectRatio (OgreChar id) const
| Gets the aspect ratio (width / height) of this character.
void | setGlyphAspectRatio (OgreChar id, Real ratio)
| Sets the aspect ratio (width / height) of this character.
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 | load (void)
| Loads the resource, if it is not already.
virtual void | reload (void)
| Reloads the resource, if it is already loaded.
bool | isReloadable (void) const
| Returns true if the Resource is reloadable, false otherwise.
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.
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.
const String & | getName (void) const
| Gets resource name.
ResourceHandle | getHandle (void) const
bool | isLoaded (void) const
| Returns true if the Resource has been loaded, false otherwise.
const String & | getGroup (void)
| Gets the group which this resource is a member of.
ResourceManager * | getCreator (void)
| Gets the manager which created this resource.
const String & | getOrigin (void) const
| Get the origin of this resource, e.g.
void | _notifyOrigin (const String &origin)
| Notify this resource of it's origin.
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.

## Static Public Member Functions

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 Member Functions

void | createTextureFromFont (void)
| Internal method for loading from ttf.
virtual void | loadImpl ()
virtual void | unloadImpl ()
size_t | calculateSize (void) const
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.
Real | mTexCoords_u1 [OGRE_NUM_GLYPHS]
| Start u coords.
Real | mTexCoords_u2 [OGRE_NUM_GLYPHS]
| End u coords.
Real | mTexCoords_v1 [OGRE_NUM_GLYPHS]
| Start v coords.
Real | mTexCoords_v2 [OGRE_NUM_GLYPHS]
| End v coords.
Real | mAspectRatio [OGRE_NUM_GLYPHS]
| Aspect ratio between x and y (width / height).
MaterialPtr | mpMaterial
| The material which is generated for this font.
TexturePtr | mTexture
| Texture pointer.
bool | mAntialiasColour
| for TRUE_TYPE font 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.
bool | mIsLoaded
| Is the resource currently loaded?
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.
String | mParamDictName
| Class name for this instance to be used as a lookup (must be initialised by subclasses).

## Static Protected Attributes

CmdType | msTypeCmd
CmdSource | msSourceCmd
CmdSize | msSizeCmd
CmdResolution | msResolutionCmd
ParamDictionaryMap | msDictionary
| Dictionary of parameters.

## Detailed Description

Class representing a font in the system.

Remarks:
  This class is simply a way of getting a font texture into the OGRE system and to easily retrieve the texture coordinates required to accurately render them. Fonts can either be loaded from precreated textures, or the texture can be generated using a truetype font. You can either create the texture manually in code, or you can use a .fontdef script to define it (probably more practical since you can reuse the definition more easily)

Note:
  This class extends both Resource and ManualResourceLoader since it is both a resource in it's own right, but it also provides the manual load implementation for the Texture it creates.

Definition at line 74 of file OgreFont.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::Resource::_notifyOrigin | ( | const String & | origin | ) | `[inherited]`

| Notify this resource of it's origin. Definition at line 214 of file OgreResource.h. References Ogre::String.

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

| Implements Ogre::Resource. Definition at line 153 of file OgreFont.h.

void Ogre::StringInterface::cleanupDictionary | ( |  | ) | `[static, inherited]`

| 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. MaterialManager) initializes.

virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const`[virtual, inherited]`

Method for copying this object's parameters to another object.

Remarks:
  This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

  Any unrecognised parameters will be ignored as with setParameter method.

Parameters:

  dest | Pointer to object to have it's parameters set the same as this object.

Definition at line 296 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | `[protected, inherited]`

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks:
  This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters:

  className | the name of the class using the dictionary

Returns:
  true if a new dictionary was created, false if it was already there

Definition at line 172 of file OgreStringInterface.h.

References Ogre::String.

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

| Internal method for loading from ttf.

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 298 of file OgreFont.h.

ResourceManager* Ogre::Resource::getCreator | ( | void |  | ) | `[inherited]`

| Gets the manager which created this resource. Definition at line 205 of file OgreResource.h.

Real Ogre::Font::getGlyphAspectRatio | ( | OgreChar | id | ) | const

| Gets the aspect ratio (width / height) of this character. Definition at line 248 of file OgreFont.h. References OGRE_GLYPH_INDEX, OgreChar, and Ogre::Real.

void Ogre::Font::getGlyphTexCoords | ( | OgreChar | id,
|  | Real & | u1,
|  | Real & | v1,
|  | Real & | u2,
|  | Real & | v2
| ) | const

Returns the teture coordinates of the associated glyph.

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

Parameters:

  id | The character code
  u1,u2,v1,v2 | location to place the results

Definition at line 223 of file OgreFont.h.

References OGRE_GLYPH_INDEX, OgreChar, and Ogre::Real.

const String& Ogre::Resource::getGroup | ( | void |  | ) | `[inherited]`

| Gets the group which this resource is a member of. Definition at line 202 of file OgreResource.h. References Ogre::String.

ResourceHandle Ogre::Resource::getHandle | ( | void |  | ) | const`[inherited]`

| Definition at line 188 of file OgreResource.h. References Ogre::ResourceHandle.

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

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 275 of file OgreFont.h.

const MaterialPtr& Ogre::Font::getMaterial | ( | void |  | ) | 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 267 of file OgreFont.h.

const String& Ogre::Resource::getName | ( | void |  | ) | const`[inherited]`

| Gets resource name. Definition at line 183 of file OgreResource.h. References Ogre::String.

const String& Ogre::Resource::getOrigin | ( | void |  | ) | const`[inherited]`

Get the origin of this resource, e.g.

a script file name.

Remarks:
  This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

Definition at line 212 of file OgreResource.h.

References Ogre::String.

const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | const`[inherited]`

| Definition at line 209 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | `[inherited]`

Retrieves the parameter dictionary for this class.

Remarks:
  Only valid to call this after createParamDictionary.

Returns:
  Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 196 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const`[virtual, inherited]`

Generic parameter retrieval method.

Remarks:
  Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters:

  name | The name of the parameter to get

Returns:
  String value of parameter, blank if not found

Definition at line 265 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::String.

const ParameterList& Ogre::StringInterface::getParameters | ( | void |  | ) | const`[inherited]`

Retrieves a list of parameters valid for this object.

Returns:
  A reference to a static list of ParameterDef objects.

size_t Ogre::Resource::getSize | ( | void |  | ) | const`[inherited]`

| Retrieves info about the size of the resource. Definition at line 172 of file OgreResource.h.

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

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

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.

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.

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

| Gets the type of font.

bool Ogre::Resource::isLoaded | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource has been loaded, false otherwise. Definition at line 195 of file OgreResource.h. References OGRE_LOCK_AUTO_MUTEX.

bool Ogre::Resource::isManuallyLoaded | ( | void |  | ) | const`[inherited]`

| Is this resource manually loaded? Definition at line 160 of file OgreResource.h.

bool Ogre::Resource::isReloadable | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource is reloadable, false otherwise. Definition at line 153 of file OgreResource.h.

virtual void Ogre::Resource::load | ( | void |  | ) | `[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

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

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

| Implements Ogre::Resource.

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::reload | ( | void |  | ) | `[virtual, inherited]`

Reloads the resource, if it is already loaded.

Remarks:
  Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

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 290 of file OgreFont.h.

void Ogre::Font::setGlyphAspectRatio | ( | OgreChar | 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, and your aspect ratio is really freaky.

Definition at line 258 of file OgreFont.h.

References OGRE_GLYPH_INDEX, OgreChar, and Ogre::Real.

void Ogre::Font::setGlyphTexCoords | ( | OgreChar | id,
|  | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |

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.

Definition at line 238 of file OgreFont.h.

References OGRE_GLYPH_INDEX, OgreChar, and Ogre::Real.

virtual bool Ogre::StringInterface::setParameter | ( | const String & | name,
|  | const String & | value
| ) | `[virtual, inherited]`

Generic parameter setting method.

Remarks:
  Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

  name | The name of the parameter to set
  value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.

Returns:
  true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | `[virtual, inherited]`

Generic multiple parameter setting method.

Remarks:
  Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

  paramList | Name/value pair list

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.

Parameters:

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

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

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::setType | ( | FontType | ftype | ) |

| Sets the type of font. Must be set before loading.

std::pair< uint, uint > Ogre::Font::StrBBox | ( | const String & | text,
|  | Real | char_height,
|  | RenderWindow & | window
| ) |

| Returns the size in pixels of a box that could contain the whole string.

virtual void Ogre::Resource::touch | ( | void |  | ) | `[virtual, inherited]`

| 'Touches' the resource to indicate it has been used. Reimplemented in Ogre::Material.

virtual void Ogre::Resource::unload | ( | void |  | ) | `[virtual, inherited]`

| Unloads the resource; this is not permanent, the resource can be reloaded later if required. Reimplemented in Ogre::GLSLGpuProgram.

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

| Implements Ogre::Resource.

## Member Data Documentation

bool Ogre::Font::mAntialiasColour `[protected]`

| for TRUE_TYPE font only Definition at line 143 of file OgreFont.h.

Real Ogre::Font::mAspectRatio[OGRE_NUM_GLYPHS]`[protected]`

| Aspect ratio between x and y (width / height). Definition at line 134 of file OgreFont.h.

ResourceManager* Ogre::Resource::mCreator `[protected, inherited]`

| Creator. Definition at line 73 of file OgreResource.h.

String Ogre::Resource::mGroup `[protected, inherited]`

| The name of the resource group. Definition at line 77 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle `[protected, inherited]`

| Numeric handle for more efficient look up than name. Definition at line 79 of file OgreResource.h.

bool Ogre::Resource::mIsLoaded `[protected, inherited]`

| Is the resource currently loaded? Definition at line 81 of file OgreResource.h.

bool Ogre::Resource::mIsManual `[protected, inherited]`

| Is this file manually loaded? Definition at line 85 of file OgreResource.h.

ManualResourceLoader* Ogre::Resource::mLoader `[protected, inherited]`

| Optional manual loader; if provided, data is loaded from here instead of a file. Definition at line 89 of file OgreResource.h.

String Ogre::Resource::mName `[protected, inherited]`

| Unique name of the resource. Definition at line 75 of file OgreResource.h.

String Ogre::Resource::mOrigin `[protected, inherited]`

| Origin of this resource (e.g. script name) - optional. Definition at line 87 of file OgreResource.h.

String Ogre::StringInterface::mParamDictName `[protected, inherited]`

| Class name for this instance to be used as a lookup (must be initialised by subclasses). Definition at line 160 of file OgreStringInterface.h.

MaterialPtr Ogre::Font::mpMaterial `[protected]`

| The material which is generated for this font. Definition at line 137 of file OgreFont.h.

ParamDictionaryMap Ogre::StringInterface::msDictionary `[static, protected, inherited]`

| Dictionary of parameters. Definition at line 157 of file OgreStringInterface.h.

size_t Ogre::Resource::mSize `[protected, inherited]`

| The size of the resource in bytes. Definition at line 83 of file OgreResource.h.

String Ogre::Font::mSource `[protected]`

| Source of the font (either an image name or a truetype font). Definition at line 116 of file OgreFont.h.

CmdResolution Ogre::Font::msResolutionCmd `[static, protected]`

| Definition at line 110 of file OgreFont.h.

CmdSize Ogre::Font::msSizeCmd `[static, protected]`

| Definition at line 109 of file OgreFont.h.

CmdSource Ogre::Font::msSourceCmd `[static, protected]`

| Definition at line 108 of file OgreFont.h.

CmdType Ogre::Font::msTypeCmd `[static, protected]`

| Definition at line 107 of file OgreFont.h.

Real Ogre::Font::mTexCoords_u1[OGRE_NUM_GLYPHS]`[protected]`

| Start u coords. Definition at line 125 of file OgreFont.h.

Real Ogre::Font::mTexCoords_u2[OGRE_NUM_GLYPHS]`[protected]`

| End u coords. Definition at line 127 of file OgreFont.h.

Real Ogre::Font::mTexCoords_v1[OGRE_NUM_GLYPHS]`[protected]`

| Start v coords. Definition at line 129 of file OgreFont.h.

Real Ogre::Font::mTexCoords_v2[OGRE_NUM_GLYPHS]`[protected]`

| End v coords. Definition at line 131 of file OgreFont.h.

TexturePtr Ogre::Font::mTexture `[protected]`

| Texture pointer. Definition at line 140 of file OgreFont.h.

uint Ogre::Font::mTtfResolution `[protected]`

| Resolution (dpi) of truetype font. Definition at line 121 of file OgreFont.h.

Real Ogre::Font::mTtfSize `[protected]`

| Size of the truetype font, in points. Definition at line 119 of file OgreFont.h.

FontType Ogre::Font::mType `[protected]`

| The type of font. Definition at line 113 of file OgreFont.h.

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

- OgreFont.h

Copyright © 2000-2005 by The OGRE Team
Last modified Sun Nov 20 12:36:43 2005