Color.h

Go to the documentation of this file.

#pragma once
#include <Base/String.h>
#include <list>
#include <map>
#include <memory>
 
 
class CA_ColorP;
 
namespace Base
{
class Color;
 
class LX_BASE_EXPORT MColor
{
public:
    MColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
    MColor();
    explicit MColor(const Base::Color& c);
 
    unsigned char red() const;
    unsigned char green() const;
    unsigned char blue() const;
    unsigned char alpha() const;
 
    unsigned char r;
    unsigned char g;
    unsigned char b;
    unsigned char a;
 
    bool operator==(const MColor& c) const;
    bool operator!=(const MColor& c) const;
 
    size_t hash() const;
};
 
 
class LX_BASE_EXPORT Color
{
public:
    //                                                       //
    // --------------------- BEGIN API --------------------- //
    //                                                       //
    // ATTENTION: DO NOT CHANGE ANY SIGNATURES IN THE API !  //
    //                                                       //
 
    enum Spec
    {
        Invalid,
        Rgb,
        Hsv,
        Cmyk
    };
 
    Color();
    Color(const Base::MColor& c);
    Color(int r, int g, int b, int a = 255);
    Color(const std::string& name);
    Color(const char* name);
    Color(const Color& rhs);
    Color(Spec spec);
 
    bool isValid() const;
 
    std::string name() const;
    void setNamedColor(const std::string& name);
 
    static std::list<std::string> colorNames();
 
    Spec spec() const;
 
    int alpha() const;
    void setAlpha(int alpha);
 
    double alphaF() const;
    void setAlphaF(double alpha);
 
    int red() const;
    int green() const;
    int blue() const;
    void setRed(int red);
    void setGreen(int green);
    void setBlue(int blue);
 
    double redF() const;
    double greenF() const;
    double blueF() const;
    void setRedF(double red);
    void setGreenF(double green);
    void setBlueF(double blue);
 
    void getRgb(int* r, int* g, int* b, int* a = nullptr) const;
    void setRgb(int r, int g, int b, int a = 255);
 
    void getRgbF(double* r, double* g, double* b, double* a = nullptr) const;
    void setRgbF(double r, double g, double b, double a = 1.0);
 
    int hue() const;  // 0 <= hue < 360
    int saturation() const;
    int value() const;
 
    double hueF() const;  // 0.0 <= hueF < 360.0
    double saturationF() const;
    double valueF() const;
 
    void getHsv(int* h, int* s, int* v, int* a = nullptr) const;
    void setHsv(int h, int s, int v, int a = 255);
 
    void getHsvF(double* h, double* s, double* v, double* a = nullptr) const;
    void setHsvF(double h, double s, double v, double a = 1.0);
 
    int cyan() const;
    int magenta() const;
    int yellow() const;
    int black() const;
 
    double cyanF() const;
    double magentaF() const;
    double yellowF() const;
    double blackF() const;
 
    void getCmyk(int* c, int* m, int* y, int* k, int* a = nullptr);
    void setCmyk(int c, int m, int y, int k, int a = 255);
 
    void getCmykF(double* c, double* m, double* y, double* k, double* a = nullptr);
    void setCmykF(double c, double m, double y, double k, double a = 1.0);
 
    Color toRgb() const;
    Color toHsv() const;
    Color toCmyk() const;
 
    Color convertTo(Spec colorSpec) const;
 
    static Color fromRgb(int r, int g, int b, int a = 255);
    static Color fromRgbF(double r, double g, double b, double a = 1.0);
 
    static Color fromHsv(int h, int s, int v, int a = 255);
    static Color fromHsvF(double h, double s, double v, double a = 1.0);
 
    static Color fromCmyk(int c, int m, int y, int k, int a = 255);
    static Color fromCmykF(double c, double m, double y, double k, double a = 1.0);
 
    Color light(int f = 150) const;
    Color lighter(int f = 150) const;
    Color dark(int f = 200) const;
    Color darker(int f = 200) const;
 
    Color& operator=(const Color&);
 
    bool operator==(const Color& c) const;
    bool operator!=(const Color& c) const;
    bool operator<(const Color& c) const;
 
    static const std::map<std::pair<unsigned int, unsigned int>, Base::Color>& getCdwkPalette();
    static std::pair<unsigned int, unsigned int> toCdwkColor(const Color& color, bool* isPrecise = nullptr);
    static Color fromCdwkColor(const unsigned int integerPart, const unsigned int decimalPart = 0);
    static unsigned int maximumCdwkColorIntegerNumber();
    static unsigned int maximumDecimalPartNumber();
    static Base::String getToolTip(const Base::Color& color);
 
    static void loadLccColors(const Base::String& filename, bool user = false);
    static void setLccColors(const std::map<int, Base::Color>& colors, const std::map<Base::Color, Base::String>& tooltips);
 
    bool isLcc() const;
    bool isMainLcc() const;
 
    friend std::size_t hash_value(const Color& b) { return b.hash(); }
 
    size_t hash() const;
 
    //                                                       //
    // ---------------------- END API ---------------------- //
    //                                                       //
 
    Color(unsigned int rgb);
    ~Color();
 
    unsigned int rgb() const;
    unsigned int rgba() const;
 
    friend LX_BASE_EXPORT std::ostream& operator<<(std::ostream& o, const Base::Color& color);
 
private:
    std::unique_ptr<CA_ColorP> _pimpl;
};
LX_BASE_EXPORT std::ostream& operator<<(std::ostream& o, const Base::Color& color);
};  // namespace Base