Defines a color using a red (R), green (G), blue (B), and alpha (A) component. More...

#include <ignition/math/Color.hh>

Public Types
typedef unsigned int	ABGR

typedef unsigned int	ARGB

typedef unsigned int	BGRA

typedef unsigned int	RGBA

Public Member Functions
	Color ()
	Constructor.

	Color (const Color &_clr)
	Copy Constructor.

	Color (const float _r, const float _g, const float _b, const float _a=1.0)
	Constructor.

virtual	~Color ()
	Destructor.

float &	A ()
	Get a mutable reference to the alpha value.

float	A () const
	Get the alpha value.

void	A (const float _a)
	Set the alpha value.

ABGR	AsABGR () const
	Get as uint32 ABGR packed value.

ARGB	AsARGB () const
	Get as uint32 ARGB packed value.

BGRA	AsBGRA () const
	Get as uint32 BGRA packed value.

RGBA	AsRGBA () const
	Get as uint32 RGBA packed value.

float &	B ()
	Get a mutable reference to the blue value.

float	B () const
	Get the blue value.

void	B (const float _b)
	Set the blue value.

float &	G ()
	Get a mutable reference to the green value.

float	G () const
	Get the green value.

void	G (const float _g)
	Set the green value.

Vector3f	HSV () const
	Get the color in HSV colorspace.

bool	operator!= (const Color &_pt) const
	Inequality operator.

const Color	operator* (const Color &_pt) const
	Multiplication operator.

const Color	operator* (const float &_v) const
	Multiply all color components by _v.

const Color &	operator*= (const Color &_pt)
	Multiplication equal operator.

Color	operator+ (const Color &_pt) const
	Addition operator (this + _pt)

Color	operator+ (const float &_v) const
	Add _v to all color components.

const Color &	operator+= (const Color &_pt)
	Addition equal operator.

Color	operator- (const Color &_pt) const
	Subtraction operator.

Color	operator- (const float &_v) const
	Subtract _v from all color components.

const Color &	operator-= (const Color &_pt)
	Subtraction equal operator.

const Color	operator/ (const Color &_pt) const
	Division operator.

const Color	operator/ (const float &_v) const
	Divide all color component by _v.

const Color &	operator/= (const Color &_pt)
	Division equal operator.

Color &	operator= (const Color &_pt)
	Equal operator.

bool	operator== (const Color &_pt) const
	Equality operator.

float	operator[] (const unsigned int _index)
	Array index operator.

float &	R ()
	Get a mutable reference to the red value.

float	R () const
	Get the red value.

void	R (const float _r)
	Set the red value.

void	Reset ()
	Reset the color to default values to red=0, green=0, blue=0, alpha=1.

void	Set (const float _r=1, const float _g=1, const float _b=1, const float _a=1)
	Set the contents of the vector.

void	SetFromABGR (const ABGR _v)
	Set from uint32 ABGR packed value.

void	SetFromARGB (const ARGB _v)
	Set from uint32 ARGB packed value.

void	SetFromBGRA (const BGRA _v)
	Set from uint32 BGRA packed value.

void	SetFromHSV (const float _h, const float _s, const float _v)
	Set a color based on HSV values.

void	SetFromRGBA (const RGBA _v)
	Set from uint32 RGBA packed value.

void	SetFromYUV (const float _y, const float _u, const float _v)
	Set from yuv.

Vector3f	YUV () const
	Get the color in YUV colorspace.

Static Public Attributes
static const Color	Black
	(0, 0, 0)

static const Color	Blue
	(0, 0, 1)

static const Color	Cyan
	(0, 1, 1)

static const Color	Green
	(0, 1, 0)

static const Color	Magenta
	(1, 0, 1)

static const Color	Red
	(1, 0, 0)

static const Color	White
	(1, 1, 1)

static const Color	Yellow
	(1, 1, 0)

Detailed Description

Defines a color using a red (R), green (G), blue (B), and alpha (A) component.

Each color component is in the range [0..1].

Member Typedef Documentation

◆ ABGR

typedef unsigned int ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::ABGR

◆ ARGB

typedef unsigned int ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::ARGB

◆ BGRA

typedef unsigned int ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::BGRA

◆ RGBA

typedef unsigned int ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::RGBA

Constructor & Destructor Documentation

◆ Color() [1/3]

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Color ( )

Constructor.

