imstkColor.h

/*
** This file is part of the Interactive Medical Simulation Toolkit (iMSTK)
** iMSTK is distributed under the Apache License, Version 2.0.
** See accompanying NOTICE for details.
*/

#pragma once

#include "imstkMath.h"

#include <iostream>

#ifdef WIN32
#pragma warning(disable : 4201)
#endif
namespace imstk
{
struct Color
{
    union
    {
        double rgba[4];
        struct
        {
            double r;
            double g;
            double b;
            double a;
        };
    };

    Color();
    Color(const double red,
          const double green,
          const double blue,
          const double alpha = 1.0);
    Color(const double* rgba_color);
    Color(const Color& color, const double alpha);

    Color& operator=(const Color& p_color);

    operator Eigen::Matrix<unsigned char, 3, 1>()
    {
        return Eigen::Matrix<unsigned char, 3, 1>(
            static_cast<unsigned char>(r * 255.0),
            static_cast<unsigned char>(g * 255.0),
            static_cast<unsigned char>(b * 255.0));
    }
    operator Eigen::Matrix<unsigned char, 4, 1>()
    {
        return Eigen::Matrix<unsigned char, 4, 1>(
            static_cast<unsigned char>(r * 255.0),
            static_cast<unsigned char>(g * 255.0),
            static_cast<unsigned char>(b * 255.0),
            static_cast<unsigned char>(a * 255.0));
    }

    friend std ::ostream& operator<<(std::ostream& os, const Color& c);

    double operator()(const int p_i) const;

    void setValue(const double p_red,
                  const double p_green,
                  const double p_blue,
                  const double p_alpha = 1.0);

    void getValue(double color[4]);

    const double* getValue() const;

    std::string rgbHex();

    static Color darken(const Color color, const double factor);
    static Color lighten(const Color color, const double factor);

    static Color clamp(const Color color, const Color min, const Color max);

    static Color lerpRgba(const Color& start, const Color& end, const double t);
    static Color lerpRgb(const Color& start, const Color& end, const double t);

    static Color White;
    static Color Black;
    static Color DarkGray;
    static Color LightGray;
    static Color Blue;
    static Color Green;
    static Color Red;
    static Color Pink;
    static Color Orange;
    static Color Yellow;
    static Color Teal;
    static Color Marigold;
    static Color Bone;
    static Color YellowBone;
    static Color Blood;
    static Color LightSkin;
    static Color DarkSkin;
};
#ifdef WIN32
#pragma warning(default : 4201)
#endif

Color operator*(const Color& color_lhs, const Color& color_rhs);
Color operator*(const Color& color_lhs, const double intensity_rhs);
Color operator*=(const Color& color_lhs, const Color& color_rhs);
Color operator*=(const Color& color_lhs, const double intensity_rhs);

Color operator+(const Color& color_lhs, const Color& color_rhs);
Color operator+(const Color& intensity_lhs, const double intensity_rhs);
Color operator+=(const Color& color_lhs, const Color& color_rhs);
Color operator+=(const Color& intensity_lhs, const double intensity_rhs);

Color operator-(const Color& color_lhs, const Color& color_rhs);
Color operator-(const Color& color_rhs, const double intensity_lhs);
Color operator-=(const Color& color_lhs, const Color& color_rhs);
Color operator-=(const Color& color_rhs, const double intensity_lhs);

bool operator==(const Color& color_lhs, const Color& color_rhs);
bool operator!=(const Color& color_lhs, const Color& color_rhs);
} // namespace imstk