#include <OgreFont.h>
Inheritance diagram for Ogre::Font:
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 ¶mList) |
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, void *) |
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 () |
| |
virtual void | unloadImpl () |
| |
size_t | calculateSize (void) const |
| |
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... |
Definition at line 60 of file OgreFont.h.
|
Definition at line 121 of file OgreFont.h. |
|
Map from unicode code point to texture coordinates.
Definition at line 141 of file OgreFont.h. |
|
A range of code points, inclusive on both ends.
Definition at line 137 of file OgreFont.h. |
|
Definition at line 138 of file OgreFont.h. |
|
Definition at line 148 of file OgreResource.h. |
|
Definition at line 122 of file OgreFont.h. |
|
Enum identifying the loading state of the resource.
Definition at line 109 of file OgreResource.h. |
|
Constructor.
|
|
|
|
Manually mark the state of this resource as having been changed.
|
|
Firing of background loading complete event.
|
|
Firing of background preparing complete event.
|
|
Notify this resource of it's origin.
Definition at line 409 of file OgreResource.h. |
|
Adds a range of code points to the list of code point ranges to generate glyphs for, if this is a truetype based font.
Definition at line 324 of file OgreFont.h. |
|
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Implements Ogre::Resource. Definition at line 164 of file OgreFont.h. |
|
Change the resource group ownership of a Resource.
|
|
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. |
|
Clear the list of code point ranges.
Definition at line 331 of file OgreFont.h. |
|
Method for copying this object's parameters to another object.
Definition at line 300 of file OgreStringInterface.h. References Ogre::ParamDictionary::mParamDefs. |
|
Internal method for creating a parameter dictionary for the class, if it does not already exist.
Definition at line 176 of file OgreStringInterface.h. |
|
Internal method for loading from ttf.
|
|
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
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. |
|
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. |
|
Gets the manager which created this resource.
Definition at line 400 of file OgreResource.h. |
|
Gets the aspect ratio (width / height) of this character.
Definition at line 285 of file OgreFont.h. |
|
Gets the information available for a glyph corresponding to a given code point, or throws an exception if it doesn't exist;.
|
|
Returns the texture coordinates of the associated glyph.
Definition at line 243 of file OgreFont.h. |
|
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance. Definition at line 388 of file OgreResource.h. |
|
Reimplemented in Ogre::SkeletonInstance. Definition at line 306 of file OgreResource.h. |
|
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 337 of file OgreResource.h. |
|
Gets the material generated for this font, as a weak reference.
Definition at line 354 of file OgreFont.h. |
|
Gets the material generated for this font, as a weak reference.
Definition at line 346 of file OgreFont.h. |
|
Gets resource name.
Reimplemented in Ogre::SkeletonInstance. Definition at line 301 of file OgreResource.h. |
|
Get the origin of this resource, e.g. a script file name.
Definition at line 407 of file OgreResource.h. |
|
Definition at line 213 of file OgreStringInterface.h. |
|
Retrieves the parameter dictionary for this class.
Definition at line 200 of file OgreStringInterface.h. |
|
Generic parameter retrieval method.
Definition at line 269 of file OgreStringInterface.h. References Ogre::ParamDictionary::getParamCommand(). |
|
Retrieves a list of parameters valid for this object.
|
|
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 290 of file OgreResource.h. |
|
Gets the source this font (either an image or a truetype font).
|
|
Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback. Definition at line 418 of file OgreResource.h. |
|
Gets the maximum baseline distance of all glyphs used in the texture.
|
|
Gets the resolution (dpi) of the font used to generate the texture.
|
|
Gets the point size of the font used to generate the texture.
|
|
Gets the type of font.
|
|
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 354 of file OgreResource.h. |
|
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 321 of file OgreResource.h. |
|
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 330 of file OgreResource.h. |
|
Is this resource manually loaded?
Definition at line 278 of file OgreResource.h. |
|
Returns true if the Resource has been prepared, false otherwise.
Definition at line 313 of file OgreResource.h. |
|
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 271 of file OgreResource.h. |
|
Loads the resource, if it is not already.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Implements Ogre::Resource. |
|
Implementation of ManualResourceLoader::loadResource, called when the Texture that this font creates needs to (re)load.
Implements Ogre::ManualResourceLoader. |
|
Definition at line 101 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 95 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 89 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 112 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 106 of file OgreMemoryAllocatedObject.h. |
|
placement operator new
Definition at line 73 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 67 of file OgreMemoryAllocatedObject.h. |
|
operator new, with debug line info
Definition at line 62 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 84 of file OgreMemoryAllocatedObject.h. |
|
array operator new, with debug line info
Definition at line 79 of file OgreMemoryAllocatedObject.h. |
|
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
Reimplemented in Ogre::Mesh. Definition at line 173 of file OgreResource.h. |
|
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
Definition at line 183 of file OgreResource.h. |
|
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
Definition at line 166 of file OgreResource.h. |
|
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. |
|
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. |
|
Called when a resource wishes to load. Note that this could get called in a background thread even in just a semithreaded ogre (OGRE_THREAD_SUPPORT==2). Thus, you must not access the rendersystem from this callback. Do that stuff in loadResource.
Definition at line 501 of file OgreResource.h. |
|
Internal hook to perform actions before the unload process.
Definition at line 178 of file OgreResource.h. |
|
Queue the firing of background loading complete event.
|
|
Queue the firing of background preparing complete event.
|
|
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Sets whether or not the colour of this font is antialiased as it is generated from a true type font.
Definition at line 369 of file OgreFont.h. |
|
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 364 of file OgreResource.h. |
|
Sets the aspect ratio (width / height) of this character.
Definition at line 302 of file OgreFont.h. |
|
Sets the texture coordinates of a glyph.
Definition at line 264 of file OgreFont.h. |
|
Generic parameter setting method.
|
|
Generic multiple parameter setting method.
|
|
Sets the source of the font.
|
|
Gets the resolution (dpi) of the font used to generate the texture (only required for FT_TRUETYPE).
|
|
Sets the size of a truetype font (only required for FT_TRUETYPE).
|
|
Sets the type of font. Must be set before loading. |
|
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, and Ogre::UnifiedHighLevelGpuProgram. Referenced by Ogre::Material::touch(). |
|
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Implements Ogre::Resource. |
|
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. |
|
for TRUE_TYPE font only
Definition at line 151 of file OgreFont.h. |
|
Definition at line 142 of file OgreFont.h. |
|
Range of code points to generate glyphs for (truetype only).
Definition at line 154 of file OgreFont.h. |
|
Creator.
Definition at line 126 of file OgreResource.h. |
|
The name of the resource group.
Definition at line 130 of file OgreResource.h. |
|
Numeric handle for more efficient look up than name.
Definition at line 132 of file OgreResource.h. |
|
Is this resource going to be background loaded? Only applicable for multithreaded.
Definition at line 136 of file OgreResource.h. |
|
Is this file manually loaded?
Definition at line 140 of file OgreResource.h. |
|
Definition at line 149 of file OgreResource.h. |
|
Optional manual loader; if provided, data is loaded from here instead of a file.
Definition at line 144 of file OgreResource.h. |
|
Is the resource currently loaded?
Definition at line 134 of file OgreResource.h. |
|
Unique name of the resource.
Definition at line 128 of file OgreResource.h. |
|
Origin of this resource (e.g. script name) - optional.
Definition at line 142 of file OgreResource.h. |
|
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 164 of file OgreStringInterface.h. |
|
The material which is generated for this font.
Definition at line 145 of file OgreFont.h. |
|
Definition at line 104 of file OgreFont.h. |
|
Dictionary of parameters.
Definition at line 161 of file OgreStringInterface.h. |
|
The size of the resource in bytes.
Definition at line 138 of file OgreResource.h. |
|
Source of the font (either an image name or a truetype font).
Definition at line 110 of file OgreFont.h. |
|
Definition at line 103 of file OgreFont.h. |
|
Definition at line 102 of file OgreFont.h. |
|
Definition at line 101 of file OgreFont.h. |
|
State count, the number of times this resource has changed state.
Definition at line 146 of file OgreResource.h. |
|
Definition at line 100 of file OgreFont.h. |
|
Texture pointer.
Definition at line 148 of file OgreFont.h. |
|
Max distance to baseline of this (truetype) font.
Definition at line 117 of file OgreFont.h. |
|
Resolution (dpi) of truetype font.
Definition at line 115 of file OgreFont.h. |
|
Size of the truetype font, in points.
Definition at line 113 of file OgreFont.h. |
|
The type of font.
Definition at line 107 of file OgreFont.h. |
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat Apr 11 13:47:53 2009