OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::Font Class Reference

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

#include <OgreFont.h>

+ Inheritance diagram for Ogre::Font:
+ Collaboration diagram for Ogre::Font:

Classes

class  CmdCharSpacer
 
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...
 

Public Types

typedef Ogre::uint32 CodePoint
 
typedef std::pair< CodePoint,
CodePoint
CodePointRange
 A range of code points, inclusive on both ends. More...
 
typedef vector< CodePointRange >
::type 
CodePointRangeList
 
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. More...
 
virtual ~Font ()
 
virtual void _dirtyState ()
 Manually mark the state of this resource as having been changed. More...
 
virtual void _fireLoadingComplete (bool wasBackgroundLoaded)
 Firing of loading complete event. More...
 
virtual void _firePreparingComplete (bool wasBackgroundLoaded)
 Firing of preparing complete event. More...
 
virtual void _fireUnloadingComplete (void)
 Firing of unloading complete event. More...
 
virtual void _notifyOrigin (const String &origin)
 Notify this resource of it's origin. More...
 
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. More...
 
virtual void addListener (Listener *lis)
 Register a listener on this resource. More...
 
virtual void changeGroupOwnership (const String &newGroup)
 Change the resource group ownership of a Resource. More...
 
void clearCodePointRanges ()
 Clear the list of code point ranges. More...
 
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
virtual void escalateLoading ()
 Escalates the loading of a background loaded resource. More...
 
bool getAntialiasColour (void) const
 Gets whether or not the colour of this font is antialiased as it is generated from a true type font. More...
 
uint getCharacterSpacer (void) const
 Gets the spacing to allocate for font characters to overlap each other. More...
 
const CodePointRangeListgetCodePointRangeList () const
 Get a const reference to the list of code point ranges to be used to generate glyphs from a truetype font. More...
 
virtual ResourceManagergetCreator (void)
 Gets the manager which created this resource. More...
 
Real getGlyphAspectRatio (CodePoint id) const
 Gets the aspect ratio (width / height) of this character. More...
 
