#include <colorHSV.h>
Public Member Functions |
|
Constructors
|
|
ColorHSV () | |
Default Constructor. |
|
ColorHSV (const ColorHSV &color) | |
Copy constructor. |
|
ColorHSV (const ColorRGBA &color) | |
Constructor with ColorRGBA. |
|
ColorHSV (const char *value) throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) | |
Constructor with parameter char*.
|
|
ColorHSV (const String &value) throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) | |
Constructor with Parameter string.
|
|
ColorHSV (const ColorUnitHue &hue, const ColorUnit &saturation, const ColorUnit &value) | |
Detailed component initializing
constructor. |
|
Destructors
|
|
virtual | ~ColorHSV () |
Destructor. |
|
virtual void | clear () |
Explicit default initialization.
|
|
Converters
|
|
operator String () const | |
Conversion to string. |
|
Assignment
|
|
void | set (const ColorHSV &color) |
Assignment. |
|
const ColorHSV & | operator= (const ColorHSV &color) |
Assignment operator. |
|
void | set (const ColorRGBA &color) |
Assignment with ColorRGBA. |
|
const ColorHSV & | operator= (const ColorRGBA &color) |
Assignment operator with ColorRGBA. |
|
void | get (ColorRGBA &color) const |
Copying to ColorRGBA. |
|
void | set (const char *value) throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Assignment with char*. |
|
const ColorHSV & | operator= (const char *value) throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Assignment operator with char*.
|
|
void | get (char *value) const |
Copying to char*. |
|
void | set (const String &value) throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Assignment with string. |
|
const ColorHSV & | operator= (const String &value) throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Assignment operator with string.
|
|
void | get (String &value) const |
Copying to string. |
|
void | swap (ColorHSV &color) |
Swapping of colorHSVs. |
|
Accessors: inspectors and mutators
|
|
void | setHue (const ColorUnitHue &hue) |
Changes the value of the hue
component. |
|
ColorUnitHue & | getHue () |
Mutable inspection of the hue
component. |
|
const ColorUnitHue & | getHue () const |
Non-mutable inspection of the hue
component. |
|
void | setSaturation (const ColorUnit &saturation) |
Changes the value of the saturation
component. |
|
ColorUnit & | getSaturation () |
Mutable inspection of the saturation
component. |
|
const ColorUnit & | getSaturation () const |
Non-mutable inspection of the
saturation component. |
|
void | setValue (const ColorUnit &value) |
Changes the value of the value
component. |
|
ColorUnit & | getValue () |
Mutable inspection of the value
component. |
|
const ColorUnit & | getValue () const |
Non-mutable inspection of the value
component. |
|
void | set (const ColorUnitHue &hue, const ColorUnit &saturation, const ColorUnit &value) |
Changes the values of the hue,
saturation and value component. |
|
void | get (ColorUnitHue &hue, ColorUnit &saturation, ColorUnit &value) const |
Inspection of the colorHSV's
components. |
|
Predicates
|
|
bool | operator== (const ColorHSV &color) const |
Equality test. |
|
bool | operator!= (const ColorHSV &color) const |
Unequality test. |
|
bool | operator< (const ColorHSV &color) const |
Smaller test. |
|
bool | operator<= (const ColorHSV &color) const |
Smaller or equal test. |
|
bool | operator> (const ColorHSV &color) const |
Greater test. |
|
bool | operator>= (const ColorHSV &color) const |
Greater or equal test. |
|
debuggers and diagnostics
|
|
virtual void | dump (std::ostream &s=std::cout, Size depth=0) const |
Internal value dump. |
|
Friends |
|
Class friends
|
|
class | ColorRGBA |
Storers
|
|
std::istream & | operator>> (std::istream &s, ColorHSV &color) |
Friendly stream input. |
|
std::ostream & | operator<< (std::ostream &s, const ColorHSV &color) |
Friendly stream output. |
An instance of ColorHSV represents a color consisting of the components hue, saturation and value. The components staturation and values are ColorUnit 's. The component hue is of class type ColorUnitHue . See description of these classes for further informations concerning type conversions.
BALL::VIEW::ColorHSV::ColorHSV | ( | ) |
Default Constructor.
Constructs new colorHSV. Initialized with color black (hue=0, saturation=0, value=0).
BALL::VIEW::ColorHSV::ColorHSV | ( | const char * | value | ) | throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Constructor with parameter char*.
Constructs new colorHSV by initialising its value with the given pointer to a string representing a color value in hex format. The length of the string can either be 6 or 7 characters depending whether the hue component is 2 or 3 bytes long. See ColorUnitHue and ColorUnit for information concerning to string format.
value | the pointer to a string representing a color |
InvalidRange | if string length != 6 && string
length != 7 |
|
NotInHexFormat | if the string is not a valid hex format string |
BALL::VIEW::ColorHSV::ColorHSV | ( | const String & | value | ) | throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Constructor with Parameter string.
Constructs new ColorHSV by initialising its value with a string representing a color value in hex format. The length of the string can either be 6 or 7 characters depending whether the hue component is 2 or 3 bytes long. See ColorUnitHue and ColorUnit for information concerning to string format.
value | a string representing a color |
InvalidRange | if string length != 6 && string
length != 7 |
|
NotInHexFormat | if the string is not a valid hex format string |
BALL::VIEW::ColorHSV::ColorHSV | ( | const ColorUnitHue & | hue, | |
const ColorUnit & | saturation, | |||
const ColorUnit & | value | |||
) |
Detailed component initializing constructor.
hue | the hue component. See ColorUnitHue | |
saturation | the staturation component. See ColorUnit | |
value | the value component. See ColorUnit |
virtual void BALL::VIEW::ColorHSV::clear | ( | ) | [virtual] |
Explicit default initialization.
Sets the color of this colorHSV to the default color (black). The value of this colorHSV is:
virtual void BALL::VIEW::ColorHSV::dump | ( | std::ostream & | s =
std::cout , |
|
Size | depth =
0 |
|||
) | const [virtual] |
Internal value dump.
Dumps the current color of this colorHSV to the output ostream s with dumping depth depth.
s | output stream where to output the color of this colorHSV | |
depth | the dumping depth |
void BALL::VIEW::ColorHSV::get | ( | String & | value | ) | const |
Copying to string.
Calls set. The string value is initialized to the color of this colorHSV. The format of the string is the same as the one given to the constructor.
value | the string receiving the color in hex format |
void BALL::VIEW::ColorHSV::get | ( | char * | value | ) | const |
Copying to char*.
Calls set. The string value is initialized to the color of this colorHSV. At least 8 bytes must be allocated for the string. The format of the string is the same as the one given to the constructor.
value | the pointer to string (at least 8 bytes long) |
void BALL::VIEW::ColorHSV::get | ( | ColorRGBA & | color | ) | const |
Copying to ColorRGBA.
Calls set. The color of the colorRGBA color is initialized to the color of this colorHSV.
color | the colorRGBA to be assigned to |
const ColorUnitHue& BALL::VIEW::ColorHSV::getHue | ( | ) | const |
Non-mutable inspection of the hue component.
For further information see ColorUnitHue& getHue().
ColorUnitHue& BALL::VIEW::ColorHSV::getHue | ( | ) |
Mutable inspection of the hue component.
Accesses the mutual reference of the hue component of this colorHSV. See ColorUnitHue for further information concerning type conversion.
ColorUnit& BALL::VIEW::ColorHSV::getSaturation | ( | ) |
Mutable inspection of the saturation component.
const ColorUnit& BALL::VIEW::ColorHSV::getValue | ( | ) | const |
Non-mutable inspection of the value component.
For further information see ColorUnit& getValue().
BALL::VIEW::ColorHSV::operator String | ( | ) | const |
Conversion to string.
bool BALL::VIEW::ColorHSV::operator< | ( | const ColorHSV & | color | ) | const |
Smaller test.
Smaller means that all components of this are smaller than all the components of color colorHSV.
bool BALL::VIEW::ColorHSV::operator<= | ( | const ColorHSV & | color | ) | const |
Smaller or equal test.
Smaller or equal means that all components of this are smaller or equal than all the components of color colorHSV.
const ColorHSV& BALL::VIEW::ColorHSV::operator= | ( | const String & | value | ) | throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Assignment operator with string.
Assigns the color represented by the string value to this colorHSV. Calls set. See constructor for format description.
value | the color represented by a string |
InvalidRange | if string length != 6 && string
length != 7 |
|
NotInHexFormat | if the string is not a valid hex format string |
const ColorHSV& BALL::VIEW::ColorHSV::operator= | ( | const char * | value | ) | throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Assignment operator with char*.
Calls set. The color of this is initialized to the color represented by the string value. See constructor for format description.
value | the color represented by a string |
InvalidRange | if string length != 6 && string
length != 7 |
|
NotInHexFormat | if the string is not a valid hex format string |
Assignment operator.
Calls set.
bool BALL::VIEW::ColorHSV::operator> | ( | const ColorHSV & | color | ) | const |
Greater test.
Greater means that all components of this are greater than all the components of color colorHSV.
bool BALL::VIEW::ColorHSV::operator>= | ( | const ColorHSV & | color | ) | const |
Greater or equal test.
Greater or equal means that all components of this are greater or equal than all the components of color colorHSV.
void BALL::VIEW::ColorHSV::set | ( | const String & | value | ) | throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Assignment with string.
Assigns the color represented by the string value to this colorHSV. The color of this is initialized to the color represented by the string value. See constructor for format description.
value | the color represented by a string |
InvalidRange | if string length != 6 && string
length != 7 |
|
NotInHexFormat | if the string is not a valid hex format string |
void BALL::VIEW::ColorHSV::set | ( | const char * | value | ) | throw (Exception::InvalidRange, ColorUnit::NotInHexFormat) |
Assignment with char*.
The color of this is initialized to the color represented by the string value. See constructor for format description.
value | the color represented by a string |
InvalidRange | if string length != 6 && string
length != 7 |
|
NotInHexFormat | if the string is not a valid hex format string |
void BALL::VIEW::ColorHSV::set | ( | const ColorRGBA & | color | ) |
void BALL::VIEW::ColorHSV::setHue | ( | const ColorUnitHue & | hue | ) |
Changes the value of the hue component.
Changes the value of of the hue component of this colorHSV to the value represented by the parameter hue. See ColorUnitHue for further information concerning the format.
hue | the new hue component of this colorHSV |
void BALL::VIEW::ColorHSV::setSaturation | ( | const ColorUnit & | saturation | ) |
Changes the value of the saturation component.
std::ostream& operator<< | ( | std::ostream & | s, | |
const ColorHSV & | color | |||
) | [friend] |
Friendly stream output.
Writes colorHSV data to the output stream s and store the color of this. The color will be stored as an vector in integer format. The output will look like '(0-360, 0-255, 0-255)'. This method is provided for convienience.
s | output stream to where the color of this colorHSV will be stored | |
color | the colorHSV from which the color will be stored |
std::istream& operator>> | ( | std::istream & | s, | |
ColorHSV & | color | |||
) | [friend] |
Friendly stream input.
Reads colorHSV data from the input stream s and restore the color of this. The hue, saturation and value component are read as integers from the input stream. The method expects an vector as written as the one by the output stream operator. This method is provided for convienience.
s | input stream from where to restore the color of this colorHSV | |
color | the colorHSV to which the color will be restored |