OgreTerrainPagedWorldSection.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_TerrainPagedWorldSection_H__
#define __Ogre_TerrainPagedWorldSection_H__

#include "OgreTerrainPrerequisites.h"
#include "OgrePagedWorldSection.h"
#include "OgrePageManager.h"
#include "OgreWorkQueue.h"
#include "OgreTerrainGroup.h"


namespace Ogre
{
    class Grid2DPageStrategy;
    class Grid2DPageStrategyData;
    class TerrainGroup;

    class _OgreTerrainExport TerrainPagedWorldSection : public PagedWorldSection,
        public WorkQueue::RequestHandler, public WorkQueue::ResponseHandler
    {
    public:
        TerrainPagedWorldSection(const String& name, PagedWorld* parent, SceneManager* sm);
        virtual ~TerrainPagedWorldSection();

        virtual void init(TerrainGroup* grp);

        virtual TerrainGroup* getTerrainGroup() { return mTerrainGroup; }

        virtual void setLoadRadius(Real sz);
        virtual Real getLoadRadius() const;
        virtual void setHoldRadius(Real sz);
        virtual Real getHoldRadius();
        virtual void setPageRange(int32 minX, int32 minY, int32 maxX, int32 maxY);
        virtual void setPageRangeMinX(int32 minX);
        virtual void setPageRangeMinY(int32 minY);
        virtual void setPageRangeMaxX(int32 maxX);
        virtual void setPageRangeMaxY(int32 maxY);
        virtual int32 getPageRangeMinX() const;
        virtual int32 getPageRangeMinY() const;
        virtual int32 getPageRangeMaxX() const;
        virtual int32 getPageRangeMaxY() const;

        virtual Grid2DPageStrategy* getGridStrategy() const;
        virtual Grid2DPageStrategyData* getGridStrategyData() const;

        virtual void setLoadingIntervalMs(uint32 loadingIntervalMs);
        virtual uint32 getLoadingIntervalMs() const;

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

        WorkQueue::Response* handleRequest(const WorkQueue::Request* req, const WorkQueue* srcQ);
        void handleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);

        static const uint16 WORKQUEUE_LOAD_TERRAIN_PAGE_REQUEST;

        class TerrainDefiner : public TerrainAlloc
        {
        public:
            virtual void define(TerrainGroup* terrainGroup, long x, long y)
            {
                terrainGroup->defineTerrain(x,y);
            }
            virtual ~TerrainDefiner() {}
        };

        void setDefiner(TerrainDefiner* terrainDefiner)
        {
            if(mTerrainDefiner)
                OGRE_DELETE mTerrainDefiner;
            mTerrainDefiner = terrainDefiner;
        }

    protected:
        TerrainGroup* mTerrainGroup;
        TerrainDefiner* mTerrainDefiner;
        std::list<PageID> mPagesInLoading;
        bool mHasRunningTasks;
        uint16 mWorkQueueChannel;
        unsigned long mNextLoadingTime;
        uint32 mLoadingIntervalMs;

        void loadSubtypeData(StreamSerialiser& ser);
        void saveSubtypeData(StreamSerialiser& ser);

        virtual void syncSettings();

    };





}

#endif