OgreResourceManager.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef _ResourceManager_H__
#define _ResourceManager_H__

#include "OgrePrerequisites.h"

#include "OgreResource.h"
#include "OgreResourceGroupManager.h"
#include "OgreIteratorWrappers.h"
#include "OgreCommon.h"
#include "OgreDataStream.h"
#include "OgreStringVector.h"
#include "OgreScriptLoader.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {

    template <typename T>
    class Pool
    {
    protected:
        typedef typename list<T>::type ItemList;
        ItemList mItems;
        OGRE_AUTO_MUTEX;
    public:
        Pool() {}
        virtual ~Pool() {}

        virtual std::pair<bool, T> removeItem()
        {
            OGRE_LOCK_AUTO_MUTEX;
            std::pair<bool, T> ret;
            if (mItems.empty())
            {
                ret.first = false;
            }
            else
            {
                ret.first = true;
                ret.second = mItems.front();
                mItems.pop_front();
            }
            return ret;
        }

        virtual void addItem(const T& i)
        {
            OGRE_LOCK_AUTO_MUTEX;
            mItems.push_front(i);
        }
        virtual void clear()
        {
            OGRE_LOCK_AUTO_MUTEX;
            mItems.clear();
        }
    };

    class _OgreExport ResourceManager : public ScriptLoader, public ResourceAlloc
    {
    public:
        OGRE_AUTO_MUTEX; // public to allow external locking
        ResourceManager();
        virtual ~ResourceManager();

        virtual ResourcePtr createResource(const String& name, const String& group,
            bool isManual = false, ManualResourceLoader* loader = 0, 
            const NameValuePairList* createParams = 0);

        typedef std::pair<ResourcePtr, bool> ResourceCreateOrRetrieveResult;
        virtual ResourceCreateOrRetrieveResult createOrRetrieve(const String& name, 
            const String& group, bool isManual = false, 
            ManualResourceLoader* loader = 0, 
            const NameValuePairList* createParams = 0);
        
        virtual void setMemoryBudget(size_t bytes);

        virtual size_t getMemoryBudget(void) const;

        virtual size_t getMemoryUsage(void) const { return mMemoryUsage.get(); }

        virtual void unload(const String& name);
        
        virtual void unload(ResourceHandle handle);

        virtual void unloadAll(bool reloadableOnly = true);

        virtual void reloadAll(bool reloadableOnly = true);

        virtual void unloadUnreferencedResources(bool reloadableOnly = true);

        virtual void reloadUnreferencedResources(bool reloadableOnly = true);

        virtual void remove(ResourcePtr& r);

        virtual void remove(const String& name);
        
        virtual void remove(ResourceHandle handle);
        virtual void removeAll(void);

        virtual void removeUnreferencedResources(bool reloadableOnly = true);

        virtual ResourcePtr getResourceByName(const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME);
        virtual ResourcePtr getByHandle(ResourceHandle handle);
        
        virtual bool resourceExists(const String& name)
        {
            return !getResourceByName(name).isNull();
        }
        virtual bool resourceExists(ResourceHandle handle)
        {
            return !getByHandle(handle).isNull();
        }

        virtual void _notifyResourceTouched(Resource* res);

        virtual void _notifyResourceLoaded(Resource* res);

        virtual void _notifyResourceUnloaded(Resource* res);

        virtual ResourcePtr prepare(const String& name, 
            const String& group, bool isManual = false, 
            ManualResourceLoader* loader = 0, const NameValuePairList* loadParams = 0,
            bool backgroundThread = false);

        virtual ResourcePtr load(const String& name, 
            const String& group, bool isManual = false, 
            ManualResourceLoader* loader = 0, const NameValuePairList* loadParams = 0,
            bool backgroundThread = false);

        virtual const StringVector& getScriptPatterns(void) const { return mScriptPatterns; }

        virtual void parseScript(DataStreamPtr& stream, const String& groupName)
                { (void)stream; (void)groupName; }

        virtual Real getLoadingOrder(void) const { return mLoadOrder; }

        const String& getResourceType(void) const { return mResourceType; }

        virtual void setVerbose(bool v) { mVerbose = v; }

        virtual bool getVerbose(void) { return mVerbose; }

        class _OgreExport ResourcePool : public Pool<ResourcePtr>, public ResourceAlloc
        {
        protected:
            String mName;
        public:
            ResourcePool(const String& name);
            ~ResourcePool();
            const String& getName() const;
            void clear();
        };
        
        ResourcePool* getResourcePool(const String& name);
        void destroyResourcePool(ResourcePool* pool);
        void destroyResourcePool(const String& name);
        void destroyAllResourcePools();




    protected:

        ResourceHandle getNextHandle(void);

        virtual Resource* createImpl(const String& name, ResourceHandle handle, 
            const String& group, bool isManual, ManualResourceLoader* loader, 
            const NameValuePairList* createParams) = 0;
        virtual void addImpl( ResourcePtr& res );
        virtual void removeImpl( ResourcePtr& res );
        virtual void checkUsage(void);


    public:
        typedef HashMap< String, ResourcePtr > ResourceMap;
        typedef HashMap< String, ResourceMap > ResourceWithGroupMap;
        typedef map<ResourceHandle, ResourcePtr>::type ResourceHandleMap;
    protected:
        ResourceHandleMap mResourcesByHandle;
        ResourceMap mResources;
        ResourceWithGroupMap mResourcesWithGroup;
        size_t mMemoryBudget; 
        AtomicScalar<ResourceHandle> mNextHandle;
        AtomicScalar<size_t> mMemoryUsage; 

        bool mVerbose;

        // IMPORTANT - all subclasses must populate the fields below

        StringVector mScriptPatterns; 
        Real mLoadOrder; 
        String mResourceType; 

    public:
        typedef MapIterator<ResourceHandleMap> ResourceMapIterator;
        ResourceMapIterator getResourceIterator(void) 
        {
            return ResourceMapIterator(mResourcesByHandle.begin(), mResourcesByHandle.end());
        }

    protected:
        typedef map<String, ResourcePool*>::type ResourcePoolMap;
        ResourcePoolMap mResourcePoolMap;
    };

}

#include "OgreHeaderSuffix.h"

#endif