![]() |
Visual Servoing Platform
version 3.3.0
|
#include <vpColor.h>
Public Types | |
enum | vpColorIdentifier { id_black = 0, id_white, id_lightGray, id_gray, id_darkGray, id_lightRed, id_red, id_darkRed, id_lightGreen, id_green, id_darkGreen, id_lightBlue, id_blue, id_darkBlue, id_yellow, id_cyan, id_orange, id_purple, id_unknown } |
enum | AlphaDefault { alpha_default = 255 } |
Public Member Functions | |
vpColor () | |
vpColor (unsigned char r, unsigned char g, unsigned char b, vpColor::vpColorIdentifier cid=vpColor::id_unknown) | |
virtual | ~vpColor () |
void | setColor (unsigned char r, unsigned char g, unsigned char b) |
bool | operator== (const vpRGBa &v) |
bool | operator!= (const vpRGBa &v) |
vpColVector | operator- (const vpRGBa &v) const |
vpColVector | operator- (const vpColVector &v) const |
vpRGBa | operator+ (const vpRGBa &v) const |
vpColVector | operator+ (const vpColVector &v) const |
vpColVector | operator* (const float &v) const |
vpColVector | operator* (const double &v) const |
bool | operator< (const vpRGBa &v) const |
bool | operator> (const vpRGBa &v) const |
Static Public Member Functions | |
static vpColor | getColor (const unsigned int &i) |
Public Attributes | |
vpColorIdentifier | id |
unsigned char | R |
unsigned char | G |
unsigned char | B |
unsigned char | A |
Static Public Attributes | |
static const vpColor | black = vpColor(0, 0, 0, id_black) |
static const vpColor | white = vpColor(255, 255, 255, id_white) |
static const vpColor | lightGray = vpColor(192, 192, 192, id_lightGray) |
static const vpColor | gray = vpColor(128, 128, 128, id_gray) |
static const vpColor | darkGray = vpColor(64, 64, 64, id_darkGray) |
static const vpColor | lightRed = vpColor(255, 140, 140, id_lightRed) |
static const vpColor | red = vpColor(255, 0, 0, id_red) |
static const vpColor | darkRed = vpColor(128, 0, 0, id_darkRed) |
static const vpColor | lightGreen = vpColor(140, 255, 140, id_lightGreen) |
static const vpColor | green = vpColor(0, 255, 0, id_green) |
static const vpColor | darkGreen = vpColor(0, 128, 0, id_darkGreen) |
static const vpColor | lightBlue = vpColor(140, 140, 255, id_lightBlue) |
static const vpColor | blue = vpColor(0, 0, 255, id_blue) |
static const vpColor | darkBlue = vpColor(0, 0, 128, id_darkBlue) |
static const vpColor | yellow = vpColor(255, 255, 0, id_yellow) |
static const vpColor | cyan = vpColor(0, 255, 255, id_cyan) |
static const vpColor | orange = vpColor(255, 165, 0, id_orange) |
static const vpColor | purple = vpColor(128, 0, 128, id_purple) |
static const vpColor | none = vpColor(0, 0, 0, id_unknown) |
static const unsigned int | nbColors = 18 |
static const vpColor | allColors [] |
Friends | |
VISP_EXPORT bool | operator== (const vpColor &c1, const vpColor &c2) |
VISP_EXPORT bool | operator!= (const vpColor &c1, const vpColor &c2) |
Related Functions | |
(Note that these are not member functions.) | |
VISP_EXPORT std::ostream & | operator<< (std::ostream &os, const vpRGBa &rgba) |
Class to define colors available for display functionnalities.
You may use predefined colors (black, white, red, green, blue, cyan and orange) or specify your own color by settings its R,G,B values.
An identifier vpColorIdentifier is associated to each color. This identifier is useful to determine if a color is predefined or specified by it R,G,B values. In that last case, the identifier is always set to vpColor::id_unknown.
The example below shows how to display geometric features in a display overlay using predefined colors (here the blue color to draw a circle) and a specific brown color (used to draw a rectangle).
|
inherited |
Predefined colors identifier.
Enumerator | |
---|---|
id_black | Identifier associated to the predefined vpColor::black color. |
id_white | Identifier associated to the predefined vpColor::white color. |
id_lightGray | Identifier associated to the predefined vpColor::lightGray color. |
id_gray | Identifier associated to the predefined vpColor::gray color. |
id_darkGray | Identifier associated to the predefined vpColor::darkGray color. |
id_lightRed | Identifier associated to the predefined vpColor::lightRed color. |
id_red | Identifier associated to the predefined vpColor::red color. |
id_darkRed | Identifier associated to the predefined vpColor::darkRed color. |
id_lightGreen | Identifier associated to the predefined vpColor::lightGreen color. |
id_green | Identifier associated to the predefined vpColor::green color. |
id_darkGreen | Identifier associated to the predefined vpColor::darkGreen color. |
id_lightBlue | Identifier associated to the predefined vpColor::lightBlue color. |
id_blue | Identifier associated to the predefined vpColor::blue color. |
id_darkBlue | Identifier associated to the predefined vpColor::darkBlue color. |
id_yellow | Identifier associated to the predefined vpColor::yellow color. |
id_cyan | Identifier associated to the predefined vpColor::cyan color. |
id_orange | Identifier associated to the predefined vpColor::orange color. |
id_purple | Identifier associated to the predefined vpColor::purple color. |
id_unknown | Identifier associated to unknowned colors. By unknowned, we mean not a predefined color. This identifier can also be used to know the number of predefined colors. |
|
inline |
Default constructor. All the colors components are set to zero.
The color identifier is set to vpColor::id_unknown to indicate that this color is not a predefined one.
|
inline |
|
inlinevirtual |
|
inlinestatic |
Get a predefined color
i | : color indice |
Definition at line 248 of file vpColor.h.
References allColors, and nbColors.
Referenced by vpIoTools::readConfigVar().
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 229 of file vpRGBa.cpp.
|
inherited |
|
inherited |
Definition at line 237 of file vpRGBa.cpp.
|
inline |
Set a color from its RGB values.
r | : Red component. |
g | : Green component. |
b | : Blue component. |
The color identifier is set to vpColor::id_unknown to indicate that this color is not a predefined one.
Compare two colors.
Return true if the R,G,B components are different.
c1,c2 | : Color to compare. |
Definition at line 147 of file vpColor.cpp.
|
related |
Writes the RGBA values to the stream os, and returns a reference to the stream. The coordinates are separated by a comma.
The following code prints the intensity of the pixel in the middle of the image:
Definition at line 269 of file vpRGBa.cpp.
Compare two colors.
Return true if the R,G,B components are the same.
c1,c2 | : Color to compare. |
Definition at line 134 of file vpColor.cpp.
|
inherited |
Additionnal component.
Definition at line 151 of file vpRGBa.h.
Referenced by vp::adjust(), vpImageConvert::convert(), vpDisplayX::displayImage(), vpDisplayX::displayImageROI(), vp::gammaCorrection(), vpRGBa::operator!=(), vpRGBa::operator*(), vpRGBa::operator+(), vpRGBa::operator-(), vpRGBa::operator<<(), vpRGBa::operator=(), vpRGBa::operator==(), and vp::stretchContrast().
|
static |
|
inherited |
Blue component.
Definition at line 150 of file vpRGBa.h.
Referenced by vp::adjust(), vpDisplayX::clearDisplay(), vpImageConvert::convert(), vpDisplayGTK::displayCharString(), vpDisplayX::displayCharString(), vpDisplayOpenCV::displayCharString(), vpDisplayGTK::displayCircle(), vpDisplayX::displayCircle(), vpDisplayOpenCV::displayCircle(), vpDisplayGTK::displayDotLine(), vpDisplayX::displayDotLine(), vpDisplayX::displayImage(), vpDisplayOpenCV::displayImage(), vpDisplayX::displayImageROI(), vpDisplayOpenCV::displayImageROI(), vpDisplayGTK::displayLine(), vpDisplayX::displayLine(), vpDisplayOpenCV::displayLine(), vpDisplayGTK::displayPoint(), vpDisplayX::displayPoint(), vpDisplayOpenCV::displayPoint(), vpDisplayGTK::displayRectangle(), vpDisplayX::displayRectangle(), vpDisplayOpenCV::displayRectangle(), vpImageDraw::drawCircle(), vp::drawContours(), vpImageDraw::drawLine(), vpImageDraw::drawPolygon(), vpImageDraw::drawRectangle(), vp::gammaCorrection(), vpImageSimulator::getImage(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpRGBa::operator!=(), vpRGBa::operator*(), vpRGBa::operator+(), vpRGBa::operator-(), vpRGBa::operator<(), vpRGBa::operator<<(), vpRGBa::operator=(), vpRGBa::operator==(), vpRGBa::operator>(), vp::stretchContrast(), vpImageTools::warpLinear(), and vpImageIo::writePPM().
< Predefined black color with R=G=B=0 and identifier vpColor::id_black. Predefined white color with R=G=B=255 and identifier vpColor::id_white.
Definition at line 173 of file vpColor.h.
Referenced by vpDisplayX::init(), vpDisplayOpenCV::init(), and vpMeTracker::track().
Predefined dark blue color with B= 128 and R=G=0 and identifier vpColor::id_darkBlue.
Definition at line 185 of file vpColor.h.
Referenced by vpMbDepthNormalTracker::display(), vpMeSite::display(), vpMeEllipse::display(), vpProjectionDisplay::displayCamera(), vpMbtFaceDepthNormal::displayFeature(), vpMbEdgeTracker::displayFeaturesOnImage(), vpImageDraw::drawFrame(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpTemplateTrackerZone::initClick(), QPlot::QPlot(), vpMeLine::sample(), vpDot2::searchDotsInArea(), vpMeLine::seekExtremities(), vpMeNurbs::seekExtremities(), and vpDot2::trackAndDisplay().
Predefined orange color with R=255, G=165 and B=0 and identifier vpColor::id_orange.
Definition at line 188 of file vpColor.h.
Referenced by vpFeatureSegment::display(), vpMeSite::display(), vpMbEdgeTracker::displayFeaturesOnImage(), vpDisplayX::init(), and vpDisplayOpenCV::init().
|
static |
Predefined yellow color with R=G=255 and B=0 and identifier vpColor::id_yellow.
Definition at line 186 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
|
static |
Predefined light red color with R= 255 and G=B=140 and identifier vpColor::id_lightRed.
Definition at line 177 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
|
static |
Predefined light blue color with B= 255 and R=G=140 and identifier vpColor::id_lightBlue.
Definition at line 183 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
|
static |
Predefined light green color with G= 255 and R=B=140 and identifier vpColor::id_lightGreen.
Definition at line 180 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
|
inherited |
Green component.
Definition at line 149 of file vpRGBa.h.
Referenced by vp::adjust(), vpDisplayX::clearDisplay(), vpImageConvert::convert(), vpDisplayGTK::displayCharString(), vpDisplayX::displayCharString(), vpDisplayOpenCV::displayCharString(), vpDisplayGTK::displayCircle(), vpDisplayX::displayCircle(), vpDisplayOpenCV::displayCircle(), vpDisplayGTK::displayDotLine(), vpDisplayX::displayDotLine(), vpDisplayX::displayImage(), vpDisplayOpenCV::displayImage(), vpDisplayX::displayImageROI(), vpDisplayOpenCV::displayImageROI(), vpDisplayGTK::displayLine(), vpDisplayX::displayLine(), vpDisplayOpenCV::displayLine(), vpDisplayGTK::displayPoint(), vpDisplayX::displayPoint(), vpDisplayOpenCV::displayPoint(), vpDisplayGTK::displayRectangle(), vpDisplayX::displayRectangle(), vpDisplayOpenCV::displayRectangle(), vpImageDraw::drawCircle(), vp::drawContours(), vpImageDraw::drawLine(), vpImageDraw::drawPolygon(), vpImageDraw::drawRectangle(), vp::gammaCorrection(), vpImageSimulator::getImage(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpRGBa::operator!=(), vpRGBa::operator*(), vpRGBa::operator+(), vpRGBa::operator-(), vpRGBa::operator<(), vpRGBa::operator<<(), vpRGBa::operator=(), vpRGBa::operator==(), vpRGBa::operator>(), vp::stretchContrast(), vpImageTools::warpLinear(), and vpImageIo::writePPM().
Predefined dark gray color with R=G=B=192 and identifier vpColor::id_darkGray.
Definition at line 176 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
Predefined dark green color with G= 128 and R=B=0 and identifier vpColor::id_darkGreen.
Definition at line 182 of file vpColor.h.
Referenced by vpMeLine::computeRhoTheta(), vpProjectionDisplay::display(), vpMeSite::display(), vpMeLine::display(), vpKeyPoint::display(), vpProjectionDisplay::displayCamera(), vpMbEdgeTracker::displayFeaturesOnImage(), vpKeyPoint::displayMatching(), vpImageDraw::drawFrame(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpMbTracker::initClick(), vpMeTracker::initTracking(), vpMeEllipse::initTracking(), vpMeNurbs::initTracking(), vpMeLine::seekExtremities(), vpMeNurbs::seekExtremitiesCanny(), vpMeSite::track(), vpDot2::trackAndDisplay(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().
vpColorIdentifier vpColor::id |
Color identifier to indicate if a color is predefined or set by the user using its RGB values.
Definition at line 168 of file vpColor.h.
Referenced by vpDisplayX::clearDisplay(), vpDisplayGTK::displayCharString(), vpDisplayX::displayCharString(), vpDisplayOpenCV::displayCharString(), vpDisplayGTK::displayCircle(), vpDisplayX::displayCircle(), vpDisplayOpenCV::displayCircle(), vpDisplayGTK::displayDotLine(), vpDisplayX::displayDotLine(), vpDisplayGTK::displayLine(), vpDisplayX::displayLine(), vpDisplayOpenCV::displayLine(), vpDisplayGTK::displayPoint(), vpDisplayX::displayPoint(), vpDisplayOpenCV::displayPoint(), vpDisplayGTK::displayRectangle(), vpDisplayX::displayRectangle(), and vpDisplayOpenCV::displayRectangle().
|
static |
Predefined blue color with R=G=0 and B=255 and identifier vpColor::id_blue.
Definition at line 184 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
|
static |
Predefined gray color with R=G=B=128 and identifier vpColor::id_gray.
Definition at line 175 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
|
static |
Predefined green color with G=255 and R=B=0 and identifier vpColor::id_green.
Definition at line 181 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
|
static |
Predefined red color with R=255 and G=B=0 and identifier vpColor::id_red.
Definition at line 178 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
|
static |
|
static |
Definition at line 191 of file vpColor.h.
Referenced by vpServoDisplay::display(), vpKeyPoint::displayMatching(), vpImageDraw::drawFrame(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().
Predefined purple color with R=128, G=0 and B=128 and identifier vpColor::id_purple.
Definition at line 189 of file vpColor.h.
Referenced by vpMbtDistanceCylinder::computeInteractionMatrixError(), vpDisplayX::init(), vpDisplayOpenCV::init(), and vpMeNurbs::seekExtremitiesCanny().
Predefined none color with R=G=B=0 and identifier vpColor::id_unknown.
Definition at line 190 of file vpColor.h.
Referenced by vpMeSite::display(), vpMbEdgeTracker::displayFeaturesOnImage(), vpDisplayX::init(), and vpDisplayOpenCV::init().
|
inherited |
Red component.
Definition at line 148 of file vpRGBa.h.
Referenced by vp::adjust(), vpDisplayX::clearDisplay(), vpImageConvert::convert(), vpDisplayGTK::displayCharString(), vpDisplayX::displayCharString(), vpDisplayOpenCV::displayCharString(), vpDisplayGTK::displayCircle(), vpDisplayX::displayCircle(), vpDisplayOpenCV::displayCircle(), vpDisplayGTK::displayDotLine(), vpDisplayX::displayDotLine(), vpDisplayX::displayImage(), vpDisplayOpenCV::displayImage(), vpDisplayX::displayImageROI(), vpDisplayOpenCV::displayImageROI(), vpDisplayGTK::displayLine(), vpDisplayX::displayLine(), vpDisplayOpenCV::displayLine(), vpDisplayGTK::displayPoint(), vpDisplayX::displayPoint(), vpDisplayOpenCV::displayPoint(), vpDisplayGTK::displayRectangle(), vpDisplayX::displayRectangle(), vpDisplayOpenCV::displayRectangle(), vpImageDraw::drawCircle(), vp::drawContours(), vpImageDraw::drawLine(), vpImageDraw::drawPolygon(), vpImageDraw::drawRectangle(), vp::gammaCorrection(), vpImageSimulator::getImage(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpRGBa::operator!=(), vpRGBa::operator*(), vpRGBa::operator+(), vpRGBa::operator-(), vpRGBa::operator<(), vpRGBa::operator<<(), vpRGBa::operator=(), vpRGBa::operator==(), vpRGBa::operator>(), vp::stretchContrast(), vpImageTools::warpLinear(), and vpImageIo::writePPM().
Predefined dark red color with R= 128 and G=B=0 and identifier vpColor::id_darkRed.
Definition at line 179 of file vpColor.h.
Referenced by vpMbtDistanceCylinder::computeInteractionMatrixError(), vpMeLine::computeRhoTheta(), vpMbDepthNormalTracker::display(), vpMeSite::display(), vpMbEdgeKltTracker::display(), vpMbKltTracker::display(), vpMeEllipse::display(), vpKeyPoint::display(), vpProjectionDisplay::displayCamera(), vpMbtFaceDepthNormal::displayFeature(), vpMbEdgeTracker::displayFeaturesOnImage(), vpKeyPoint::displayMatching(), vpMbtDistanceKltCylinder::displayPrimitive(), vpMbtDistanceKltPoints::displayPrimitive(), vpImageDraw::drawFrame(), vpWireFrameSimulator::getInternalImage(), vpRobotWireFrameSimulator::getInternalView(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpTemplateTrackerZone::initClick(), vpMbTracker::initClick(), vpMeEllipse::initTracking(), vpMeLine::initTracking(), QPlot::QPlot(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpMeEllipse::track(), vpMeSite::track(), vpMeLine::track(), vpDot::track(), vpDot2::track(), and vpDot2::trackAndDisplay().
Predefined light gray color with R=G=B=64 and identifier vpColor::id_lightGray.
Definition at line 174 of file vpColor.h.
Referenced by vpDisplayX::init(), and vpDisplayOpenCV::init().
Predefined cyan color with R=0 and G=B=255 and identifier vpColor::id_cyan.
Definition at line 187 of file vpColor.h.
Referenced by vpFeatureSegment::display(), vpMeSite::display(), vpMbEdgeTracker::displayFeaturesOnImage(), vpMeSite::getQueryList(), vpDisplayX::init(), and vpDisplayOpenCV::init().