OGRE-Next  4.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::v1::OldSkeletonManager Class Referencefinal

Handles the management of skeleton resources. More...

#include <OgreOldSkeletonManager.h>

+ Inheritance diagram for Ogre::v1::OldSkeletonManager:

Public Member Functions

 OldSkeletonManager ()
 Constructor. More...
 
 ~OldSkeletonManager () override
 
SkeletonPtr create (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
 Create a new skeleton. More...
 
SkeletonPtr getByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
 Get a resource by name. More...
 
- Public Member Functions inherited from Ogre::ResourceManager
 ResourceManager ()
 
 ~ResourceManager () override
 
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 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...
 
virtual ResourcePtr createResource (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...
 
void destroyAllResourcePools ()
 destroy all pools More...
 
void destroyResourcePool (const String &name)
 Destroy a resource pool. More...
 
void destroyResourcePool (ResourcePool *pool)
 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...
 
Real getLoadingOrder () const override
 Gets the relative loading order of resources of this type. More...
 
virtual size_t getMemoryBudget () const
 Get the limit on the amount of memory this resource handler may use. More...
 
virtual size_t getMemoryUsage () const
 Gets the current memory usage, in bytes. More...
 
virtual ResourcePtr getResourceByName (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...
 
ResourceMapIterator getResourceIterator ()
 Returns an iterator over all resources in this manager. More...
 
ResourcePoolgetResourcePool (const String &name)
 Create a resource pool, or reuse one that already exists. More...
 
const StringgetResourceType () const
 Gets a string identifying the type of resource this manager handles. More...
 
const StringVectorgetScriptPatterns () const override
 Gets the file patterns which should be used to find scripts for this ResourceManager. More...
 
virtual bool getVerbose ()
 Gets whether this manager and its resources habitually produce log output. 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 parseScript (DataStreamPtr &stream, const String &groupName) override
 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...
 
void reloadAll (bool reloadableOnly=true)
 Caused all currently loaded resources to be reloaded. More...
 
virtual void reloadAll (Resource::LoadingFlags flags)
 Caused all currently loaded resources to be reloaded. More...
 
void reloadUnreferencedResources (bool reloadableOnly=true)
 Caused all currently loaded but not referenced by any other object resources to be reloaded. More...
 
virtual void remove (const 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 ()
 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...
 
void unloadAll (bool reloadableOnly=true)
 Unloads all resources. More...
 
virtual void unloadAll (Resource::LoadingFlags flags)
 Unloads all resources. More...
 
void unloadUnreferencedResources (bool reloadableOnly=true)
 Unload all resources which are not referenced by any other object. More...
 
- Public Member Functions inherited from Ogre::ScriptLoader
virtual ~ScriptLoader ()
 
- Public Member Functions inherited from Ogre::Singleton< OldSkeletonManager >
 Singleton ()
 
 ~Singleton ()
 

Static Public Member Functions

static OldSkeletonManagergetSingleton ()
 Override standard Singleton retrieval. More...
 
static OldSkeletonManagergetSingletonPtr ()
 Override standard Singleton retrieval. More...
 
- Static Public Member Functions inherited from Ogre::Singleton< OldSkeletonManager >
static OldSkeletonManager & getSingleton ()
 
static OldSkeletonManager * getSingletonPtr ()
 

Additional Inherited Members

- Public Types inherited from Ogre::ResourceManager
typedef std::pair< ResourcePtr, bool > ResourceCreateOrRetrieveResult
 
typedef map< ResourceHandle, ResourcePtr >::type ResourceHandleMap
 
typedef unordered_map< String, ResourcePtr >::type ResourceMap
 
typedef MapIterator< ResourceHandleMapResourceMapIterator
 
typedef unordered_map< String, ResourceMap >::type ResourceWithGroupMap
 
- Public Attributes inherited from Ogre::ResourceManager
 OGRE_AUTO_MUTEX
 

Detailed Description

Handles the management of skeleton resources.

Remarks
This class deals with the runtime management of skeleton data; like other resource managers it handles the creation of resources (in this case skeleton data), working within a fixed memory budget.

Constructor & Destructor Documentation

◆ OldSkeletonManager()

Ogre::v1::OldSkeletonManager::OldSkeletonManager ( )

Constructor.

◆ ~OldSkeletonManager()

Ogre::v1::OldSkeletonManager::~OldSkeletonManager ( )
override

Member Function Documentation

◆ create()

SkeletonPtr Ogre::v1::OldSkeletonManager::create ( const String name,
const String group,
bool  isManual = false,
ManualResourceLoader loader = 0,
const NameValuePairList createParams = 0 
)

Create a new skeleton.

See also
ResourceManager::createResource

◆ getByName()

SkeletonPtr Ogre::v1::OldSkeletonManager::getByName ( const String name,
const String groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME 
)

Get a resource by name.

See also
ResourceManager::getResourceByName

◆ getSingleton()

static OldSkeletonManager& Ogre::v1::OldSkeletonManager::getSingleton ( )
static

Override standard Singleton retrieval.

Remarks
Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.
This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

◆ getSingletonPtr()

static OldSkeletonManager* Ogre::v1::OldSkeletonManager::getSingletonPtr ( )
static

Override standard Singleton retrieval.

Remarks
Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.
This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

The documentation for this class was generated from the following file: