hdi::core::ArtColor::Channels::HSB Struct Reference

Describes a set of HSB channels. More...

#include <hdicoreArtColor.h>

Collaboration diagram for hdi::core::ArtColor::Channels::HSB:

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

Public Attributes
Angle	hue
	Stores the HSB color hue channel.
double	saturation
	Stores the HSB color saturation channel, in the range [0.0,1.0].
double	brightness
	Stores the HSB color brightness channel, in the range [0.0,1.0].

Detailed Description

Describes a set of HSB channels.

Constructor & Destructor Documentation

HSB() [1/3]

hdi::core::ArtColor::Channels::HSB::HSB

(

)

Constructs a HSB object with default values.

Author

GW

Date

03/2015

HSB() [2/3]

hdi::core::ArtColor::Channels::HSB::HSB

(

const HSB &

obj_

)

Constructs a new HSB object from an existing HSB.

Author

GW

Date

03/2015

Parameters

obj_	Existing HSB object to copy values from

HSB() [3/3]

hdi::core::ArtColor::Channels::HSB::HSB	(	const Angle &	h_,
		const double	s_,
		const double	b_
	)

Constructs a new HSB object with the given values.

Author

GW

Date

03/2015

Parameters

h_	(See hue member description)
s_	(See saturation member description)
b_	(See brightness member description)

~HSB()

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

virtual

Destructs a HSB object.

Author

GW

Date

03/2015

Member Function Documentation

operator!=()

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

(

const HSB &

rhs_

)

const

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

Author

GW

Date

03/2015

Parameters

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

Returns

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

operator=()

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

(

const HSB &

rhs_

)

HSB assignment operator.

Author

GW

Date

03/2015

Parameters

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

Returns

The target HSB object, but with its values updated

operator==()

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

(

const HSB &

rhs_

)

const

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

Author

GW

Date

03/2015

Parameters

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

Returns

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