Ogre::FontManager Class Reference

Manages Font resources, parsing .fontdef files and generally organising them. More...

#include <OgreFontManager.h>

Inheritance diagram for Ogre::FontManager:

Public Member Functions
	FontManager ()
	~FontManager () override
FontPtr	create (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
	Create a new font.
FontPtr	getByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Get a resource by name.
void	parseScript (DataStreamPtr &stream, const String &groupName) override
	Parse a script file.
Public Member Functions inherited from Ogre::ResourceManager
	ResourceManager ()
	~ResourceManager () override
virtual void	_notifyResourceLoaded (Resource *res)
	Notify this manager that a resource which it manages has been loaded.
virtual void	_notifyResourceTouched (Resource *res)
	Notify this manager that a resource which it manages has been 'touched', i.e.
virtual void	_notifyResourceUnloaded (Resource *res)
	Notify this manager that a resource which it manages has been unloaded.
virtual ResourceCreateOrRetrieveResult	createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
	Create a new resource, or retrieve an existing one with the same name if it already exists.
virtual ResourcePtr	createResource (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
	Creates a new blank resource, but does not immediately load it.
void	destroyAllResourcePools ()
	destroy all pools
void	destroyResourcePool (const String &name)
	Destroy a resource pool.
void	destroyResourcePool (ResourcePool *pool)
	Destroy a resource pool.
virtual ResourcePtr	getByHandle (ResourceHandle handle)
	Retrieves a pointer to a resource by handle, or null if the resource does not exist.
Real	getLoadingOrder () const override
	Gets the relative loading order of resources of this type.
virtual size_t	getMemoryBudget () const
	Get the limit on the amount of memory this resource handler may use.
virtual size_t	getMemoryUsage () const
	Gets the current memory usage, in bytes.
virtual ResourcePtr	getResourceByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Retrieves a pointer to a resource by name, or null if the resource does not exist.
ResourceMapIterator	getResourceIterator ()
	Returns an iterator over all resources in this manager.
ResourcePool *	getResourcePool (const String &name)
	Create a resource pool, or reuse one that already exists.
const String &	getResourceType () const
	Gets a string identifying the type of resource this manager handles.
const StringVector &	getScriptPatterns () const override
	Gets the file patterns which should be used to find scripts for this ResourceManager.
virtual bool	getVerbose ()
	Gets whether this manager and its resources habitually produce log output.
virtual ResourcePtr	load (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
	Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters).
void	parseScript (DataStreamPtr &stream, const String &groupName) override
	Parse the definition of a set of resources from a script file.
virtual ResourcePtr	prepare (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
	Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type parameters).
void	reloadAll (bool reloadableOnly=true)
	Caused all currently loaded resources to be reloaded.
virtual void	reloadAll (Resource::LoadingFlags flags)
	Caused all currently loaded resources to be reloaded.
void	reloadUnreferencedResources (bool reloadableOnly=true)
	Caused all currently loaded but not referenced by any other object resources to be reloaded.
virtual void	remove (const ResourcePtr &r)
	Remove a single resource.
virtual void	remove (const String &name)
	Remove a single resource by name.
virtual void	remove (ResourceHandle handle)
	Remove a single resource by handle.
virtual void	removeAll ()
	Removes all resources.
virtual void	removeUnreferencedResources (bool reloadableOnly=true)
	Remove all resources which are not referenced by any other object.
virtual bool	resourceExists (const String &name)
	Returns whether the named resource exists in this manager.
virtual bool	resourceExists (ResourceHandle handle)
	Returns whether a resource with the given handle exists in this manager.
virtual void	setMemoryBudget (size_t bytes)
	Set a limit on the amount of memory this resource handler may use.
virtual void	setVerbose (bool v)
	Sets whether this manager and its resources habitually produce log output.
virtual void	unload (const String &name)
	Unloads a single resource by name.
virtual void	unload (ResourceHandle handle)
	Unloads a single resource by handle.
void	unloadAll (bool reloadableOnly=true)
	Unloads all resources.
virtual void	unloadAll (Resource::LoadingFlags flags)
	Unloads all resources.
void	unloadUnreferencedResources (bool reloadableOnly=true)
	Unload all resources which are not referenced by any other object.
Public Member Functions inherited from Ogre::ScriptLoader
virtual	~ScriptLoader ()
Public Member Functions inherited from Ogre::Singleton< FontManager >
	Singleton ()
	~Singleton ()

Static Public Member Functions
static FontManager &	getSingleton ()
	Override standard Singleton retrieval.
static FontManager *	getSingletonPtr ()
	Override standard Singleton retrieval.
Static Public Member Functions inherited from Ogre::Singleton< FontManager >
static FontManager &	getSingleton ()
static FontManager *	getSingletonPtr ()

Additional Inherited Members
Public Types inherited from Ogre::ResourceManager
typedef std::pair< ResourcePtr, bool >	ResourceCreateOrRetrieveResult
typedef map< ResourceHandle, ResourcePtr >::type	ResourceHandleMap
typedef unordered_map< String, ResourcePtr >::type	ResourceMap
typedef MapIterator< ResourceHandleMap >	ResourceMapIterator
typedef unordered_map< String, ResourceMap >::type	ResourceWithGroupMap
Public Attributes inherited from Ogre::ResourceManager
	OGRE_AUTO_MUTEX

Detailed Description

Manages Font resources, parsing .fontdef files and generally organising them.

Constructor & Destructor Documentation

FontManager()

Ogre::FontManager::FontManager

(

)

~FontManager()

Ogre::FontManager::~FontManager ( )

override

Member Function Documentation

create()

FontPtr Ogre::FontManager::create	(	const String &	name,
		const String &	group,
		bool	isManual = false,
		ManualResourceLoader *	loader = 0,
		const NameValuePairList *	createParams = 0
	)

Create a new font.

See also

ResourceManager::createResource

getByName()

FontPtr Ogre::FontManager::getByName	(	const String &	name,
		const String &	groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME
	)

Get a resource by name.

See also

ResourceManager::getResourceByName

getSingleton()

static FontManager & Ogre::FontManager::getSingleton ( )

static

Override standard Singleton retrieval.

Remarks

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

getSingletonPtr()

static FontManager * Ogre::FontManager::getSingletonPtr ( )

static

Override standard Singleton retrieval.

Remarks

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

parseScript()

void Ogre::FontManager::parseScript ( DataStreamPtr &  stream, const String &  groupName  )

overridevirtual

Parse a script file.

Parameters

stream	Weak reference to a data stream which is the source of the script
groupName	The name of a resource group which should be used if any resources are created during the parse of this script.

Implements Ogre::ScriptLoader.

---

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

• OgreFontManager.h