#include <RGBColor.h>

Collaboration diagram for RGBColor:

Public Member Functions
unsigned char	alpha () const
	Returns the alpha-amount of the color. More...

unsigned char	blue () const
	Returns the blue-amount of the color. More...

RGBColor	changedBrightness (int change, int toChange=3) const
	Returns a new color with altered brightness. More...

unsigned char	green () const
	Returns the green-amount of the color. More...

RGBColor	invertedColor () const
	obtain inverted of current RGBColor More...

bool	operator!= (const RGBColor &c) const

bool	operator== (const RGBColor &c) const

unsigned char	red () const
	Returns the red-amount of the color. More...

	RGBColor ()
	Constructor. More...

	RGBColor (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=255)
	Constructor. More...

	RGBColor (const RGBColor &col)
	Copy constructor. More...

void	set (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
	assigns new values More...

	~RGBColor ()
	Destructor. More...

Static Public Member Functions
static RGBColor	fromHSV (double h, double s, double v)
	Converts the given hsv-triplet to rgb. More...

static RGBColor	interpolate (const RGBColor &minColor, const RGBColor &maxColor, double weight)
	Interpolates between two colors. More...

static RGBColor	parseColor (std::string coldef)
	Parses a color information. More...

static RGBColor	parseColorReporting (const std::string &coldef, const std::string &objecttype, const char *objectid, bool report, bool &ok)
	Parses a color information. More...

Static Public Attributes
static const RGBColor	DEFAULT_COLOR = RGBColor::YELLOW
	The default color (for vehicle types and vehicles) More...

static const std::string	DEFAULT_COLOR_STRING = toString(RGBColor::DEFAULT_COLOR)
	The string description of the default color. More...


static const RGBColor	RED = RGBColor(255, 0, 0, 255)
	named colors More...

static const RGBColor	GREEN = RGBColor(0, 255, 0, 255)

static const RGBColor	BLUE = RGBColor(0, 0, 255, 255)

static const RGBColor	YELLOW = RGBColor(255, 255, 0, 255)

static const RGBColor	CYAN = RGBColor(0, 255, 255, 255)

static const RGBColor	MAGENTA = RGBColor(255, 0, 255, 255)

static const RGBColor	ORANGE = RGBColor(255, 128, 0, 255)

static const RGBColor	WHITE = RGBColor(255, 255, 255, 255)

static const RGBColor	BLACK = RGBColor(0, 0, 0, 255)

static const RGBColor	GREY = RGBColor(128, 128, 128, 255)

Private Attributes
unsigned char	myAlpha

unsigned char	myBlue

unsigned char	myGreen

unsigned char	myRed
	The color amounts. More...

Friends
std::ostream &	operator<< (std::ostream &os, const RGBColor &col)
	Writes the color to the given stream. More...

Detailed Description

The definition of a color in the RGB-space with an alpha channel. The cube is meant to lie between (0, 0, 0) and (255, 255, 255)

Definition at line 46 of file RGBColor.h.

Constructor & Destructor Documentation

◆ RGBColor() [1/3]

RGBColor::RGBColor ( )

Constructor.

Definition at line 66 of file RGBColor.cpp.

Referenced by fromHSV(), interpolate(), invertedColor(), parseColor(), and parseColorReporting().

◆ RGBColor() [2/3]

RGBColor::RGBColor	(	unsigned char	red,
		unsigned char	green,
		unsigned char	blue,
		unsigned char	alpha = `255`
	)

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 70 of file RGBColor.cpp.

◆ RGBColor() [3/3]

RGBColor::RGBColor ( const RGBColor & col )

Copy constructor.

Definition at line 74 of file RGBColor.cpp.

◆ ~RGBColor()

RGBColor::~RGBColor ( )

Destructor.

Definition at line 78 of file RGBColor.cpp.

Member Function Documentation

◆ alpha()

unsigned char RGBColor::alpha ( ) const

inline

Returns the alpha-amount of the color.

Returns: The alpha component's value

Definition at line 89 of file RGBColor.h.

References changedBrightness(), fromHSV(), interpolate(), invertedColor(), myAlpha, operator!=(), operator<<, operator==(), parseColor(), and parseColorReporting().

Referenced by GUILane::drawAsWaterway(), GLHelper::drawText(), libsumo::Person::getColor(), GUIJunctionWrapper::getColorValue(), MFXUtils::getFXColor(), GUISUMOAbstractView::makeSnapshot(), libsumo::Helper::makeTraCIColor(), GUISUMOAbstractView::onConfigure(), GUISUMOAbstractView::paintGL(), GLHelper::setColor(), and BinaryFormatter::writeAttr().

◆ blue()

unsigned char RGBColor::blue ( ) const

inline

Returns the blue-amount of the color.

Returns: The blue component's value

Definition at line 82 of file RGBColor.h.

References myBlue.

Referenced by changedBrightness(), GUILane::drawAsWaterway(), GLHelper::drawText(), GUIParameterTracker::GUIParameterTrackerPanel::drawValue(), libsumo::Person::getColor(), GUIJunctionWrapper::getColorValue(), MFXUtils::getFXColor(), GUISUMOAbstractView::makeSnapshot(), libsumo::Helper::makeTraCIColor(), GUISUMOAbstractView::onConfigure(), GUISUMOAbstractView::paintGL(), GLHelper::setColor(), and BinaryFormatter::writeAttr().

◆ changedBrightness()

RGBColor RGBColor::changedBrightness	(	int	change,
		int	toChange = `3`
	)		const

Returns a new color with altered brightness.

Parameters

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

Returns: The new color

Definition at line 156 of file RGBColor.cpp.

References blue(), changedBrightness(), green(), MAX2(), MIN2(), myAlpha, myBlue, myGreen, myRed, and red().

Referenced by alpha(), changedBrightness(), GUIPerson::drawAction_drawAsPoly(), GUIVehicle::drawAction_drawRailCarriages(), GUIBaseVehicle::drawAction_drawVehicleAsPoly(), GNEPoly::drawGL(), and GUIPerson::drawGLAdditional().

◆ fromHSV()

RGBColor RGBColor::fromHSV	(	double	h,
		double	s,
		double	v
	)

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 301 of file RGBColor.cpp.

References RGBColor().

Referenced by alpha(), GLHelper::debugVertices(), GUIEdge::setFunctionalColor(), GUIContainer::setFunctionalColor(), GNELane::setFunctionalColor(), GUIPerson::setFunctionalColor(), GUILane::setFunctionalColor(), and GUIBaseVehicle::setFunctionalColor().

◆ green()

unsigned char RGBColor::green ( ) const

inline

Returns the green-amount of the color.

Returns: The green component's value

Definition at line 75 of file RGBColor.h.

References myGreen.

Referenced by changedBrightness(), GUILane::drawAsWaterway(), GLHelper::drawText(), GUIParameterTracker::GUIParameterTrackerPanel::drawValue(), libsumo::Person::getColor(), GUIJunctionWrapper::getColorValue(), MFXUtils::getFXColor(), GUISUMOAbstractView::makeSnapshot(), libsumo::Helper::makeTraCIColor(), GUISUMOAbstractView::onConfigure(), GUISUMOAbstractView::paintGL(), GLHelper::setColor(), and BinaryFormatter::writeAttr().

◆ interpolate()

RGBColor RGBColor::interpolate	(	const RGBColor &	minColor,
		const RGBColor &	maxColor,
		double	weight
	)

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 285 of file RGBColor.cpp.

References myAlpha, myBlue, myGreen, myRed, and RGBColor().

Referenced by alpha(), and GUIPropertyScheme< T >::interpolate().

◆ invertedColor()

RGBColor RGBColor::invertedColor ( ) const

obtain inverted of current RGBColor

Definition at line 145 of file RGBColor.cpp.

References myAlpha, myBlue, myGreen, myRed, and RGBColor().

Referenced by alpha(), GNEPOI::drawGL(), GNEPOILane::drawGL(), and GNEPoly::drawGL().

◆ operator!=()

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

Definition at line 139 of file RGBColor.cpp.

References myAlpha, myBlue, myGreen, and myRed.

Referenced by alpha().

◆ operator==()

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

Definition at line 133 of file RGBColor.cpp.

References myAlpha, myBlue, myGreen, and myRed.

Referenced by alpha().

◆ parseColor()

RGBColor RGBColor::parseColor ( std::string coldef )

static

Parses a color information.

It is assumed that the color is stored as "<RED>,<GREEN>,<BLUE>" and each color is represented as a double. Alternatively the color can be stored as "<RED>,<GREEN>,<BLUE>,<ALPHA>" and each color is represented as an unsigned byte.

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 179 of file RGBColor.cpp.

References TplConvert::_2double(), TplConvert::_2int(), TplConvert::_hex2int(), BLACK, BLUE, CYAN, StringTokenizer::getVector(), GREEN, GREY, MAGENTA, ORANGE, RED, RGBColor(), WHITE, and YELLOW.

Referenced by PCTypeMap::add(), NLHandler::addDistrict(), GNEPolygonFrame::addPOI(), GNEPolygonFrame::addPOILane(), GNEPolygonFrame::addPolygon(), alpha(), SUMOSAXAttributesImpl_Cached::getColor(), SUMOSAXAttributesImpl_Xerces::getColor(), PCLoaderVisum::load(), PCLoaderArcView::load(), PCLoaderDlrNavteq::loadPOIFile(), PCLoaderDlrNavteq::loadPolyFile(), PCLoaderXML::myStartElement(), GNEPolygonFrame::ShapeAttributeSingle::onCmdSetColorAttribute(), GNEAttributeCarrier::parse(), parseColorReporting(), and PCTypeMap::PCTypeMap().

◆ parseColorReporting()

RGBColor RGBColor::parseColorReporting	(	const std::string &	coldef,
		const std::string &	objecttype,
		const char *	objectid,
		bool	report,
		bool &	ok
	)

static

Parses a color information.

It is assumed that the color is stored as "<RED>,<GREEN>,<BLUE>" and each color is represented as a double. Alternatively the color can be stored as "<RED>,<GREEN>,<BLUE>,<ALPHA>" and each color is represented as an unsigned byte.

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

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 259 of file RGBColor.cpp.

References parseColor(), RGBColor(), UNUSED_PARAMETER, and WRITE_ERROR.

Referenced by alpha(), GUISettingsHandler::myStartElement(), and GUISettingsHandler::parseTextSettings().

◆ red()

unsigned char RGBColor::red ( ) const

inline

Returns the red-amount of the color.

Returns: The red component's value

Definition at line 68 of file RGBColor.h.

References myRed.

Referenced by changedBrightness(), GUILane::drawAsWaterway(), GLHelper::drawText(), GUIParameterTracker::GUIParameterTrackerPanel::drawValue(), libsumo::Person::getColor(), GUIJunctionWrapper::getColorValue(), MFXUtils::getFXColor(), GUISUMOAbstractView::makeSnapshot(), libsumo::Helper::makeTraCIColor(), GUISUMOAbstractView::onConfigure(), GUISUMOAbstractView::paintGL(), GLHelper::setColor(), and BinaryFormatter::writeAttr().

◆ set()

void RGBColor::set	(	unsigned char	r,
		unsigned char	g,
		unsigned char	b,
		unsigned char	a
	)

assigns new values

Parameters

[in]	r	The red component's value
[in]	g	The green component's value
[in]	b	The blue component's value
[in]	a	The alpha component's value

Definition at line 82 of file RGBColor.cpp.

References myAlpha, myBlue, myGreen, and myRed.

Referenced by TraCIServerAPI_Vehicle::processSet(), and libsumo::Vehicle::setColor().

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const RGBColor &	col
	)

