Defines a color. More...
#include <common/common.hh>
Public Types | |
typedef unsigned int | ABGR |
typedef unsigned int | ARGB |
typedef unsigned int | BGRA |
typedef unsigned int | RGBA |
Public Member Functions | |
Color () | |
Constructor. More... | |
Color (float _r, float _g, float _b, float _a=1.0) | |
Constructor. More... | |
Color (const Color &_clr) | |
Copy Constructor. More... | |
virtual | ~Color () |
Destructor. More... | |
ABGR | GetAsABGR () const |
Get as uint32 ABGR packed value. More... | |
ARGB | GetAsARGB () const |
Get as uint32 ARGB packed value. More... | |
BGRA | GetAsBGRA () const |
Get as uint32 BGRA packed value. More... | |
RGBA | GetAsRGBA () const |
Get as uint32 RGBA packed value. More... | |
math::Vector3 | GetAsYUV () const |
Get the color in YUV colorspace. More... | |
ignition::math::Vector3d | HSV () const |
Get the color in HSV colorspace. More... | |
bool | operator!= (const Color &_pt) const |
Inequality operator. More... | |
const Color | operator* (const Color &_pt) const |
Multiplication operator. More... | |
const Color | operator* (const float &_v) const |
Multiply all color components by _v. More... | |
const Color & | operator*= (const Color &_pt) |
Multiplication equal operator. More... | |
Color | operator+ (const Color &_pt) const |
Addition operator (this + _pt) More... | |
Color | operator+ (const float &_v) const |
Add _v to all color components. More... | |
const Color & | operator+= (const Color &_pt) |
Addition equal operator. More... | |
Color | operator- (const Color &_pt) const |
Subtraction operator. More... | |
Color | operator- (const float &_v) const |
Subtract _v from all color components. More... | |
const Color & | operator-= (const Color &_pt) |
Subtraction equal operator. More... | |
const Color | operator/ (const Color &_pt) const |
Division operator. More... | |
const Color | operator/ (const float &_v) const |
Divide all color component by _v. More... | |
const Color & | operator/= (const Color &_pt) |
Division equal operator. More... | |
Color & | operator= (const Color &_pt) |
Equal operator. More... | |
bool | operator== (const Color &_pt) const |
Equality operator. More... | |
float | operator[] (unsigned int _index) |
Array index operator. More... | |
void | Reset () |
Reset the color to default values. More... | |
void | Set (float _r=1, float _g=1, float _b=1, float _a=1) |
Set the contents of the vector. More... | |
void | SetFromABGR (const ABGR _v) |
Set from uint32 ABGR packed value. More... | |
void | SetFromARGB (const ARGB _v) |
Set from uint32 ARGB packed value. More... | |
void | SetFromBGRA (const BGRA _v) |
Set from uint32 BGRA packed value. More... | |
void | SetFromHSV (float _h, float _s, float _v) |
Set a color based on HSV values. More... | |
void | SetFromRGBA (const RGBA _v) |
Set from uint32 RGBA packed value. More... | |
void | SetFromYUV (float _y, float _u, float _v) |
Set from yuv. More... | |
ignition::math::Vector3d | YUV () const |
Get the color in YUV colorspace. More... | |
Public Attributes | |
float | a |
float | b |
float | g |
float | r |
Static Public Attributes | |
static const Color | Black |
(0, 0, 0) More... | |
static const Color | Blue |
(0, 0, 1) More... | |
static const Color | Green |
(0, 1, 0) More... | |
static const Color | Purple |
(1, 0, 1) More... | |
static const Color | Red |
(1, 0, 0) More... | |
static const Color | White |
(1, 1, 1) More... | |
static const Color | Yellow |
(1, 1, 0) More... | |
Friends | |
std::ostream & | operator<< (std::ostream &_out, const Color &_pt) |
Stream insertion operator. More... | |
std::istream & | operator>> (std::istream &_in, Color &_pt) |
Stream insertion operator. More... | |
Defines a color.
typedef unsigned int ABGR |
typedef unsigned int ARGB |
typedef unsigned int BGRA |
typedef unsigned int RGBA |
Color | ( | ) |
Constructor.
Color | ( | float | _r, |
float | _g, | ||
float | _b, | ||
float | _a = 1.0 |
||
) |
Constructor.
[in] | _r | Red value (range 0 to 1) |
[in] | _g | Green value (range 0 to 1 |
[in] | _b | Blue value (range 0 to 1 |
[in] | _a | Alpha value (0=transparent, 1=opaque) |
|
virtual |
Destructor.
ABGR GetAsABGR | ( | ) | const |
Get as uint32 ABGR packed value.
ARGB GetAsARGB | ( | ) | const |
Get as uint32 ARGB packed value.
BGRA GetAsBGRA | ( | ) | const |
Get as uint32 BGRA packed value.
RGBA GetAsRGBA | ( | ) | const |
Get as uint32 RGBA packed value.
math::Vector3 GetAsYUV | ( | ) | const |
Get the color in YUV colorspace.
ignition::math::Vector3d HSV | ( | ) | const |
Get the color in HSV colorspace.
bool operator!= | ( | const Color & | _pt | ) | const |
Inequality operator.
[in] | _pt | The color to check for inequality |
Multiplication operator.
[in] | _pt | The color to muliply by |
const Color operator* | ( | const float & | _v | ) | const |
Multiply all color components by _v.
[in] | _v | The value to multiply by |
Multiplication equal operator.
[in] | _pt | The color to muliply by |
Color operator+ | ( | const float & | _v | ) | const |
Add _v to all color components.
[in] | _v | Value to add to each color component |
Subtraction operator.
[in] | _pt | The color to substract |
Color operator- | ( | const float & | _v | ) | const |
Subtract _v from all color components.
[in] | _v | Value to subtract |
const Color operator/ | ( | const float & | _v | ) | const |
Divide all color component by _v.
[in] | _v | The value to divide by |
bool operator== | ( | const Color & | _pt | ) | const |
Equality operator.
[in] | _pt | The color to check for equality |
float operator[] | ( | unsigned int | _index | ) |
Array index operator.
[in] | _index | Color component index(0=red, 1=green, 2=blue) |
void Reset | ( | ) |
Reset the color to default values.
void Set | ( | float | _r = 1 , |
float | _g = 1 , |
||
float | _b = 1 , |
||
float | _a = 1 |
||
) |
Set the contents of the vector.
[in] | _r | Red value (range 0 to 1) |
[in] | _g | Green value (range 0 to 1) |
[in] | _b | Blue value (range 0 to 1) |
[in] | _a | Alpha value (0=transparent, 1=opaque) |
void SetFromABGR | ( | const ABGR | _v | ) |
Set from uint32 ABGR packed value.
[in] | _v | the new color |
void SetFromARGB | ( | const ARGB | _v | ) |
Set from uint32 ARGB packed value.
[in] | _v | the new color |
void SetFromBGRA | ( | const BGRA | _v | ) |
Set from uint32 BGRA packed value.
[in] | _v | the new color |
void SetFromHSV | ( | float | _h, |
float | _s, | ||
float | _v | ||
) |
Set a color based on HSV values.
[in] | _h | Hue(0..360) |
[in] | _s | Saturation(0..1) |
[in] | _v | Value(0..1) |
void SetFromRGBA | ( | const RGBA | _v | ) |
Set from uint32 RGBA packed value.
[in] | _v | the new color |
void SetFromYUV | ( | float | _y, |
float | _u, | ||
float | _v | ||
) |
Set from yuv.
[in] | _y | value |
[in] | _u | value |
[in] | _v | value |
ignition::math::Vector3d YUV | ( | ) | const |
Get the color in YUV colorspace.
|
friend |
Stream insertion operator.
[in] | _out | the output stream |
[in] | _pt | the color |
|
friend |
Stream insertion operator.
[in] | _in | the input stream |
[in] | _pt |
float a |
float b |
|
static |
(0, 0, 0)
|
static |
(0, 0, 1)
float g |
|
static |
(0, 1, 0)
|
static |
(1, 0, 1)
float r |
|
static |
(1, 0, 0)
|
static |
(1, 1, 1)
Referenced by ServerFixture::CheckPointer().
|
static |
(1, 1, 0)