Color.h

Go to the documentation of this file.

/* -*- mode: c++ -*- */
#ifndef _BOARD_COLOR_H_
#define _BOARD_COLOR_H_

#include <ostream>
#include <string>

namespace LibBoard {

class Color {

public:

  inline Color( const unsigned int rgb, unsigned char alpha = 255 );

  inline Color( unsigned char red,
                unsigned char  green,
                unsigned char  blue,
                unsigned char alpha = 255 );

  inline Color( unsigned char gray, unsigned char alpha = 255 );

  inline Color( const bool valid = true );

  inline void red( unsigned char red );
  inline void green( unsigned char green );
  inline void blue( unsigned char blue );
  inline void alpha( unsigned char alpha );

  inline unsigned char red() const;
  inline unsigned char green() const;
  inline unsigned char blue() const;
  inline unsigned char alpha() const;
  
  inline Color & setRGBi( const unsigned char red,
                          const unsigned char green,
                          const unsigned char blue,
                          const unsigned char alpha = 255 );
  
  Color & setRGBf( float red,
                   float green,
                   float blue,
                   float alpha = 1.0 );
  
  bool operator==( const Color & other ) const;

  bool operator!=( const Color & other ) const;

  bool operator<( const Color & other ) const;

  void flushPostscript( std::ostream & ) const;

  std::string svg() const;

  std::string svgAlpha( const char * prefix ) const;

  std::string postscript() const;
  
  std::string tikz() const;


  inline bool valid() const { return (*this) != Color::Null; }


public:
  static const Color Null;
  static const Color Black;
  static const Color Gray;
  static const Color White;
  static const Color Red;
  static const Color Green;
  static const Color Lime;
  static const Color Blue;
  static const Color Cyan;
  static const Color Magenta;
  static const Color Yellow;
  static const Color Silver;
  static const Color Purple;
  static const Color Navy;
  static const Color Aqua;

private:
  int _red;       
  int _green;                   
  int _blue;                    
  int _alpha;                   
};

inline Color &
Color::setRGBi( const unsigned char red,
                const unsigned char green,
                const unsigned char blue,
                const unsigned char alpha ) {
  _red = red;
  _green = green;
  _blue = blue;
  _alpha = alpha;
  return *this;
}


inline Color::Color( const unsigned int rgb, unsigned char alpha )
  :_alpha( alpha )
{
  _red = ( rgb & 0xFF0000u ) >> 16;
  _green = ( rgb & 0xFF00u ) >> 8;
  _blue = rgb & 0xFF;
}

inline Color::Color( unsigned char red,
                     unsigned char  green,
                     unsigned char  blue,
                     unsigned char alpha )
  :_red(red),_green(green),_blue(blue),_alpha(alpha)
{ }

inline Color::Color( unsigned char gray, unsigned char alpha )
  :_red(gray),_green(gray),_blue(gray),_alpha(alpha)
{ }

inline Color::Color( const bool valid )
  :_red(-1),_green(-1),_blue(-1),_alpha(255)
{
  if ( valid ) {
    _red = _green = _blue = 0;
  }
}

inline void
Color::red( const unsigned char red )
{
  _red = red;
}

inline void
Color::green( unsigned char green )
{
  _green = green;
}

inline void 
Color::blue( unsigned char blue )
{
  _blue = blue;
}

inline void 
Color::alpha( unsigned char alpha )
{
  _alpha = alpha;
}

inline unsigned char Color::red() const { return _red; } 
inline unsigned char Color::green() const { return _green; } 
inline unsigned char Color::blue() const { return _blue; } 
inline unsigned char Color::alpha() const { return _alpha; } 

}

#endif // _COLOR_H_