OGRE-Next
2.3
Object-Oriented Graphics Rendering Engine
|
Abstract class representing a loadable resource (e.g. More...
#include <OgreResource.h>
Classes | |
class | Listener |
Public Types | |
enum | LoadingFlags { LF_DEFAULT = 0 , LF_INCLUDE_NON_RELOADABLE = 1 , LF_ONLY_UNREFERENCED = 2 , LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3 , LF_PRESERVE_STATE = 4 , LF_MARKED_FOR_RELOAD = 8 } |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More... | |
enum | LoadingState { LOADSTATE_UNLOADED , LOADSTATE_LOADING , LOADSTATE_LOADED , LOADSTATE_UNLOADING , LOADSTATE_PREPARED , LOADSTATE_PREPARING , LOADSTATE_UNLOADED_MARKED_FOR_RELOAD } |
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 () |
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 size_t | calculateSize () const |
Calculate the size of a resource; this will only be called after 'load'. 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 () |
Gets the manager which created this resource. More... | |
virtual const String & | getGroup () const |
Gets the group which this resource is a member of. More... | |
virtual ResourceHandle | getHandle () const |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. More... | |
virtual const String & | getName () const |
Gets resource name. More... | |
virtual const String & | getOrigin () const |
Get the origin of this resource, e.g. More... | |
ParamDictionary * | getParamDictionary () |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary () const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters () const |
Retrieves a list of parameters valid for this object. More... | |
virtual size_t | getSize () 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 () const |
Returns whether this Resource has been earmarked for background loading. More... | |
virtual bool | isLoaded () 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 () const |
Is this resource manually loaded? More... | |
virtual bool | isPrepared () const |
Returns true if the Resource has been prepared, false otherwise. More... | |
virtual bool | isReloadable () 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... | |
bool | markForReload () |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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 *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
virtual void | prepare (bool backgroundThread=false) |
Prepares the resource for load, if it is not already. More... | |
virtual void | reload (LoadingFlags flags=LF_DEFAULT) |
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 void | setManuallyLoaded (bool isManual) |
Set "Is this resource manually loaded?". 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 | setToLoaded () |
Change the Resource loading state to loaded. More... | |
virtual void | touch () |
'Touches' the resource to indicate it has been used. More... | |
virtual void | unload () |
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... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
Abstract class representing a loadable resource (e.g.
textures, sounds etc)
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior.
Enum identifying the loading state of the resource.
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.
|
virtual |
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtual |
Calculate the size of a resource; this will only be called after 'load'.
Reimplemented in Ogre::GLSLShader, Ogre::UnifiedHighLevelGpuProgram, Ogre::HighLevelGpuProgram, and Ogre::GpuProgram.
|
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. |
References Ogre::StringInterface::setParameter().
|
virtual |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtual |
Gets the manager which created this resource.
|
inlinevirtual |
Gets the group which this resource is a member of.
Reimplemented in Ogre::v1::OldSkeletonInstance.
|
inlinevirtual |
Reimplemented in Ogre::v1::OldSkeletonInstance.
|
inlinevirtual |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
References Ogre::AtomicScalar< T >::get().
|
inlinevirtual |
Gets resource name.
Reimplemented in Ogre::v1::OldSkeletonInstance.
Referenced by Ogre::GpuProgramUsage::getProgramName().
|
inlinevirtual |
Get the origin of this resource, e.g.
a script file name.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
|
inlineinherited |
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
References Ogre::ParamCommand::doGet().
|
inherited |
Retrieves a list of parameters valid for this object.
|
inlinevirtual |
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
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.
|
inlinevirtual |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtual |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
References Ogre::AtomicScalar< T >::get().
|
inlinevirtual |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
References Ogre::AtomicScalar< T >::get().
|
inlinevirtual |
Is this resource manually loaded?
|
inlinevirtual |
Returns true if the Resource has been prepared, false otherwise.
References Ogre::AtomicScalar< T >::get().
|
inlinevirtual |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
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.
|
inline |
References Ogre::AtomicScalar< T >::cas().
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
|
inlineinherited |
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
|
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 |
|
virtual |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram, and Ogre::v1::Mesh.
|
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.
|
inlinevirtual |
Set "Is this resource manually loaded?".
|
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 |
|
inlinevirtual |
Change the Resource loading state to loaded.
References Ogre::AtomicScalar< T >::set().
|
virtual |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram, and Ogre::Material.
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.
Ogre::Resource::OGRE_AUTO_MUTEX |