Manages the locating and loading of BSP-based indoor levels. More...
#include <OgreBspResourceManager.h>
Public Types | |
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult |
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap |
typedef HashMap< String, ResourcePtr > | ResourceMap |
typedef MapIterator < ResourceHandleMap > | ResourceMapIterator |
typedef HashMap< String, ResourceMap > | ResourceWithGroupMap |
Public Member Functions | |
BspResourceManager () | |
~BspResourceManager () | |
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... | |
virtual ResourcePtr | create (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... | |
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. 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... | |
virtual ResourcePtr | getByName (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. More... | |
virtual Real | getLoadingOrder (void) const |
Gets the relative loading order of resources of this type. More... | |
virtual size_t | getMemoryBudget (void) const |
Get the limit on the amount of memory this resource handler may use. More... | |
virtual size_t | getMemoryUsage (void) const |
Gets the current memory usage, in bytes. 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... | |
virtual const StringVector & | getScriptPatterns (void) const |
Gets the file patterns which should be used to find scripts for this ResourceManager. More... | |
virtual 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) |
Loads a BSP-based level from the named file. More... | |
ResourcePtr | load (DataStreamPtr &stream, const String &group) |
Loads a BSP-based level from a stream. More... | |
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). 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 | parseScript (DataStreamPtr &stream, const String &groupName) |
Parse the definition of a set of resources from a script file. More... | |
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). More... | |
virtual void | reloadAll (bool reloadableOnly=true) |
Caused all currently loaded resources to be reloaded. More... | |
virtual void | reloadUnreferencedResources (bool reloadableOnly=true) |
Caused all currently loaded but not referenced by any other object resources to be reloaded. More... | |
virtual void | remove (ResourcePtr &r) |
Remove a single resource. More... | |
virtual void | remove (const String &name) |
Remove a single resource by name. More... | |
virtual void | remove (ResourceHandle handle) |
Remove a single resource by handle. More... | |
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... | |
virtual bool | resourceExists (const String &name) |
Returns whether the named resource exists in this manager. More... | |
virtual bool | resourceExists (ResourceHandle handle) |
Returns whether a resource with the given handle exists in this manager. More... | |
virtual void | setMemoryBudget (size_t bytes) |
Set a limit on the amount of memory this resource handler may use. More... | |
virtual void | setVerbose (bool v) |
Sets whether this manager and its resources habitually produce log output. More... | |
virtual void | unload (const String &name) |
Unloads a single resource by name. More... | |
virtual void | unload (ResourceHandle handle) |
Unloads a single resource by handle. More... | |
virtual void | unloadAll (bool reloadableOnly=true) |
Unloads all resources. More... | |
virtual void | unloadUnreferencedResources (bool reloadableOnly=true) |
Unload all resources which are not referenced by any other object. More... | |
Static Public Member Functions | |
static BspResourceManager & | getSingleton (void) |
Override standard Singleton retrieval. More... | |
static BspResourceManager * | getSingletonPtr (void) |
Override standard Singleton retrieval. More... | |
Protected Types | |
typedef map< String, ResourcePool * >::type | ResourcePoolMap |
Protected Member Functions | |
virtual void | addImpl (ResourcePtr &res) |
Add a newly created resource to the manager (note weak reference) More... | |
virtual void | checkUsage (void) |
Checks memory usage and pages out if required. More... | |
Resource * | createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *createParams) |
ResourceHandle | getNextHandle (void) |
Allocates the next handle. More... | |
virtual void | removeImpl (ResourcePtr &res) |
Remove a resource from this manager; remove it from the lists. More... | |
Protected Attributes | |
Real | mLoadOrder |
Loading order relative to other managers, higher is later. More... | |
size_t | mMemoryBudget |
size_t | mMemoryUsage |
ResourceHandle | mNextHandle |
ResourcePoolMap | mResourcePoolMap |
ResourceMap | mResources |
ResourceHandleMap | mResourcesByHandle |
ResourceWithGroupMap | mResourcesWithGroup |
String | mResourceType |
String identifying the resource type this manager handles. More... | |
StringVector | mScriptPatterns |
Patterns to use to look for scripts if supported (e.g. *.overlay) More... | |
Quake3ShaderManager * | mShaderMgr |
bool | mVerbose |
Static Protected Attributes | |
static BspResourceManager * | ms_Singleton |
Manages the locating and loading of BSP-based indoor levels.
Like other ResourceManager specialisations it manages the location and loading of a specific type of resource, in this case files containing Binary Space Partition (BSP) based level files e.g. Quake3 levels.
However, note that unlike other ResourceManager implementations, only 1 BspLevel resource is allowed to be loaded at one time. Loading another automatically unloads the currently loaded level if any.
Definition at line 45 of file OgreBspResourceManager.h.
|
inherited |
Definition at line 103 of file OgreResourceManager.h.
|
inherited |
Definition at line 494 of file OgreResourceManager.h.
|
inherited |
Definition at line 492 of file OgreResourceManager.h.
|
inherited |
Definition at line 515 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 526 of file OgreResourceManager.h.
|
inherited |
Definition at line 493 of file OgreResourceManager.h.
Ogre::BspResourceManager::BspResourceManager | ( | ) |
Ogre::BspResourceManager::~BspResourceManager | ( | ) |
|
virtualinherited |
Notify this manager that a resource which it manages has been loaded.
|
virtualinherited |
Notify this manager that a resource which it manages has been 'touched', i.e.
used.
|
virtualinherited |
Notify this manager that a resource which it manages has been unloaded.
|
protectedvirtualinherited |
Add a newly created resource to the manager (note weak reference)
|
protectedvirtualinherited |
Checks memory usage and pages out if required.
|
virtualinherited |
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 |
|
protectedvirtual |
Implements Ogre::ResourceManager.
|
virtualinherited |
Create a new resource, or retrieve an existing one with the same name if it already exists.
|
inherited |
destroy all pools
|
inherited |
Destroy a resource pool.
|
inherited |
Destroy a resource pool.
|
virtualinherited |
Retrieves a pointer to a resource by handle, or null if the resource does not exist.
|
virtualinherited |
Retrieves a pointer to a resource by name, or null if the resource does not exist.
|
inlinevirtualinherited |
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader.
Definition at line 412 of file OgreResourceManager.h.
|
virtualinherited |
Get the limit on the amount of memory this resource handler may use.
|
inlinevirtualinherited |
Gets the current memory usage, in bytes.
Definition at line 136 of file OgreResourceManager.h.
|
protectedinherited |
Allocates the next handle.
|
inlineinherited |
Returns an iterator over all resources in this manager.
Definition at line 520 of file OgreResourceManager.h.
|
inherited |
Create a resource pool, or reuse one that already exists.
|
inlineinherited |
Gets a string identifying the type of resource this manager handles.
Definition at line 415 of file OgreResourceManager.h.
|
inlinevirtualinherited |
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader.
Definition at line 388 of file OgreResourceManager.h.
|
static |
Override standard Singleton retrieval.
|
static |
Override standard Singleton retrieval.
|
inlinevirtualinherited |
Gets whether this manager and its resources habitually produce log output.
Definition at line 421 of file OgreResourceManager.h.
ResourcePtr Ogre::BspResourceManager::load | ( | const String & | name, |
const String & | group, | ||
bool | isManual = false , |
||
ManualResourceLoader * | loader = 0 , |
||
const NameValuePairList * | loadParams = 0 |
||
) |
Loads a BSP-based level from the named file.
Currently only supports loading of Quake3 .bsp files.
ResourcePtr Ogre::BspResourceManager::load | ( | DataStreamPtr & | stream, |
const String & | group | ||
) |
Loads a BSP-based level from a stream.
Currently only supports loading of Quake3 .bsp files.
|
virtualinherited |
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 |
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
|
inlinevirtualinherited |
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::MaterialManager, Ogre::CompositorManager, and Ogre::FontManager.
Definition at line 403 of file OgreResourceManager.h.
|
virtualinherited |
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 |
|
virtualinherited |
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. |
|
virtualinherited |
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. |
|
virtualinherited |
Remove a single resource.
|
virtualinherited |
Remove a single resource by name.
|
virtualinherited |
Remove a single resource by handle.
|
virtualinherited |
Removes all resources.
Reimplemented in Ogre::CompositorManager.
|
protectedvirtualinherited |
Remove a resource from this manager; remove it from the lists.
|
virtualinherited |
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. |
|
inlinevirtualinherited |
Returns whether the named resource exists in this manager.
Definition at line 308 of file OgreResourceManager.h.
|
inlinevirtualinherited |
Returns whether a resource with the given handle exists in this manager.
Definition at line 313 of file OgreResourceManager.h.
|
virtualinherited |
Set a limit on the amount of memory this resource handler may use.
|
inlinevirtualinherited |
Sets whether this manager and its resources habitually produce log output.
Definition at line 418 of file OgreResourceManager.h.
|
virtualinherited |
Unloads a single resource by name.
|
virtualinherited |
Unloads a single resource by handle.
|
virtualinherited |
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. |
|
virtualinherited |
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. |
|
protectedinherited |
Loading order relative to other managers, higher is later.
Definition at line 510 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 500 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 501 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 499 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 527 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 497 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 496 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 498 of file OgreResourceManager.h.
|
protectedinherited |
String identifying the resource type this manager handles.
Definition at line 512 of file OgreResourceManager.h.
|
staticprotectedinherited |
Definition at line 75 of file OgreSingleton.h.
|
protectedinherited |
Patterns to use to look for scripts if supported (e.g. *.overlay)
Definition at line 508 of file OgreResourceManager.h.
|
protected |
Definition at line 104 of file OgreBspResourceManager.h.
|
protectedinherited |
Definition at line 503 of file OgreResourceManager.h.