vpColor Class Reference

#include <visp3/core/vpColor.h>

Inheritance diagram for vpColor:

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)

Detailed Description

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).

#include <visp3/core/vpConfig.h>
#include <visp3/gui/vpDisplayD3D.h>
#include <visp3/gui/vpDisplayGDI.h>
#include <visp3/gui/vpDisplayGTK.h>
#include <visp3/gui/vpDisplayOpenCV.h>
#include <visp3/gui/vpDisplayX.h>

int main()
{
  vpImage<unsigned char> I(240, 320); // Create a black grey level image

  vpDisplay *d;

  // Depending on the detected third party libraries, we instantiate here the
  // first video device which is available
#if defined(VISP_HAVE_X11)
  d = new vpDisplayX;
#elif defined(VISP_HAVE_GTK)
  d = new vpDisplayGTK;
#elif defined(VISP_HAVE_GDI)
  d = new vpDisplayGDI;
#elif defined(VISP_HAVE_D3D9)
  d = new vpDisplayD3D;
#elif defined(VISP_HAVE_OPENCV)
  d = new vpDisplayOpenCV;
#endif

  // Initialize the display with the image I. Display and image are
  // now link together.
#ifdef VISP_HAVE_DISPLAY
  d->init(I);
#endif

  // Set the display background with image I content
  vpDisplay::display(I);

  // Draw a filled circle with the predefined blue color
  vpDisplay::displayCircle(I, 100, 200, 30, vpColor::blue, true);

  // Creation of a new brown color with its RGB values
  vpColor color(128, 100, 50);

  // Draw a brown rectangle in the display overlay (foreground)
  vpDisplay::displayRectangle(I, 10, 10, 100, 20, color, true);

  // Flush the foreground and background display
  vpDisplay::flush(I);

  delete d;
}

Examples:

servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, and SickLDMRS-Process.cpp.

Definition at line 120 of file vpColor.h.

Member Enumeration Documentation

enum vpRGBa::AlphaDefault

inherited

Enumerator
alpha_default

Definition at line 69 of file vpRGBa.h.

enum vpColor::vpColorIdentifier

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.

Definition at line 124 of file vpColor.h.

Constructor & Destructor Documentation

vpColor::vpColor ( )

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.

Definition at line 204 of file vpColor.h.

vpColor::vpColor ( unsigned char  r, unsigned char  g, unsigned char  b, vpColor::vpColorIdentifier  cid = vpColor::id_unknown  )

inline

Construct a color from its RGB values.

Parameters

r	: Red component.
g	: Green component.
b	: Blue component.
cid	: The color identifier to indicate if this color is or not a predefined one.

Definition at line 215 of file vpColor.h.

virtual vpColor::~vpColor ( )

inlinevirtual

Default destructor.

Definition at line 219 of file vpColor.h.

References vpRGBa::operator!=(), and vpRGBa::operator==().

Member Function Documentation

static vpColor vpColor::getColor ( const unsigned int &  i )

inlinestatic

Get a predefined color

Parameters

i	: color indice

Examples:

testAprilTag.cpp, testConnectedComponents.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, and tutorial-connected-components.cpp.

Definition at line 249 of file vpColor.h.

References allColors, black, blue, cyan, darkBlue, darkGray, darkGreen, darkRed, gray, green, lightBlue, lightGray, lightGreen, lightRed, nbColors, none, orange, purple, red, white, and yellow.

Referenced by vpIoTools::readConfigVar().

bool vpRGBa::operator!= ( const vpRGBa &  v )

inherited

Compare two color pixels.

Returns

true if the images are different, false if they are the same.

Definition at line 136 of file vpRGBa.cpp.

References vpRGBa::A, vpRGBa::B, vpRGBa::G, and vpRGBa::R.

Referenced by ~vpColor().

vpColVector vpRGBa::operator* ( const float &  v ) const

inherited

Multiplication operator : v * "this".

Parameters

v	: Value to multiply.

Returns

v * "this"

Definition at line 204 of file vpRGBa.cpp.

References vpRGBa::A, vpRGBa::B, vpRGBa::G, and vpRGBa::R.

vpColVector vpRGBa::operator* ( const double &  v ) const

inherited

Multiplication operator : v * "this".

Parameters

v	: Value to multiply.

Returns

v * "this"

Definition at line 219 of file vpRGBa.cpp.