friend

Writes the color to the given stream.

Parameters

[out]	os	The stream to write to
[in]	col	The color to write

Returns: The stream

Definition at line 91 of file RGBColor.cpp.

Referenced by alpha().

Field Documentation

◆ BLACK

const RGBColor RGBColor::BLACK = RGBColor(0, 0, 0, 255)

static

Definition at line 186 of file RGBColor.h.

Referenced by GUISUMOAbstractView::displayLegend(), GNEDetectorE1::drawGL(), GNEDetectorE2::drawGL(), GUICalibrator::drawGL(), GNERerouter::drawGL(), GNECalibrator::drawGL(), GUITriggeredRerouter::GUITriggeredRerouterEdge::drawGL(), GUIParameterTracker::GUIParameterTrackerPanel::drawValue(), GUIVisualizationSettings::initNeteditDefaults(), GUIVisualizationSettings::initSumoGuiDefaults(), NIImporter_Vissim::NIImporter_Vissim(), GUIParam_PopupMenuInterface::onCmdOpenTracker(), parseColor(), and GUISUMOAbstractView::showToolTipFor().

◆ BLUE

const RGBColor RGBColor::BLUE = RGBColor(0, 0, 255, 255)

static

Definition at line 180 of file RGBColor.h.

Referenced by AGActivityTripWriter::AGActivityTripWriter(), GUIViewTraffic::buildColorRainbow(), GNEViewNet::buildColorRainbow(), GNEViewNet::doPaintGL(), GUIVisualizationSettings::initNeteditDefaults(), GUIVisualizationSettings::initSumoGuiDefaults(), parseColor(), RODFDetectorCon::saveAsPOIs(), and NBSign::writeAsPOI().

