/* -*-c++-*- */
/* osgEarth - Geospatial SDK for OpenSceneGraph
* Copyright 2018 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_UTIL_EXAMPLE_RESOURCES_H
#define OSGEARTH_UTIL_EXAMPLE_RESOURCES_H 1

#include <osgEarthUtil/Common>
#include <osgEarthUtil/Controls>
#include <osgEarthUtil/EarthManipulator>
#include <osgEarthUtil/Sky>
#include <osgEarthUtil/SimpleOceanLayer>
#include <osgEarth/Viewpoint>

//#include <osg/ArgumentParser>

namespace osgEarth {
    class MapNode;
}
namespace osg {
    class ArgumentParser;
}
namespace osgViewer {
    class View;
    class ViewerBase;
};

/**
 * This is a collection of resources used by the osgEarth example applications.
 */
namespace osgEarth { namespace Util
{
    using namespace osgEarth;
    using namespace osgEarth::Util::Controls;

    /**
     * Parses a set of built-in example arguments. Any Controls created by parsing
     * command-line parameters will appear in the lower-left corner of the display.
     */
    class OSGEARTHUTIL_EXPORT MapNodeHelper
    {
    public:
        /**
         * Loads a map file and processes all the built-in example command line
         * arguemnts and XML externals.
         */
        osg::Group* load(
            osg::ArgumentParser&   args,
            osgViewer::ViewerBase* viewer,
            Container*             userContainer = 0L) const
        {
            return load(args, viewer, userContainer, 0L);
        }

        osg::Group* load(
            osg::ArgumentParser&   args,
            osgViewer::ViewerBase* viewer,
            Container*             userContainer,
            const osgDB::Options*  readOptions) const;

        /**
         * Takes an existing map node and processes all the built-in example command
         * line arguments and mapNode externals.
         */
        void parse(
            MapNode*             mapNode,
            osg::ArgumentParser& args,
            osgViewer::View*     view,
            osg::Group*          parentGroup,
            Container*           userContainer) const;

        void parse(
            MapNode*             mapNode,
            osg::ArgumentParser& args,
            osgViewer::View*     view,
            osg::Group*          parentGroup,
            LabelControl*        userLabel) const;

        /**
         * Configures a view with a stock set of event handlers that are useful
         * for demos, and performs some other common view configuration for osgEarth.
         */
        void configureView( osgViewer::View* view ) const;

        /**
         * Returns a usage string
         */
        std::string usage() const;
    };


    /**
     * Creates a UI Control with a list of clickable viewpoints.
     */
    class OSGEARTHUTIL_EXPORT ViewpointControlFactory
    {
    public:
        Control* create(
            const std::vector<Viewpoint>& list,
            osgViewer::View*              view) const;
    };


    /**
     * Creates UI controls that show the map coordinates under the mouse
     */
    class OSGEARTHUTIL_EXPORT MouseCoordsControlFactory
    {
    public:
        Control* create(
            MapNode*         mapNode,
            osgViewer::View* view ) const;
    };


    /**
     * Creates a UI Control reflecting all the named Annotations found in a
     * scene graph.
     */
    class OSGEARTHUTIL_EXPORT AnnotationGraphControlFactory
    {
    public:
        Control* create(
            osg::Node*       node,
            osgViewer::View* view) const;
    };


    /**
     * Creates a set of controls for manipulating the Sky model.
     */
    class OSGEARTHUTIL_EXPORT SkyControlFactory
    {
    public:
        static Control* create(SkyNode* sky);
    };


    /**
     * Creates a set of controls for manipulating the Ocean surface model.
     */
    class OSGEARTHUTIL_EXPORT OceanControlFactory
    {
    public:
        static Control* create(SimpleOceanLayer* ocean);
    };


    /**
    * Creates UI controls displaying the map attribution
    */
    class OSGEARTHUTIL_EXPORT AttributionControlFactory
    {
    public:
        Control* create(MapNode* mapNode) const;
    };

} } // namespace osgEarth::Util


#define OE_UI_HANDLER(X) \
    struct X : public osgEarth::Util::Controls::ControlEventHandler { \
        App& _app; X(App& app):_app(app) { } \
        void onValueChanged(osgEarth::Util::Controls::Control*) { _app. X (); } \
        void onClick(osgEarth::Util::Controls::Control*) { _app. X (); } }

#endif // OSGEARTH_UTIL_EXAMPLE_RESOURCES_H
