Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Member Functions | Public Attributes | List of all members
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:
Collaboration graph
[legend]

Public Member Functions

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

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

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

Constructs a HSB object with default values.

Author
GW
Date
03/2015
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
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)
virtual hdi::core::ArtColor::Channels::HSB::~HSB ( )
virtual

Destructs a HSB object.

Author
GW
Date
03/2015

Member Function Documentation

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