const GlyphInfogetGlyphInfo (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;. More...
 
const UVRectgetGlyphTexCoords (CodePoint id) const
 Returns the texture coordinates of the associated glyph. More...
 
virtual const StringgetGroup (void) const
 Gets the group which this resource is a member of. More...
 
virtual ResourceHandle getHandle (void) const
 
virtual LoadingState getLoadingState () const
 Returns the current loading state. More...
 
const MaterialPtrgetMaterial () const
 Gets the material generated for this font, as a weak reference. More...
 
const MaterialPtrgetMaterial ()
 Gets the material generated for this font, as a weak reference. More...
 
virtual const StringgetName (void) const
 Gets resource name. More...
 
virtual const StringgetOrigin (void) const
 Get the origin of this resource, e.g. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
virtual String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
virtual size_t getSize (void) const
 Retrieves info about the size of the resource. More...
 
const StringgetSource (void) const
 Gets the source this font (either an image or a truetype font). More...
 
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. More...
 
int getTrueTypeMaxBearingY () const
 Gets the maximum baseline distance of all glyphs used in the texture. More...
 
uint getTrueTypeResolution (void) const
 Gets the resolution (dpi) of the font used to generate the texture. More...
 
Real getTrueTypeSize (void) const
 Gets the point size of the font used to generate the texture. More...
 
FontType getType (void) const
 Gets the type of font. More...
 
virtual bool isBackgroundLoaded (void) const
 Returns whether this Resource has been earmarked for background loading. More...
 
virtual bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise. More...
 
virtual bool isLoading () const
 Returns whether the resource is currently in the process of background loading. More...
 
virtual bool isManuallyLoaded (void) const
 Is this resource manually loaded? More...
 
virtual bool isPrepared (void) const
 Returns true if the Resource has been prepared, false otherwise. More...
 
virtual bool isReloadable (void) const
 Returns true if the Resource is reloadable, false otherwise. More...
 
virtual void load (bool backgroundThread=false)
 Loads the resource, if it is not already. More...
 
void loadResource (Resource *resource)
 Implementation of ManualResourceLoader::loadResource, called when the Texture that this font creates needs to (re)load. More...
 
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 *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void prepare (bool backgroundThread=false)
 Prepares the resource for load, if it is not already. More...
 
virtual void prepareResource (Resource *resource)
 Called when a resource wishes to load. More...
 
virtual void reload (void)
 Reloads the resource, if it is already loaded. More...
 
virtual void removeListener (Listener *lis)
 Remove a listener on this resource. More...
 
void setAntialiasColour (bool enabled)
 Sets whether or not the colour of this font is antialiased as it is generated from a true type font. More...
 
virtual void setBackgroundLoaded (bool bl)
 Tells the resource whether it is background loaded or not. More...
 
void setCharacterSpacer (uint charSpacer)
 Sets the spacing to allocate for font characters to overlap each other. More...
 
void setGlyphAspectRatio (CodePoint id, Real ratio)
 Sets the aspect ratio (width / height) of this character. More...
 
void setGlyphTexCoords (CodePoint id, Real u1, Real v1, Real u2, Real v2, Real textureAspect)
 Sets the texture coordinates of a glyph. More...
 
virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
void setSource (const String &source)
 Sets the source of the font. More...
 
void setTrueTypeResolution (uint ttfResolution)
 Gets the resolution (dpi) of the font used to generate the texture (only required for FT_TRUETYPE). More...
 
void setTrueTypeSize (Real ttfSize)
 Sets the size of a truetype font (only required for FT_TRUETYPE). More...
 
void setType (FontType ftype)
 Sets the type of font. More...
 
virtual void touch (void)
 'Touches' the resource to indicate it has been used. More...
 
virtual void unload (void)
 Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...
 

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. More...
 

Public Attributes

 OGRE_AUTO_MUTEX
 

Protected Types

typedef map< CodePoint,
GlyphInfo >::type 
CodePointMap
 Map from unicode code point to texture coordinates. More...
 
typedef set< Listener * >::type ListenerList
 

Protected Member Functions

size_t calculateSize (void) const
 Calculate the size of a resource; this will only be called after 'load'. More...
 
bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
 
void createTextureFromFont (void)
 Internal method for loading from ttf. More...
 
virtual void loadImpl ()
 Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. More...
 
 OGRE_MUTEX (mListenerListMutex)
 
virtual void postLoadImpl (void)
 Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. More...
 
virtual void postUnloadImpl (void)
 Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. More...
 
virtual void preLoadImpl (void)
 Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. More...
 
virtual void prepareImpl (void)
 Internal implementation of the meat of the 'prepare' action. More...
 
virtual void preUnloadImpl (void)
 Internal hook to perform actions before the unload process. More...
 
virtual void unloadImpl ()
 Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader. More...
 
virtual void unprepareImpl (void)
 Internal function for undoing the 'prepare' action. More...
 

Protected Attributes

bool mAntialiasColour
 for TRUE_TYPE font only More...
 
uint mCharacterSpacer
 Add a gap between letters vertically and horizonally prevents nasty artifacts caused by fonts atypically wide or tall characters. More...
 
CodePointMap mCodePointMap
 
CodePointRangeList mCodePointRangeList
 Range of code points to generate glyphs for (truetype only) More...
 
ResourceManagermCreator
 Creator. More...
 
String mGroup
 The name of the resource group. More...
 
ResourceHandle mHandle
 Numeric handle for more efficient look up than name. More...
 
volatile bool mIsBackgroundLoaded
 Is this resource going to be background loaded? Only applicable for multithreaded. More...
 
bool mIsManual
 Is this file manually loaded? More...
 
ListenerList mListenerList
 
ManualResourceLoadermLoader
 Optional manual loader; if provided, data is loaded from here instead of a file. More...
 
AtomicScalar< LoadingStatemLoadingState
 Is the resource currently loaded? More...
 
MaterialPtr mMaterial
 The material which is generated for this font. More...
 
String mName
 Unique name of the resource. More...
 
String mOrigin
 Origin of this resource (e.g. script name) - optional. More...
 
size_t mSize
 The size of the resource in bytes. More...
 
String mSource
 Source of the font (either an image name or a truetype font) More...
 
size_t mStateCount
 State count, the number of times this resource has changed state. More...
 
TexturePtr mTexture
 Texture pointer. More...
 
int mTtfMaxBearingY
 Max distance to baseline of this (truetype) font. More...
 
uint mTtfResolution
 Resolution (dpi) of truetype font. More...
 
Real mTtfSize
 Size of the truetype font, in points. More...
 
FontType mType
 The type of font. More...
 

Static Protected Attributes

static CmdCharSpacer msCharacterSpacerCmd
 
static CmdCodePoints msCodePointsCmd
 
static CmdResolution msResolutionCmd
 
static CmdSize msSizeCmd
 
static CmdSource msSourceCmd
 
static CmdType msTypeCmd
 

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

Member Typedef Documentation

Definition at line 139 of file OgreFont.h.

typedef map<CodePoint, GlyphInfo>::type Ogre::Font::CodePointMap
protected

Map from unicode code point to texture coordinates.

Definition at line 159 of file OgreFont.h.

A range of code points, inclusive on both ends.

Definition at line 155 of file OgreFont.h.

Definition at line 156 of file OgreFont.h.

typedef set<Listener*>::type Ogre::Resource::ListenerList
protectedinherited

Definition at line 166 of file OgreResource.h.

Definition at line 140 of file OgreFont.h.

Member Enumeration Documentation

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 127 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

virtual void Ogre::Resource::_dirtyState ( )
virtualinherited

Manually mark the state of this resource as having been changed.

Remarks
You only need to call this from outside if you explicitly want derived objects to think this object has changed.
See also
getStateCount.
virtual void Ogre::Resource::_fireLoadingComplete ( bool  wasBackgroundLoaded)
virtualinherited

Firing of loading complete event.

Remarks
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.
Parameters
wasBackgroundLoadedWhether this was a background loaded event
virtual void Ogre::Resource::_firePreparingComplete ( bool  wasBackgroundLoaded)
virtualinherited

Firing of preparing complete event.

Remarks
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.
Parameters
wasBackgroundLoadedWhether this was a background loaded event
virtual void Ogre::Resource::_fireUnloadingComplete ( void  )
virtualinherited

Firing of unloading complete event.

Remarks
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.
virtual void Ogre::Resource::_notifyOrigin ( const String origin)
inlinevirtualinherited

Notify this resource of it's origin.

Definition at line 420 of file OgreResource.h.

void Ogre::Font::addCodePointRange ( const CodePointRange range)
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.

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

virtual void Ogre::Resource::addListener ( Listener lis)
virtualinherited

Register a listener on this resource.

See also
Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

size_t Ogre::Font::calculateSize ( void  ) const
inlineprotectedvirtual

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

Reimplemented from Ogre::Resource.

Definition at line 182 of file OgreFont.h.

virtual void Ogre::Resource::changeGroupOwnership ( const String newGroup)
virtualinherited

Change the resource group ownership of a Resource.

Remarks
This method is generally reserved for internal use, although if you really know what you're doing you can use it to move this resource from one group to another.
Parameters
newGroupName of the new group
static void Ogre::StringInterface::cleanupDictionary ( )
staticinherited

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.

void Ogre::Font::clearCodePointRanges ( )
inline

Clear the list of code point ranges.

Definition at line 363 of file OgreFont.h.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlinevirtualinherited

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
destPointer to object to have it's parameters set the same as this object.

Definition at line 303 of file OgreStringInterface.h.

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

bool Ogre::StringInterface::createParamDictionary ( const String className)
inlineprotectedinherited

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
classNamethe name of the class using the dictionary
Returns
true if a new dictionary was created, false if it was already there

Definition at line 186 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

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

Internal method for loading from ttf.

virtual void Ogre::Resource::escalateLoading ( )
virtualinherited

Escalates the loading of a background loaded resource.

Remarks
If a resource is set to load in the background, but something needs it before it's been loaded, there could be a problem. If the user of this resource really can't wait, they can escalate the loading which basically pulls the loading into the current thread immediately. If the resource is already being loaded but just hasn't quite finished then this method will simply wait until the background load is complete.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

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

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

Definition at line 409 of file OgreFont.h.

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

Gets the spacing to allocate for font characters to overlap each other.

Remarks
Returns the size of the character spacer, in points. A higher value allows for more stretched-out fonts. A low value reduces memory and processing time. The default is "5".
const CodePointRangeList& Ogre::Font::getCodePointRangeList ( ) const
inline

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

Definition at line 370 of file OgreFont.h.

virtual ResourceManager* Ogre::Resource::getCreator ( void  )
inlinevirtualinherited

Gets the manager which created this resource.

Definition at line 411 of file OgreResource.h.

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

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

Definition at line 317 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;.

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

Returns the texture coordinates of the associated glyph.

Remarks
Parameter is a short to allow both ASCII and wide chars.
Parameters
idThe code point (unicode)
Returns
A rectangle with the UV coordinates, or null UVs if the code point was not present

Definition at line 275 of file OgreFont.h.

virtual const String& Ogre::Resource::getGroup ( void  ) const
inlinevirtualinherited

Gets the group which this resource is a member of.

Definition at line 399 of file OgreResource.h.

virtual ResourceHandle Ogre::Resource::getHandle ( void  ) const
inlinevirtualinherited

Reimplemented in Ogre::SkeletonInstance.

Definition at line 317 of file OgreResource.h.

virtual LoadingState Ogre::Resource::getLoadingState ( ) const
inlinevirtualinherited

Returns the current loading state.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 348 of file OgreResource.h.

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

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

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

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

virtual const String& Ogre::Resource::getName ( void  ) const
inlinevirtualinherited

Gets resource name.

Reimplemented in Ogre::SkeletonInstance.

Definition at line 312 of file OgreResource.h.

virtual const String& Ogre::Resource::getOrigin ( void  ) const
inlinevirtualinherited

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 418 of file OgreResource.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  )
inlineinherited

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 219 of file OgreStringInterface.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  ) const
inlineinherited

