Color4.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_MATH_COLOR4_HPP
#define NOMLIB_MATH_COLOR4_HPP
 
#include <algorithm>
#include <vector>
 
#include "nomlib/config.hpp"
 
// FIXME: The following declaration is necessary in order to avoid a very
// nasty compiling conflict that can happen under Windows anytime the
// windef.h header file is included (commonly from windows.h), due to min and
// max macros being declared there. This is why macros are evil.
//
// http://support.microsoft.com/kb/143208
// http://stackoverflow.com/questions/5004858/stdmin-gives-error
#if defined( NOM_PLATFORM_WINDOWS )
  #undef min
  #undef max
#endif
 
namespace nom {

const std::string COLOR_DELIMITER = ", ";

template <typename T>
struct Color4
{
    Color4 ( void ) :
      r ( -1 ),
      g ( -1 ),
      b ( -1 ),
      a ( Color4<T>::ALPHA_OPAQUE )
    {
      //NOM_LOG_TRACE(NOM);
    }

    ~Color4 ( void )
    {
      //NOM_LOG_TRACE(NOM);
    }

    template <typename U>
    Color4( const Color4<U>& rhs ) :
      r{ static_cast<T> ( rhs.r ) },
      g{ static_cast<T> ( rhs.g ) },
      b{ static_cast<T> ( rhs.b ) },
      a{ static_cast<T> ( rhs.a ) }
    {
      //NOM_LOG_TRACE(NOM);
    }

    explicit Color4( const Color4<float>& rhs ) :
      r{ static_cast<float> ( rhs.r ) },
      g{ static_cast<float> ( rhs.g ) },
      b{ static_cast<float> ( rhs.b ) },
      a{ static_cast<float> ( rhs.a ) }
    {
      //NOM_LOG_TRACE(NOM);
    }

    Color4 ( T r, T g, T b )  :
      r ( r ),
      g ( g ),
      b ( b ),
      a ( Color4<T>::ALPHA_OPAQUE )
    {
      //NOM_LOG_TRACE(NOM);
    }

    Color4 ( T red, T green, T blue, T alpha )  :
      r ( red ),
      g ( green ),
      b ( blue ),
      a ( alpha )
    {
      //NOM_LOG_TRACE(NOM);
    }

    static const T ALPHA_TRANSPARENT;

    static const T ALPHA_OPAQUE;

    static const Color4 null;

    static const Color4 Transparent;
    static const Color4 Black;
    static const Color4 White;
    static const Color4 Red;
    static const Color4 Green;
    static const Color4 Blue;
    static const Color4 Yellow;
    static const Color4 Magenta;
    static const Color4 Cyan;

    static const Color4 Silver;
    static const Color4 Purple;
    static const Color4 Orange;
    static const Color4 LightGray;
    static const Color4 Gray;
    static const Color4 SkyBlue;
 
    // static const Color4 ButtonGradient;

    T r;

    T g;

    T b;

