KeosColor.h

Go to the documentation of this file.

/*
 * This source file is part of KEOS (Free 3D Engine)
 * For the latest info, see http://www.keosengine.org/
 * E-mails : thierry.vouriot@keosengine.org, yeri@keosengine.org
 *
 * This program 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 2 of the License, or (at your option) any later
 * version.
 *
 * This program 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
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307, USA, or go to
 * http://www.gnu.org/copyleft/lesser.txt.
 *
 */

#ifndef KEOS_COLOR_H
#define KEOS_COLOR_H

#include "KeosPrerequisites.h"

namespace Keos
{
  //-----------------------------------------------------------------------
  class CColor
  {
  public :

    CColor(ulong nColor = 0xFF000000)
    {
      m_nColor = nColor;
    }

    CColor(uchar r, uchar g, uchar b, uchar a = 0xFF)
    {
      Set(r, g, b, a);
    }

    ulong ToARGB() const
    {
      return (GetAlpha() << 24) | (GetRed() << 16) | (GetGreen() << 8) | (GetBlue() << 0);
    }

    ulong ToABGR() const
    {
      return (GetAlpha() << 24) | (GetBlue() << 16) | (GetGreen() << 8) | (GetRed() << 0);
    }

    ulong ToRGBA() const
    {
      //return (GetRed() << 24) | (GetGreen() << 16) | (GetBlue() << 8) | (GetAlpha() << 0);
      return m_nColor; 
    }

    uchar GetAlpha() const
    {
      return static_cast<uchar>((m_nColor & 0xFF000000) >> 24);
    }

    uchar GetRed() const
    {
      return static_cast<uchar>((m_nColor & 0x00FF0000) >> 16);
    }

    uchar GetGreen() const
    {
      return static_cast<uchar>((m_nColor & 0x0000FF00) >> 8);
    }

    uchar GetBlue() const
    {
      return static_cast<uchar>((m_nColor & 0x000000FF) >> 0);
    }

    void SetFloats(float r, float g, float b, float a = 1.0f)
    {
      int R = static_cast<int>(r * 255.0f);
      int G = static_cast<int>(g * 255.0f);
      int B = static_cast<int>(b * 255.0f);
      int A = static_cast<int>(a * 255.0f);

      SetInt(R, G, B, A);
    }

    void Set(uchar r, uchar g, uchar b, uchar a = 0xFF)
    {
      m_nColor = (a << 24) | (r << 16) | (g << 8) | (b << 0);
    }

    void ToFloat(float Dest[]) const
    {
      Dest[0] = GetRed()   / 255.0f;
      Dest[1] = GetGreen() / 255.0f;
      Dest[2] = GetBlue()  / 255.0f;
      Dest[3] = GetAlpha() / 255.0f;
    }

    bool operator ==(const CColor& c) const
    {
      return m_nColor == c.m_nColor;
    }

    bool operator !=(const CColor& c) const
    {
      return !(*this == c);
    }

    const CColor& operator +=(const CColor& c)
    {
      int R = GetRed()   + c.GetRed();
      int G = GetGreen() + c.GetGreen();
      int B = GetBlue()  + c.GetBlue();
      int A = GetAlpha() + c.GetAlpha();

      SetInt(R, G, B, A);

      return *this;
    }

    const CColor& operator -=(const CColor& c)
    {
      int R = GetRed()   - c.GetRed();
      int G = GetGreen() - c.GetGreen();
      int B = GetBlue()  - c.GetBlue();
      int A = GetAlpha() - c.GetAlpha();

      SetInt(R, G, B, A);

      return *this;
    }

    CColor operator +(const CColor& c) const
    {
      int R = GetRed()   + c.GetRed();
      int G = GetGreen() + c.GetGreen();
      int B = GetBlue()  + c.GetBlue();
      int A = GetAlpha() + c.GetAlpha();

      CColor Ret;
      Ret.SetInt(R, G, B, A);

      return Ret;
    }

    CColor operator -(const CColor& c) const
    {
      int R = GetRed()   - c.GetRed();
      int G = GetGreen() - c.GetGreen();
      int B = GetBlue()  - c.GetBlue();
      int A = GetAlpha() - c.GetAlpha();

      CColor Ret;
      Ret.SetInt(R, G, B, A);

      return Ret;
    }

    CColor operator *(float v) const
    {
      int R = static_cast<int>(GetRed()   * v);
      int G = static_cast<int>(GetGreen() * v);
      int B = static_cast<int>(GetBlue()  * v);
      int A = static_cast<int>(GetAlpha() * v);

      CColor Ret;
      Ret.SetInt(R, G, B, A);

      return Ret;
    }

    const CColor& operator *=(float v)
    {
      int R = static_cast<int>(GetRed()   * v);
      int G = static_cast<int>(GetGreen() * v);
      int B = static_cast<int>(GetBlue()  * v);
      int A = static_cast<int>(GetAlpha() * v);

      SetInt(R, G, B, A);

      return *this;
    }

    CColor operator /(float v) const
    {
      return *this * (1.0f / v);
    }

    const CColor& operator /=(float v)
    {
      return *this *= (1.0f / v);
    }

    CColor Add(const CColor& c) const
    {
      return *this + c;
    }

    CColor Modulate(const CColor& c) const
    {
      uchar R = static_cast<uchar>(GetRed()   * c.GetRed()   / 255);
      uchar G = static_cast<uchar>(GetGreen() * c.GetGreen() / 255);
      uchar B = static_cast<uchar>(GetBlue()  * c.GetBlue()  / 255);
      uchar A = static_cast<uchar>(GetAlpha() * c.GetAlpha() / 255);

      return CColor(R, G, B, A);
    }

    static const ulong White = 0xFFFFFFFF;
    static const ulong Black = 0xFF000000;
    static const ulong Red   = 0xFFFF0000;
    static const ulong Green = 0xFF00FF00;
    static const ulong Blue  = 0xFF0000FF;

    friend std::istream& operator >>(std::istream& Stream, CColor& Color)
    {
      int R, G, B, A;
      Stream >> R >> G >> B >> A;
      Color.SetInt(R, G, B, A);

      return Stream;
    }

    friend std::ostream& operator <<(std::ostream& Stream, const CColor& Color)
    {
      return Stream << (int)Color.GetRed() << " " << (int)Color.GetGreen() << " " << (int)Color.GetBlue() << " " << (int)Color.GetAlpha();
    }

  private :

    void SetInt(int r, int g, int b, int a = 0xFF)
    {
      uchar R = (r >= 0) ? (r <= 255 ? r : 255) : 0;
      uchar G = (g >= 0) ? (g <= 255 ? g : 255) : 0;
      uchar B = (b >= 0) ? (b <= 255 ? b : 255) : 0;
      uchar A = (a >= 0) ? (a <= 255 ? a : 255) : 0;

      Set(R, G, B);
    }

    ulong m_nColor;
  };

} // namespace Keos


#endif // KEOS_COLOR_H

---