Definition at line 224 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String name) const
inlinevirtualinherited

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
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

Definition at line 272 of file OgreStringInterface.h.

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

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.
virtual size_t Ogre::Resource::getSize ( void  ) const
inlinevirtualinherited

Retrieves info about the size of the resource.

Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.

Definition at line 301 of file OgreResource.h.

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

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

virtual size_t Ogre::Resource::getStateCount ( ) const
inlinevirtualinherited

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 429 of file OgreResource.h.

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.
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.

virtual bool Ogre::Resource::isBackgroundLoaded ( void  ) const
inlinevirtualinherited

Returns whether this Resource has been earmarked for background loading.

Remarks
This option only makes sense when you have built Ogre with thread support (OGRE_THREAD_SUPPORT). If a resource has been marked for background loading, then it won't load on demand like normal when load() is called. Instead, it will ignore request to load() except if the caller indicates it is the background loader. Any other users of this resource should check isLoaded(), and if that returns false, don't use the resource and come back later.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 365 of file OgreResource.h.

virtual bool Ogre::Resource::isLoaded ( void  ) const
inlinevirtualinherited

Returns true if the Resource has been loaded, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 332 of file OgreResource.h.

virtual bool Ogre::Resource::isLoading ( ) const
inlinevirtualinherited

Returns whether the resource is currently in the process of background loading.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 341 of file OgreResource.h.

