OgrePagedWorld.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 __Ogre_PagedWorld_H__
#define __Ogre_PagedWorld_H__

#include "OgrePagingPrerequisites.h"
#include "OgreString.h"
#include "OgreDataStream.h"
#include "OgreCommon.h"

namespace Ogre
{
    class PageManager;

    class _OgrePagingExport PagedWorld : public PageAlloc
    {
    protected:
        String mName;
        PageManager* mManager;
        PageProvider* mPageProvider;

    public:
        static const uint32 CHUNK_ID;
        static const uint16 CHUNK_VERSION;
        static const uint32 CHUNK_SECTIONDECLARATION_ID;
        PagedWorld(const String& name, PageManager* manager);
        virtual ~PagedWorld();

        const String& getName() const { return mName; }
        PageManager* getManager() const { return mManager; }

        void load(const String& filename);
        void load(const DataStreamPtr& stream);
        bool load(StreamSerialiser& stream);
        void save(const String& filename);
        void save(const DataStreamPtr& stream);
        void save(StreamSerialiser& stream);

        PagedWorldSection* createSection(SceneManager* sceneMgr,
            const String& typeName,
            const String& sectionName = StringUtil::BLANK);


        PagedWorldSection* createSection(const String& strategyName, SceneManager* sceneMgr,
            const String& sectionName = StringUtil::BLANK);


        PagedWorldSection* createSection(PageStrategy* strategy, SceneManager* sceneMgr, 
            const String& sectionName = StringUtil::BLANK);
        void destroySection(const String& name);
        void destroySection(PagedWorldSection* sec);
        void destroyAllSections();

        size_t getSectionCount() const { return mSections.size(); }

        PagedWorldSection* getSection(const String& name);

        typedef map<String, PagedWorldSection*>::type SectionMap;
        const SectionMap& getSections() const { return mSections; }

        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);

        virtual void frameStart(Real timeSinceLastFrame);
        virtual void frameEnd(Real timeElapsed);
        virtual void notifyCamera(Camera* cam);

        _OgrePagingExport friend std::ostream& operator <<( std::ostream& o, const PagedWorld& p );


    protected:
        SectionMap mSections;
        NameGenerator mSectionNameGenerator;
    };
    
}

#endif