PaletteEntry.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 DRAIN_PALETTE_ENTRY
#define DRAIN_PALETTE_ENTRY
 
#include <iomanip>
 
 
//#include "drain/util/BeanLike.h"
#include "drain/util/VariableMap.h"
 
#include "Legend.h"
 
 
namespace drain
{
 
class FavaBean {
public:
 
    inline
    FavaBean(){};
 
    inline
    FavaBean(const FavaBean & b){};
 
    typedef FlexVariableMap map_t;
 
    inline
    const map_t & getParameters() const { return parameters; };
 
    inline
    map_t & getParameters() { return parameters; };
 
 
    const std::string name;  // todo separate (Beanlet)
 
    const std::string description; // todo separate (Beanlet)
 
    //ReferenceMap parameters;  // todo separate (Beanlet)
    map_t parameters;  // todo separate (Beanlet)?
 
};
 
namespace image
{
 
 
 
 
class PalEntry { //  : public ABC { //: public drain::BeanLike {
 
 
public:
 
 
    typedef double value_t;
 
    //typedef drain::UniTuple<value_t,3> color_t;
    typedef std::vector<value_t> color_vect_t;
    typedef drain::FlexVariableMap map_t;
 
    PalEntry(const color_vect_t & color={}, value_t alpha=1.0, const std::string & label = "");
 
    PalEntry(const std::initializer_list<drain::Variable::init_pair_t > & args);
 
//protected:
 
    //ReferenceMap parameters;  // todo separate (Beanlet)
    map_t parameters;  // todo separate (Beanlet)?
 
    //color_t color;
    drain::FlexibleVariable & color; // "Inverse" linkage to parameters.
    value_t alpha = 1.0;
 
    std::string label;
 
    inline
    PalEntry & operator=(const PalEntry & b);
 
 
    inline
    const map_t & getParameters() const { return parameters; };
 
    inline
    map_t & getParameters() { return parameters; };
 
 
    const std::string name;  // todo separate (Beanlet)
 
    const std::string description; // todo separate (Beanlet)
 
protected:
 
    //ReferenceMap parameters;  // todo separate (Beanlet)
 
    void init();
 
};
 
 
 
 
 
class PaletteEntry { // : public BeanLike { // public FavaBean { //
 
public:
 
    typedef double value_t;
 
    // UUSI
    typedef std::vector<value_t> color_vect_t;
    typedef drain::FlexVariableMap map_t;
 
    typedef FlexibleVariable color_t; // NEW
    // typedef UniTuple<value_t,3> color_t;  // UNITUPLE
    // typedef std::vector<value_t> color_t; // VECT
 
    PaletteEntry();
 
    PaletteEntry(const PaletteEntry & entry);
 
 
    PaletteEntry(const char * code, const char * label, const color_vect_t & color, value_t alpha=255.0, bool hidden=false);
 
 
    PaletteEntry(const char * label, const color_vect_t & color, value_t alpha=255.0, bool hidden=false);
 
 
    PaletteEntry(const color_vect_t & color, value_t alpha=255.0, bool hidden=false);
 
 
    PaletteEntry(const std::initializer_list<Variable::init_pair_t > & args);
 
 
    //PaletteEntry(const std::string & label);
    PaletteEntry(const char * label);
 
    // UUSI
    map_t parameters;
 
    std::string code;
 
    std::string label;
 
    // double value;
    // Experimental
    FlexibleVariable & color;
 
    // color_t color;
 
    value_t alpha;
 
 
 
    bool hidden;
 
    // inline
    PaletteEntry & operator=(const PaletteEntry & b);
 
 
    inline
    const map_t & getParameters() const { return parameters; };
 
    inline
    map_t & getParameters() { return parameters; };
 
    //  std::ostream & toOStream(std::ostream &ostr, char separator='\t', char separator2=0) const;
    std::ostream & toStream(std::ostream &ostr, char separator='\t') const;
 
    void checkAlpha();
 
 
    void getHexColor(std::ostream & ostr) const;
 
    inline
    void getHexColor(std::string & str, const std::string & prefix = "") const {
        std::stringstream sstr;
        sstr << prefix;
        getHexColor(sstr);
        str = sstr.str();
    }
 
    //template <class T>
    /*
    PaletteEntry & operator=(const drain::VariableMap & m){
        setParameters(m);
        return *this;
    };
    */
 
protected:
 
    void init();
 
};
 
 
 
inline
std::ostream & operator<<(std::ostream &ostr, const PaletteEntry & entry){
    return entry.toStream(ostr);
}
 
 
} // image::
 
template <>
std::ostream & drain::Sprinter::toStream(std::ostream & ostr, const drain::image::PaletteEntry & entry, const drain::SprinterLayout & layout);
 
 
} // drain::
 
/*
template <>
inline
std::ostream & drain::Sprinter::toStream(std::ostream & ostr, const drain::image::PaletteEntry::color_t & color, const drain::SprinterLayout & layout){
 
    ostr << layout.arrayChars.prefix; // << "xx";
    ostr << std::fixed << std::setprecision(1); // ensure ".0"
    drain::Sprinter::toStream(ostr, color[0], layout);
    ostr << layout.arrayChars.separator;
    drain::Sprinter::toStream(ostr, color[1], layout);
    ostr << layout.arrayChars.separator;
    drain::Sprinter::toStream(ostr, color[2], layout);
    ostr << layout.arrayChars.suffix;
    return ostr;
}
*/
 
 
#endif