OgrePagedWorldSection.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-2012 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_PagedWorldSection_H__
#define __Ogre_PagedWorldSection_H__

#include "OgrePagingPrerequisites.h"
#include "OgreAxisAlignedBox.h"

namespace Ogre
{
    class _OgrePagingExport PagedWorldSection : public PageAlloc
    {
    public:
        typedef map<PageID, Page*>::type PageMap;
    protected:
        String mName;
        AxisAlignedBox mAABB;
        PagedWorld* mParent;
        PageStrategy* mStrategy;
        PageStrategyData* mStrategyData;
        PageMap mPages;
        PageProvider* mPageProvider;
        SceneManager* mSceneMgr;

        virtual void loadSubtypeData(StreamSerialiser& ser) {}
        virtual void saveSubtypeData(StreamSerialiser& ser) {}


    public:
        static const uint32 CHUNK_ID;
        static const uint16 CHUNK_VERSION;

        PagedWorldSection(const String& name, PagedWorld* parent, SceneManager* sm);
        virtual ~PagedWorldSection();

        PageManager* getManager() const;

        virtual const String& getName() const { return mName; }
        virtual PageStrategy* getStrategy() const { return mStrategy; }
        virtual void setStrategy(PageStrategy* strat);
        virtual void setStrategy(const String& stratName);

        virtual void setSceneManager(SceneManager* sm);
        
        virtual void setSceneManager(const String& smName);
        virtual SceneManager* getSceneManager() const { return mSceneMgr; }

        virtual PagedWorld* getWorld() const { return mParent; }
        virtual PageStrategyData* getStrategyData() const { return mStrategyData; }
        virtual void setBoundingBox(const AxisAlignedBox& box);
        virtual const AxisAlignedBox& getBoundingBox() const;


        virtual bool load(StreamSerialiser& stream);
        virtual void save(StreamSerialiser& stream);


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

        virtual Page* loadOrCreatePage(const Vector3& worldPos);

        virtual PageID getPageID(const Vector3& worldPos);


        virtual void loadPage(PageID pageID, bool forceSynchronous = false);

        virtual void unloadPage(PageID pageID, bool forceSynchronous = false);
        virtual void unloadPage(Page* p, bool forceSynchronous = false);
        virtual bool _prepareProceduralPage(Page* page);
        virtual bool _loadProceduralPage(Page* page);
        virtual bool _unloadProceduralPage(Page* page);
        virtual bool _unprepareProceduralPage(Page* page);

        virtual void holdPage(PageID pageID);

        virtual Page* getPage(PageID pageID);

        virtual void removeAllPages();

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

        virtual StreamSerialiser* _readPageStream(PageID pageID);

        virtual StreamSerialiser* _writePageStream(PageID pageID);

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

        virtual const String& getType();

    };


    class _OgrePagingExport PagedWorldSectionFactory : public PageAlloc
    {
    public:
        virtual ~PagedWorldSectionFactory() {}
        virtual const String& getName() const = 0;
        virtual PagedWorldSection* createInstance(const String& name, PagedWorld* parent, SceneManager* sm) = 0;
        virtual void destroyInstance(PagedWorldSection*) = 0;


    };

}

#endif