ARGoS  3
A parallel, multi-engine simulator for swarm robotics
argos::CColor Class Reference

The basic color type. More...

#include <color.h>

List of all members.

Classes

struct  TChannels

Public Member Functions

 CColor ()
 Class constructor.
 CColor (const UInt8 un_red, const UInt8 un_green, const UInt8 un_blue, const UInt8 un_alpha=255) throw ()
 Class constructor.
Real ToGrayScale () const throw ()
 Returns the color in grayscale.
UInt8 GetRed () const throw ()
 Returns the red channel of the color.
void SetRed (const UInt8 un_red) throw ()
 Sets the red channel of the color.
UInt8 GetGreen () const throw ()
 Returns the green channel of the color.
void SetGreen (const UInt8 un_green) throw ()
 Sets the green channel of the color.
UInt8 GetBlue () const throw ()
 Returns the blue channel of the color.
void SetBlue (const UInt8 un_blue) throw ()
 Sets the blue channel of the color.
UInt8 GetAlpha () const throw ()
 Returns the alpha channel of the color.
void SetAlpha (const UInt8 un_alpha) throw ()
 Sets the alpha channel of the color.
void Set (const UInt8 un_red, const UInt8 un_green, const UInt8 un_blue, const UInt8 un_alpha=255) throw ()
 Sets the RGBA values of the color.
void Set (const std::string &str_color)
 Sets the RGBA values of the color from a string.
 operator UInt32 ()
 Cast operator.
bool operator== (const CColor &c_color2) const throw ()
 Returns true if the given color is identical to the current.
bool operator!= (const CColor &c_color2) const throw ()
 Returns true if the given color is different from the current.

Static Public Attributes

static CColor BLACK
static CColor WHITE
static CColor RED
static CColor GREEN
static CColor BLUE
static CColor MAGENTA
static CColor CYAN
static CColor YELLOW
static CColor ORANGE
static CColor GRAY10
static CColor GRAY20
static CColor GRAY30
static CColor GRAY40
static CColor GRAY50
static CColor GRAY60
static CColor GRAY70
static CColor GRAY80
static CColor GRAY90

Friends

std::ostream & operator<< (std::ostream &os, const CColor &c_color)
 Output stream operator.
std::istream & operator>> (std::istream &is, CColor &c_color)
 Input stream operator.

Detailed Description

The basic color type.

In ARGoS, color is encoded into the RGBA schema.

Definition at line 25 of file color.h.


Constructor & Destructor Documentation

argos::CColor::CColor ( ) [inline]

Class constructor.

Definition at line 51 of file color.h.

argos::CColor::CColor ( const UInt8  un_red,
const UInt8  un_green,
const UInt8  un_blue,
const UInt8  un_alpha = 255 
) throw () [inline, explicit]

Class constructor.

Definition at line 56 of file color.h.


Member Function Documentation

UInt8 argos::CColor::GetAlpha ( ) const throw () [inline]

Returns the alpha channel of the color.

Returns:
the alpha channel of the color.

Definition at line 110 of file color.h.

UInt8 argos::CColor::GetBlue ( ) const throw () [inline]

Returns the blue channel of the color.

Returns:
the blue channel of the color.

Definition at line 99 of file color.h.

UInt8 argos::CColor::GetGreen ( ) const throw () [inline]

Returns the green channel of the color.

Returns:
the green channel of the color.

Definition at line 88 of file color.h.

UInt8 argos::CColor::GetRed ( ) const throw () [inline]

Returns the red channel of the color.

Returns:
the red channel of the color.

Definition at line 77 of file color.h.

argos::CColor::operator UInt32 ( ) [inline]

Cast operator.

Casts the color into a 32-bit structure.

Definition at line 176 of file color.h.

bool argos::CColor::operator!= ( const CColor c_color2) const throw () [inline]

Returns true if the given color is different from the current.

Parameters:
c_color2the color to compare the current color to.
Returns:
true if the given color is different from the current.

Definition at line 194 of file color.h.

bool argos::CColor::operator== ( const CColor c_color2) const throw () [inline]

Returns true if the given color is identical to the current.

Parameters:
c_color2the color to compare the current color to.
Returns:
true if the given color is identical to the current.

Definition at line 185 of file color.h.

void argos::CColor::Set ( const UInt8  un_red,
const UInt8  un_green,
const UInt8  un_blue,
const UInt8  un_alpha = 255 
) throw () [inline]

Sets the RGBA values of the color.

Parameters:
un_redthe red channel of the color.
un_greenthe green channel of the color.
un_bluethe blue channel of the color.
un_alphathe alpha channel of the color.

Definition at line 124 of file color.h.

void argos::CColor::Set ( const std::string &  str_color) [inline]

Sets the RGBA values of the color from a string.

The input stringcan contain predefined color names, such as red. The color can be also input as a tuple <r,g,b,a>.

Parameters:
str_colorthe input string.
Exceptions:
CARGoSExceptionin case of a parse error.

Definition at line 141 of file color.h.

void argos::CColor::SetAlpha ( const UInt8  un_alpha) throw () [inline]

Sets the alpha channel of the color.

Parameters:
un_alphathe alpha channel of the color.

Definition at line 115 of file color.h.

void argos::CColor::SetBlue ( const UInt8  un_blue) throw () [inline]

Sets the blue channel of the color.

Parameters:
un_bluethe blue channel of the color.

Definition at line 104 of file color.h.

void argos::CColor::SetGreen ( const UInt8  un_green) throw () [inline]

Sets the green channel of the color.

Parameters:
un_greenthe green channel of the color.

Definition at line 93 of file color.h.

void argos::CColor::SetRed ( const UInt8  un_red) throw () [inline]

Sets the red channel of the color.

Parameters:
un_redthe red channel of the color.

Definition at line 82 of file color.h.

Real argos::CColor::ToGrayScale ( ) const throw () [inline]

Returns the color in grayscale.

Returns:
the color in grayscale. The returned value is in the range [0,1].

Definition at line 66 of file color.h.


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const CColor c_color 
) [friend]

Output stream operator.

Operator to serialize a color into a C++ output stream. When a color corresponds to one of the predefined constants (such as argos::CColor::RED) it streams the color name. For instance, if the current color is argos::CColor::RED, the output is a string containing red. Otherwise, the color is output as a tuple <r,g,b,a>.

Parameters:
osthe C++ output stream.
c_colorthe color to stream.
Returns:
the new state of the C++ output stream.

Definition at line 209 of file color.h.

std::istream& operator>> ( std::istream &  is,
CColor c_color 
) [friend]

Input stream operator.

Operator to get a color from a C++ input stream. The input stream value can contain predefined color names, such as red. The color can be also input as a tuple <r,g,b,a>.

Parameters:
isthe C++ input stream.
c_colorthe color to fill.
Returns:
the new state of the C++ input stream.

Definition at line 247 of file color.h.


Member Data Documentation

Definition at line 29 of file color.h.

Definition at line 33 of file color.h.

Definition at line 35 of file color.h.

Definition at line 38 of file color.h.

Definition at line 39 of file color.h.

Definition at line 40 of file color.h.

Definition at line 41 of file color.h.

Definition at line 42 of file color.h.

Definition at line 43 of file color.h.

Definition at line 44 of file color.h.

Definition at line 45 of file color.h.

Definition at line 46 of file color.h.

Definition at line 32 of file color.h.

Definition at line 34 of file color.h.

Definition at line 37 of file color.h.

Definition at line 31 of file color.h.

Definition at line 30 of file color.h.

Definition at line 36 of file color.h.


The documentation for this class was generated from the following files: