#include <OgreResource.h>
Public Types | |
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING } |
Enum identifying the loading state of the resource. More... | |
Public Member Functions | |
Resource (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0) | |
Standard constructor. | |
virtual | ~Resource () |
Virtual destructor. | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. | |
virtual void | reload (void) |
Reloads the resource, if it is already loaded. | |
bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. | |
bool | isManuallyLoaded (void) const |
Is this resource manually loaded? | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. | |
size_t | getSize (void) const |
Retrieves info about the size of the resource. | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. | |
const String & | getName (void) const |
Gets resource name. | |
ResourceHandle | getHandle (void) const |
bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. | |
LoadingState | isLoading () const |
Returns whether the resource is currently in the process of background loading. | |
LoadingState | getLoadingState () const |
Returns the current loading state. | |
bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. | |
void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. | |
void | escalateLoading () |
Escalates the loading of a background loaded resource. | |
void | addListener (Listener *lis) |
Register a listener on this resource. | |
void | removeListener (Listener *lis) |
Remove a listener on this resource. | |
const String & | getGroup (void) |
Gets the group which this resource is a member of. | |
void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. | |
ResourceManager * | getCreator (void) |
Gets the manager which created this resource. | |
const String & | getOrigin (void) const |
Get the origin of this resource, e.g. | |
void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. | |
virtual void | _fireBackgroundLoadingComplete (void) |
Firing of background loading complete event. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
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. | |
Protected Types | |
typedef std::list < Listener * > | ListenerList |
Protected Member Functions | |
Resource () | |
Protected unnamed constructor to prevent default construction. | |
virtual void | preLoadImpl (void) |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. | |
virtual void | postLoadImpl (void) |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. | |
virtual void | preUnloadImpl (void) |
Internal hook to perform actions before the unload process. | |
virtual void | postUnloadImpl (void) |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. | |
virtual void | loadImpl (void)=0 |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. | |
virtual void | unloadImpl (void)=0 |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader. | |
virtual size_t | calculateSize (void) const =0 |
Calculate the size of a resource; this will only be called after 'load'. | |
virtual void | queueFireBackgroundLoadingComplete (void) |
Queue the firing of background loading complete event. | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Protected Attributes | |
ResourceManager * | mCreator |
Creator. | |
String | mName |
Unique name of the resource. | |
String | mGroup |
The name of the resource group. | |
ResourceHandle | mHandle |
Numeric handle for more efficient look up than name. | |
volatile LoadingState | mLoadingState |
Is the resource currently loaded? | |
volatile bool | mIsBackgroundLoaded |
Is this resource going to be background loaded? Only applicable for multithreaded. | |
size_t | mSize |
Mutex to cover the status of loading. | |
bool | mIsManual |
Is this file manually loaded? | |
String | mOrigin |
Origin of this resource (e.g. script name) - optional. | |
ManualResourceLoader * | mLoader |
Optional manual loader; if provided, data is loaded from here instead of a file. | |
ListenerList | mListenerList |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses). | |
Static Protected Attributes | |
static ParamDictionaryMap | msDictionary |
Dictionary of parameters. | |
Classes | |
class | Listener |
textures, sounds etc)
Definition at line 71 of file OgreResource.h.
typedef std::list<Listener*> Ogre::Resource::ListenerList [protected] |
Definition at line 131 of file OgreResource.h.
Enum identifying the loading state of the resource.
LOADSTATE_UNLOADED | Not loaded. |
LOADSTATE_LOADING | Loading is in progress. |
LOADSTATE_LOADED | Fully loaded. |
LOADSTATE_UNLOADING | Currently unloading. |
Definition at line 96 of file OgreResource.h.
Ogre::Resource::Resource | ( | ) | [protected] |
Protected unnamed constructor to prevent default construction.
Definition at line 137 of file OgreResource.h.
Ogre::Resource::Resource | ( | ResourceManager * | creator, | |
const String & | name, | |||
ResourceHandle | handle, | |||
const String & | group, | |||
bool | isManual = false , |
|||
ManualResourceLoader * | loader = 0 | |||
) |
Standard constructor.
creator | Pointer to the ResourceManager that is creating this resource | |
name | The unique name of the resource | |
group | The name of the resource group to which this resource belongs | |
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 ManualResourceLoader 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 ManualResourceLoader instance is strongly recommended. |
virtual Ogre::Resource::~Resource | ( | ) | [virtual] |
Virtual destructor.
Shouldn't need to be overloaded, as the resource deallocation code should reside in unload()
virtual void Ogre::Resource::preLoadImpl | ( | void | ) | [protected, virtual] |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
Definition at line 149 of file OgreResource.h.
virtual void Ogre::Resource::postLoadImpl | ( | void | ) | [protected, virtual] |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
Reimplemented in Ogre::Mesh.
Definition at line 156 of file OgreResource.h.
virtual void Ogre::Resource::preUnloadImpl | ( | void | ) | [protected, virtual] |
Internal hook to perform actions before the unload process.
Definition at line 161 of file OgreResource.h.
virtual void Ogre::Resource::postUnloadImpl | ( | void | ) | [protected, virtual] |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
Definition at line 166 of file OgreResource.h.
virtual void Ogre::Resource::loadImpl | ( | void | ) | [protected, pure virtual] |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.
Implemented in Ogre::Compositor, Ogre::Font, Ogre::GpuProgram, Ogre::HighLevelGpuProgram, Ogre::Material, Ogre::Mesh, Ogre::PatchMesh, Ogre::Skeleton, and Ogre::SkeletonInstance.
virtual void Ogre::Resource::unloadImpl | ( | void | ) | [protected, pure virtual] |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.
Implemented in Ogre::Compositor, Ogre::Font, Ogre::HighLevelGpuProgram, Ogre::Material, Ogre::Mesh, Ogre::Skeleton, Ogre::SkeletonInstance, and Ogre::Texture.
virtual size_t Ogre::Resource::calculateSize | ( | void | ) | const [protected, pure virtual] |
Calculate the size of a resource; this will only be called after 'load'.
Implemented in Ogre::Compositor, Ogre::Font, Ogre::GpuProgram, Ogre::Material, Ogre::Mesh, Ogre::Skeleton, and Ogre::Texture.
virtual void Ogre::Resource::queueFireBackgroundLoadingComplete | ( | void | ) | [protected, virtual] |
Queue the firing of background loading complete event.
virtual void Ogre::Resource::load | ( | bool | backgroundThread = false |
) | [virtual] |
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::Resource::reload | ( | void | ) | [virtual] |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
bool Ogre::Resource::isReloadable | ( | void | ) | const |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 228 of file OgreResource.h.
bool Ogre::Resource::isManuallyLoaded | ( | void | ) | const |
virtual void Ogre::Resource::unload | ( | void | ) | [virtual] |
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
size_t Ogre::Resource::getSize | ( | void | ) | const |
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 247 of file OgreResource.h.
virtual void Ogre::Resource::touch | ( | void | ) | [virtual] |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, and Ogre::UnifiedHighLevelGpuProgram.
Referenced by Ogre::Material::touch().
const String& Ogre::Resource::getName | ( | void | ) | const |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 258 of file OgreResource.h.
ResourceHandle Ogre::Resource::getHandle | ( | void | ) | const |
bool Ogre::Resource::isLoaded | ( | void | ) | const |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 270 of file OgreResource.h.
LoadingState Ogre::Resource::isLoading | ( | ) | const |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 279 of file OgreResource.h.
LoadingState Ogre::Resource::getLoadingState | ( | ) | const |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 286 of file OgreResource.h.
bool Ogre::Resource::isBackgroundLoaded | ( | void | ) | const |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 303 of file OgreResource.h.
void Ogre::Resource::setBackgroundLoaded | ( | bool | bl | ) |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 313 of file OgreResource.h.
void Ogre::Resource::escalateLoading | ( | ) |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
void Ogre::Resource::addListener | ( | Listener * | lis | ) |
void Ogre::Resource::removeListener | ( | Listener * | lis | ) |
const String& Ogre::Resource::getGroup | ( | void | ) |
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 337 of file OgreResource.h.
void Ogre::Resource::changeGroupOwnership | ( | const String & | newGroup | ) |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
ResourceManager* Ogre::Resource::getCreator | ( | void | ) |
const String& Ogre::Resource::getOrigin | ( | void | ) | const |
Get the origin of this resource, e.g.
a script file name.
Definition at line 356 of file OgreResource.h.
void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) |
virtual void Ogre::Resource::_fireBackgroundLoadingComplete | ( | void | ) | [virtual] |
Firing of background loading complete event.
bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | [protected, inherited] |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
className | the name of the class using the dictionary |
Definition at line 176 of file OgreStringInterface.h.
ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 200 of file OgreStringInterface.h.
const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 213 of file OgreStringInterface.h.
const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const [inherited] |
Retrieves a list of parameters valid for this object.
virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, | |
const String & | value | |||
) | [virtual, inherited] |
Generic parameter setting method.
name | The name of the parameter to set | |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
Referenced by Ogre::StringInterface::copyParametersTo().
virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual, inherited] |
Generic multiple parameter setting method.
paramList | Name/value pair list |
virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual, inherited] |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 269 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const [virtual, inherited] |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 300 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
static void Ogre::StringInterface::cleanupDictionary | ( | ) | [static, inherited] |
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.
ResourceManager* Ogre::Resource::mCreator [protected] |
String Ogre::Resource::mName [protected] |
String Ogre::Resource::mGroup [protected] |
ResourceHandle Ogre::Resource::mHandle [protected] |
volatile LoadingState Ogre::Resource::mLoadingState [protected] |
volatile bool Ogre::Resource::mIsBackgroundLoaded [protected] |
Is this resource going to be background loaded? Only applicable for multithreaded.
Definition at line 119 of file OgreResource.h.
size_t Ogre::Resource::mSize [protected] |
Mutex to cover the status of loading.
The size of the resource in bytes
Definition at line 123 of file OgreResource.h.
bool Ogre::Resource::mIsManual [protected] |
String Ogre::Resource::mOrigin [protected] |
Origin of this resource (e.g. script name) - optional.
Definition at line 127 of file OgreResource.h.
ManualResourceLoader* Ogre::Resource::mLoader [protected] |
Optional manual loader; if provided, data is loaded from here instead of a file.
Definition at line 129 of file OgreResource.h.
ListenerList Ogre::Resource::mListenerList [protected] |
Definition at line 132 of file OgreResource.h.
ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited] |
String Ogre::StringInterface::mParamDictName [protected, inherited] |
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 164 of file OgreStringInterface.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:52:27 2008