◆ CYAN

const RGBColor RGBColor::CYAN = RGBColor(0, 255, 255, 255)

static

Definition at line 182 of file RGBColor.h.

Referenced by GUIViewTraffic::buildColorRainbow(), GNEViewNet::buildColorRainbow(), GNEConnectorFrame::GNEConnectorFrame(), GUIVisualizationSettings::initNeteditDefaults(), GUIVisualizationSettings::initSumoGuiDefaults(), NIImporter_Vissim::NIImporter_Vissim(), and parseColor().

◆ DEFAULT_COLOR

const RGBColor RGBColor::DEFAULT_COLOR = RGBColor::YELLOW

static

The default color (for vehicle types and vehicles)

Definition at line 191 of file RGBColor.h.

Referenced by MSRoute::getColor(), SUMOVehicleParserHelper::parseCommonAttributes(), MSBaseVehicle::replaceRouteEdges(), MSTriggeredRerouter::rerouteParkingArea(), and GUIBaseVehicle::setFunctionalColor().

◆ DEFAULT_COLOR_STRING

const std::string RGBColor::DEFAULT_COLOR_STRING = toString(RGBColor::DEFAULT_COLOR)

static

The string description of the default color.

Definition at line 194 of file RGBColor.h.

◆ GREEN

const RGBColor RGBColor::GREEN = RGBColor(0, 255, 0, 255)