References vpRGBa::A, vpRGBa::B, vpRGBa::G, and vpRGBa::R.

vpRGBa vpRGBa::operator+ ( const vpRGBa &  v ) const

inherited

Addition operator : "this" + v.

Parameters

v	: Color to add to the current object "this".

Returns

"this" + v

Warning

in case of overflow : e.g. 128+128 returns 0 for all 4 channels

Definition at line 159 of file vpRGBa.cpp.

References vpRGBa::A, vpRGBa::B, vpRGBa::G, and vpRGBa::R.

vpColVector vpRGBa::operator+ ( const vpColVector &  v ) const

inherited

Addition operator : "this" + v.

Parameters

v	: Color to add to the current object "this".

Returns

"this" + v

Definition at line 189 of file vpRGBa.cpp.

References vpRGBa::A, vpRGBa::B, vpRGBa::G, and vpRGBa::R.

vpColVector vpRGBa::operator- ( const vpRGBa &  v ) const

inherited

Substraction operator : "this" - v.

Parameters

v	: Color to substract to the current object "this".

Returns

"this" - v

Definition at line 143 of file vpRGBa.cpp.

References vpRGBa::A, vpRGBa::B, vpRGBa::G, and vpRGBa::R.

vpColVector vpRGBa::operator- ( const vpColVector &  v ) const

inherited

Substraction operator : "this" - v.

Parameters

v	: Color to substract to the current object "this".

Returns

"this" - v

Definition at line 174 of file vpRGBa.cpp.

References vpRGBa::A, vpRGBa::B, vpRGBa::G, and vpRGBa::R.

bool vpRGBa::operator< ( const vpRGBa &  v ) const

inherited

Definition at line 229 of file vpRGBa.cpp.

References vpRGBa::B, vpRGBa::G, and vpRGBa::R.

bool vpRGBa::operator== ( const vpRGBa &  v )

inherited

Compare two RGBa values.

Returns

true if the values are the same, false otherwise.

Definition at line 118 of file vpRGBa.cpp.

References vpRGBa::A, vpRGBa::B, vpRGBa::G, and vpRGBa::R.

Referenced by ~vpColor().

bool vpRGBa::operator> ( const vpRGBa &  v ) const

inherited

Definition at line 237 of file vpRGBa.cpp.

References vpRGBa::B, vpRGBa::G, and vpRGBa::R.

void vpColor::setColor ( unsigned char  r, unsigned char  g, unsigned char  b  )

inline

Set a color from its RGB values.

Parameters

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.

Definition at line 234 of file vpColor.h.

Friends And Related Function Documentation

VISP_EXPORT bool operator!= ( const vpColor &  c1, const vpColor &  c2  )

friend

Compare two colors.

Return true if the R,G,B components are different.

Parameters

c1,c2

: Color to compare.

Definition at line 147 of file vpColor.cpp.

VISP_EXPORT bool operator== ( const vpColor &  c1, const vpColor &  c2  )

friend

Compare two colors.

Return true if the R,G,B components are the same.

Parameters

c1,c2

: Color to compare.

Definition at line 134 of file vpColor.cpp.

Member Data Documentation

unsigned char vpRGBa::A

inherited

Additionnal component.

Examples:

testImageDifference.cpp, and testPerformanceLUT.cpp.

Definition at line 151 of file vpRGBa.h.

Referenced by vp::adjust(), vpImageConvert::convert(), vpImageConvert::createDepthHistogram(), vpDisplayX::displayImage(), vpDisplayX::displayImageROI(), vp::gammaCorrection(), vpDisplayX::getImage(), vpImageTools::imageDifference(), vpImageTools::imageDifferenceAbsolute(), vpImageConvert::merge(), vpRGBa::operator!=(), vpRGBa::operator*(), vpRGBa::operator+(), vpRGBa::operator-(), vpRGBa::operator=(), vpRGBa::operator==(), and vp::stretchContrast().

vpColor const vpColor::allColors

static

Initial value:

= {vpColor::blue,       
                                                       vpColor::green,      
                                                       vpColor::red,        
                                                       vpColor::cyan,       
                                                       vpColor::purple,     
                                                       vpColor::yellow,     
                                                       vpColor::orange,     
                                                       vpColor::lightBlue,  
                                                       vpColor::lightGreen, 
                                                       vpColor::lightRed,   
                                                       vpColor::darkBlue,   
                                                       vpColor::darkGreen,  
                                                       vpColor::darkRed,    
                                                       vpColor::lightGray,  
                                                       vpColor::gray,       
                                                       vpColor::darkGray,   
                                                       vpColor::black,      
                                                       vpColor::white}