    T a;
};

template <typename T>
inline Color4<T> difference_color_blend( const Color4<T>& lhs, const Color4<T>& rhs )
{
  Color4<T> c;
  c.r = abs( lhs.r - rhs.r );
  c.g = abs( lhs.g - rhs.g );
  c.b = abs( lhs.b - rhs.b );
 
  return c;
}

template <typename T>
inline std::ostream& operator << ( std::ostream& os, const Color4<T>& color )
{
  os
  << static_cast<sint> ( color.r )
  << COLOR_DELIMITER
  << static_cast<sint> ( color.g )
  << COLOR_DELIMITER
  << static_cast<sint> ( color.b )
  << COLOR_DELIMITER
  << static_cast<sint> ( color.a );
 
  return os;
}

inline std::ostream& operator <<( std::ostream& os, const Color4<float>& color )
{
  os
  << static_cast<float> ( color.r )
  << COLOR_DELIMITER
  << static_cast<float> ( color.g )
  << COLOR_DELIMITER
  << static_cast<float> ( color.b )
  << COLOR_DELIMITER
  << static_cast<float> ( color.a );
 
  return os;
}

template <typename T>
inline bool operator == ( const Color4<T>& left, const Color4<T>& right )
{
  return ( left.r == right.r ) &&
         ( left.g == right.g ) &&
         ( left.b == right.b ) &&
         ( left.a == right.a );
}

template <typename T>
inline bool operator != ( const Color4<T>& left, const Color4<T>& right )
{
  return ! ( left == right );
}

template <typename T>
inline Color4<T> operator + ( const Color4<T>& left, const Color4<T>& right )
{
  return Color4<T> (  static_cast<T> ( std::min ( left.r + right.r, 255 ) ),
                    static_cast<T> ( std::min ( left.g + right.g, 255 ) ),
                    static_cast<T> ( std::min ( left.b + right.b, 255 ) ),
                    static_cast<T> ( std::min ( left.a + right.a, 255 ) )
                  );
}

inline Color4<float> operator +( const Color4<float>& lhs, const Color4<float>& rhs )
{
  return Color4<float>  (
                          std::min( ( lhs.r + rhs.r / 255 ), 1.0f ),
                          std::min( ( lhs.g + rhs.g / 255 ), 1.0f ),
                          std::min( ( lhs.b + rhs.b / 255 ), 1.0f ),
                          std::min( ( lhs.a + rhs.a / 255 ), 1.0f )
                        );
}

template <typename T>
inline Color4<T> operator ++ ( Color4<T>& left )
{
  return Color4<T> (  static_cast<T> ( left.r-- ),
                    static_cast<T> ( left.g-- ),
                    static_cast<T> ( left.b-- ),
                    static_cast<T> ( left.a-- )
                );
}
 
template <typename T>
inline Color4<T> operator - ( const Color4<T>& left, const Color4<T>& right )
{
  return Color4<T>  (
                      static_cast<T> ( std::min( left.r - right.r, 255 ) ),
                      static_cast<T> ( std::min( left.g - right.g, 255 ) ),
                      static_cast<T> ( std::min( left.b - right.b, 255 ) ),
                      static_cast<T> ( std::min( left.a - right.a, 255 ) )
                    );
}

inline Color4<float> operator -( const Color4<float>& lhs, const Color4<float>& rhs )
{
  return Color4<float>  (
                          std::min( ( lhs.r - rhs.r ) / 255, 1.0f ),
                          std::min( ( lhs.g - rhs.g ) / 255, 1.0f ),
                          std::min( ( lhs.b - rhs.b ) / 255, 1.0f ),
                          std::min( ( lhs.a - rhs.a ) / 255, 1.0f )
                        );
}

template <typename T>
inline Color4<T> operator -- ( Color4<T>& left )
{
  return Color4<T> ( static_cast<T> ( left.r-- ),
                    static_cast<T> ( left.g-- ),
                    static_cast<T> ( left.b-- ),
                    static_cast<T> ( left.a-- )
                  );
}

template <typename T>
inline Color4<T> operator * ( const Color4<T>& left, const Color4<T>& right )
{
  return Color4<T>  (
                      static_cast<T> ( left.r * right.r / 255 ),
                      static_cast<T> ( left.g * right.g / 255 ),
                      static_cast<T> ( left.b * right.b / 255 ),
                      static_cast<T> ( left.a * right.a / 255 )
                    );
}
 
template <typename T>
inline Color4<T>& operator += ( Color4<T>& left, const Color4<T>& right )
{
  return left = left + right;
}
 
template <typename T>
inline Color4<T>& operator -= ( Color4<T>& left, const Color4<T>& right )
{
  return left = left - right;
}
 
template <typename T>
inline Color4<T>& operator *= ( Color4<T>& left, const Color4<T>& right )
{
  return left = left * right;
}

template <typename T>
inline bool operator <(const Color4<T> lhs, const Color4<T>& rhs)
{
  return  (lhs.r < rhs.r) && (lhs.r < rhs.r)  &&
          (lhs.g < rhs.g) && (lhs.g < rhs.g)  &&
          (lhs.b < rhs.b) && (lhs.b < rhs.b)  &&
          (lhs.a < rhs.a) && (lhs.a < rhs.a);
}

template <typename T>
inline bool operator >(const Color4<T>& lhs, const Color4<T>& rhs)
{
  return  (rhs.r < lhs.r) && (rhs.r < lhs.r)  &&
          (rhs.g < lhs.g) && (rhs.g < lhs.g)  &&
          (rhs.b < lhs.b) && (rhs.b < lhs.b)  &&
          (rhs.a < lhs.a) && (rhs.a < lhs.a);
}

template <typename T>
inline bool operator <=(const Color4<T>& lhs, const Color4<T>& rhs)
{
  return  (lhs.r <= rhs.r) && (lhs.r <= rhs.r)  &&
          (lhs.g <= rhs.g) && (lhs.g <= rhs.g)  &&
          (lhs.b <= rhs.b) && (lhs.b <= rhs.b)  &&
          (lhs.a <= rhs.a) && (lhs.a <= rhs.a);
}

template <typename T>
inline bool operator >=(const Color4<T>& lhs, const Color4<T>& rhs)
{
  return  (rhs.r <= lhs.r) && (rhs.r <= lhs.r)  &&
          (rhs.g <= lhs.g) && (rhs.g <= lhs.g)  &&
          (rhs.b <= lhs.b) && (rhs.b <= lhs.b)  &&
          (rhs.a <= lhs.a) && (rhs.a <= lhs.a);
}

template <typename T>
inline Color4<T> operator /(const Color4<T>& lhs, const Color4<T>& rhs)
{
  return Color4<T>( lhs.r / rhs.r,
                    lhs.g / rhs.g,
                    lhs.b / rhs.b,
                    lhs.a / rhs.a
                  );
}

template <typename T>
inline Color4<T>& operator /=(Color4<T>& lhs, Color4<T>& rhs)
{
  lhs.r /= rhs.r;
  lhs.g /= rhs.g;
  lhs.b /= rhs.b;
  lhs.a /= rhs.a;
 
  return lhs;
}

typedef Color4<int16> Color4i;

typedef Color4<float> Color4f;

typedef Color4<uint8> Color4u;

typedef std::vector<Color4i> Color4iColors;

typedef std::vector<Color4f> Color4fColors;

typedef std::vector<Color4u> Color4uColors;
 
Color4i
make_color_from_hex_string(const std::string& hex_encoding);
 
Color4i
make_color_from_string(const std::string& color);
 
} // namespace nom
 
#endif // include guard defined