static

Definition at line 179 of file RGBColor.h.

Referenced by GNENet::addPolygonForEditShapes(), AGActivityTripWriter::AGActivityTripWriter(), GUIViewTraffic::buildColorRainbow(), GNEViewNet::buildColorRainbow(), GNECrossingFrame::crossingParameters::crossingParameters(), GUIBaseVehicle::drawLinkItem(), GNEConnectorFrame::GNEConnectorFrame(), GUIVisualizationSettings::initNeteditDefaults(), GUIVisualizationSettings::initSumoGuiDefaults(), NIImporter_Vissim::NIImporter_Vissim(), GUIApplicationWindow::onCmdGaming(), parseColor(), and RODFDetectorCon::saveAsPOIs().

◆ GREY

const RGBColor RGBColor::GREY = RGBColor(128, 128, 128, 255)

static

Definition at line 187 of file RGBColor.h.

Referenced by GUIBaseVehicle::drawAction_drawVehicleAsPoly(), GUIVisualizationSettings::initNeteditDefaults(), GUIVisualizationSettings::initSumoGuiDefaults(), NIImporter_Vissim::NIImporter_Vissim(), parseColor(), and NBSign::writeAsPOI().

◆ MAGENTA

const RGBColor RGBColor::MAGENTA = RGBColor(255, 0, 255, 255)

static

Definition at line 183 of file RGBColor.h.

Referenced by GUIViewTraffic::buildColorRainbow(), GNEViewNet::buildColorRainbow(), GNEViewNet::doPaintGL(), GNEConnectorFrame::GNEConnectorFrame(), GUIVisualizationSettings::initNeteditDefaults(), GUIVisualizationSettings::initSumoGuiDefaults(), NIImporter_Vissim::NIImporter_Vissim(), and parseColor().

