OgreGrid2DPageStrategy.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_Grid2DPageStrategy_H__
#define __Ogre_Grid2DPageStrategy_H__

#include "OgrePagingPrerequisites.h"
#include "OgrePageStrategy.h"
#include "OgreVector2.h"
#include "OgreVector3.h"
#include "OgreQuaternion.h"

namespace Ogre
{


    enum Grid2DMode
    {
        G2D_X_Z = 0, 
        G2D_X_Y = 1, 
        G2D_Y_Z = 2
    };
    class _OgrePagingExport Grid2DPageStrategyData : public PageStrategyData
    {
    protected:
        Grid2DMode mMode;
        Vector3 mWorldOrigin;
        Vector2 mOrigin;
        Real mCellSize;
        Real mLoadRadius;
        Real mHoldRadius;
        Real mLoadRadiusInCells;
        Real mHoldRadiusInCells;
        int32 mMinCellX;
        int32 mMinCellY;
        int32 mMaxCellX;
        int32 mMaxCellY;

        void updateDerivedMetrics();

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

        Grid2DPageStrategyData();
        ~Grid2DPageStrategyData();

        virtual void setMode(Grid2DMode mode);

        virtual Grid2DMode getMode() const { return mMode; }

        virtual void setOrigin(const Vector3& worldOrigin);
        virtual const Vector3& getOrigin(const Vector3& worldOrigin) { return mWorldOrigin; }
        virtual void setCellSize(Real sz);
        virtual Real getCellSize() const { return mCellSize; }
        virtual void setLoadRadius(Real sz);
        virtual Real getLoadRadius() const { return mLoadRadius; }
        virtual void setHoldRadius(Real sz);
        virtual Real getHoldRadius() const { return mHoldRadius; }
        virtual Real getLoadRadiusInCells() { return mLoadRadiusInCells; }
        virtual Real getHoldRadiusInCells(){ return mHoldRadiusInCells; }

        virtual void setCellRange(int32 minX, int32 minY, int32 maxX, int32 maxY);
        virtual void setCellRangeMinX(int32 minX);
        virtual void setCellRangeMinY(int32 minY);
        virtual void setCellRangeMaxX(int32 maxX);
        virtual void setCellRangeMaxY(int32 maxY);
        virtual int32 getCellRangeMinX() const { return mMinCellX; }
        virtual int32 getCellRangeMinY() const { return mMinCellY; }
        virtual int32 getCellRangeMaxX() const { return mMaxCellX; }
        virtual int32 getCellRangeMaxY() const { return mMaxCellY; }

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

        virtual void convertWorldToGridSpace(const Vector3& world, Vector2& grid);
        virtual void convertGridToWorldSpace(const Vector2& grid, Vector3& world);
        virtual void getMidPointGridSpace(int32 x, int32 y, Vector2& mid);
        virtual void getBottomLeftGridSpace(int32 x, int32 y, Vector2& bl);
        virtual void getCornersGridSpace(int32 x, int32 y, Vector2* pFourPoints);
        
        void determineGridLocation(const Vector2& gridpos, int32* x, int32* y);

        PageID calculatePageID(int32 x, int32 y);
        void calculateCell(PageID inPageID, int32* x, int32* y);

    };


    class _OgrePagingExport Grid2DPageStrategy : public PageStrategy
    {
    public:
        Grid2DPageStrategy(PageManager* manager);

        ~Grid2DPageStrategy();

        // Overridden members
        void notifyCamera(Camera* cam, PagedWorldSection* section);
        PageStrategyData* createData();
        void destroyData(PageStrategyData* d);
        void updateDebugDisplay(Page* p, SceneNode* sn);
        PageID getPageID(const Vector3& worldPos, PagedWorldSection* section);
    };

}

#endif