virtual bool Ogre::Resource::isManuallyLoaded ( void  ) const
inlinevirtualinherited

Is this resource manually loaded?

Definition at line 289 of file OgreResource.h.

virtual bool Ogre::Resource::isPrepared ( void  ) const
inlinevirtualinherited

Returns true if the Resource has been prepared, false otherwise.

Definition at line 324 of file OgreResource.h.

virtual bool Ogre::Resource::isReloadable ( void  ) const
inlinevirtualinherited

Returns true if the Resource is reloadable, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 282 of file OgreResource.h.

virtual void Ogre::Resource::load ( bool  backgroundThread = false)
virtualinherited

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
backgroundThreadIndicates whether the caller of this method is the background resource loading thread.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::Font::loadImpl ( )
protectedvirtual

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

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.

Ogre::Resource::OGRE_MUTEX ( mListenerListMutex  )
protectedinherited
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Resource::postLoadImpl ( void  )
inlineprotectedvirtualinherited

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, Ogre::D3D9Texture, and Ogre::D3D11Texture.

Definition at line 191 of file OgreResource.h.

virtual void Ogre::Resource::postUnloadImpl ( void  )
inlineprotectedvirtualinherited

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 201 of file OgreResource.h.

virtual void Ogre::Resource::preLoadImpl ( void  )
inlineprotectedvirtualinherited

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 184 of file OgreResource.h.

