/* -*-c++-*- */
/* osgEarth - Dynamic map generation toolkit for OpenSceneGraph
* Copyright 2015 Pelican Mapping
* http://osgearth.org
*
* osgEarth is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* 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.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>
*/
#ifndef OSGEARTH_DRIVERS_MP_TERRAIN_ENGINE_SINGLE_KEY_NODE_FACTORY
#define OSGEARTH_DRIVERS_MP_TERRAIN_ENGINE_SINGLE_KEY_NODE_FACTORY 1

#include "Common"
#include "KeyNodeFactory"
#include "TerrainNode"
#include "TileModelCompiler"
#include "TileModelFactory"
#include "TileNodeRegistry"
#include <osgEarth/Map>
#include <osgEarth/Progress>

using namespace osgEarth;

namespace osgEarth { namespace Drivers { namespace MPTerrainEngine
{
    class SingleKeyNodeFactory : public KeyNodeFactory
    {
    public:
        SingleKeyNodeFactory(
            const Map*                          map,
            TileModelFactory*                   modelFactory,
            TileModelCompiler*                  modelCompiler,
            TileNodeRegistry*                   liveTiles,
            TileNodeRegistry*                   deadTiles,
            const MPTerrainEngineOptions&       options,
            UID                                 engineUID,
            TerrainTileNodeBroker*              tileNodeBroker );

        /** dtor */
        virtual ~SingleKeyNodeFactory() { }


    public: // KeyNodeFactory

        /**
         * Creates a TileNode or TileGroup corresponding to the TileKey.
         *
         * @param key           TileKey for which to create a new node
         * @param accumulate    Whether to accumulate data from parent tiles if necessary
         * @param setupChildren When true, build and include the necessary structures to
         *                      page in subtiles if and when necessary. If false, you just get
         *                      the tile alone with no paging support.
         * @param progress      Callback for cancelation and progress reporting
         */
        osg::Node* createNode(
            const TileKey&    key, 
            bool              accumulate,
            bool              setupChildren,
            ProgressCallback* progress );

    protected:
        osg::Node* createTile(
            TileModel*        model,
            bool              setupChildrenIfNecessary,
            ProgressCallback* progress);

        MapFrame                            _frame;
        osg::ref_ptr<TileModelFactory>      _modelFactory;
        osg::ref_ptr<TileModelCompiler>     _modelCompiler;
        osg::ref_ptr<TileNodeRegistry>      _liveTiles;
        osg::ref_ptr<TileNodeRegistry>      _deadTiles;
        const MPTerrainEngineOptions&       _options;
        UID                                 _engineUID;
        TerrainTileNodeBroker*              _tileNodeBroker;
        bool                                _debug;

        unsigned getMinimumRequiredLevel();
    };

} } } // namespace osgEarth::Drivers::MPTerrainEngine

#endif // OSGEARTH_DRIVERS_MP_TERRAIN_ENGINE_SINGLE_KEY_NODE_FACTORY
