OgrePageManager.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-2014 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 __Ogre_PageManager_H__
#define __Ogre_PageManager_H__

#include "OgrePagingPrerequisites.h"
#include "OgreString.h"
#include "OgreResourceGroupManager.h"
#include "OgreCommon.h"
#include "OgreCamera.h"
#include "OgreFrameListener.h"
#include "OgreNameGenerator.h"

namespace Ogre
{
    class PagedWorldSection;
    class PagedWorldSectionFactory;


    class PageProvider
    {
    public:
        PageProvider() {}
        virtual ~PageProvider() {}

        virtual bool prepareProceduralPage(Page* page, PagedWorldSection* section) { return false; }
        virtual bool loadProceduralPage(Page* page, PagedWorldSection* section) { return false; }
        virtual bool unloadProceduralPage(Page* page, PagedWorldSection* section) { return false; }
        virtual bool unprepareProceduralPage(Page* page, PagedWorldSection* section) { return false; }

        virtual StreamSerialiser* readWorldStream(const String& filename) { return 0; }
        virtual StreamSerialiser* writeWorldStream(const String& filename) { return 0; }
        virtual StreamSerialiser* readPageStream(PageID pageID, PagedWorldSection* section) { return 0; }

        virtual StreamSerialiser* writePageStream(PageID pageID, PagedWorldSection* section) { return 0; }
    };
    
    class _OgrePagingExport PageManager : public PageAlloc
    {
    public:
        PageManager();
        virtual ~PageManager();

        PagedWorld* createWorld(const String& name = StringUtil::BLANK);

        void destroyWorld(const String& name);

        void destroyWorld(PagedWorld* world);

        PagedWorld* loadWorld(const String& filename, const String& name = StringUtil::BLANK);
        PagedWorld* loadWorld(const DataStreamPtr& stream, const String& name = StringUtil::BLANK);
        void saveWorld(PagedWorld* world, const String& filename);
        void saveWorld(PagedWorld* world, const DataStreamPtr& stream);
        PagedWorld* getWorld(const String& name);
        typedef map<String, PagedWorld*>::type WorldMap;
        const WorldMap& getWorlds() const { return mWorlds; }


        typedef map<String, PageStrategy*>::type StrategyMap;
        void addStrategy(PageStrategy* strategy);

        void removeStrategy(PageStrategy* strategy);

        PageStrategy* getStrategy(const String& name);

        const StrategyMap& getStrategies() const;


        typedef map<String, PageContentCollectionFactory*>::type ContentCollectionFactoryMap;
        void addContentCollectionFactory(PageContentCollectionFactory* f);

        void removeContentCollectionFactory(PageContentCollectionFactory* f);

        PageContentCollectionFactory* getContentCollectionFactory(const String& name);

        PageContentCollection* createContentCollection(const String& typeName);

        void destroyContentCollection(PageContentCollection* coll);

        const ContentCollectionFactoryMap& getContentCollectionFactories() const;

        typedef map<String, PageContentFactory*>::type ContentFactoryMap;
        void addContentFactory(PageContentFactory* f);

        void removeContentFactory(PageContentFactory* f);

        PageContentFactory* getContentFactory(const String& name);

        const ContentFactoryMap& getContentFactories() const;

        PageContent* createContent(const String& typeName);

        void destroyContent(PageContent* c);


        typedef map<String, PagedWorldSectionFactory*>::type WorldSectionFactoryMap;
        void addWorldSectionFactory(PagedWorldSectionFactory* f);

        void removeWorldSectionFactory(PagedWorldSectionFactory* f);

        PagedWorldSectionFactory* getWorldSectionFactory(const String& name);

        PagedWorldSection* createWorldSection(const String& typeName, 
            const String& name, PagedWorld* parent, SceneManager* sm);

        void destroyWorldSection(PagedWorldSection* s);

        const WorldSectionFactoryMap& getWorldSectionFactories() const;


        void setPageProvider(PageProvider* provider) { mPageProvider = provider; }
        
        PageProvider* getPageProvider() const { return mPageProvider; }

        virtual bool _prepareProceduralPage(Page* page, PagedWorldSection* section);
        virtual bool _loadProceduralPage(Page* page, PagedWorldSection* section);
        virtual bool _unloadProceduralPage(Page* page, PagedWorldSection* section);
        virtual bool _unprepareProceduralPage(Page* page, PagedWorldSection* section);
        StreamSerialiser* _readPageStream(PageID pageID, PagedWorldSection* section);

        StreamSerialiser* _writePageStream(PageID pageID, PagedWorldSection* section);
        StreamSerialiser* _readWorldStream(const String& filename);

        StreamSerialiser* _writeWorldStream(const String& filename);

        const String& getPageResourceGroup() const { return mPageResourceGroup; }
        void setPageResourceGroup(const String& g) { mPageResourceGroup = g; }

        void addCamera(Camera* c);

        void removeCamera(Camera* c);

        bool hasCamera(Camera* c) const;

        typedef vector<Camera*>::type CameraList;
        const CameraList& getCameraList() const;

        void setDebugDisplayLevel(uint8 lvl) { mDebugDisplayLvl = lvl; }
        uint8 getDebugDisplayLevel() const { return mDebugDisplayLvl; }

        void setPagingOperationsEnabled(bool enabled) { mPagingEnabled = enabled; }

        bool getPagingOperationsEnabled() const { return mPagingEnabled; }


    protected:

        class EventRouter : public Camera::Listener, public FrameListener
        {
        public:
            PageManager* pManager;
            WorldMap* pWorldMap;
            CameraList* pCameraList;

            EventRouter() : pManager(0), pWorldMap(0), pCameraList(0) {}
            ~EventRouter() {}

            void cameraPreRenderScene(Camera* cam);
            void cameraDestroyed(Camera* cam);
            bool frameStarted(const FrameEvent& evt);
            bool frameEnded(const FrameEvent& evt);
        };

        void createStandardStrategies();
        void createStandardContentFactories();

        WorldMap mWorlds;
        StrategyMap mStrategies;
        ContentCollectionFactoryMap mContentCollectionFactories;
        ContentFactoryMap mContentFactories;
        WorldSectionFactoryMap mWorldSectionFactories;
        NameGenerator mWorldNameGenerator;
        PageProvider* mPageProvider;
        String mPageResourceGroup;
        CameraList mCameraList;
        EventRouter mEventRouter;
        uint8 mDebugDisplayLvl;
        bool mPagingEnabled;

        Grid2DPageStrategy* mGrid2DPageStrategy;
        Grid3DPageStrategy* mGrid3DPageStrategy;
        SimplePageContentCollectionFactory* mSimpleCollectionFactory;
    };

}

#endif