OgreResourceBackgroundQueue.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-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/
#ifndef __ResourceBackgroundQueue_H__
#define __ResourceBackgroundQueue_H__


#include "OgrePrerequisites.h"
#include "OgreCommon.h"
#include "OgreSingleton.h"

#if OGRE_THREAD_SUPPORT
#   include <boost/thread/thread.hpp>
#   include <boost/thread/condition.hpp>
#endif

namespace Ogre {

    typedef unsigned long BackgroundProcessTicket;

    class _OgreExport ResourceBackgroundQueueListener
    {
    public:
        virtual void operationCompleted(BackgroundProcessTicket ticket) = 0;
    };
    
    class _OgreExport ResourceBackgroundQueue : public Singleton<ResourceBackgroundQueue>
    {
    protected:
        enum RequestType
        {
            RT_INITIALISE_GROUP,
            RT_INITIALISE_ALL_GROUPS,
            RT_LOAD_GROUP,
            RT_LOAD_RESOURCE,
            RT_SHUTDOWN
        };
        struct Request
        {
            BackgroundProcessTicket ticketID;
            RequestType type;
            String resourceName;
            String resourceType;
            String groupName;
            bool isManual; 
            ManualResourceLoader* loader;
            const NameValuePairList* loadParams;
            ResourceBackgroundQueueListener* listener;
        };
        typedef std::list<Request> RequestQueue;
        typedef std::map<BackgroundProcessTicket, Request*> RequestTicketMap;
        
        RequestQueue mRequestQueue;
        
        RequestTicketMap mRequestTicketMap;

        unsigned long mNextTicketID;

#if OGRE_THREAD_SUPPORT

        boost::thread* mThread;
        boost::condition mCondition;
        static void threadFunc(void);
        BackgroundProcessTicket addRequest(Request& req);
#else

        void* mThread;
#endif

        OGRE_AUTO_MUTEX

    public:
        ResourceBackgroundQueue();
        virtual ~ResourceBackgroundQueue();

        virtual void initialise(void);
        
        virtual void shutdown(void);

        virtual BackgroundProcessTicket initialiseResourceGroup(
            const String& name, ResourceBackgroundQueueListener* listener = 0);

        virtual BackgroundProcessTicket initialiseAllResourceGroups( 
            ResourceBackgroundQueueListener* listener = 0);
        virtual BackgroundProcessTicket loadResourceGroup(const String& name, 
            ResourceBackgroundQueueListener* listener = 0);


        virtual BackgroundProcessTicket load(
            const String& resType, const String& name, 
            const String& group, bool isManual = false, 
            ManualResourceLoader* loader = 0, 
            const NameValuePairList* loadParams = 0, 
            ResourceBackgroundQueueListener* listener = 0);

        virtual bool isProcessComplete(BackgroundProcessTicket ticket);

        static ResourceBackgroundQueue& getSingleton(void);
        static ResourceBackgroundQueue* getSingletonPtr(void);
        

    };


}

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:48 2006