Color.h

Go to the documentation of this file.

/* Copyright 2013-2019 Homegear GmbH
 *
 * libhomegear-base 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 3 of the
 * License, or (at your option) any later version.
 * 
 * libhomegear-base 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 libhomegear-base.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU Lesser General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
*/

#ifndef COLOR_H_
#define COLOR_H_

#include "Math.h"

#include <cmath>
#include <string>

namespace BaseLib
{

class Color
{
public:
    class NormalizedRGB;
    class HSV;

    class RGB
    {
    public:
        RGB() {}

        RGB(const std::string& rgbString);

        RGB(NormalizedRGB& rgb) { setRed(rgb.getRed()); setGreen(rgb.getGreen()); setBlue(rgb.getBlue()); }
        RGB(uint8_t red, uint8_t green, uint8_t blue) { setRed(red); setGreen(green); setBlue(blue); }
        virtual ~RGB() {}

        bool opacityDefined() { return _opacityDefined; };
        uint8_t getOpacity() const { return _opacity; }

        void setOpacity(double value) { _opacityDefined = true; _opacity = value * 255; }
        void setOpacity(uint8_t value) { _opacityDefined = true; _opacity = value; }

        uint8_t getRed() const { return _red; }

        void setRed(double value) { _red = value * 255; }
        void setRed(uint8_t value) { _red = value; }
        uint8_t getGreen() const { return _green; }

        void setGreen(double value) { _green = value * 255; }
        void setGreen(uint8_t value) { _green = value; }
        uint8_t getBlue() const { return _blue; }

        void setBlue(double value) { _blue = value * 255; }
        void setBlue(uint8_t value) { _blue = value; }

        std::string toString();
    protected:
        bool _opacityDefined = false;
        uint8_t _opacity = 255;
        uint8_t _red = 0;
        uint8_t _green = 0;
        uint8_t _blue = 0;
    };

    class NormalizedRGB
    {
    public:
        NormalizedRGB() {}

        NormalizedRGB(uint8_t red, uint8_t green, uint8_t blue) { setRed(red); setGreen(green); setBlue(blue); }

        NormalizedRGB(RGB& rgb) { setRed(rgb.getRed()); setGreen(rgb.getGreen()); setBlue(rgb.getBlue()); }
        NormalizedRGB(double red, double green, double blue) { setRed(red); setGreen(green); setBlue(blue); }
        virtual ~NormalizedRGB() {}

        double getRed() const { return _red; }

        void setRed(uint8_t value) { _red = ((double)value) / 255.0; }
        void setRed(double value) { _red = value; if(_red < 0) { _red = 0; } else if(_red > 1) { _red = 1; } }
        double getGreen() const { return _green; }

        void setGreen(uint8_t value) { _green = ((double)value) / 255.0; }
        void setGreen(double value) { _green = value; if(_green < 0) { _green = 0; } else if(_green > 1) { _green = 1; } }
        double getBlue() const { return _blue; }

        void setBlue(uint8_t value) { _blue = ((double)value) / 255.0; }
        void setBlue(double value) { _blue = value; if(_blue < 0) { _blue = 0; } else if(_blue > 1) { _blue = 1; } }

        HSV toHSV();
    protected:
        double _red = 0;
        double _green = 0;
        double _blue = 0;
    };

    class HSV
    {
    public:
        HSV() {}
        HSV(double hue, double saturation, double brightness) { setHue(hue); setSaturation(saturation); setBrightness(brightness); }
        virtual ~HSV() {}

        double getHue() const { return _hue; }
        void setHue(double value) { _hue = value; if(_hue < 0) { _hue = 0; } else { _hue = std::fmod(_hue, 360.0); } }
        double getSaturation() const { return _saturation; }
        void setSaturation(double value) { _saturation = value; if(_saturation < 0) { _saturation = 0; } else if(_saturation > 1) { _saturation = 1; } }
        double getBrightness() const { return _brightness; }
        void setBrightness(double value) { _brightness = value; if(_brightness < 0) { _brightness = 0; } else if(_brightness > 1) { _brightness = 1; } }

        RGB toRGB();
    protected:
        double _hue = 0;
        double _saturation = 0;
        double _brightness = 0;
    };

    virtual ~Color();

    static void getConversionMatrix(const Math::Triangle& gamut, Math::Matrix3x3& conversionMatrix, Math::Matrix3x3& inversedConversionMatrix);

    static void rgbToCie1931Xy(const NormalizedRGB& rgb, const Math::Matrix3x3& conversionMatrix, const double& gamma, Math::Point2D& xy, double& brightness);

    static void cie1931XyToRgb(const Math::Point2D& xy, const double& brightness, const Math::Matrix3x3& conversionMatrix, const double& gamma, NormalizedRGB& rgb);
protected:
    Color();
};

}

#endif