TYPalette.h

Go to the documentation of this file.

/*
 * Copyright (C) <2012> <EDF-R&D> <FRANCE>
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
/*
 *
 *
 *
 *
 */
 
#ifndef __TY_PALETTE__
#define __TY_PALETTE__
 
#include <map>
 
#include "Tympan/core/color.h"
#include "Tympan/models/business/TYElement.h"
 
class TYPalette : public TYElement
{
    OPROTODECL(TYPalette)
    TY_EXTENSION_DECL_ONLY(TYPalette)
    TY_EXT_GRAPHIC_DECL_ONLY(TYPalette)
 
    // Methodes
public:
    typedef float values_type;
 
    typedef std::map<values_type, OColor> color_map_type;
    typedef color_map_type::iterator color_map_iter;
    typedef color_map_type::const_iterator color_map_const_iter;
    typedef color_map_type::value_type color_map_item;
    TYPalette();
 
    TYPalette(const TYPalette& other);
 
    virtual ~TYPalette();
 
    TYPalette& operator=(const TYPalette& other);
 
    bool operator==(const TYPalette& other) const;
 
    bool operator!=(const TYPalette& other) const;
 
    virtual bool deepCopy(const TYElement* pOther, bool copyId = true, bool pUseCopyTag = false);
 
    virtual std::string toString() const;
 
    virtual DOM_Element toXML(DOM_Element& domElement) /* const */;
 
    virtual int fromXML(DOM_Element domElement);
 
    void clear();
 
    static const values_type infinity;
 
    values_type getValueMin() const
    {
        assert(getNbColors() >= 2);
        return _colorMap.begin()->first;
    }
 
    values_type getValueMax() const
    {
        assert(getNbColors() >= 2);
        return (++_colorMap.rbegin())->first;
    }
 
    size_t getNbColors() const
    {
        return _colorMap.size();
    }
 
    size_t getNbValues() const
    {
        return _colorMap.size() - 1;
    }
 
    const OColor& getInfColor() const
    {
        assert(getNbColors() >= 2);
        return _colorMap.begin()->second;
    }
 
    void setInfColor(const OColor& color)
    {
        assert(getNbColors() >= 2);
        _colorMap.begin()->second = color;
    }
 
    const OColor& getSupColor() const
    {
        assert(_colorMap.size() >= 2);
        return _colorMap.rbegin()->second;
    }
 
    void setSupColor(const OColor& color)
    {
        assert(_colorMap.size() >= 2);
        return _colorMap.rbegin()->second = color;
    }
 
    bool insertColor(values_type value, const OColor& color);
 
    bool moveValue(values_type old_value, values_type new_value);
 
    bool removeValue(values_type value);
 
    void resetcolorMapFromColors(values_type valueMin, values_type valueMax,
                                 const std::vector<OColor>& lookupTable);
 
    void resetToDefault();
 
    bool resetFromPreferences();
 
    void saveToPreferences();
 
    // OLookupTable& getLookupTable() { return _colorMap; } // XXX update callers
    const color_map_type& getColorMap() const
    {
        return _colorMap;
    } // Should be replace be an smart range
 
    // void setColors(const OLookupTable& lookupTable) { _colorMap = lookupTable; } // XXX update callers
 
    // void setColorFromPercent(values_type percent, const OColor& color); //XXX merge into setColorFromValue
 
    const OColor& getColorFromValue(values_type value) const;
 
    const OColor& getColorFromIndex(unsigned i) const;
 
    TYPalette::values_type getValueFromIndex(unsigned i) const;
 
    // void setColorFromValue(values_type value, const OColor& color); // Unused : to be deleted ?
 
    values_type denormalize(values_type percent) const
    {
        return getValueMin() + (getValueMax() - getValueMin()) * percent;
    }
 
    values_type normalize(values_type value) const;
 
    static LPTYPalette loadPaletteFromFile(const QString& qFileName);
 
    bool savePaletteToFile(const QString& qFileName);
 
    void makeLinearPalette(unsigned int nb_colors, float value_min, float value_max);
 
protected:
    color_map_type _colorMap;
 
    int load_legacy_XML(const DOM_Element& domElement);
 
    DOM_Element save_legacy_XML(DOM_Element& domElement);
};
 
#endif // __TY_PALETTE__