◆ myAlpha

unsigned char RGBColor::myAlpha

private

Definition at line 198 of file RGBColor.h.

Referenced by alpha(), changedBrightness(), interpolate(), invertedColor(), operator!=(), operator<<(), operator==(), and set().

◆ myBlue

unsigned char RGBColor::myBlue

private

Definition at line 198 of file RGBColor.h.

Referenced by blue(), changedBrightness(), interpolate(), invertedColor(), operator!=(), operator<<(), operator==(), and set().

◆ myGreen

unsigned char RGBColor::myGreen

private

Definition at line 198 of file RGBColor.h.

Referenced by changedBrightness(), green(), interpolate(), invertedColor(), operator!=(), operator<<(), operator==(), and set().

◆ myRed

unsigned char RGBColor::myRed

private

The color amounts.

Definition at line 198 of file RGBColor.h.

Referenced by changedBrightness(), interpolate(), invertedColor(), operator!=(), operator<<(), operator==(), red(), and set().

◆ ORANGE

const RGBColor RGBColor::ORANGE = RGBColor(255, 128, 0, 255)

static

Definition at line 184 of file RGBColor.h.

Referenced by GUIViewTraffic::buildColorRainbow(), GNEViewNet::buildColorRainbow(), GUIVisualizationSettings::initNeteditDefaults(), GUIVisualizationSettings::initSumoGuiDefaults(), and parseColor().

◆ RED

const RGBColor RGBColor::RED = RGBColor(255, 0, 0, 255)

static

named colors

Definition at line 178 of file RGBColor.h.

Referenced by AGActivityTripWriter::AGActivityTripWriter(), GUIViewTraffic::buildColorRainbow(), GNEViewNet::buildColorRainbow(), GNEViewNet::doPaintGL(), GUIVisualizationSettings::initNeteditDefaults(), GUIVisualizationSettings::initSumoGuiDefaults(), NIImporter_Vissim::NIImporter_Vissim(), GUIApplicationWindow::onCmdGaming(), parseColor(), RODFDetectorCon::saveAsPOIs(), and NBSign::writeAsPOI().

◆ WHITE

const RGBColor RGBColor::WHITE = RGBColor(255, 255, 255, 255)

static

Definition at line 185 of file RGBColor.h.

Referenced by GNEDetectorE1::drawGL(), GNEVaporizer::drawGL(), GNERouteProbe::drawGL(), GUITLLogicPhasesTrackerWindow::drawValues(), GUIVisualizationSettings::initSumoGuiDefaults(), NIImporter_Vissim::NIImporter_Vissim(), and parseColor().

◆ YELLOW

const RGBColor RGBColor::YELLOW = RGBColor(255, 255, 0, 255)

static

Definition at line 181 of file RGBColor.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), GUIViewTraffic::buildColorRainbow(), GNEViewNet::buildColorRainbow(), GNEConnectorFrame::GNEConnectorFrame(), GUIVisualizationSettings::initNeteditDefaults(), GUIVisualizationSettings::initSumoGuiDefaults(), NIImporter_Vissim::NIImporter_Vissim(), parseColor(), and NBSign::writeAsPOI().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ RGBColor() [1/3]

◆ RGBColor() [2/3]

◆ RGBColor() [3/3]

◆ ~RGBColor()

Member Function Documentation

◆ alpha()

◆ blue()

◆ changedBrightness()

◆ fromHSV()

◆ green()

◆ interpolate()

◆ invertedColor()

◆ operator!=()

◆ operator==()

◆ parseColor()

◆ parseColorReporting()

◆ red()

◆ set()

Friends And Related Function Documentation

◆ operator<<

Field Documentation

◆ BLACK

◆ BLUE

◆ CYAN

◆ DEFAULT_COLOR

◆ DEFAULT_COLOR_STRING

◆ GREEN

◆ GREY

◆ MAGENTA

◆ myAlpha

◆ myBlue

◆ myGreen

◆ myRed

◆ ORANGE

◆ RED

◆ WHITE

◆ YELLOW