hdi::core::ArtColor::Channels::RGB Struct Reference

Describes a set of RGB channels. More...

#include <hdicoreArtColor.h>

Public Member Functions
()	RGB ()
	Constructs an RGB object with default values.
()	RGB (const RGB &obj_)
	Constructs a new RGB object from an existing RGB.
()	RGB (const double r_, const double g_, const double b_)
	Constructs a new RGB object with the given values.
virtual	~RGB ()
	Destructs an RGB object.
RGB &	operator= (const RGB &rhs_)
	RGB assignment operator.
bool	operator== (const RGB &rhs_) const
	Tests whether a given RGB object is the same as another.
bool	operator!= (const RGB &rhs_) const
	Tests whether a given RGB object is not the same as another.

Public Attributes
double	red
	Stores the RGB color red channel, in the range [0.0,1.0].
double	green
	Stores the RGB color green channel, in the range [0.0,1.0].
double	blue
	Stores the RGB color blue channel, in the range [0.0,1.0].

Detailed Description

Describes a set of RGB channels.

Constructor & Destructor Documentation

RGB() [1/3]

() hdi::core::ArtColor::Channels::RGB::RGB

(

)

Constructs an RGB object with default values.

Author

GW

Date

07/2014

RGB() [2/3]

() hdi::core::ArtColor::Channels::RGB::RGB

(

const RGB &

obj_

)

Constructs a new RGB object from an existing RGB.

Author

GW

Date

07/2014

Parameters

obj_	Existing RGB object to copy values from

RGB() [3/3]

() hdi::core::ArtColor::Channels::RGB::RGB	(	const double	r_,
		const double	g_,
		const double	b_
	)

Constructs a new RGB object with the given values.

Author

GW

Date

07/2014

Parameters

r_	(See red member description)
g_	(See green member description)
b_	(See blue member description)

~RGB()

virtual hdi::core::ArtColor::Channels::RGB::~RGB ( )

virtual

Destructs an RGB object.

Author

GW

Date

07/2014

Member Function Documentation

operator!=()

bool hdi::core::ArtColor::Channels::RGB::operator!=

(

const RGB &

rhs_

)

const

Tests whether a given RGB object is not the same as another.

Author

GW

Date

03/2015

Parameters

rhs_	RGB to compare against (righthand side of inequality operator)

Returns

true for the target and rhs_ being different colors, false otherwise

operator=()

RGB & hdi::core::ArtColor::Channels::RGB::operator=

(

const RGB &

rhs_

)

RGB assignment operator.

Author

GW

Date

07/2014

Parameters

rhs_	Existing RGB object to copy values from (righthand side of the assignment operator)

Returns

The target RGB object, but with its values updated

operator==()

bool hdi::core::ArtColor::Channels::RGB::operator==

(

const RGB &

rhs_

)

const

Tests whether a given RGB object is the same as another.

Author

GW

Date

03/2015

Parameters

rhs_	RGB to compare against (righthand side of equality operator)

Returns

true for the target and rhs_ being the same colors, false otherwise