#include <OgreBspResourceManager.h>
Inheritance diagram for Ogre::BspResourceManager:
Public Types | ||||||||||||||||
typedef HashMap< String, ResourcePtr > | ResourceMap | |||||||||||||||
typedef std::map< ResourceHandle, ResourcePtr > | ResourceHandleMap | |||||||||||||||
typedef MapIterator< ResourceHandleMap > | ResourceMapIterator | |||||||||||||||
Public Member Functions | ||||||||||||||||
BspResourceManager () | ||||||||||||||||
~BspResourceManager () | ||||||||||||||||
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. | ||||||||||||||||
ResourcePtr | load (DataStreamPtr &stream, const String &group) | |||||||||||||||
Loads a BSP-based level from a stream. | ||||||||||||||||
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. | ||||||||||||||||
virtual void | setMemoryBudget (size_t bytes) | |||||||||||||||
Set a limit on the amount of memory this resource handler may use. | ||||||||||||||||
virtual size_t | getMemoryBudget (void) const | |||||||||||||||
Get the limit on the amount of memory this resource handler may use. | ||||||||||||||||
virtual void | unload (const String &name) | |||||||||||||||
Unloads a single resource by name. | ||||||||||||||||
virtual void | unload (ResourceHandle handle) | |||||||||||||||
Unloads a single resource by handle. | ||||||||||||||||
virtual void | unloadAll (bool reloadableOnly=true) | |||||||||||||||
Unloads all resources. | ||||||||||||||||
virtual void | reloadAll (bool reloadableOnly=true) | |||||||||||||||
Caused all currently loaded resources to be reloaded. | ||||||||||||||||
virtual void | unloadUnreferencedResources (bool reloadableOnly=true) | |||||||||||||||
Unload all resources which are not referenced by any other object. | ||||||||||||||||
virtual void | reloadUnreferencedResources (bool reloadableOnly=true) | |||||||||||||||
Caused all currently loaded but not referenced by any other object resources to be reloaded. | ||||||||||||||||
virtual void | remove (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 (void) | |||||||||||||||
Removes all resources. | ||||||||||||||||
virtual ResourcePtr | getByName (const String &name) | |||||||||||||||
Retrieves a pointer to a resource by name, or null if the resource does not exist. | ||||||||||||||||
virtual ResourcePtr | getByHandle (ResourceHandle handle) | |||||||||||||||
Retrieves a pointer to a resource by handle, or null if the resource does not exist. | ||||||||||||||||
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 | _notifyResourceTouched (Resource *res) | |||||||||||||||
Notify this manager that a resource which it manages has been 'touched', ie used. | ||||||||||||||||
virtual void | _notifyResourceLoaded (Resource *res) | |||||||||||||||
Notify this manager that a resource which it manages has been loaded. | ||||||||||||||||
virtual void | _notifyResourceUnloaded (Resource *res) | |||||||||||||||
Notify this manager that a resource which it manages has been unloaded. | ||||||||||||||||
virtual const StringVector & | getScriptPatterns (void) const | |||||||||||||||
Gets the file patterns which should be used to find scripts for this ResourceManager. | ||||||||||||||||
virtual void | parseScript (DataStreamPtr &stream, const String &groupName) | |||||||||||||||
Parse the definition of a set of resources from a script file. | ||||||||||||||||
virtual Real | getLoadingOrder (void) const | |||||||||||||||
Gets the relative loading order of resources of this type. | ||||||||||||||||
const String & | getResourceType (void) const | |||||||||||||||
Gets a string identifying the type of resource this manager handles. | ||||||||||||||||
ResourceMapIterator | getResourceIterator (void) | |||||||||||||||
Returns an iterator over all resources in this manager. | ||||||||||||||||
Singleton (void) | ||||||||||||||||
Static Public Member Functions | ||||||||||||||||
static BspResourceManager & | getSingleton (void) | |||||||||||||||
Override standard Singleton retrieval. | ||||||||||||||||
static BspResourceManager * | getSingletonPtr (void) | |||||||||||||||
Override standard Singleton retrieval. | ||||||||||||||||
Protected Member Functions | ||||||||||||||||
Resource * | createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *createParams) | |||||||||||||||
| ||||||||||||||||
ResourceHandle | getNextHandle (void) | |||||||||||||||
Allocates the next handle. | ||||||||||||||||
virtual void | addImpl (ResourcePtr &res) | |||||||||||||||
Add a newly created resource to the manager (note weak reference). | ||||||||||||||||
virtual void | removeImpl (ResourcePtr &res) | |||||||||||||||
Remove a resource from this manager; remove it from the lists. | ||||||||||||||||
virtual void | checkUsage (void) | |||||||||||||||
Checks memory usage and pages out if required. | ||||||||||||||||
virtual size_t | getMemoryUsage (void) const | |||||||||||||||
Gets the current memory usage, in bytes. | ||||||||||||||||
Protected Attributes | ||||||||||||||||
Quake3ShaderManager * | mShaderMgr | |||||||||||||||
ResourceHandleMap | mResourcesByHandle | |||||||||||||||
ResourceMap | mResources | |||||||||||||||
ResourceHandle | mNextHandle | |||||||||||||||
size_t | mMemoryBudget | |||||||||||||||
size_t | mMemoryUsage | |||||||||||||||
StringVector | mScriptPatterns | |||||||||||||||
Patterns to use to look for scripts if supported (e.g. *.overlay). | ||||||||||||||||
Real | mLoadOrder | |||||||||||||||
Loading order relative to other managers, higher is later. | ||||||||||||||||
String | mResourceType | |||||||||||||||
String identifying the resource type this manager handles. | ||||||||||||||||
Static Protected Attributes | ||||||||||||||||
static BspResourceManager * | ms_Singleton |
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 42 of file OgreBspResourceManager.h.
|
Definition at line 387 of file OgreResourceManager.h. |
|
Definition at line 386 of file OgreResourceManager.h. |
|
Definition at line 405 of file OgreResourceManager.h. |
|
|
|
|
|
Notify this manager that a resource which it manages has been loaded.
|
|
Notify this manager that a resource which it manages has been 'touched', ie used.
|
|
Notify this manager that a resource which it manages has been unloaded.
|
|
Add a newly created resource to the manager (note weak reference).
|
|
Checks memory usage and pages out if required.
|
|
Creates a new blank resource, but does not immediately load it.
|
|
Implements Ogre::ResourceManager. |
|
Retrieves a pointer to a resource by handle, or null if the resource does not exist.
|
|
Retrieves a pointer to a resource by name, or null if the resource does not exist.
|
|
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader. Definition at line 340 of file OgreResourceManager.h. |
|
Get the limit on the amount of memory this resource handler may use.
|
|
Gets the current memory usage, in bytes.
Definition at line 382 of file OgreResourceManager.h. |
|
Allocates the next handle.
|
|
Returns an iterator over all resources in this manager.
Definition at line 410 of file OgreResourceManager.h. |
|
Gets a string identifying the type of resource this manager handles.
Definition at line 343 of file OgreResourceManager.h. |
|
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader. Definition at line 317 of file OgreResourceManager.h. |
|
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< BspResourceManager >. |
|
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< BspResourceManager >. |
|
Loads a BSP-based level from a stream. Currently only supports loading of Quake3 .bsp files. |
|
Loads a BSP-based level from the named file. Currently only supports loading of Quake3 .bsp files. Reimplemented from Ogre::ResourceManager. |
|
Parse the definition of a set of resources from a script file.
Implements Ogre::ScriptLoader. Reimplemented in Ogre::CompositorManager, Ogre::FontManager, and Ogre::MaterialManager. Definition at line 332 of file OgreResourceManager.h. |
|
Caused all currently loaded resources to be reloaded.
|
|
Caused all currently loaded but not referenced by any other object resources to be reloaded.
|
|
Remove a single resource by handle.
|
|
Remove a single resource by name.
|
|
Remove a single resource.
|
|
Removes all resources.
Reimplemented in Ogre::CompositorManager. |
|
Remove a resource from this manager; remove it from the lists.
|
|
Returns whether a resource with the given handle exists in this manager.
Definition at line 265 of file OgreResourceManager.h. |
|
Returns whether the named resource exists in this manager.
Definition at line 260 of file OgreResourceManager.h. |
|
Set a limit on the amount of memory this resource handler may use.
|
|
Definition at line 57 of file OgreSingleton.h. |
|
Unloads a single resource by handle.
|
|
Unloads a single resource by name.
|
|
Unloads all resources.
|
|
Unload all resources which are not referenced by any other object.
|
|
Loading order relative to other managers, higher is later.
Definition at line 400 of file OgreResourceManager.h. |
|
Definition at line 392 of file OgreResourceManager.h. |
|
Definition at line 393 of file OgreResourceManager.h. |
|
Definition at line 391 of file OgreResourceManager.h. |
|
Definition at line 390 of file OgreResourceManager.h. |
|
Definition at line 389 of file OgreResourceManager.h. |
|
String identifying the resource type this manager handles.
Definition at line 402 of file OgreResourceManager.h. |
|
Definition at line 54 of file OgreSingleton.h. |
|
Patterns to use to look for scripts if supported (e.g. *.overlay).
Definition at line 398 of file OgreResourceManager.h. |
|
Definition at line 101 of file OgreBspResourceManager.h. |
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jan 21 10:07:07 2007