color.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2011 by the OpenStructure authors
//
// This library 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 3.0 of the License, or (at your option)
// any later version.
// This library 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 library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------
#ifndef OST_COLOR_HH
#define OST_COLOR_HH

/*
  Author: Ansgar Philippsen, Marco Biasini
*/

#include <iosfwd>

#include <boost/operators.hpp>

#include <ost/gfx/module_config.hh>
#include <ost/geom/geom.hh>

namespace ost { namespace gfx {

class DLLEXPORT_OST_GFX Color :   
  private boost::additive<Color>,
  private boost::additive<Color, float>,
  private boost::multiplicative<Color, float>{

public:
  Color();

  void SetRGB(float r, float g, float b);
  geom::Vec3 GetRGB() const;
  geom::Vec4 GetRGBA() const;
  float GetRed() const;
  void SetRed(float);
  float GetGreen() const;
  void SetGreen(float);
  float GetBlue() const;
  void SetBlue(float);
  void SetHSV(float h, float s, float v);
  geom::Vec3 GetHSV() const;
  geom::Vec4 GetHSVA() const;
  float GetHue() const;
  void SetHue(float);
  float GetSat() const;
  void SetSat(float);
  float GetVal() const;
  void SetVal(float);
  float GetAlpha() const;
  void SetAlpha(float);

  
  operator const float* () const;
  operator float* ();
  
  Color& operator*=(float rhs);
  Color& operator+=(float rhs);
    
  Color& operator+=(const Color& rhs);  
  Color& operator-=(const Color& rhs);    
  Color& operator-=(float rhs);
  Color& operator/=(float rhs);  


  geom::Vec3 ToHSV() const {return GetHSV();}

  Color(float r, float g, float b, float a=1.0);

  float Red() const {return GetRed();}
  float Green() const {return GetGreen();}
  float Blue() const {return GetBlue();}
  float Alpha() const {return GetAlpha();}

  static Color FromRGB(unsigned char r, unsigned char g, 
                       unsigned char b, unsigned char a = 0xff) {
    static float f=1.0/255.0;
    return Color(f*static_cast<float>(r),f*static_cast<float>(g),
                 f*static_cast<float>(b),f*static_cast<float>(a));
  }


private:
  void to_hsv() const;
  void to_rgb() const;

  mutable float rgba_[4];
  mutable float hsv_[3];
  mutable bool rgb_dirty_;
  mutable bool hsv_dirty_;
};


Color DLLEXPORT_OST_GFX RGB(float r, float g, float b);

Color DLLEXPORT_OST_GFX RGBb(uchar r, uchar g, uchar b);

Color DLLEXPORT_OST_GFX RGBi(unsigned int r, unsigned int g, unsigned int b);

Color DLLEXPORT_OST_GFX RGBA(float r, float g, float b, float a);

Color DLLEXPORT_OST_GFX RGBAb(uchar r, uchar g, uchar b, uchar a);

Color DLLEXPORT_OST_GFX RGBAi(unsigned int r, unsigned int g, unsigned int b, unsigned int a);


Color DLLEXPORT_OST_GFX HSV(float h, float s, float v);

  Color DLLEXPORT_OST_GFX HSVi(int h, int s, int v);

Color DLLEXPORT_OST_GFX HSVA(float h, float s, float v, float a);

Color DLLEXPORT_OST_GFX HSVAi(int h, int s, int v, int a);


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

}}

#endif