graphics-overlay.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
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.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
 
#ifndef RACK_SVG_OVERLAY
#define RACK_SVG_OVERLAY
 
//
#include <vector>
 
#include <drain/prog/Command.h>
#include <drain/util/Base64.h>
 
#include "hi5/Hi5.h"
#include "resources.h" // ctx
#include "graphics-radar.h" // ctx
 
 
 
 
namespace rack {
 
 
 
class CmdPolarBase : public Graphic, public drain::BasicCommand {
 
protected:
 
    drain::SteppedRange<double> radiusMetres = {0.0, 0.0, 0.0};// (50000.0, 0.0, 250000.0);
    drain::SteppedRange<double> azimuthDegrees = {0.0, 0.0, 0.0}; // (30, 0, 360);
    bool MASK = false;
 
public:
 
    /*
    enum GRAPHIC {
        GRID, // overlapping with element class?
        DOT,
        LABEL, // External
        RAY,
        SECTOR,
        ANNULUS,
        CIRCLE,
    };
    const drain::ClassXML cssClass;
    */
 
 
    inline
    CmdPolarBase(const std::string & name, const std::string & description, Graphic::GRAPHIC cg = GRID) : Graphic(cg),
        drain::BasicCommand(name, description + ". CSS classes: GRID," + (const std::string &)cls)
    {
    };
 
    inline
    CmdPolarBase(const CmdPolarBase & cmd): Graphic(cmd.cls), drain::BasicCommand(cmd) {
    }
 
 
    static
    const std::string DATA_ID; // "data-latest"
 
 
    static
    drain::image::TreeSVG & getOverlayGroup(RackContext & ctx, RadarSVG & radarSVG);
 
    // static
    drain::image::TreeSVG & getOverlay(drain::image::TreeSVG & overlayGroup, const std::string & label="") const;
 
    static
    double ensureMetricRange(double maxRange, double range=1.0);
 
    // todo also min,max range check
 
 
    static
    void resolveDistance(const drain::SteppedRange<double> & ownDist, const drain::SteppedRange<double> & sharedDist, drain::SteppedRange<double> & dist, double maxDistance = 0.0);
 
    static
    void resolveAzimuthRange(const drain::SteppedRange<double> & ownAzm, const drain::SteppedRange<double> & sharedAzm, drain::SteppedRange<double> & azm);
 
 
    static
    void addGeoData(const drain::image::Image & imageData, drain::image::NodeSVG & node);
 
 
 
};
 
 
class CmdRadarDot : public CmdPolarBase { //  drain::BasicCommand,
 
public:
 
    // Default: 10 kms.
    CmdRadarDot() : CmdPolarBase(__FUNCTION__, "Mark the radar position with a circle", DOT) {
        getParameters().link("radius", radiusMetres.range.tuple(10000.0,10000.0), "metres or relative").setFill(true);
        getParameters().link("MASK", MASK, "add mask");
    };
 
    // Copy constructor
    CmdRadarDot(const CmdRadarDot & cmd) : CmdPolarBase(cmd) {
        getParameters().copyStruct(cmd.getParameters(), cmd, *this);
    }
 
 
    virtual
    void exec() const override;
 
};
 
class CmdRadarDotTest : public CmdPolarBase { //  drain::BasicCommand,
 
public:
 
    // Default: 10 kms.
    CmdRadarDotTest() : CmdPolarBase(__FUNCTION__, "Mark the radar position with a circle", DOT) {
        getParameters().link("radius", radiusMetres.range.tuple(10000.0,10000.0), "metres or relative").setFill(true);
        getParameters().link("MASK", MASK, "add mask");
    };
 
    // Copy constructor
    CmdRadarDotTest(const CmdRadarDotTest & cmd) : CmdPolarBase(cmd) {
        getParameters().copyStruct(cmd.getParameters(), cmd, *this);
    }
 
 
    virtual
    void exec() const override;
 
};
 
 
class CmdRadarGrid : public CmdPolarBase { //  drain::BasicCommand,
 
