OgreTerrainZonePageSource.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-2011 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.
-----------------------------------------------------------------------------
OgreTerrainZonePageSource.h  -  based on OgreTerrainPageSource.h from Ogre3d

-----------------------------------------------------------------------------
begin                : Thu May 3 2007
author               : Eric Cha
email                : ericcATxenopiDOTcom

-----------------------------------------------------------------------------
*/

#ifndef __TerrainZonePageSource_H__
#define __TerrainZonePageSource_H__

#include "OgreTerrainZonePrerequisites.h"
#include "OgreSingleton.h"

namespace Ogre {

    typedef std::pair<String, String> TerrainZonePageSourceOption;
    typedef vector<TerrainZonePageSourceOption>::type TerrainZonePageSourceOptionList;

    class _OgreOctreeZonePluginExport TerrainZonePageSourceListener
    {
    public:
        virtual void pageConstructed(TerrainZone* zone, size_t pagex, size_t pagez, Real* heightData) = 0;
        virtual ~TerrainZonePageSourceListener() {}
    };

    class _OgreOctreeZonePluginExport TerrainZonePageSourceListenerManager :
        public Singleton<TerrainZonePageSourceListenerManager>, public GeneralAllocatedObject
    {
    protected:
        typedef vector<TerrainZonePageSourceListener*>::type PageSourceListenerList;
        PageSourceListenerList mPageSourceListeners;
    public:
        TerrainZonePageSourceListenerManager() {}
        virtual ~TerrainZonePageSourceListenerManager() {}

        void addListener(TerrainZonePageSourceListener* pl);
        void removeListener(TerrainZonePageSourceListener* pl);
        
        void firePageConstructed(TerrainZone* manager, size_t pagex, size_t pagez, Real* heightData);

        static TerrainZonePageSourceListenerManager& getSingleton(void);
        static TerrainZonePageSourceListenerManager* getSingletonPtr(void); 
    
    };


    class _OgreOctreeZonePluginExport TerrainZonePageSource : public GeometryAllocatedObject
    {
    protected:
        TerrainZone* mTerrainZone;
        bool mAsyncLoading;
        unsigned short mPageSize;
        unsigned short mTileSize;

        void firePageConstructed(size_t pagex, size_t pagez, Real* heightData);

        virtual TerrainZonePage* buildPage(Real* heightData, const MaterialPtr& pMaterial);


    public:
        TerrainZonePageSource(); 
        virtual ~TerrainZonePageSource() { shutdown(); }

        virtual void initialise(TerrainZone* tz, 
            ushort tileSize, ushort pageSize, bool asyncLoading, 
            TerrainZonePageSourceOptionList& optionList)
        {
            mTerrainZone = tz;
            mTileSize = tileSize;
            mPageSize = pageSize;
            mAsyncLoading = asyncLoading;
        }
        virtual void shutdown(void) {}

        virtual void requestPage(ushort x, ushort z) = 0;
        virtual void expirePage(ushort x, ushort z) = 0;
        
        static void addListener(TerrainZonePageSourceListener* pl);
        static void removeListener(TerrainZonePageSourceListener* pl);

    };

}

#endif