Abstract class representing a loadable resource (e.g. More...
#include <OgreResource.h>
Classes | |
class | Listener |
Public Types | |
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING } |
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. More... | |
virtual | ~Resource () |
Virtual destructor. More... | |
virtual void | _dirtyState () |
Manually mark the state of this resource as having been changed. More... | |
virtual void | _fireLoadingComplete (bool wasBackgroundLoaded) |
Firing of loading complete event. More... | |
virtual void | _firePreparingComplete (bool wasBackgroundLoaded) |
Firing of preparing complete event. More... | |
virtual void | _fireUnloadingComplete (void) |
Firing of unloading complete event. More... | |
virtual void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. More... | |
virtual void | addListener (Listener *lis) |
Register a listener on this resource. More... | |
virtual void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. More... | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. More... | |
virtual void | escalateLoading () |
Escalates the loading of a background loaded resource. More... | |
virtual ResourceManager * | getCreator (void) |
Gets the manager which created this resource. More... | |
virtual const String & | getGroup (void) |
Gets the group which this resource is a member of. More... | |
virtual ResourceHandle | getHandle (void) const |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. More... | |
virtual const String & | getName (void) const |
Gets resource name. More... | |
virtual const String & | getOrigin (void) const |
Get the origin of this resource, e.g. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
virtual size_t | getSize (void) const |
Retrieves info about the size of the resource. More... | |
virtual size_t | getStateCount () const |
Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More... | |
virtual bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. More... | |
virtual bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. More... | |
virtual bool | isLoading () const |
Returns whether the resource is currently in the process of background loading. More... | |
virtual bool | isManuallyLoaded (void) const |
Is this resource manually loaded? More... | |
virtual bool | isPrepared (void) const |
Returns true if the Resource has been prepared, false otherwise. More... | |
virtual bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. More... | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. 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 | prepare (bool backgroundThread=false) |
Prepares the resource for load, if it is not already. More... | |
virtual void | reload (void) |
Reloads the resource, if it is already loaded. More... | |
virtual void | removeListener (Listener *lis) |
Remove a listener on this resource. More... | |
virtual void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. More... | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. More... | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. More... | |
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. More... | |
Protected Types | |
typedef list< Listener * >::type | ListenerList |
Protected Member Functions | |
Resource () | |
Protected unnamed constructor to prevent default construction. More... | |
virtual size_t | calculateSize (void) const =0 |
Calculate the size of a resource; this will only be called after 'load'. More... | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. More... | |
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. More... | |
virtual void | postLoadImpl (void) |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. More... | |
virtual void | postUnloadImpl (void) |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. More... | |
virtual void | preLoadImpl (void) |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. More... | |
virtual void | prepareImpl (void) |
Internal implementation of the meat of the 'prepare' action. More... | |
virtual void | preUnloadImpl (void) |
Internal hook to perform actions before the unload process. More... | |
virtual void | unloadImpl (void)=0 |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader. More... | |
virtual void | unprepareImpl (void) |
Internal function for undoing the 'prepare' action. More... | |
Protected Attributes | |
ResourceManager * | mCreator |
Creator. More... | |
String | mGroup |
The name of the resource group. More... | |
ResourceHandle | mHandle |
Numeric handle for more efficient look up than name. More... | |
volatile bool | mIsBackgroundLoaded |
Is this resource going to be background loaded? Only applicable for multithreaded. More... | |
bool | mIsManual |
Is this file manually loaded? More... | |
ListenerList | mListenerList |
ManualResourceLoader * | mLoader |
Optional manual loader; if provided, data is loaded from here instead of a file. More... | |
AtomicScalar< LoadingState > | mLoadingState |
Is the resource currently loaded? More... | |
String | mName |
Unique name of the resource. More... | |
String | mOrigin |
Origin of this resource (e.g. script name) - optional. More... | |
size_t | mSize |
The size of the resource in bytes. More... | |
size_t | mStateCount |
State count, the number of times this resource has changed state. More... | |
Abstract class representing a loadable resource (e.g.
textures, sounds etc)
Definition at line 77 of file OgreResource.h.
|
protected |
Definition at line 164 of file OgreResource.h.
Enum identifying the loading state of the resource.
Definition at line 125 of file OgreResource.h.
|
inlineprotected |
Protected unnamed constructor to prevent default construction.
Definition at line 170 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 |
Virtual destructor.
Shouldn't need to be overloaded, as the resource deallocation code should reside in unload()
|
virtual |
Manually mark the state of this resource as having been changed.
|
virtual |
Firing of loading complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
virtual |
Firing of preparing complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
virtual |
Firing of unloading complete event.
|
inlinevirtual |
Notify this resource of it's origin.
Definition at line 420 of file OgreResource.h.
|
virtual |
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
protectedpure virtual |
Calculate the size of a resource; this will only be called after 'load'.
Implemented in Ogre::Skeleton, Ogre::Texture, Ogre::Mesh, Ogre::GpuProgram, Ogre::Font, Ogre::Material, Ogre::Compositor, Ogre::BspLevel, and Ogre::D3D9Texture.
|
virtual |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
|
staticinherited |
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.
|
inlinevirtualinherited |
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 301 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
|
inlineprotectedinherited |
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 184 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
|
virtual |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtual |
Gets the manager which created this resource.
Definition at line 411 of file OgreResource.h.
|
inlinevirtual |
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 399 of file OgreResource.h.
|
inlinevirtual |
Reimplemented in Ogre::SkeletonInstance.
Definition at line 317 of file OgreResource.h.
|
inlinevirtual |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 348 of file OgreResource.h.
|
inlinevirtual |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 312 of file OgreResource.h.
|
inlinevirtual |
Get the origin of this resource, e.g.
a script file name.
Definition at line 418 of file OgreResource.h.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
Definition at line 217 of file OgreStringInterface.h.
|
inlineinherited |
Definition at line 222 of file OgreStringInterface.h.
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 270 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
|
inherited |
Retrieves a list of parameters valid for this object.
|
inlinevirtual |
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 301 of file OgreResource.h.
|
inlinevirtual |
Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.
Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback.
Definition at line 429 of file OgreResource.h.
|
inlinevirtual |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 365 of file OgreResource.h.
|
inlinevirtual |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 332 of file OgreResource.h.
|
inlinevirtual |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 341 of file OgreResource.h.
|
inlinevirtual |
Is this resource manually loaded?
Definition at line 289 of file OgreResource.h.
|
inlinevirtual |
Returns true if the Resource has been prepared, false otherwise.
Definition at line 324 of file OgreResource.h.
|
inlinevirtual |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 282 of file OgreResource.h.
|
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.
|
protectedpure 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::Skeleton, Ogre::Mesh, Ogre::GpuProgram, Ogre::Font, Ogre::SkeletonInstance, Ogre::Material, Ogre::D3D9Texture, Ogre::Compositor, Ogre::D3D10Texture, Ogre::D3D11Texture, Ogre::BspLevel, Ogre::HighLevelGpuProgram, Ogre::GLSLGpuProgram, Ogre::D3D9GpuProgram, Ogre::PatchMesh, Ogre::GLTexture, Ogre::GLESTexture, Ogre::D3D10GpuProgram, and Ogre::D3D11GpuProgram.
|
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.
|
inlineprotectedvirtual |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
Reimplemented in Ogre::Mesh, and Ogre::D3D9Texture.
Definition at line 189 of file OgreResource.h.
|
inlineprotectedvirtual |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
Definition at line 199 of file OgreResource.h.
|
inlineprotectedvirtual |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
Definition at line 182 of file OgreResource.h.
|
virtual |
Prepares the resource for load, if it is not already.
One can call prepare() before load(), but this is not required as load() will call prepare() itself, if needed. When OGRE_THREAD_SUPPORT==1 both load() and prepare() are thread-safe. When OGRE_THREAD_SUPPORT==2 however, only prepare() is thread-safe. The reason for this function is to allow a background thread to do some of the loading work, without requiring the whole render system to be thread-safe. The background thread would call prepare() while the main render loop would later call load(). So long as prepare() remains thread-safe, subclasses can arbitrarily split the work of loading a resource between load() and prepare(). It is best to try and do as much work in prepare(), however, since this will leave less work for the main render thread to do and thus increase FPS.
backgroundThread | Whether this is occurring in a background thread |
|
inlineprotectedvirtual |
Internal implementation of the meat of the 'prepare' action.
Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::Material, Ogre::PatchMesh, Ogre::GLTexture, and Ogre::GLESTexture.
Definition at line 203 of file OgreResource.h.
|
inlineprotectedvirtual |
Internal hook to perform actions before the unload process.
Definition at line 194 of file OgreResource.h.
|
virtual |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtual |
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtual |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 375 of file OgreResource.h.
|
virtualinherited |
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().
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
|
virtual |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, and Ogre::UnifiedHighLevelGpuProgram.
Referenced by Ogre::Material::touch().
|
virtual |
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
protectedpure virtual |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.
Implemented in Ogre::Skeleton, Ogre::Texture, Ogre::Mesh, Ogre::Font, Ogre::GLSLProgram, Ogre::D3D9GpuFragmentProgram, Ogre::SkeletonInstance, Ogre::Material, Ogre::Compositor, Ogre::D3D9GpuVertexProgram, Ogre::GLArbGpuProgram, Ogre::BspLevel, Ogre::HighLevelGpuProgram, Ogre::D3D10GpuFragmentProgram, Ogre::D3D11GpuFragmentProgram, Ogre::GLSLGpuProgram, Ogre::D3D9GpuProgram, Ogre::D3D10GpuVertexProgram, Ogre::D3D11GpuVertexProgram, Ogre::GLGpuProgram, and Ogre::GLGpuNvparseProgram.
|
inlineprotectedvirtual |
Internal function for undoing the 'prepare' action.
Called when the load is completed, and when resources are unloaded when they are prepared but not yet loaded.
Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::Material, Ogre::GLTexture, and Ogre::GLESTexture.
Definition at line 208 of file OgreResource.h.
|
protected |
Creator.
Definition at line 142 of file OgreResource.h.
|
protected |
The name of the resource group.
Definition at line 146 of file OgreResource.h.
|
protected |
Numeric handle for more efficient look up than name.
Definition at line 148 of file OgreResource.h.
|
protected |
Is this resource going to be background loaded? Only applicable for multithreaded.
Definition at line 152 of file OgreResource.h.
|
protected |
Is this file manually loaded?
Definition at line 156 of file OgreResource.h.
|
protected |
Definition at line 165 of file OgreResource.h.
|
protected |
Optional manual loader; if provided, data is loaded from here instead of a file.
Definition at line 160 of file OgreResource.h.
|
protected |
Is the resource currently loaded?
Definition at line 150 of file OgreResource.h.
|
protected |
Unique name of the resource.
Definition at line 144 of file OgreResource.h.
|
protected |
Origin of this resource (e.g. script name) - optional.
Definition at line 158 of file OgreResource.h.
|
protected |
The size of the resource in bytes.
Definition at line 154 of file OgreResource.h.
|
protected |
State count, the number of times this resource has changed state.
Definition at line 162 of file OgreResource.h.