Referenced by Color(), operator!=(), operator*(), operator*(), operator*=(), operator+(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/(), operator/=(), operator<<, operator=(), operator==(), and operator>>.

◆ Color() [2/3]

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Color	(	const float	_r,
		const float	_g,
		const float	_b,
		const float	_a = 1.0 )

Constructor.

Parameters

[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)

◆ Color() [3/3]

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Color ( const Color & _clr )

Copy Constructor.

Parameters

[in] _clr Color to copy

References Color().

◆ ~Color()

virtual ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::~Color ( )

virtual

Destructor.

Member Function Documentation

◆ A() [1/3]

float & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::A ( )

Get a mutable reference to the alpha value.

Returns: The alpha value

◆ A() [2/3]

float ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::A ( ) const

Get the alpha value.

Returns: The alpha value

◆ A() [3/3]

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::A ( const float _a )

Set the alpha value.

Parameters

_r	New alpha value

◆ AsABGR()

ABGR ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::AsABGR ( ) const

Get as uint32 ABGR packed value.

Returns: the color

◆ AsARGB()

ARGB ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::AsARGB ( ) const

Get as uint32 ARGB packed value.

Returns: the color

◆ AsBGRA()

BGRA ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::AsBGRA ( ) const

Get as uint32 BGRA packed value.

Returns: the color

◆ AsRGBA()

RGBA ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::AsRGBA ( ) const

Get as uint32 RGBA packed value.

Returns: the color

◆ B() [1/3]

float & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::B ( )

Get a mutable reference to the blue value.

Returns: The blue value

◆ B() [2/3]

float ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::B ( ) const

Get the blue value.

Returns: The blue value

◆ B() [3/3]

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::B ( const float _b )

Set the blue value.

Parameters

_r	New blue value

◆ G() [1/3]

float & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::G ( )

Get a mutable reference to the green value.

Returns: The green value

◆ G() [2/3]

float ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::G ( ) const

Get the green value.

Returns: The green value

◆ G() [3/3]

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::G ( const float _g )

Set the green value.

Parameters

_r	New green value

◆ HSV()

Vector3f ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::HSV ( ) const

Get the color in HSV colorspace.

Returns: HSV values in a Vector3f format. A vector3f containing {NAN_F, NAN_F, NAN_F} is returned on error.

◆ operator!=()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator!= ( const Color & _pt ) const

Inequality operator.

Parameters

[in] _pt The color to check for inequality

Returns: True if the this color does not equal _pt

References Color().

◆ operator*() [1/2]

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator* ( const Color & _pt ) const

Multiplication operator.

Parameters

[in] _pt The color to muliply by

Returns: The resulting color

References Color().

◆ operator*() [2/2]

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator* ( const float & _v ) const

Multiply all color components by _v.

Parameters

[in] _v The value to multiply by

Returns: The resulting color

References Color().

◆ operator*=()

const Color & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator*= ( const Color & _pt )

Multiplication equal operator.

Parameters

[in] _pt The color to muliply by

Returns: The resulting color

References Color().

◆ operator+() [1/2]

Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator+ ( const Color & _pt ) const

Addition operator (this + _pt)

Parameters

[in] _pt Color to add

Returns: The resulting color

References Color().

◆ operator+() [2/2]

Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator+ ( const float & _v ) const

Add _v to all color components.

Parameters

[in] _v Value to add to each color component

Returns: The resulting color

References Color().

◆ operator+=()

const Color & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator+= ( const Color & _pt )

Addition equal operator.

Parameters

[in] _pt Color to add

Returns: The resulting color

References Color().

◆ operator-() [1/2]

Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator- ( const Color & _pt ) const

Subtraction operator.

Parameters

[in] _pt The color to substract

Returns: The resulting color

References Color().

◆ operator-() [2/2]

Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator- ( const float & _v ) const

Subtract _v from all color components.

Parameters

[in] _v Value to subtract

Returns: The resulting color

References Color().

◆ operator-=()

const Color & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator-= ( const Color & _pt )

Subtraction equal operator.

Parameters

[in] _pt Color to subtract

Returns: The resulting color

References Color().

◆ operator/() [1/2]

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator/ ( const Color & _pt ) const

Division operator.

Parameters

[in] _pt Color to divide by

Returns: The resulting color

References Color().

◆ operator/() [2/2]

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator/ ( const float & _v ) const

Divide all color component by _v.

Parameters

[in] _v The value to divide by

Returns: The resulting color

References Color().

◆ operator/=()

const Color & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator/= ( const Color & _pt )

Division equal operator.

Parameters

[in] _pt Color to divide by

Returns: The resulting color

References Color().

◆ operator=()

Color & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator= ( const Color & _pt )

Equal operator.

Parameters

[in] _pt Color to copy

Returns: Reference to this color

References Color().

◆ operator==()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator== ( const Color & _pt ) const

Equality operator.

Parameters

[in] _pt The color to check for equality

Returns: True if the this color equals _pt

References Color().

◆ operator[]()

float ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::operator[] ( const unsigned int _index )

Array index operator.

Parameters

[in] _index Color component index(0=red, 1=green, 2=blue)

Returns: r, g, b, or a when _index is 0, 1, 2 or 3. A NAN_F value is returned if the _index is invalid

◆ R() [1/3]

float & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::R ( )

Get a mutable reference to the red value.

Returns: The red value

◆ R() [2/3]

float ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::R ( ) const

Get the red value.

Returns: The red value

◆ R() [3/3]

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::R ( const float _r )

Set the red value.

Parameters

_r	New red value

◆ Reset()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Reset ( )

Reset the color to default values to red=0, green=0, blue=0, alpha=1.

◆ Set()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Set	(	const float	_r = 1,
		const float	_g = 1,
		const float	_b = 1,
		const float	_a = 1 )

Set the contents of the vector.

Parameters

[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)

◆ SetFromABGR()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::SetFromABGR ( const ABGR _v )

Set from uint32 ABGR packed value.

Parameters

[in] _v the new color

◆ SetFromARGB()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::SetFromARGB ( const ARGB _v )

Set from uint32 ARGB packed value.

Parameters

[in] _v the new color

◆ SetFromBGRA()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::SetFromBGRA ( const BGRA _v )

Set from uint32 BGRA packed value.

Parameters

[in] _v the new color

◆ SetFromHSV()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::SetFromHSV	(	const float	_h,
		const float	_s,
		const float	_v )

Set a color based on HSV values.

Parameters

[in]	_h	Hue(0..360)
[in]	_s	Saturation(0..1)
[in]	_v	Value(0..1)

◆ SetFromRGBA()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::SetFromRGBA ( const RGBA _v )

Set from uint32 RGBA packed value.

Parameters

[in] _v the new color

◆ SetFromYUV()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::SetFromYUV	(	const float	_y,
		const float	_u,
		const float	_v )

Set from yuv.

Parameters

[in]	_y	value
[in]	_u	value
[in]	_v	value

◆ YUV()

Vector3f ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::YUV ( ) const

Get the color in YUV colorspace.

Returns: the YUV color

Member Data Documentation

◆ Black

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Black

static

(0, 0, 0)

◆ Blue

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Blue

static

(0, 0, 1)

◆ Cyan

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Cyan

static

(0, 1, 1)

◆ Green

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Green

static

(0, 1, 0)

◆ Magenta

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Magenta

static

(1, 0, 1)

◆ Red

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Red

static

(1, 0, 0)

◆ White

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::White

static

(1, 1, 1)

◆ Yellow

const Color ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Color::Yellow

static

(1, 1, 0)

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

Color.hh

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ ABGR

◆ ARGB

◆ BGRA

◆ RGBA

Constructor & Destructor Documentation

◆ Color() [1/3]

◆ Color() [2/3]

◆ Color() [3/3]

◆ ~Color()

Member Function Documentation

◆ A() [1/3]

◆ A() [2/3]

◆ A() [3/3]

◆ AsABGR()

◆ AsARGB()

◆ AsBGRA()

◆ AsRGBA()

◆ B() [1/3]

◆ B() [2/3]

◆ B() [3/3]

◆ G() [1/3]

◆ G() [2/3]

◆ G() [3/3]

◆ HSV()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=()

◆ operator=()

◆ operator==()

◆ operator[]()

◆ R() [1/3]

◆ R() [2/3]

◆ R() [3/3]

◆ Reset()

◆ Set()

◆ SetFromABGR()

◆ SetFromARGB()

◆ SetFromBGRA()

◆ SetFromHSV()

◆ SetFromRGBA()

◆ SetFromYUV()

◆ YUV()

Member Data Documentation

◆ Black

◆ Blue

◆ Cyan

◆ Green

◆ Magenta

◆ Red

◆ White

◆ Yellow