virtual void Ogre::Resource::prepare ( bool  backgroundThread = false)
virtualinherited

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.

Parameters
backgroundThreadWhether this is occurring in a background thread
virtual void Ogre::Resource::prepareImpl ( void  )
inlineprotectedvirtualinherited

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

Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::D3D11Texture, Ogre::Material, Ogre::PatchMesh, Ogre::GLTexture, and Ogre::GL3PlusTexture.

Definition at line 205 of file OgreResource.h.

virtual void Ogre::ManualResourceLoader::prepareResource ( Resource resource)
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.

Parameters
resourceThe resource which wishes to load

Definition at line 526 of file OgreResource.h.

virtual void Ogre::Resource::preUnloadImpl ( void  )
inlineprotectedvirtualinherited

Internal hook to perform actions before the unload process.

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

Definition at line 196 of file OgreResource.h.

virtual void Ogre::Resource::reload ( void  )
virtualinherited

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.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::Resource::removeListener ( Listener lis)
virtualinherited

Remove a listener on this resource.

See also
Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

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

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

virtual void Ogre::Resource::setBackgroundLoaded ( bool  bl)
inlinevirtualinherited

Tells the resource whether it is background loaded or not.

See also
Resource::isBackgroundLoaded. Note that calling this only defers the normal on-demand loading behaviour of a resource, it does not actually set up a thread to make sure the resource gets loaded in the background. You should use ResourceBackgroundLoadingQueue to manage the actual loading (which will call this method itself).

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 375 of file OgreResource.h.

void Ogre::Font::setCharacterSpacer ( uint  charSpacer)

Sets the spacing to allocate for font characters to overlap each other.

Parameters
charSpacerThe 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".
void Ogre::Font::setGlyphAspectRatio ( CodePoint  id,
Real  ratio 
)
inline

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

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

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

virtual bool Ogre::StringInterface::setParameter ( const String name,
const String value 
)
virtualinherited

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
nameThe name of the parameter to set
valueString 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)
virtualinherited

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
paramListName/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, and call addCodePointRange as many times as required to define the range of glyphs you want to be available.
Parameters
sourceAn 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
ttfResolutionThe resolution in dpi
void Ogre::Font::setTrueTypeSize ( Real  ttfSize)

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

Parameters
ttfSizeThe 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.

virtual void Ogre::Resource::touch ( void  )
virtualinherited

'Touches' the resource to indicate it has been used.

Reimplemented in Ogre::Material, Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.

Referenced by Ogre::Material::touch().

virtual void Ogre::Resource::unload ( void  )
virtualinherited

Unloads the resource; this is not permanent, the resource can be reloaded later if required.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::Font::unloadImpl ( )
protectedvirtual

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

Implements Ogre::Resource.

virtual void Ogre::Resource::unprepareImpl ( void  )
inlineprotectedvirtualinherited

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::Mesh, Ogre::D3D9Texture, Ogre::D3D11Texture, Ogre::Material, Ogre::GLTexture, and Ogre::GL3PlusTexture.

Definition at line 210 of file OgreResource.h.

Member Data Documentation

bool Ogre::Font::mAntialiasColour
protected

for TRUE_TYPE font only

