Color.h

Go to the documentation of this file.

#pragma once

#pragma warning(push)
#pragma warning(disable : 4251)

#include <Base/base_defines.h>

#include <list>
#include <map>
#include <memory>
#include <string>
#include <vector>

class CA_ColorP;

// Smart pointer to private implementation of Color
typedef std::unique_ptr<CA_ColorP> pCA_ColorP;

namespace Base
{
class Color;

class 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 BASE_EXPORT Color
{
public:
    //                                                       //
    // --------------------- BEGIN API --------------------- //
    //                                                       //
    // ATTENTION: DO NOT CHANGE ANY SIGNATURES IN THE API !  //
    //                                                       //

    enum Spec
    {
        Invalid,
        Rgb,
        Hsv,
        Cmyk
    };
    enum Origin
    {
        Unknown,
        Cadwork,
        Greyscale
    };

    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);
    ~Color();

    bool isValid() const;

    std::string name() const;
    void setNamedColor(const std::string& name);

    static std::list<std::string> colorNames();

    Spec spec() const;

    void setOrigin(Origin o);
    Origin origin() 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 = 0) const;
    void setRgb(int r, int g, int b, int a = 255);

    void getRgbF(double* r, double* g, double* b, double* a = 0) 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 = 0) const;
    void setHsv(int h, int s, int v, int a = 255);

    void getHsvF(double* h, double* s, double* v, double* a = 0) 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 = 0);
    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 = 0);
    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 isEqualIgnoreOrigin(const Color& c) const;
    bool operator==(const Color& c) const;
    bool operator!=(const Color& c) const;
    bool operator<(const Color& c) const;

    static int toCdwkColor(const Color& color, bool* isPrecise = NULL);
    static Color fromCdwkColor(const int index);
    static int maximumCdwkColorNumber();

    static int toGreyscaleColor(const Color& color, bool* isPrecise = NULL);
    static Color fromGreyscaleColor(const int index);

    friend std::size_t hash_value(const Color& b) { return b.hash(); }

    size_t hash() const;

    //                                                       //
    // ---------------------- END API ---------------------- //
    //                                                       //

    Color toCdwkOrigin() const;  // return color with Cadwork origin, if color exists in cadwork palette, otherwise return original color
    unsigned int rgb() const;
    unsigned int rgba() const;

    friend BASE_EXPORT std::ostream& operator<<(std::ostream& o, const Base::Color& color);

private:
    pCA_ColorP _pimpl;
};

};  // namespace Base


#pragma warning(pop)