/* -*-c++-*- */
/* osgEarth - Geospatial SDK for OpenSceneGraph
 * Copyright 2019 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_MASK_SOURCE_H
#define OSGEARTH_MASK_SOURCE_H 1

#include <osgEarth/Common>
#include <osgEarth/Config>
#include <osgEarth/Revisioning>
#include <osgEarth/SpatialReference>
#include <osgEarth/Status>
#include <osg/Referenced>

namespace osgEarth
{   
    class ProgressCallback;
    
    /**
     * Configuration options for a masking source.
     */
    class OSGEARTH_EXPORT MaskSourceOptions : public DriverConfigOptions
    {
    public:
        MaskSourceOptions( const ConfigOptions& options =ConfigOptions() ) :
              DriverConfigOptions( options ) { fromConfig(_conf); }

        /** dtor */
        virtual ~MaskSourceOptions();

    public: // properties

    public:
        virtual Config getConfig() const;

    protected:
        virtual void mergeConfig( const Config& conf );
        
    private:
        void fromConfig( const Config& conf );
    };


    /**
     * MaskSource is a plugin object that generates a masking goemetry
     *
     * TODO: there is only one kind of mask source (FeatureMaskSource) so
     * consider removing this and just having a single MaskLayer type. -gw
     */
    class OSGEARTH_EXPORT MaskSource : public osg::Object, public Revisioned
    {
    public:        
        MaskSource( const MaskSourceOptions& options =MaskSourceOptions() );

        /** dtor */
        virtual ~MaskSource();

        /**
         * Attempt to open the mask source, and return an initial status.
         */
        const Status& open(const osgDB::Options* readOptions);

        /**
         * Status of this source. *
         */
        const Status& getStatus() const { return _status; }

        /**
         * Subclass implements this method to create the boundary geometry.
         */
        virtual osg::Vec3dArray* createBoundary(
            const SpatialReference* srs, 
            ProgressCallback*       progress) =0;

        /**
         * The initialization options 
         */
        const MaskSourceOptions& getOptions() const { return _options; }


    protected:

        /**
         * One time initialization of the source. Called by open(), and
         * returns the initial Status.
         */
        virtual Status initialize(const osgDB::Options* dbOptions) =0;

        /**
         * Subclass can call this to set a status in case something fails
         */
        void setStatus(const Status& value) { _status = value; }

    public: 

        // META_Object specialization:
        virtual osg::Object* cloneType() const { return 0; } // cloneType() not appropriate
        virtual osg::Object* clone(const osg::CopyOp&) const { return 0; } // clone() not appropriate
        virtual bool isSameKindAs(const osg::Object* obj) const { return dynamic_cast<const MaskSource*>(obj)!=NULL; }
        virtual const char* className() const { return "MaskSource"; }
        virtual const char* libraryName() const { return "osgEarth"; }

    private:
        const MaskSourceOptions _options;
        Status _status;

        friend class Map;
        friend class MaskSourceFactory;
    };

    //--------------------------------------------------------------------

    class OSGEARTH_EXPORT MaskSourceDriver : public osgDB::ReaderWriter
    {
    protected:        
        const MaskSourceOptions& getMaskSourceOptions(const osgDB::Options* readOptions) const;
        virtual ~MaskSourceDriver();
    };

    //--------------------------------------------------------------------

    class OSGEARTH_EXPORT MaskSourceFactory
    {   
	public:
        static MaskSource* create(const MaskSourceOptions& options);
        virtual ~MaskSourceFactory();
    };
}

#endif // OSGEARTH_MASK_SOURCE_H
