![]() |
OGRE 2.1
Object-Oriented Graphics Rendering Engine
|
Class representing a font in the system. More...
#include <OgreFont.h>
Classes | |
struct | GlyphInfo |
Information about the position and size of a glyph in a texture. More... | |
Public Types | |
typedef Ogre::uint32 | CodePoint |
typedef std::pair< CodePoint, CodePoint > | CodePointRange |
A range of code points, inclusive on both ends. | |
typedef vector< CodePointRange >::type | CodePointRangeList |
enum | LoadingFlags { LF_DEFAULT = 0 , LF_INCLUDE_NON_RELOADABLE = 1 , LF_ONLY_UNREFERENCED = 2 , LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3 , LF_PRESERVE_STATE = 4 } |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More... | |
enum | LoadingState { LOADSTATE_UNLOADED , LOADSTATE_LOADING , LOADSTATE_LOADED , LOADSTATE_UNLOADING , LOADSTATE_PREPARED , LOADSTATE_PREPARING } |
Enum identifying the loading state of the resource. More... | |
typedef Ogre::FloatRect | UVRect |
Public Member Functions | |
Font (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0) | |
Constructor. | |
virtual | ~Font () |
virtual void | _dirtyState () |
Manually mark the state of this resource as having been changed. | |
virtual void | _fireLoadingComplete (bool wasBackgroundLoaded) |
Firing of loading complete event. | |
virtual void | _firePreparingComplete (bool wasBackgroundLoaded) |
Firing of preparing complete event. | |
virtual void | _fireUnloadingComplete (void) |
Firing of unloading complete event. | |
virtual void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. | |
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. | |
virtual void | addListener (Listener *lis) |
Register a listener on this resource. | |
virtual void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. | |
void | clearCodePointRanges () |
Clear the list of code point ranges. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
virtual void | escalateLoading () |
Escalates the loading of a background loaded resource. | |
bool | getAntialiasColour (void) const |
Gets whether or not the colour of this font is antialiased as it is generated from a true type font. | |
uint | getCharacterSpacer (void) const |
Gets the spacing to allocate for font characters to overlap each other. | |
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. | |
virtual ResourceManager * | getCreator (void) |
Gets the manager which created this resource. | |
Real | getGlyphAspectRatio (CodePoint id) const |
Gets 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;. | |
const UVRect & | getGlyphTexCoords (CodePoint id) const |
Returns the texture coordinates of the associated glyph. | |
virtual const String & | getGroup (void) const |
Gets the group which this resource is a member of. | |
virtual ResourceHandle | getHandle (void) const |
HlmsDatablock * | getHlmsDatablock () |
Gets the HLMS Datablock generated for this font. | |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. | |
const MaterialPtr & | getMaterial () |
Gets the material generated for this font, as a weak reference. | |
const MaterialPtr & | getMaterial () const |
Gets the material generated for this font, as a weak reference. | |
virtual const String & | getName (void) const |
Gets resource name. | |
virtual const String & | getOrigin (void) const |
Get the origin of this resource, e.g. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual size_t | getSize (void) const |
Retrieves info about the size of the resource. | |
const String & | getSource (void) const |
Gets the source this font (either an image or a truetype font). | |
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. | |
int | getTrueTypeMaxBearingY () const |
Gets the maximum baseline distance of all glyphs used in the texture. | |
uint | getTrueTypeResolution (void) const |
Gets the resolution (dpi) of the font used to generate the texture. | |
Real | getTrueTypeSize (void) const |
Gets the point size of the font used to generate the texture. | |
FontType | getType (void) const |
Gets the type of font. | |
virtual bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. | |
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 bool | isManuallyLoaded (void) const |
Is this resource manually loaded? | |
virtual bool | isPrepared (void) const |
Returns true if the Resource has been prepared, false otherwise. | |
virtual bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. | |
void | loadResource (Resource *resource) |
Implementation of ManualResourceLoader::loadResource, called when the Texture that this font creates needs to (re)load. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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 *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
virtual void | prepare (bool backgroundThread=false) |
Prepares the resource for load, if it is not already. | |
virtual void | prepareResource (Resource *resource) |
Called when a resource wishes to load. | |
virtual void | reload (LoadingFlags flags=LF_DEFAULT) |
Reloads the resource, if it is already loaded. | |
virtual void | removeListener (Listener *lis) |
Remove a listener on this resource. | |
void | setAntialiasColour (bool enabled) |
Sets whether or not the colour of this font is antialiased as it is generated from a true type font. | |
virtual void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. | |
void | setCharacterSpacer (uint charSpacer) |
Sets the spacing to allocate for font characters to overlap each other. | |
void | setGlyphAspectRatio (CodePoint id, Real ratio) |
Sets the aspect ratio (width / height) of this character. | |
void | setGlyphTexCoords (CodePoint id, Real u1, Real v1, Real u2, Real v2, Real textureAspect) |
Sets the texture coordinates of a glyph. | |
virtual void | setManuallyLoaded (bool isManual) |
Set "Is this resource manually loaded?". | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
void | setSource (const String &source) |
Sets the source of the font. | |
virtual void | setToLoaded (void) |
Change the Resource loading state to loaded. | |
void | setTrueTypeResolution (uint ttfResolution) |
Gets the resolution (dpi) of the font used to generate the texture (only required for FT_TRUETYPE). | |
void | setTrueTypeSize (Real ttfSize) |
Sets the size of a truetype font (only required for FT_TRUETYPE). | |
void | setType (FontType ftype) |
Sets the type of font. | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. | |
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. | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
Class representing a font in the system.
typedef std::pair<CodePoint, CodePoint> Ogre::Font::CodePointRange |
A range of code points, inclusive on both ends.
|
inherited |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior.
|
inherited |
Ogre::Font::Font | ( | ResourceManager * | creator, |
const String & | name, | ||
ResourceHandle | handle, | ||
const String & | group, | ||
bool | isManual = false , |
||
ManualResourceLoader * | loader = 0 |
||
) |
Constructor.
|
virtual |
Manually mark the state of this resource as having been changed.
Firing of loading complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
Firing of preparing complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
Firing of unloading complete event.
Notify this resource of it's origin.
|
inline |
Adds a range of code points to the list of code point ranges to generate glyphs for, if this is a truetype based font.
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
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.
|
inline |
Clear the list of code point ranges.
|
inlinevirtualinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
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.
Gets the spacing to allocate for font characters to overlap each other.
|
inline |
Get a const reference to the list of code point ranges to be used to generate glyphs from a truetype font.
|
inlinevirtualinherited |
Gets the manager which created this resource.
Gets the aspect ratio (width / height) of this character.
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.
id | The code point (unicode) |
Gets the group which this resource is a member of.
Reimplemented in Ogre::v1::OldSkeletonInstance.
|
inlinevirtualinherited |
Reimplemented in Ogre::v1::OldSkeletonInstance.
|
inline |
Gets the HLMS Datablock generated for this font.
|
inlinevirtualinherited |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inline |
Gets the material generated for this font, as a weak reference.
|
inline |
Gets the material generated for this font, as a weak reference.
Gets resource name.
Reimplemented in Ogre::v1::OldSkeletonInstance.
Referenced by Ogre::GpuProgramUsage::getProgramName().
Get the origin of this resource, e.g.
a script file name.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
|
inlineinherited |
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
|
inherited |
Retrieves a list of parameters valid for this object.
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram, and Ogre::CgProgram.
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.
int Ogre::Font::getTrueTypeMaxBearingY | ( | ) | const |
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.
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Is this resource manually loaded?
Returns true if the Resource has been prepared, false otherwise.
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Implementation of ManualResourceLoader::loadResource, called when the Texture that this font creates needs to (re)load.
Implements Ogre::ManualResourceLoader.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
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.
backgroundThread | Whether this is occurring in a background thread |
|
inlinevirtualinherited |
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.
resource | The resource which wishes to load |
|
virtualinherited |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::v1::Mesh, and 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.
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Sets the spacing to allocate for font characters to overlap each other.
charSpacer | The size of the character spacer, in points. Increasing it allows for more stretched-out fonts; decreasing it reduces memory and processing time. The default is "5". |
Sets the aspect ratio (width / height) of this character.
|
inline |
Sets the texture coordinates of a glyph.
Set "Is this resource manually loaded?".
|
virtualinherited |
Generic parameter setting method.
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. |
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
Sets the source of the font.
source | An image file or a truetype font, depending on the type of this font |
Change the Resource loading state to loaded.
Gets the resolution (dpi) of the font used to generate the texture (only required for FT_TRUETYPE).
ttfResolution | The resolution in dpi |
Sets the size of a truetype font (only required for FT_TRUETYPE).
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. |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, Ogre::UnifiedHighLevelGpuProgram, and Ogre::CgProgram.
Referenced by Ogre::Material::touch().
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inherited |