![]() |
OGRE
1.10.12
Object-Oriented Graphics Rendering Engine
|
Defines a generic resource handler. More...
#include <OgreResourceManager.h>
Classes | |
class | ResourcePool |
Definition of a pool of resources, which users can use to reuse similar resources many times without destroying and recreating them. More... | |
Public Types | |
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult |
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap |
typedef OGRE_HashMap< String, ResourcePtr > | ResourceMap |
typedef MapIterator< ResourceHandleMap > | ResourceMapIterator |
typedef OGRE_HashMap< String, ResourceMap > | ResourceWithGroupMap |
Public Member Functions | |
ResourceManager () | |
virtual | ~ResourceManager () |
virtual void | _notifyResourceLoaded (Resource *res) |
Notify this manager that a resource which it manages has been loaded. More... | |
virtual void | _notifyResourceTouched (Resource *res) |
Notify this manager that a resource which it manages has been 'touched', i.e. More... | |
virtual void | _notifyResourceUnloaded (Resource *res) |
Notify this manager that a resource which it manages has been unloaded. More... | |
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. More... | |
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. More... | |
void | destroyAllResourcePools () |
destroy all pools More... | |
void | destroyResourcePool (ResourcePool *pool) |
Destroy a resource pool. More... | |
void | destroyResourcePool (const String &name) |
Destroy a resource pool. More... | |
virtual ResourcePtr | getByHandle (ResourceHandle handle) |
Retrieves a pointer to a resource by handle, or null if the resource does not exist. More... | |
Real | getLoadingOrder (void) const |
Gets the relative loading order of resources of this type. More... | |
size_t | getMemoryBudget (void) const |
Get the limit on the amount of memory this resource handler may use. More... | |
size_t | getMemoryUsage (void) const |
Gets the current memory usage, in bytes. More... | |
virtual ResourcePtr | getResourceByName (const String &name, const String &groupName OGRE_RESOURCE_GROUP_INIT) |
Retrieves a pointer to a resource by name, or null if the resource does not exist. More... | |
ResourceMapIterator | getResourceIterator (void) |
Returns an iterator over all resources in this manager. More... | |
ResourcePool * | getResourcePool (const String &name) |
Create a resource pool, or reuse one that already exists. More... | |
const String & | getResourceType (void) const |
Gets a string identifying the type of resource this manager handles. More... | |
const StringVector & | getScriptPatterns (void) const |
Gets the file patterns which should be used to find scripts for this ResourceManager. More... | |
bool | getVerbose (void) |
Gets whether this manager and its resources habitually produce log output. More... | |
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). More... | |
void | parseScript (DataStreamPtr &stream, const String &groupName) |
Parse the definition of a set of resources from a script file. More... | |
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). More... | |
void | reloadAll (bool reloadableOnly=true) |
Caused all currently loaded resources to be reloaded. More... | |
virtual void | reloadAll (Resource::LoadingFlags flags) |
Caused all currently loaded resources to be reloaded. More... | |
void | reloadUnreferencedResources (bool reloadableOnly=true) |
Caused all currently loaded but not referenced by any other object resources to be reloaded. More... | |
void | remove (const ResourcePtr &r) |
Remove a single resource. More... | |
void | remove (const String &name, const String &group OGRE_RESOURCE_GROUP_INIT) |
void | remove (ResourceHandle handle) |
virtual void | removeAll (void) |
Removes all resources. More... | |
virtual void | removeUnreferencedResources (bool reloadableOnly=true) |
Remove all resources which are not referenced by any other object. More... | |
bool | resourceExists (const String &name, const String &group OGRE_RESOURCE_GROUP_INIT) |
Returns whether the named resource exists in this manager. More... | |
bool | resourceExists (ResourceHandle handle) |
Returns whether a resource with the given handle exists in this manager. More... | |
void | setMemoryBudget (size_t bytes) |
Set a limit on the amount of memory this resource handler may use. More... | |
void | setVerbose (bool v) |
Sets whether this manager and its resources habitually produce log output. More... | |
void | unload (const String &name, const String &group OGRE_RESOURCE_GROUP_INIT) |
Unloads a single resource by name. More... | |
void | unload (ResourceHandle handle) |
Unloads a single resource by handle. More... | |
void | unloadAll (bool reloadableOnly=true) |
Unloads all resources. More... | |
virtual void | unloadAll (Resource::LoadingFlags flags) |
Unloads all resources. More... | |
void | unloadUnreferencedResources (bool reloadableOnly=true) |
Unload all resources which are not referenced by any other object. More... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
Defines a generic resource handler.
typedef std::pair<ResourcePtr, bool> Ogre::ResourceManager::ResourceCreateOrRetrieveResult |
typedef map<ResourceHandle, ResourcePtr>::type Ogre::ResourceManager::ResourceHandleMap |
Ogre::ResourceManager::ResourceManager | ( | ) |
|
virtual |
ResourcePtr Ogre::ResourceManager::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.
name | The unique name of the resource |
group | The name of the resource group to attach this new resource to |
isManual | Is this resource manually loaded? If so, you should really populate the loader parameter in order that the load process can call the loader back when loading is required. |
loader | Pointer to a ManualLoader implementation which will be called when the Resource wishes to load (should be supplied if you set isManual to true). You can in fact leave this parameter null if you wish, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualLoader instance is strongly recommended. |
createParams | If any parameters are required to create an instance, they should be supplied here as name / value pairs |
ResourceCreateOrRetrieveResult Ogre::ResourceManager::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.
void Ogre::ResourceManager::setMemoryBudget | ( | size_t | bytes | ) |
Set a limit on the amount of memory this resource handler may use.
size_t Ogre::ResourceManager::getMemoryBudget | ( | void | ) | const |
Get the limit on the amount of memory this resource handler may use.
|
inline |
Gets the current memory usage, in bytes.
References OGRE_RESOURCE_GROUP_INIT.
void Ogre::ResourceManager::unload | ( | const String & | name, |
const String &group | OGRE_RESOURCE_GROUP_INIT | ||
) |
Unloads a single resource by name.
void Ogre::ResourceManager::unload | ( | ResourceHandle | handle | ) |
Unloads a single resource by handle.
|
inline |
Unloads all resources.
reloadableOnly | If true (the default), only unload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't load them later. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later. |
References Ogre::Resource::LF_DEFAULT, and Ogre::Resource::LF_INCLUDE_NON_RELOADABLE.
|
inline |
Caused all currently loaded resources to be reloaded.
reloadableOnly | If true (the default), only reload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't loaded again. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later. |
References Ogre::Resource::LF_DEFAULT, and Ogre::Resource::LF_INCLUDE_NON_RELOADABLE.
|
inline |
Unload all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only unloads resources which can be subsequently automatically reloaded. |
References Ogre::Resource::LF_ONLY_UNREFERENCED, and Ogre::Resource::LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE.
|
inline |
Caused all currently loaded but not referenced by any other object resources to be reloaded.
reloadableOnly | If true (the default), only reloads resources which can be subsequently automatically reloaded. |
References Ogre::Resource::LF_ONLY_UNREFERENCED, Ogre::Resource::LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE, and OGRE_RESOURCE_GROUP_INIT.
|
virtual |
Unloads all resources.
flags | Allow to restrict processing to only reloadable and/or unreferenced resources. |
|
virtual |
Caused all currently loaded resources to be reloaded.
flags | Allow to restrict processing to only reloadable and/or unreferenced resources. Additionally, reloading could be done with preserving some selected resource states that could be used elsewhere. |
void Ogre::ResourceManager::remove | ( | const ResourcePtr & | r | ) |
Remove a single resource.
void Ogre::ResourceManager::remove | ( | const String & | name, |
const String &group | OGRE_RESOURCE_GROUP_INIT | ||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void Ogre::ResourceManager::remove | ( | ResourceHandle | handle | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
virtual |
Removes all resources.
Reimplemented in Ogre::CompositorManager.
|
virtual |
Remove all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only removes resources which can be subsequently automatically reloaded. |
|
virtual |
Retrieves a pointer to a resource by name, or null if the resource does not exist.
|
virtual |
Retrieves a pointer to a resource by handle, or null if the resource does not exist.
|
inline |
Returns whether the named resource exists in this manager.
References Ogre::SharedPtr< T >::get().
|
inline |
Returns whether a resource with the given handle exists in this manager.
References Ogre::SharedPtr< T >::get().
|
virtual |
Notify this manager that a resource which it manages has been 'touched', i.e.
used.
|
virtual |
Notify this manager that a resource which it manages has been loaded.
|
virtual |
Notify this manager that a resource which it manages has been unloaded.
ResourcePtr Ogre::ResourceManager::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).
name | The name of the Resource |
group | The resource group to which this resource will belong |
isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter |
loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter |
loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource. |
backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread |
ResourcePtr Ogre::ResourceManager::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).
name | The name of the Resource |
group | The resource group to which this resource will belong |
isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter |
loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter |
loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource. |
backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread |
|
inlinevirtual |
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader.
|
inlinevirtual |
Parse the definition of a set of resources from a script file.
stream | Weak reference to a data stream which is the source of the script |
groupName | The name of the resource group that resources which are parsed are to become a member of. If this group is loaded or unloaded, then the resources discovered in this script will be loaded / unloaded with it. |
Implements Ogre::ScriptLoader.
Reimplemented in Ogre::FontManager.
|
inlinevirtual |
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader.
|
inline |
Gets a string identifying the type of resource this manager handles.
|
inline |
Sets whether this manager and its resources habitually produce log output.
|
inline |
Gets whether this manager and its resources habitually produce log output.
ResourcePool* Ogre::ResourceManager::getResourcePool | ( | const String & | name | ) |
Create a resource pool, or reuse one that already exists.
void Ogre::ResourceManager::destroyResourcePool | ( | ResourcePool * | pool | ) |
Destroy a resource pool.
void Ogre::ResourceManager::destroyResourcePool | ( | const String & | name | ) |
Destroy a resource pool.
void Ogre::ResourceManager::destroyAllResourcePools | ( | ) |
destroy all pools
|
inline |
Returns an iterator over all resources in this manager.
Ogre::ResourceManager::OGRE_AUTO_MUTEX |