/* -*-c++-*- */
/* osgEarth - Geospatial SDK for OpenSceneGraph
* Copyright 2008-2012 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_SPLAT_SPLAT_LAYER_H
#define OSGEARTH_SPLAT_SPLAT_LAYER_H

#include "Export"
#include "Zone"
#include <osgEarth/VisibleLayer>
#include <osgEarth/LayerReference>
#include <osgEarth/LandCoverLayer>

namespace osgEarth { namespace Splat
{
    //! Layer that renders geotypical textures on the terrain based on
    //! classification data ("texture splatting").
    class OSGEARTHSPLAT_EXPORT SplatLayer : public VisibleLayer
    {
    public:
        class OSGEARTHSPLAT_EXPORT Options : public VisibleLayer::Options
        {
        public:
            META_LayerOptions(osgEarth, Options, VisibleLayer::Options);
            OE_OPTION(std::string, landCoverLayer);
            OE_OPTION_VECTOR(ZoneOptions, zones);
            virtual Config getConfig() const;
        private:
            void fromConfig(const Config& conf);
        };

    public:
        META_Layer(osgEarthSplat, SplatLayer, Options, VisibleLayer, SplatImage);

        //! Layer containing required coverage data
        void setLandCoverLayer(LandCoverLayer* landCoverLayer);
        LandCoverLayer* getLandCoverLayer() const { return _landCoverLayer.getLayer(); }

        //! Layer containing the land cover dictionary.
        void setLandCoverDictionary(LandCoverDictionary* landCoverDict);
        LandCoverDictionary* getLandCoverDictionary() const { return _landCoverDict.getLayer(); }

        //! Splatting zones
        Zones& getZones() { return _zones; }
        const Zones& getZones() const { return _zones; }

    protected:

        //! Override post-ctor init
        virtual void init();
        virtual void setTerrainResources(TerrainResources* res);

        //! Serialize
        virtual Config getConfig() const;

    public:

        //! Called when this layer is added to the map
        virtual void addedToMap(const Map* map);
        virtual void removedFromMap(const Map* map);

    public:

        virtual void resizeGLObjectBuffers(unsigned maxSize);
        virtual void releaseGLObjects(osg::State* state) const;

    protected:
        virtual ~SplatLayer() { }

        LayerReference<LandCoverDictionary> _landCoverDict;
        LayerReference<LandCoverLayer> _landCoverLayer;

        TextureImageUnitReservation _splatBinding;
        TextureImageUnitReservation _lutBinding;
        TextureImageUnitReservation _noiseBinding;

        Zones _zones;
        bool _zonesConfigured;
        bool _editMode;
        bool _gpuNoise;

        void buildStateSets();

        struct ZoneSelector : public Layer::TraversalCallback
        {
            SplatLayer* _layer;
            ZoneSelector(SplatLayer* layer) : _layer(layer) { }
            void operator()(osg::Node*, osg::NodeVisitor*) const;
        };
        friend struct ZoneSelector;
    };

} } // namespace osgEarth::Splat

#endif // OSGEARTH_SPLAT_SPLAT_LAYER_FACTORY_H
