OgreResource.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 _Resource_H__
#define _Resource_H__

#include "OgrePrerequisites.h"
#include "OgreString.h"
#include "OgreSharedPtr.h"
#include "OgreStringInterface.h"
#include "OgreAtomicScalar.h"
#include "Threading/OgreThreadHeaders.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {

    typedef unsigned long long int ResourceHandle;


    // Forward declaration
    class ManualResourceLoader;

    class _OgreExport Resource : public StringInterface, public ResourceAlloc
    {
    public:
        OGRE_AUTO_MUTEX; // public to allow external locking
        class Listener
        {
        public:
            Listener() {}
            virtual ~Listener() {}

            OGRE_DEPRECATED virtual void backgroundLoadingComplete(Resource*) {}

            OGRE_DEPRECATED virtual void backgroundPreparingComplete(Resource*) {}

            virtual void loadingComplete(Resource*) {}


            virtual void preparingComplete(Resource*) {}

            virtual void unloadingComplete(Resource*) {}
        };
        
        enum LoadingState
        {
            LOADSTATE_UNLOADED,
            LOADSTATE_LOADING,
            LOADSTATE_LOADED,
            LOADSTATE_UNLOADING,
            LOADSTATE_PREPARED,
            LOADSTATE_PREPARING
        };
    protected:
        ResourceManager* mCreator;
        String mName;
        String mGroup;
        ResourceHandle mHandle;
        AtomicScalar<LoadingState> mLoadingState;
        volatile bool mIsBackgroundLoaded;
        size_t mSize;
        bool mIsManual;
        String mOrigin;
        ManualResourceLoader* mLoader;
        size_t mStateCount;

        typedef set<Listener*>::type ListenerList;
        ListenerList mListenerList;
        OGRE_MUTEX(mListenerListMutex);

        Resource() 
            : mCreator(0), mHandle(0), mLoadingState(LOADSTATE_UNLOADED), 
            mIsBackgroundLoaded(false), mSize(0), mIsManual(0), mLoader(0)
        { 
        }

        virtual void preLoadImpl(void) {}
        virtual void postLoadImpl(void) {}

        virtual void preUnloadImpl(void) {}
        virtual void postUnloadImpl(void) {}

        virtual void prepareImpl(void) {}
        virtual void unprepareImpl(void) {}
        virtual void loadImpl(void) = 0;
        virtual void unloadImpl(void) = 0;

    public:
        Resource(ResourceManager* creator, const String& name, ResourceHandle handle,
            const String& group, bool isManual = false, ManualResourceLoader* loader = 0);

        virtual ~Resource();

        virtual void prepare(bool backgroundThread = false);

        virtual void load(bool backgroundThread = false);

        virtual void reload(void);

        virtual bool isReloadable(void) const
        {
            return !mIsManual || mLoader;
        }

        virtual bool isManuallyLoaded(void) const
        {
            return mIsManual;
        }

        virtual void unload(void);

        virtual size_t getSize(void) const
        { 
            return mSize; 
        }

        virtual void touch(void);

        virtual const String& getName(void) const 
        { 
            return mName; 
        }

        virtual ResourceHandle getHandle(void) const
        {
            return mHandle;
        }

        virtual bool isPrepared(void) const 
        { 
            // No lock required to read this state since no modify
            return (mLoadingState.get() == LOADSTATE_PREPARED); 
        }

        virtual bool isLoaded(void) const 
        { 
            // No lock required to read this state since no modify
            return (mLoadingState.get() == LOADSTATE_LOADED); 
        }

        virtual bool isLoading() const
        {
            return (mLoadingState.get() == LOADSTATE_LOADING);
        }

        virtual LoadingState getLoadingState() const
        {
            return mLoadingState.get();
        }



        virtual bool isBackgroundLoaded(void) const { return mIsBackgroundLoaded; }

        virtual void setBackgroundLoaded(bool bl) { mIsBackgroundLoaded = bl; }

        virtual void escalateLoading();

        virtual void addListener(Listener* lis);

        virtual void removeListener(Listener* lis);

        virtual const String& getGroup(void) const { return mGroup; }

        virtual void changeGroupOwnership(const String& newGroup);

        virtual ResourceManager* getCreator(void) { return mCreator; }
        virtual const String& getOrigin(void) const { return mOrigin; }
        virtual void _notifyOrigin(const String& origin) { mOrigin = origin; }

        virtual size_t getStateCount() const { return mStateCount; }

        virtual void _dirtyState();


        virtual void _fireLoadingComplete(bool wasBackgroundLoaded);

        virtual void _firePreparingComplete(bool wasBackgroundLoaded);

        virtual void _fireUnloadingComplete(void);

        virtual size_t calculateSize(void) const;

    };

    typedef SharedPtr<Resource> ResourcePtr;

    class _OgreExport ManualResourceLoader
    {
    public:
        ManualResourceLoader() {}
        virtual ~ManualResourceLoader() {}

        virtual void prepareResource(Resource* resource)
                { (void)resource; }

        virtual void loadResource(Resource* resource) = 0;
    };
}

#include "OgreHeaderSuffix.h"

#endif