Definition at line 195 of file vpColor.h.

Referenced by getColor().

unsigned char vpRGBa::B

inherited

Blue component.

Examples:

testImageDifference.cpp, and testPerformanceLUT.cpp.

Definition at line 150 of file vpRGBa.h.

Referenced by vp::adjust(), vpDisplayX::clearDisplay(), vpImageConvert::convert(), vpImageConvert::createDepthHistogram(), 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(), vp::drawContours(), vp::gammaCorrection(), vpDisplayX::getImage(), vpImageSimulator::getImage(), vpImageTools::imageDifference(), vpImageTools::imageDifferenceAbsolute(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpImageConvert::merge(), vpRGBa::operator!=(), vpRGBa::operator*(), vpRGBa::operator+(), vpRGBa::operator-(), vpRGBa::operator<(), vpRGBa::operator=(), vpRGBa::operator==(), vpRGBa::operator>(), vp::stretchContrast(), vp::unsharpMask(), and vpImageIo::writePPM().

vpColor const vpColor::black = vpColor(0, 0, 0, id_black)

static

< 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.

Examples:

manDisplay.cpp, manGeometricFeatures.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, testDisplayPolygonLines.cpp, and testDisplays.cpp.

Definition at line 174 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), vpDisplayOpenCV::init(), and vpMeTracker::track().

vpColor const vpColor::blue = vpColor(0, 0, 255, id_blue)

static

Predefined dark blue color with B= 128 and R=G=0 and identifier vpColor::id_darkBlue.

Examples:

displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, manGeometricFeatures.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoMomentImage.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent-SR300.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, testDisplays.cpp, testForceTorqueAti.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, tutorial-apriltag-detector.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, tutorial-ibvs-4pts-wireframe-robot-viper.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-surf-homography-deprecated.cpp, tutorial-pose-from-qrcode-image.cpp, and wireframeSimulator.cpp.

Definition at line 186 of file vpColor.h.

