#include <RGBColor.h>

Inheritance diagram for RGBColor:

Public Member Functions
SUMOReal	blue () const throw ()
	Returns the blue-amount of the color.
RGBColor	changedBrightness (SUMOReal change)
	Returns a new color with altered brightness.
SUMOReal	green () const throw ()
	Returns the green-amount of the color.
bool	operator!= (const RGBColor &c) const
bool	operator== (const RGBColor &c) const
SUMOReal	red () const throw ()
	Returns the red-amount of the color.
	RGBColor (const RGBColor &col) throw ()
	Copy constructor.
	RGBColor () throw ()
	Constructor.
	RGBColor (SUMOReal red, SUMOReal green, SUMOReal blue) throw ()
	Constructor.
void	set (SUMOReal r, SUMOReal g, SUMOReal b) throw ()
	assigns new values
	~RGBColor () throw ()
	Destructor.
Static Public Member Functions
static RGBColor	fromHSV (SUMOReal h, SUMOReal s, SUMOReal v) throw ()
	Converts the given hsv-triplet to rgb.
static RGBColor	getDefaultColor () throw ()
	Returns the default color by parsing DEFAULT_COLOR_STRING.
static RGBColor	interpolate (const RGBColor &minColor, const RGBColor &maxColor, SUMOReal weight) throw ()
	Interpolates between two colors.
static RGBColor	parseColor (const std::string &coldef) throw (EmptyData, NumberFormatException)
	Parses a color information.
static RGBColor	parseColorReporting (const std::string &coldef, const std::string &objecttype, const char *objectid, bool report, bool &ok) throw ()
	Parses a color information.
Static Public Attributes
static const RGBColor	DEFAULT_COLOR = RGBColor::parseColor(RGBColor::DEFAULT_COLOR_STRING)
	The default color (for vehicle types and vehicles)
static const std::string	DEFAULT_COLOR_STRING = "1,1,0"
	The string description of the default color.
Private Attributes
SUMOReal	myBlue
SUMOReal	myGreen
SUMOReal	myRed
	The color amounts.
Friends
std::ostream &	operator<< (std::ostream &os, const RGBColor &col)
	Writes the color to the given stream.

Detailed Description

The definition of a color in the RGB-space. The cube is meant to lie between (0, 0, 0) and (1, 1, 1)

Definition at line 44 of file RGBColor.h.

Constructor & Destructor Documentation

RGBColor::RGBColor ( ) throw ()

Constructor.

Definition at line 54 of file RGBColor.cpp.

Referenced by changedBrightness().

RGBColor::RGBColor	(	SUMOReal	red,
		SUMOReal	green,
		SUMOReal	blue
	)		throw ()

Constructor.

Parameters:

[in]	red	The red component's value
[in]	green	The green component's value
[in]	blue	The blue component's value

Definition at line 58 of file RGBColor.cpp.

RGBColor::RGBColor ( const RGBColor & col ) throw ()

Copy constructor.

Definition at line 62 of file RGBColor.cpp.

RGBColor::~RGBColor ( ) throw ()

Destructor.

Definition at line 66 of file RGBColor.cpp.

Member Function Documentation

SUMOReal RGBColor::blue ( ) const throw () [inline]

Returns the blue-amount of the color.

Returns:: The red component's value

Definition at line 88 of file RGBColor.h.

References myBlue.