    // future option
    bool AMZ_TEXT = true;
    bool DIST_TEXT = true;
 
public:
 
    inline
    CmdRadarGrid() : CmdPolarBase(__FUNCTION__, "Draw polar sectors and rings", GRID) { // __FUNCTION__, "Adjust font sizes in CSS style section.") {
        getParameters().link("radius", radiusMetres.tuple(0.0, 0.0, 0.0), "step:start:end (metres or relative)").fillArray = false;
        getParameters().link("azimuth", azimuthDegrees.tuple(30.0, 0.0, 360.0), "step:start:end (degrees)").fillArray = false;
        getParameters().link("MASK", MASK, "add a mask");
    };
 
    // Copy constructor
    inline
    CmdRadarGrid(const CmdRadarGrid & cmd) : CmdPolarBase(cmd) {
        getParameters().copyStruct(cmd.getParameters(), cmd, *this);
    }
 
    virtual
    void exec() const override;
 
};
 
class CmdRadarSector : public CmdPolarBase { // public drain::BasicCommand,
 
public:
 
    CmdRadarSector() : CmdPolarBase(__FUNCTION__, "Draw a sector, annulus or a disc.", SECTOR) { // __FUNCTION__, "Adjust font sizes in CSS style section.") {
        getParameters().link("radius", radiusMetres.range.tuple(0.0, 1.0), "start:end (metres or relative)").fillArray = true;
        getParameters().link("azimuth", azimuthDegrees.range.tuple(0.0, 0.0), "start:end (degrees)").fillArray = false;
        getParameters().link("MASK", MASK, "add a mask");
    };
 
    // Copy constructor
    CmdRadarSector(const CmdRadarSector & cmd) : CmdPolarBase(cmd) {
        getParameters().copyStruct(cmd.getParameters(), cmd, *this);
    }
 
    virtual
    void exec() const override;
 
};
 
 
class CmdRadarRay : public CmdPolarBase { // public drain::BasicCommand, public CmdPolarBase {
 
public:
 
    CmdRadarRay() : CmdPolarBase(__FUNCTION__, "Draw a sector, annulus or a disc. Styles: GRID,HIGHLIGHT,CmdPolarSector", RAY) { // __FUNCTION__, "Adjust font sizes in CSS style section.") {
        getParameters().link("radius", radiusMetres.range.tuple(0.0, 1.0), "start:end (metres)").fillArray = true;
        getParameters().link("azimuth", azimuthDegrees.range.min, "(degrees)");
        getParameters().link("MASK", MASK, "add a mask");
    };
 
    // Copy constructor
    CmdRadarRay(const CmdRadarRay & cmd) : CmdPolarBase(cmd) {
        getParameters().copyStruct(cmd.getParameters(), cmd, *this);
    }
 
    virtual
    void exec() const override;
 
};
 
 
class CmdRadarLabel : public CmdPolarBase { //  drain::BasicCommand,
 
protected:
 
    // Mutable, to convert escaped chars. \see StringMapper::convertEscaped(
    // mutable
    std::string label = "${NOD}\n${PLC}";
 
public:
 
    CmdRadarLabel() : CmdPolarBase(__FUNCTION__, "Draw circle describing the radar range.", LABEL) {
        getParameters().separator = 0;
        getParameters().link("label", label, "string, supporting variables like ${where:lon}, ${NOD}, ${PLC}"); //.setSeparator(0);
        //getParameters().link("azimuth", azimuthDegrees.tuple(), "step:start:end (degrees)").fillArray = false;
    };
 
    // Copy constructor
    inline
    CmdRadarLabel(const CmdRadarLabel & cmd) : CmdPolarBase(cmd) {
        getParameters().copyStruct(cmd.getParameters(), cmd, *this);
    }
 
 
    virtual
    void exec() const override;
 
};
 
}
 
#endif