Definition at line 169 of file OgreFont.h.

uint Ogre::Font::mCharacterSpacer
protected

Add a gap between letters vertically and horizonally prevents nasty artifacts caused by fonts atypically wide or tall characters.

Definition at line 128 of file OgreFont.h.

CodePointMap Ogre::Font::mCodePointMap
protected

Definition at line 160 of file OgreFont.h.

CodePointRangeList Ogre::Font::mCodePointRangeList
protected

Range of code points to generate glyphs for (truetype only)

Definition at line 172 of file OgreFont.h.

ResourceManager* Ogre::Resource::mCreator
protectedinherited

Creator.

Definition at line 144 of file OgreResource.h.

String Ogre::Resource::mGroup
protectedinherited

The name of the resource group.

Definition at line 148 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle
protectedinherited

Numeric handle for more efficient look up than name.

Definition at line 150 of file OgreResource.h.

volatile bool Ogre::Resource::mIsBackgroundLoaded
protectedinherited

Is this resource going to be background loaded? Only applicable for multithreaded.

Definition at line 154 of file OgreResource.h.

bool Ogre::Resource::mIsManual
protectedinherited

Is this file manually loaded?

Definition at line 158 of file OgreResource.h.

ListenerList Ogre::Resource::mListenerList
protectedinherited

Definition at line 167 of file OgreResource.h.

ManualResourceLoader* Ogre::Resource::mLoader
protectedinherited

Optional manual loader; if provided, data is loaded from here instead of a file.

Definition at line 162 of file OgreResource.h.

AtomicScalar<LoadingState> Ogre::Resource::mLoadingState
protectedinherited

Is the resource currently loaded?

Definition at line 152 of file OgreResource.h.

MaterialPtr Ogre::Font::mMaterial
protected

The material which is generated for this font.

Definition at line 163 of file OgreFont.h.

String Ogre::Resource::mName
protectedinherited

Unique name of the resource.

Definition at line 146 of file OgreResource.h.

String Ogre::Resource::mOrigin
protectedinherited

Origin of this resource (e.g. script name) - optional.

Definition at line 160 of file OgreResource.h.

CmdCharSpacer Ogre::Font::msCharacterSpacerCmd
staticprotected

Definition at line 115 of file OgreFont.h.

CmdCodePoints Ogre::Font::msCodePointsCmd
staticprotected

Definition at line 118 of file OgreFont.h.

size_t Ogre::Resource::mSize
protectedinherited

The size of the resource in bytes.

Definition at line 156 of file OgreResource.h.

String Ogre::Font::mSource
protected

Source of the font (either an image name or a truetype font)

Definition at line 124 of file OgreFont.h.

CmdResolution Ogre::Font::msResolutionCmd
staticprotected

Definition at line 117 of file OgreFont.h.

CmdSize Ogre::Font::msSizeCmd
staticprotected

Definition at line 116 of file OgreFont.h.

CmdSource Ogre::Font::msSourceCmd
staticprotected

Definition at line 114 of file OgreFont.h.

size_t Ogre::Resource::mStateCount
protectedinherited

State count, the number of times this resource has changed state.

Definition at line 164 of file OgreResource.h.

CmdType Ogre::Font::msTypeCmd
staticprotected

Definition at line 113 of file OgreFont.h.

TexturePtr Ogre::Font::mTexture
protected

Texture pointer.

Definition at line 166 of file OgreFont.h.

int Ogre::Font::mTtfMaxBearingY
protected

Max distance to baseline of this (truetype) font.

Definition at line 135 of file OgreFont.h.

uint Ogre::Font::mTtfResolution
protected

Resolution (dpi) of truetype font.

Definition at line 133 of file OgreFont.h.

Real Ogre::Font::mTtfSize
protected

Size of the truetype font, in points.

Definition at line 131 of file OgreFont.h.

FontType Ogre::Font::mType
protected

The type of font.

Definition at line 121 of file OgreFont.h.

Ogre::Resource::OGRE_AUTO_MUTEX
inherited

Definition at line 82 of file OgreResource.h.


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