Referenced by vpMeSite::display(), vpMeEllipse::display(), vpProjectionDisplay::displayCamera(), vpMbtFaceDepthNormal::displayFeature(), getColor(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpTemplateTrackerZone::initClick(), vpMeEllipse::printParameters(), QPlot::QPlot(), vpMeLine::sample(), vpDot2::searchDotsInArea(), vpMeLine::seekExtremities(), vpMeNurbs::seekExtremities(), vpDot2::trackAndDisplay(), and vpMeEllipse::~vpMeEllipse().

vpColor const vpColor::cyan = vpColor(0, 255, 255, id_cyan)

static

Predefined orange color with R=255, G=165 and B=0 and identifier vpColor::id_orange.

Examples:

servoMomentImage.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, and servoViper850Point2DArtVelocity-jointAvoidance-large.cpp.

Definition at line 189 of file vpColor.h.

Referenced by vpFeatureSegment::display(), vpMeSite::display(), getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

vpColor const vpColor::darkBlue = vpColor(0, 0, 128, id_darkBlue)

static

Predefined yellow color with R=G=255 and B=0 and identifier vpColor::id_yellow.

Definition at line 187 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

vpColor const vpColor::darkGray = vpColor(64, 64, 64, id_darkGray)

static

Predefined light red color with R= 255 and G=B=140 and identifier vpColor::id_lightRed.

Definition at line 178 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

vpColor const vpColor::darkGreen = vpColor(0, 128, 0, id_darkGreen)

static

Predefined light blue color with B= 255 and R=G=140 and identifier vpColor::id_lightBlue.

Definition at line 184 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

vpColor const vpColor::darkRed = vpColor(128, 0, 0, id_darkRed)

static

Predefined light green color with G= 255 and R=B=140 and identifier vpColor::id_lightGreen.

Examples:

mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltMultiTracking.cpp, and mbtKltTracking.cpp.

Definition at line 181 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

unsigned char vpRGBa::G

inherited

Green component.

Examples:

testImageDifference.cpp, and testPerformanceLUT.cpp.

Definition at line 149 of file vpRGBa.h.

Referenced by vp::adjust(), vpDisplayX::clearDisplay(), vpImageConvert::convert(), vpImageConvert::createDepthHistogram(), 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(), vp::drawContours(), vp::gammaCorrection(), vpDisplayX::getImage(), vpImageSimulator::getImage(), vpImageTools::imageDifference(), vpImageTools::imageDifferenceAbsolute(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpImageConvert::merge(), vpRGBa::operator!=(), vpRGBa::operator*(), vpRGBa::operator+(), vpRGBa::operator-(), vpRGBa::operator<(), vpRGBa::operator=(), vpRGBa::operator==(), vpRGBa::operator>(), vp::stretchContrast(), vp::unsharpMask(), and vpImageIo::writePPM().

vpColor const vpColor::gray = vpColor(128, 128, 128, id_gray)

static

Predefined dark gray color with R=G=B=192 and identifier vpColor::id_darkGray.

Definition at line 177 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

vpColor const vpColor::green = vpColor(0, 255, 0, id_green)

static

Predefined dark green color with G= 128 and R=B=0 and identifier vpColor::id_darkGreen.

Examples:

BSpline.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, fernClassifier.cpp, keyPointSurf.cpp, manDisplay.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, planarObjectDetector.cpp, plot2d.cpp, plot3d.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoMomentImage.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent-SR300.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testAprilTag.cpp, testDisplays.cpp, testFeatureSegment.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testNurbs.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-contour.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-ibvs-4pts-display.cpp, tutorial-ibvs-4pts-image-tracking.cpp, tutorial-ibvs-4pts-ogre-tracking.cpp, tutorial-ibvs-4pts-wireframe-camera.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, tutorial-ibvs-4pts-wireframe-robot-viper.cpp, tutorial-klt-tracker-live-v4l2.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-matching-keypoint.cpp, tutorial-matching-surf-deprecated.cpp, tutorial-matching-surf-homography-deprecated.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-video-recorder.cpp, and wireframeSimulator.cpp.

Definition at line 183 of file vpColor.h.

Referenced by vpVirtualGrabber::acquire(), vpMeLine::computeRhoSignFromIntensity(), vpMeLine::computeRhoTheta(), vpBasicFeature::dimension_s(), vpProjectionDisplay::display(), vpMeSite::display(), vpMeLine::display(), vpKeyPoint::display(), vpProjectionDisplay::displayCamera(), vpKeyPoint::displayMatching(), getColor(), vpDot2::getFreemanChain(), vpMeNurbs::getNurbs(), vpCircle::getR(), vpSphere::getR(), vpLine::getRho(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpMbTracker::initClick(), vpMeTracker::initTracking(), vpMeEllipse::initTracking(), vpMeNurbs::initTracking(), vpDisplay::isInitialised(), vpMeEllipse::printParameters(), vpDot2::searchDotsInArea(), vpMeLine::seekExtremities(), vpMeNurbs::seekExtremitiesCanny(), vpDisplayWin32::setDownScalingFactor(), vpMeSite::track(), vpDot2::trackAndDisplay(), vpSimulatorAfma6::updateArticularPosition(), vpSimulatorViper850::updateArticularPosition(), vpFeatureMoment::vpFeatureMoment(), vpTemplateTracker::vpTemplateTracker(), vpBasicKeyPoint::~vpBasicKeyPoint(), vpFeatureDepth::~vpFeatureDepth(), vpFeatureEllipse::~vpFeatureEllipse(), vpFeatureLine::~vpFeatureLine(), vpFeaturePoint::~vpFeaturePoint(), vpFeaturePoint3D::~vpFeaturePoint3D(), vpFeaturePointPolar::~vpFeaturePointPolar(), vpFeatureSegment::~vpFeatureSegment(), vpFeatureThetaU::~vpFeatureThetaU(), vpFeatureTranslation::~vpFeatureTranslation(), vpFeatureVanishingPoint::~vpFeatureVanishingPoint(), vpForwardProjection::~vpForwardProjection(), and vpPoint::~vpPoint().

vpColorIdentifier vpColor::id

Color identifier to indicate if a color is predefined or set by the user using its RGB values.

Definition at line 169 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().

vpColor const vpColor::lightBlue = vpColor(140, 140, 255, id_lightBlue)

static

Predefined blue color with R=G=0 and B=255 and identifier vpColor::id_blue.

Definition at line 185 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

vpColor const vpColor::lightGray = vpColor(192, 192, 192, id_lightGray)

static

Predefined gray color with R=G=B=128 and identifier vpColor::id_gray.

Definition at line 176 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

vpColor const vpColor::lightGreen = vpColor(140, 255, 140, id_lightGreen)

static

Predefined green color with G=255 and R=B=0 and identifier vpColor::id_green.

Definition at line 182 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

vpColor const vpColor::lightRed = vpColor(255, 140, 140, id_lightRed)

static

Predefined red color with R=255 and G=B=0 and identifier vpColor::id_red.

Definition at line 179 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), and vpDisplayOpenCV::init().

const unsigned int vpColor::nbColors = 18

static

Array of available colors.

Definition at line 194 of file vpColor.h.

Referenced by getColor().

vpColor const vpColor::none = vpColor(0, 0, 0, id_unknown)

static

Examples:

mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-pbvs.cpp, servoFrankaPBVS.cpp, servoSimu4Points.cpp, servoSimuCylinder.cpp, servoSimuSphere.cpp, testAprilTag.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-chessboard-pose.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-live-realsense2.cpp, tutorial-mb-generic-tracker-apriltag-live-webcam.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, tutorial-mb-tracker.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, and tutorial-pose-from-qrcode-image.cpp.

Definition at line 192 of file vpColor.h.

Referenced by vpServoDisplay::display(), vpKeyPoint::displayMatching(), getColor(), vpPose::getPoints(), vpDisplay::isInitialised(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

vpColor const vpColor::orange = vpColor(255, 165, 0, id_orange)

static

Predefined purple color with R=128, G=0 and B=128 and identifier vpColor::id_purple.

Examples:

displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, manGeometricFeatures.cpp, servoMomentImage.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, and testDisplays.cpp.

Definition at line 190 of file vpColor.h.

Referenced by vpMbtDistanceCylinder::computeInteractionMatrixError(), getColor(), vpDisplayX::init(), vpDisplayOpenCV::init(), and vpMeNurbs::seekExtremitiesCanny().

vpColor const vpColor::purple = vpColor(128, 0, 128, id_purple)

static

Predefined none color with R=G=B=0 and identifier vpColor::id_unknown.

Examples:

manDisplay.cpp, and servoMomentImage.cpp.

Definition at line 191 of file vpColor.h.

Referenced by vpMeSite::display(), getColor(), vpDisplayX::init(), vpDisplayOpenCV::init(), and vpDot2::searchDotsInArea().

unsigned char vpRGBa::R

inherited

Red component.

Examples:

testImageDifference.cpp, and testPerformanceLUT.cpp.

Definition at line 148 of file vpRGBa.h.

Referenced by vp::adjust(), vpDisplayX::clearDisplay(), vpImageConvert::convert(), vpImageConvert::createDepthHistogram(), 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(), vp::drawContours(), vp::gammaCorrection(), vpDisplayX::getImage(), vpImageSimulator::getImage(), vpImageTools::imageDifference(), vpImageTools::imageDifferenceAbsolute(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpImageConvert::merge(), vpRGBa::operator!=(), vpRGBa::operator*(), vpRGBa::operator+(), vpRGBa::operator-(), vpRGBa::operator<(), vpRGBa::operator=(), vpRGBa::operator==(), vpRGBa::operator>(), vp::stretchContrast(), vp::unsharpMask(), and vpImageIo::writePPM().

vpColor const vpColor::red = vpColor(255, 0, 0, id_red)

static

Predefined dark red color with R= 128 and G=B=0 and identifier vpColor::id_darkRed.

Examples:

AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, fernClassifier.cpp, grabFlyCapture.cpp, grabRealSense.cpp, grabRealSense2.cpp, grabV4l2MultiCpp11Thread.cpp, keyPointSurf.cpp, manDisplay.cpp, manGeometricFeatures.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltMultiTracking.cpp, mbtKltTracking.cpp, planarObjectDetector.cpp, plot2d.cpp, plot3d.cpp, poseVirtualVS.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent-SR300.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testAprilTag.cpp, testContours.cpp, testDisplayPolygonLines.cpp, testDisplays.cpp, testFeatureSegment.cpp, testForceTorqueAti.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageResize.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testNurbs.cpp, testRealSense2_D435.cpp, testRealSense2_SR300.cpp, testTrackDot.cpp, testVirtuoseWithGlove.cpp, trackDot.cpp, trackKltOpencv.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-autothreshold.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-blob-tracker-live-firewire.cpp, tutorial-blob-tracker-live-v4l2.cpp, tutorial-brightness-adjustment.cpp, tutorial-chessboard-pose.cpp, tutorial-connected-components.cpp, tutorial-contour.cpp, tutorial-contrast-sharpening.cpp, tutorial-count-coins.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-draw-cross.cpp, tutorial-draw-line.cpp, tutorial-draw-point.cpp, tutorial-draw-rectangle.cpp, tutorial-draw-text.cpp, tutorial-export-image.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flood-fill.cpp, tutorial-franka-acquire-calib-data.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-grabber-v4l2.cpp, tutorial-ibvs-4pts-display.cpp, tutorial-ibvs-4pts-image-tracking.cpp, tutorial-ibvs-4pts-ogre-tracking.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, tutorial-ibvs-4pts-wireframe-robot-viper.cpp, tutorial-image-display-scaled-auto.cpp, tutorial-image-display-scaled-manu.cpp, tutorial-image-display.cpp, tutorial-image-filter.cpp, tutorial-image-viewer.cpp, tutorial-klt-tracker-live-v4l2.cpp, tutorial-klt-tracker-with-reinit.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-surf-homography-deprecated.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-live-realsense2.cpp, tutorial-mb-generic-tracker-apriltag-live-webcam.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, tutorial-mb-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-qrcode-image.cpp, tutorial-simu-pioneer-continuous-gain-adaptive.cpp, tutorial-simu-pioneer-continuous-gain-constant.cpp, tutorial-simu-pioneer-pan.cpp, tutorial-simu-pioneer.cpp, tutorial-template-tracker.cpp, tutorial-video-reader.cpp, tutorial-video-recorder.cpp, and wireframeSimulator.cpp.

Definition at line 180 of file vpColor.h.

Referenced by vpVirtualGrabber::acquire(), vpMbtDistanceCylinder::computeInteractionMatrixError(), vpMeLine::computeRhoTheta(), vpMeSite::display(), vpMeEllipse::display(), vpKeyPoint::display(), vpProjectionDisplay::displayCamera(), vpMbtFaceDepthNormal::displayFeature(), vpKeyPoint::displayMatching(), vpMbtDistanceKltCylinder::displayPrimitive(), vpMbtDistanceKltPoints::displayPrimitive(), getColor(), vpDot2::getFreemanChain(), vpWireFrameSimulator::getInternalImage(), vpRobotWireFrameSimulator::getInternalView(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpTemplateTrackerZone::initClick(), vpMbTracker::initClick(), vpMeEllipse::initTracking(), vpMeLine::initTracking(), vpDot::operator==(), QPlot::QPlot(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpDot::setGraphicsThickness(), vpMeEllipse::track(), vpMeSite::track(), vpMeLine::track(), vpDot2::track(), vpDot::track(), vpDot2::trackAndDisplay(), and vpMeEllipse::~vpMeEllipse().

vpColor const vpColor::white = vpColor(255, 255, 255, id_white)

static

Predefined light gray color with R=G=B=64 and identifier vpColor::id_lightGray.

Examples:

manDisplay.cpp, testVirtuoseWithGlove.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-matching-keypoint.cpp, tutorial-matching-surf-deprecated.cpp, and tutorial-matching-surf-homography-deprecated.cpp.

Definition at line 175 of file vpColor.h.

Referenced by getColor(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpDisplay::isInitialised(), vpHistogram::set(), and vpDisplayWin32::setDownScalingFactor().

vpColor const vpColor::yellow = vpColor(255, 255, 0, id_yellow)

static

Predefined cyan color with R=0 and G=B=255 and identifier vpColor::id_cyan.

Examples:

displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, servoFrankaPBVS.cpp, SickLDMRS-Process.cpp, testDisplays.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, tutorial-draw-text.cpp, tutorial-mb-generic-tracker-live.cpp, and tutorial-mb-generic-tracker-rgbd-realsense.cpp.

Definition at line 188 of file vpColor.h.

Referenced by vpFeatureSegment::display(), vpMeSite::display(), getColor(), vpMeSite::getQueryList(), vpDisplayX::init(), and vpDisplayOpenCV::init().