SUMO - Simulation of Urban MObility
RGBColor Class Reference

#include <RGBColor.h>

Collaboration diagram for RGBColor:
Collaboration graph

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 std::mt19937 * getColorRNG ()
 
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 RGBColor randomHue (double s=1, double v=1)
 Return color with random hue. 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)
 
static const RGBColor INVISIBLE = RGBColor(0, 0, 0, 0)
 

Private Attributes

unsigned char myAlpha
 
unsigned char myBlue
 
unsigned char myGreen
 
unsigned char myRed
 The color amounts. More...
 

Static Private Attributes

static std::mt19937 myRNG
 A random number generator to generate random colors independent of other randomness. 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 41 of file RGBColor.h.

Constructor & Destructor Documentation

◆ RGBColor() [1/3]

RGBColor::RGBColor ( )

Constructor.

Definition at line 64 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]redThe red component's value
[in]greenThe green component's value
[in]blueThe blue component's value

Definition at line 68 of file RGBColor.cpp.

◆ RGBColor() [3/3]

RGBColor::RGBColor ( const RGBColor col)

Copy constructor.

Definition at line 72 of file RGBColor.cpp.

◆ ~RGBColor()

RGBColor::~RGBColor ( )

Destructor.

Definition at line 76 of file RGBColor.cpp.

Member Function Documentation

◆ alpha()

◆ blue()

◆ changedBrightness()

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

Returns a new color with altered brightness.

Parameters
[in]changeThe absolute change applied to all channels (within bounds)
[in]changeThe number of colors to change
Returns
The new color

Definition at line 154 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(), GNETAZ::drawGL(), GNELane::drawGL(), GNEPoly::drawGL(), GNEEdge::drawGL(), and GUIPerson::drawGLAdditional().

◆ fromHSV()

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

Converts the given hsv-triplet to rgb.

Parameters
[in]hHue (0-360)
[in]sSaturation (0-1)
[in]vValue (0-1)
Returns
The color as RGB
Author
Alvy Ray Smith (http://www.alvyray.com/default.htm)

Definition at line 299 of file RGBColor.cpp.

References RGBColor().

Referenced by getColorRNG(), randomHue(), GUIContainer::setFunctionalColor(), GUIPerson::setFunctionalColor(), GUILane::setFunctionalColor(), GNELane::setFunctionalColor(), and GUIBaseVehicle::setFunctionalColor().

◆ getColorRNG()

static std::mt19937* RGBColor::getColorRNG ( )
inlinestatic

◆ green()

◆ 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]minColorThe color to interpolate from
[in]maxColorThe color to interpolate to
[in]weightThe weight of the first color
Returns
The interpolated color

Definition at line 283 of file RGBColor.cpp.

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

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

◆ invertedColor()

RGBColor RGBColor::invertedColor ( ) const

obtain inverted of current RGBColor

Definition at line 143 of file RGBColor.cpp.

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

Referenced by alpha(), GNETAZ::drawGL(), and GNEPoly::drawGL().

◆ operator!=()

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

Definition at line 137 of file RGBColor.cpp.

References myAlpha, myBlue, myGreen, and myRed.

Referenced by getColorRNG().

◆ operator==()

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

Definition at line 131 of file RGBColor.cpp.

References myAlpha, myBlue, myGreen, and myRed.

Referenced by getColorRNG().

◆ 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]coldefThe color definition to parse
Returns
The parsed color
Exceptions
EmptyDataIf the definition has less than three entries
NumberFormatExceptionIf one of the components is not numeric

Definition at line 177 of file RGBColor.cpp.

References BLACK, BLUE, CYAN, StringTokenizer::getVector(), GREEN, GREY, StringUtils::hexToInt(), MAGENTA, ORANGE, RED, RGBColor(), StringUtils::toDouble(), StringUtils::toInt(), WHITE, and YELLOW.

Referenced by PCTypeMap::add(), NLHandler::addDistrict(), GNEPolygonFrame::addPOI(), GNEPolygonFrame::addPOILane(), GNEPolygonFrame::addPolygon(), SUMOSAXAttributesImpl_Cached::getColor(), SUMOSAXAttributesImpl_Xerces::getColor(), getColorRNG(), PCLoaderVisum::load(), PCLoaderArcView::load(), PCLoaderDlrNavteq::loadPOIFile(), PCLoaderDlrNavteq::loadPolyFile(), PCLoaderXML::myStartElement(), GNEInspectorFrame::AttributesEditor::AttributeInput::onCmdOpenAttributeDialog(), GNEFrame::ACAttributeRow::onCmdSetColorAttribute(), GNETAZFrame::TAZParameters::onCmdSetColorAttribute(), GNEAttributeCarrier::parse(), parseColorReporting(), PCTypeMap::PCTypeMap(), and GUILane::setFunctionalColor().

◆ 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]coldefThe color definition to parse
[in]objecttypeThe type of the currently parsed object
[in]objectidThe id of the currently parsed object
[in]reportWhether errors shall be reported
[in,out]okWhether parsing was successful
Returns
The parsed color
Exceptions
EmptyDataIf the definition has less than three entries
NumberFormatExceptionIf one of the components is not numeric

Definition at line 257 of file RGBColor.cpp.

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

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

◆ randomHue()

RGBColor RGBColor::randomHue ( double  s = 1,
double  v = 1 
)
static

Return color with random hue.

Parameters
[in]sSaturation (0-1)
[in]vValue (0-1)
Returns
The color as RGB

Definition at line 334 of file RGBColor.cpp.

References fromHSV(), myRNG, and RandHelper::rand().

Referenced by GLHelper::debugVertices(), and getColorRNG().

◆ red()

◆ set()

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

assigns new values

Parameters
[in]rThe red component's value
[in]gThe green component's value
[in]bThe blue component's value
[in]aThe alpha component's value

Definition at line 80 of file RGBColor.cpp.

References myAlpha, myBlue, myGreen, and myRed.

Referenced by libsumo::Vehicle::remove(), and libsumo::Person::setParameter().

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]osThe stream to write to
[in]colThe color to write
Returns
The stream

Definition at line 89 of file RGBColor.cpp.

Referenced by getColorRNG().

Field Documentation

◆ BLACK

◆ BLUE

◆ CYAN

◆ DEFAULT_COLOR

const RGBColor RGBColor::DEFAULT_COLOR = RGBColor::YELLOW
static

◆ 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 201 of file RGBColor.h.

◆ GREEN

◆ GREY

◆ INVISIBLE

const RGBColor RGBColor::INVISIBLE = RGBColor(0, 0, 0, 0)
static

Definition at line 194 of file RGBColor.h.

Referenced by GLHelper::drawTextSettings().

◆ MAGENTA

◆ myAlpha

unsigned char RGBColor::myAlpha
private

◆ myBlue

unsigned char RGBColor::myBlue
private

◆ myGreen

unsigned char RGBColor::myGreen
private

◆ myRed

unsigned char RGBColor::myRed
private

The color amounts.

Definition at line 205 of file RGBColor.h.

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

◆ myRNG

std::mt19937 RGBColor::myRNG
staticprivate

A random number generator to generate random colors independent of other randomness.

Definition at line 208 of file RGBColor.h.

Referenced by getColorRNG(), and randomHue().

◆ ORANGE

◆ RED

◆ WHITE

◆ YELLOW


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