rt::Color Struct Reference

#include <Color.h>

Public Types
enum	Channel { Red , Green , Blue }

Public Member Functions
	Color (Real red, Real green, Real blue)
Color &	clamp ()
	Garantees that color channels are between 0 and 1.
	operator float * ()
	operator const float * () const
Real	r () const
Real	g () const
Real	b () const
Real &	r ()
Real &	g ()
Real &	b ()
Color	operator* (Real v) const
Color	operator* (Color other) const
Color	operator+ (Color other) const
Color &	operator+= (Color other)
Color	sup (Color other) const
Channel	argmax () const
Real	max () const
Real	min () const
void	getHSV (int &h, Real &s, Real &v) const
void	setHSV (int h, Real s, Real v)

Detailed Description

This structure codes the color of an object, as well as its transparency. Color channels are stored as floating point values between 0 and 1.

Definition at line 15 of file Color.h.

Member Enumeration Documentation

Channel

enum rt::Color::Channel

Definition at line 93 of file Color.h.

{ Red, Green, Blue };

Constructor & Destructor Documentation

Color() [1/2]

rt::Color::Color ( )

inline

Definition at line 20 of file Color.h.

: my_channels( 0.0, 0.0, 0.0 ) {}

Color() [2/2]

rt::Color::Color ( Real  red, Real  green, Real  blue  )

inline

Definition at line 21 of file Color.h.

      : my_channels( red, green, blue ) 
    {
      clamp();
    }

Member Function Documentation

argmax()

Channel rt::Color::argmax ( ) const

inline

Definition at line 94 of file Color.h.

    {
      if ( r() >= g() ) return r() >= b() ? Red : Blue;
      else              return g() >= b() ? Green : Blue;
    }

b() [1/2]

Real & rt::Color::b ( )

inline

Definition at line 44 of file Color.h.

{ return my_channels[ 2 ]; }

b() [2/2]

Real rt::Color::b ( ) const

inline

Definition at line 41 of file Color.h.

{ return my_channels[ 2 ]; }

clamp()

Color & rt::Color::clamp ( )

inline

Garantees that color channels are between 0 and 1.

Definition at line 27 of file Color.h.

    {
      my_channels[ 0 ] = std::max( 0.0f, std::min( 1.0f, my_channels[ 0 ] ) );
      my_channels[ 1 ] = std::max( 0.0f, std::min( 1.0f, my_channels[ 1 ] ) );
      my_channels[ 2 ] = std::max( 0.0f, std::min( 1.0f, my_channels[ 2 ] ) );
      return *this;
    }

g() [1/2]

Real & rt::Color::g ( )

inline

Definition at line 43 of file Color.h.

{ return my_channels[ 1 ]; }

g() [2/2]

Real rt::Color::g ( ) const

inline

Definition at line 40 of file Color.h.

{ return my_channels[ 1 ]; }

getHSV()

void rt::Color::getHSV ( int &  h, Real &  s, Real &  v  ) const

inline

Definition at line 102 of file Color.h.

    {
      // Taking care of hue
      if ( max() == min() ) h = 0;
      else {
        switch ( argmax() ) {
        case Red:   h = ( (int) ( 60.0 * ( g() - b() ) / ( max() - min() ) + 360.0 ) ) % 360;
          break;
        case Green: h = ( (int) ( 60.0 * ( b() - r() ) / ( max() - min() ) + 120.0 ) );
          break;
        case Blue:  h = ( (int) ( 60.0 * ( r() - g() ) / ( max() - min() ) + 240.0 ) );
          break;
        }
      }
      // Taking care of saturation
      s = max() == 0.0 ? 0.0 : 1.0 - min() / max();
      // Taking care of value
      v = max();
    }

max()

Real rt::Color::max ( ) const

inline

Definition at line 99 of file Color.h.

{ return std::max( std::max( r(), g() ), b() ); }

min()

Real rt::Color::min ( ) const

inline

Definition at line 100 of file Color.h.

{ return std::min( std::min( r(), g() ), b() ); }

operator const float *()

rt::Color::operator const float * ( ) const

inline

Definition at line 37 of file Color.h.

{ return my_channels; }

operator float *()

rt::Color::operator float * ( )

inline

Definition at line 35 of file Color.h.

{ return my_channels; }

operator*() [1/2]

Color rt::Color::operator* ( Color  other ) const

inline

Definition at line 57 of file Color.h.

    {
      Color tmp( *this );
      tmp.my_channels[ 0 ] *= other.my_channels[ 0 ];
      tmp.my_channels[ 1 ] *= other.my_channels[ 1 ];
      tmp.my_channels[ 2 ] *= other.my_channels[ 2 ];
      return tmp;
    }

operator*() [2/2]

Color rt::Color::operator* ( Real  v ) const

inline

Definition at line 47 of file Color.h.

    {
      Color tmp( *this );
      tmp.my_channels[ 0 ] *= v;
      tmp.my_channels[ 1 ] *= v;
      tmp.my_channels[ 2 ] *= v;
      return tmp;
    }

operator+()

Color rt::Color::operator+ ( Color  other ) const

inline

Definition at line 67 of file Color.h.

    {
      Color tmp( *this );
      tmp.my_channels[ 0 ] += other.my_channels[ 0 ];
      tmp.my_channels[ 1 ] += other.my_channels[ 1 ];
      tmp.my_channels[ 2 ] += other.my_channels[ 2 ];
      return tmp;
    }

operator+=()

Color & rt::Color::operator+= ( Color  other )

inline

Definition at line 77 of file Color.h.

    {
      my_channels[ 0 ] += other.my_channels[ 0 ];
      my_channels[ 1 ] += other.my_channels[ 1 ];
      my_channels[ 2 ] += other.my_channels[ 2 ];
      return *this;
    }

r() [1/2]

Real & rt::Color::r ( )

inline

Definition at line 42 of file Color.h.

{ return my_channels[ 0 ]; }

r() [2/2]

Real rt::Color::r ( ) const

inline

Definition at line 39 of file Color.h.

{ return my_channels[ 0 ]; }

setHSV()

void rt::Color::setHSV ( int  h, Real  s, Real  v  )

inline

Definition at line 122 of file Color.h.

    {
      int t = ( h / 60 ) % 6;
      Real f = ( (Real) h / 60.0 ) - (Real) t;
      Real bv = v;
      Real bl = (int) ( v * ( 1 - s ) );
      Real bm = (int) ( v * ( 1 - f * s ) );
      Real bn = (int) ( v * ( 1 - ( 1 - f ) * s ) );
      switch ( t ) {
      case 0: r() = bv; g() = bn; b() = bl; break;
      case 1: r() = bm; g() = bv; b() = bl; break;
      case 2: r() = bl; g() = bv; b() = bn; break;
      case 3: r() = bl; g() = bm; b() = bv; break;
      case 4: r() = bn; g() = bl; b() = bv; break;
      case 5: r() = bv; g() = bl; b() = bm; break;
      }
      clamp();
    }

sup()

Color rt::Color::sup ( Color  other ) const

inline

Definition at line 85 of file Color.h.

    {
      other[ 0 ] = std::max( (*this)[ 0 ], other[ 0 ] );
      other[ 1 ] = std::max( (*this)[ 1 ], other[ 1 ] );
      other[ 2 ] = std::max( (*this)[ 2 ], other[ 2 ] );
      return other;
    }

---

The documentation for this struct was generated from the following file:

• TP2/Color.h