/* -*-c++-*- */
/* osgEarth - Geospatial SDK for OpenSceneGraph
 * Copyright 2020 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * 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_XYZ_MODEL_LAYER
#define OSGEARTH_XYZ_MODEL_LAYER 1

#include <osgEarth/Common>
#include <osgEarth/Layer>
#include <osgEarth/LayerReference>
#include <osgEarth/TiledModelLayer>

namespace osgEarth {
    class Map;
}

namespace osgEarth
{  
    /**
     * Layer that loads a pregenerated quadtree of model files
     */
    class OSGEARTH_EXPORT XYZModelLayer : public TiledModelLayer
    {
    public: // serialization
        struct OSGEARTH_EXPORT Options : public TiledModelLayer::Options                         
        {
            META_LayerOptions(osgEarth, Options, TiledModelLayer::Options);
            OE_OPTION(URI, url);
            OE_OPTION(bool, additive);
            OE_OPTION(bool, invertY);
            OE_OPTION(int, minLevel);
            OE_OPTION(int, maxLevel);
            OE_OPTION(ProfileOptions, profile);
            Config getConfig() const override;
            void fromConfig(const Config& conf);
        };

    public:
        META_Layer(osgEarth, XYZModelLayer, Options, TiledModelLayer, XYZModel);

        //! Tiling profile (required)
        void setProfile(const Profile* profile);
        const Profile* getProfile() const override { return _profile.get(); }

        //! Whether to flip the Y axis for tile indexing
        //! TODO: do we need this? Since the URL supports ${-y}?
        void setInvertY(const bool& value);
        const bool& getInvertY() const;

        //! Base URL for requests
        void setURL(const URI& value);
        const URI& getURL() const;

        //! Whether new LODs should be added to the scene (true) or replace existing ones (false)
        void setAdditive(const bool& value);
        const bool& getAdditive() const;

        //! Minimum level of detail to access
        void setMinLevel(unsigned value);
        unsigned getMinLevel() const override;

        //! Maximum level of detail to access
        void setMaxLevel(unsigned value);
        unsigned getMaxLevel() const override;

        //! Forces a rebuild on this layer.
        void dirty();

    public: // Layer

        //! opens the layer and returns the status
        Status openImplementation() override;

        //! closes the layer
        Status closeImplementation() override;

        //! The Node representing this layer.
        osg::Node* getNode() const override;

        //! Serialization
        Config getConfig() const override;

    public: // Layer
        
        //! called by the map when this layer is added
        void addedToMap(const Map*) override;

        //! called by the map when this layer is removed
        void removedFromMap(const Map*) override;

        //! post-ctor initialization
        void init() override;

    protected: // TiledModelLayer

        //! Creates an OSG node from a tile key.
        osg::ref_ptr<osg::Node> createTileImplementation(const TileKey&, ProgressCallback*) const override;

    protected:

        virtual ~XYZModelLayer();

    private:
        osg::ref_ptr<osg::Group> _root;
        osg::ref_ptr<const Profile> _profile;
        osg::observer_ptr< const Map > _map;
        bool _graphDirty;
        
        void create();
    };

} // namespace osgEarth

#endif // OSGEARTH_XYZ_MODEL_LAYER