Referenced by changedBrightness(), GUIDialog_ViewSettings::convert(), MFXUtils::getFXColor(), TraCIServerAPI_VehicleType::getVariable(), GUISUMOAbstractView::makeSnapshot(), GUISUMOAbstractView::onConfigure(), GUISUMOAbstractView::paintGL(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Polygon::processGet(), TraCIServerAPI_POI::processGet(), MSVehicleType::saveState(), and GLHelper::setColor().

RGBColor RGBColor::changedBrightness ( SUMOReal change )

Returns a new color with altered brightness.

Parameters:

[in] change The absolute change applied to all channels (within bounds)

Returns:: The new color

Definition at line 103 of file RGBColor.cpp.

References blue(), green(), MAX2(), MIN2(), myBlue, myGreen, myRed, red(), RGBColor(), and SUMOReal.

Referenced by drawAction_drawVehicleAsPoly().

RGBColor RGBColor::fromHSV	(	SUMOReal	h,
		SUMOReal	s,
		SUMOReal	v
	)		throw () `[static]`

Converts the given hsv-triplet to rgb.

Parameters:

[in]	h	Hue (0-360)
[in]	s	Saturation (0-1)
[in]	v	Value (0-1)

Returns:: The color as RGB

Author:: Alvy Ray Smith (http://www.alvyray.com/default.htm)

Definition at line 172 of file RGBColor.cpp.

Referenced by GUIVehicle::setFunctionalColor().

RGBColor RGBColor::getDefaultColor ( ) throw () [static]

Returns the default color by parsing DEFAULT_COLOR_STRING.

Returns:: The default color

Definition at line 151 of file RGBColor.cpp.

References DEFAULT_COLOR_STRING, and parseColor().

Referenced by MSRouteHandler::openRoute().

SUMOReal RGBColor::green ( ) const throw () [inline]

Returns the green-amount of the color.

Returns:: The red component's value

Definition at line 80 of file RGBColor.h.

References myGreen.

Referenced by changedBrightness(), GUIDialog_ViewSettings::convert(), MFXUtils::getFXColor(), TraCIServerAPI_VehicleType::getVariable(), GUISUMOAbstractView::makeSnapshot(), GUISUMOAbstractView::onConfigure(), GUISUMOAbstractView::paintGL(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Polygon::processGet(), TraCIServerAPI_POI::processGet(), MSVehicleType::saveState(), and GLHelper::setColor().

RGBColor RGBColor::interpolate	(	const RGBColor &	minColor,
		const RGBColor &	maxColor,
		SUMOReal	weight
	)		throw () `[static]`

Interpolates between two colors.

The interpolated color is calculated as a weighted average of the RGB values of minColor and maxColor, giving weight to maxColor and 1-weight to minColor.

Parameters:

[in]	minColor	The color to interpolate from
[in]	maxColor	The color to interpolate to
[in]	weight	The weight of the first color

Returns:: The interpolated color

Definition at line 157 of file RGBColor.cpp.

References SUMOReal.

Referenced by GUIColorScheme::getColor().

bool RGBColor::operator!= ( const RGBColor & c ) const

Definition at line 96 of file RGBColor.cpp.

References myBlue, myGreen, and myRed.

bool RGBColor::operator== ( const RGBColor & c ) const

Definition at line 89 of file RGBColor.cpp.

References myBlue, myGreen, and myRed.

RGBColor RGBColor::parseColor ( const std::string & coldef ) throw (EmptyData, NumberFormatException) [static]

Parses a color information.

It is assumed that the color is stored as "<RED>,<GREEN>,<BLUE>" And each color is represented as a SUMOReal.

Parameters:

[in] coldef The color definition to parse

Returns:: The parsed color

Exceptions:

EmptyData	If the definition has less than three entries
NumberFormatException	If one of the components is not numeric

Definition at line 112 of file RGBColor.cpp.

References TplConvert< E >::_2SUMOReal(), StringTokenizer::next(), StringTokenizer::size(), and SUMOReal.

Referenced by getDefaultColor(), PCLoaderVisum::load(), PCLoaderArcView::load(), PCLoaderOSM::loadIfSet(), PCLoaderDlrNavteq::loadPOIFile(), PCLoaderDlrNavteq::loadPolyFile(), PCLoaderXML::myStartElement(), and SUMOVehicleParserHelper::parseCommonAttributes().

RGBColor RGBColor::parseColorReporting	(	const std::string &	coldef,
		const std::string &	objecttype,
		const char *	objectid,
		bool	report,
		bool &	ok
	)		throw () `[static]`

Parses a color information.

It is assumed that the color is stored as "<RED>,<GREEN>,<BLUE>" And each color is represented as a SUMOReal.

Parameters:

[in]	coldef	The color definition to parse
[in]	objecttype	The type of the currently parsed object
[in]	objectid	The id of the currently parsed object
[in]	report	Whether errors shall be reported
[in,out]	ok	Whether parsing was successful