Visual Servoing Platform  version 3.5.0 under development (2022-02-15)

#include <visp3/gui/vpDisplayGDI.h>

+ Inheritance diagram for vpDisplayGDI:

Public Types

enum  vpScaleType {
  SCALE_AUTO, SCALE_1, SCALE_2, SCALE_3,
  SCALE_4, SCALE_5, SCALE_6, SCALE_7,
  SCALE_8, SCALE_9, SCALE_10, SCALE_DEFAULT
}
 

Public Member Functions

 vpDisplayGDI ()
 
 vpDisplayGDI (int winx, int winy, const std::string &title="")
 
 vpDisplayGDI (vpImage< unsigned char > &I, vpScaleType type)
 
 vpDisplayGDI (vpImage< unsigned char > &I, int winx=-1, int winy=-1, const std::string &title="", vpScaleType type=SCALE_DEFAULT)
 
 vpDisplayGDI (vpImage< vpRGBa > &I, vpScaleType type)
 
 vpDisplayGDI (vpImage< vpRGBa > &I, int winx=-1, int winy=-1, const std::string &title="", vpScaleType type=SCALE_DEFAULT)
 
virtual ~vpDisplayGDI ()
 
void clearDisplay (const vpColor &color=vpColor::white)
 
void closeDisplay ()
 
void displayImage (const vpImage< vpRGBa > &I)
 
void displayImage (const vpImage< unsigned char > &I)
 
void displayImageROI (const vpImage< unsigned char > &I, const vpImagePoint &iP, unsigned int width, unsigned int height)
 
void displayImageROI (const vpImage< vpRGBa > &I, const vpImagePoint &iP, unsigned int width, unsigned int height)
 
void flushDisplay ()
 
void flushDisplayROI (const vpImagePoint &iP, unsigned int width, unsigned int height)
 
void getImage (vpImage< vpRGBa > &I)
 
unsigned int getScreenHeight ()
 
void getScreenSize (unsigned int &width, unsigned int &height)
 
unsigned int getScreenWidth ()
 
void init (vpImage< unsigned char > &I, int winx=-1, int winy=-1, const std::string &title="")
 
void init (vpImage< vpRGBa > &I, int winx=-1, int winy=-1, const std::string &title="")
 
void init (unsigned int width, unsigned int height, int winx=-1, int winy=-1, const std::string &title="")
 
void setFont (const std::string &fontname)
 
void setDownScalingFactor (unsigned int scale)
 
void setDownScalingFactor (vpScaleType scaleType)
 
void setTitle (const std::string &windowtitle)
 
void setWindowPosition (int winx, int winy)
 
Inherited functionalities from vpDisplay
unsigned int computeAutoScale (unsigned int width, unsigned int height)
 
unsigned int getDownScalingFactor ()
 
unsigned int getHeight () const
 
unsigned int getWidth () const
 
int getWindowXPosition () const
 
int getWindowYPosition () const
 
bool isInitialised ()
 

Static Public Member Functions

Static public vpDisplay functionalities on gray level images.
static void getImage (const vpImage< unsigned char > &Is, vpImage< vpRGBa > &Id)
 
static void setFont (const vpImage< unsigned char > &I, const std::string &font)
 
static void setTitle (const vpImage< unsigned char > &I, const std::string &windowtitle)
 
static void setWindowPosition (const vpImage< unsigned char > &I, int winx, int winy)
 
static void displayArrow (const vpImage< unsigned char > &I, const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color=vpColor::white, unsigned int w=4, unsigned int h=2, unsigned int thickness=1)
 
static void displayArrow (const vpImage< unsigned char > &I, int i1, int j1, int i2, int j2, const vpColor &color=vpColor::white, unsigned int w=4, unsigned int h=2, unsigned int thickness=1)
 
static void displayCharString (const vpImage< unsigned char > &I, const vpImagePoint &ip, const char *string, const vpColor &color)
 
static void displayCharString (const vpImage< unsigned char > &I, int i, int j, const char *string, const vpColor &color)
 
static void displayCircle (const vpImage< unsigned char > &I, const vpImagePoint &center, unsigned int radius, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayCircle (const vpImage< unsigned char > &I, int i, int j, unsigned int radius, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayCross (const vpImage< unsigned char > &I, const vpImagePoint &ip, unsigned int size, const vpColor &color, unsigned int thickness=1)
 
static void displayCross (const vpImage< unsigned char > &I, int i, int j, unsigned int size, const vpColor &color, unsigned int thickness=1)
 
static void displayDotLine (const vpImage< unsigned char > &I, const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1)
 
static void displayDotLine (const vpImage< unsigned char > &I, int i1, int j1, int i2, int j2, const vpColor &color, unsigned int thickness=1)
 
static void displayDotLine (const vpImage< unsigned char > &I, const std::vector< vpImagePoint > &ips, bool closeTheShape, const vpColor &color, unsigned int thickness=1)
 
static void displayDotLine (const vpImage< unsigned char > &I, const std::list< vpImagePoint > &ips, bool closeTheShape, const vpColor &color, unsigned int thickness=1)
 
static void displayLine (const vpImage< unsigned char > &I, const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1, bool segment=true)
 
static void displayLine (const vpImage< unsigned char > &I, int i1, int j1, int i2, int j2, const vpColor &color, unsigned int thickness=1, bool segment=true)
 
static void displayLine (const vpImage< unsigned char > &I, const std::vector< vpImagePoint > &ips, bool closeTheShape, const vpColor &color, unsigned int thickness=1)
 
static void displayLine (const vpImage< unsigned char > &I, const std::list< vpImagePoint > &ips, bool closeTheShape, const vpColor &color, unsigned int thickness=1)
 
static void displayPoint (const vpImage< unsigned char > &I, const vpImagePoint &ip, const vpColor &color, unsigned int thickness=1)
 
static void displayPoint (const vpImage< unsigned char > &I, int i, int j, const vpColor &color, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< unsigned char > &I, const vpImagePoint &topLeft, unsigned int width, unsigned int height, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< unsigned char > &I, const vpImagePoint &topLeft, const vpImagePoint &bottomRight, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< unsigned char > &I, const vpRect &rectangle, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< unsigned char > &I, const vpImagePoint &center, float angle, unsigned int width, unsigned int height, const vpColor &color, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< unsigned char > &I, int i, int j, unsigned int width, unsigned int height, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< unsigned char > &I, unsigned int i, unsigned int j, float angle, unsigned int width, unsigned int height, const vpColor &color, unsigned int thickness=1)
 
static bool getClick (const vpImage< unsigned char > &I, bool blocking=true)
 
static bool getClick (const vpImage< unsigned char > &I, vpImagePoint &ip, bool blocking=true)
 
static bool getClick (const vpImage< unsigned char > &I, vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
static bool getClick (const vpImage< unsigned char > &I, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
static bool getClickUp (const vpImage< unsigned char > &I, vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
static bool getClickUp (const vpImage< unsigned char > &I, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
static bool getKeyboardEvent (const vpImage< unsigned char > &I, bool blocking=true)
 
static bool getKeyboardEvent (const vpImage< unsigned char > &I, std::string &key, bool blocking=true)
 
static bool getKeyboardEvent (const vpImage< unsigned char > &I, char *key, bool blocking=true)
 
static bool getPointerMotionEvent (const vpImage< unsigned char > &I, vpImagePoint &ip)
 
static bool getPointerPosition (const vpImage< unsigned char > &I, vpImagePoint &ip)
 
static unsigned int getDownScalingFactor (const vpImage< unsigned char > &I)
 
static void close (vpImage< unsigned char > &I)
 
static void display (const vpImage< unsigned char > &I)
 
static void displayCamera (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color, unsigned int thickness)
 
static void displayEllipse (const vpImage< unsigned char > &I, const vpImagePoint &center, const double &coef1, const double &coef2, const double &coef3, bool use_normalized_centered_moments, const vpColor &color, unsigned int thickness=1, bool display_center=false, bool display_arc=false)
 
static void displayEllipse (const vpImage< unsigned char > &I, const vpImagePoint &center, const double &coef1, const double &coef2, const double &coef3, const double &smallalpha, const double &highalpha, bool use_normalized_centered_moments, const vpColor &color, unsigned int thickness=1, bool display_center=false, bool display_arc=false)
 
static void displayFrame (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color=vpColor::none, unsigned int thickness=1, const vpImagePoint &offset=vpImagePoint(0, 0))
 
static void displayPolygon (const vpImage< unsigned char > &I, const std::vector< vpImagePoint > &vip, const vpColor &color, unsigned int thickness=1, bool closed=true)
 
static void displayROI (const vpImage< unsigned char > &I, const vpRect &roi)
 
static void displayText (const vpImage< unsigned char > &I, const vpImagePoint &ip, const std::string &s, const vpColor &color)
 
static void displayText (const vpImage< unsigned char > &I, int i, int j, const std::string &s, const vpColor &color)
 
static void flush (const vpImage< unsigned char > &I)
 
static void flushROI (const vpImage< unsigned char > &I, const vpRect &roi)
 
static void setBackground (const vpImage< unsigned char > &I, const vpColor &color)
 
Static public vpDisplay functionalities on 32 bits color images.
static void getImage (const vpImage< vpRGBa > &Is, vpImage< vpRGBa > &Id)
 
static void setFont (const vpImage< vpRGBa > &I, const std::string &font)
 
static void setTitle (const vpImage< vpRGBa > &I, const std::string &windowtitle)
 
static void setWindowPosition (const vpImage< vpRGBa > &I, int winx, int winy)
 
static void displayArrow (const vpImage< vpRGBa > &I, const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color=vpColor::white, unsigned int w=4, unsigned int h=2, unsigned int thickness=1)
 
static void displayArrow (const vpImage< vpRGBa > &I, int i1, int j1, int i2, int j2, const vpColor &color=vpColor::white, unsigned int w=4, unsigned int h=2, unsigned int thickness=1)
 
static void displayCharString (const vpImage< vpRGBa > &I, const vpImagePoint &ip, const char *string, const vpColor &color)
 
static void displayCharString (const vpImage< vpRGBa > &I, int i, int j, const char *string, const vpColor &color)
 
static void displayCircle (const vpImage< vpRGBa > &I, const vpImagePoint &center, unsigned int radius, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayCircle (const vpImage< vpRGBa > &I, int i, int j, unsigned int radius, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayCross (const vpImage< vpRGBa > &I, const vpImagePoint &ip, unsigned int size, const vpColor &color, unsigned int thickness=1)
 
static void displayCross (const vpImage< vpRGBa > &I, int i, int j, unsigned int size, const vpColor &color, unsigned int thickness=1)
 
static void displayDotLine (const vpImage< vpRGBa > &I, const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1)
 
static void displayDotLine (const vpImage< vpRGBa > &I, int i1, int j1, int i2, int j2, const vpColor &color, unsigned int thickness=1)
 
static void displayDotLine (const vpImage< vpRGBa > &I, const std::vector< vpImagePoint > &ips, bool closeTheShape, const vpColor &color, unsigned int thickness=1)
 
static void displayDotLine (const vpImage< vpRGBa > &I, const std::list< vpImagePoint > &ips, bool closeTheShape, const vpColor &color, unsigned int thickness=1)
 
static void displayLine (const vpImage< vpRGBa > &I, const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1, bool segment=true)
 
static void displayLine (const vpImage< vpRGBa > &I, int i1, int j1, int i2, int j2, const vpColor &color, unsigned int thickness=1, bool segment=true)
 
static void displayLine (const vpImage< vpRGBa > &I, const std::vector< vpImagePoint > &ips, bool closeTheShape, const vpColor &color, unsigned int thickness=1)
 
static void displayLine (const vpImage< vpRGBa > &I, const std::list< vpImagePoint > &ips, bool closeTheShape, const vpColor &color, unsigned int thickness=1)
 
static void displayPoint (const vpImage< vpRGBa > &I, const vpImagePoint &ip, const vpColor &color, unsigned int thickness=1)
 
static void displayPoint (const vpImage< vpRGBa > &I, int i, int j, const vpColor &color, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< vpRGBa > &I, const vpImagePoint &topLeft, unsigned int width, unsigned int height, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< vpRGBa > &I, const vpImagePoint &topLeft, const vpImagePoint &bottomRight, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< vpRGBa > &I, const vpRect &rectangle, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< vpRGBa > &I, const vpImagePoint &center, float angle, unsigned int width, unsigned int height, const vpColor &color, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< vpRGBa > &I, int i, int j, unsigned int width, unsigned int height, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
static void displayRectangle (const vpImage< vpRGBa > &I, unsigned int i, unsigned int j, float angle, unsigned int width, unsigned int height, const vpColor &color, unsigned int thickness=1)
 
static bool getClick (const vpImage< vpRGBa > &I, bool blocking=true)
 
static bool getClick (const vpImage< vpRGBa > &I, vpImagePoint &ip, bool blocking=true)
 
static bool getClick (const vpImage< vpRGBa > &I, vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
static bool getClick (const vpImage< vpRGBa > &I, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
static bool getClickUp (const vpImage< vpRGBa > &I, vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
static bool getClickUp (const vpImage< vpRGBa > &I, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
static bool getKeyboardEvent (const vpImage< vpRGBa > &I, bool blocking=true)
 
static bool getKeyboardEvent (const vpImage< vpRGBa > &I, std::string &key, bool blocking=true)
 
static bool getKeyboardEvent (const vpImage< vpRGBa > &I, char *key, bool blocking=true)
 
static bool getPointerMotionEvent (const vpImage< vpRGBa > &I, vpImagePoint &ip)
 
static bool getPointerPosition (const vpImage< vpRGBa > &I, vpImagePoint &ip)
 
static unsigned int getDownScalingFactor (const vpImage< vpRGBa > &I)
 
static void close (vpImage< vpRGBa > &I)
 
static void display (const vpImage< vpRGBa > &I)
 
static void displayCamera (const vpImage< vpRGBa > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color, unsigned int thickness)
 
static void displayEllipse (const vpImage< vpRGBa > &I, const vpImagePoint &center, const double &coef1, const double &coef2, const double &coef3, bool use_centered_moments, const vpColor &color, unsigned int thickness=1, bool display_center=false, bool display_arc=false)
 
static void displayEllipse (const vpImage< vpRGBa > &I, const vpImagePoint &center, const double &coef1, const double &coef2, const double &coef3, const double &theta1, const double &theta2, bool use_centered_moments, const vpColor &color, unsigned int thickness=1, bool display_center=false, bool display_arc=false)
 
static void displayFrame (const vpImage< vpRGBa > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color=vpColor::none, unsigned int thickness=1, const vpImagePoint &offset=vpImagePoint(0, 0))
 
static void displayPolygon (const vpImage< vpRGBa > &I, const std::vector< vpImagePoint > &vip, const vpColor &color, unsigned int thickness=1, bool closed=true)
 
static void displayROI (const vpImage< vpRGBa > &I, const vpRect &roi)
 
static void displayText (const vpImage< vpRGBa > &I, const vpImagePoint &ip, const std::string &s, const vpColor &color)
 
static void displayText (const vpImage< vpRGBa > &I, int i, int j, const std::string &s, const vpColor &color)
 
static void flush (const vpImage< vpRGBa > &I)
 
static void flushROI (const vpImage< vpRGBa > &I, const vpRect &roi)
 
static void setBackground (const vpImage< vpRGBa > &I, const vpColor &color)
 

Protected Member Functions

void displayArrow (const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color=vpColor::white, unsigned int w=4, unsigned int h=2, unsigned int thickness=1)
 
void displayCharString (const vpImagePoint &ip, const char *text, const vpColor &color=vpColor::green)
 
void displayCircle (const vpImagePoint &center, unsigned int radius, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
void displayCross (const vpImagePoint &ip, unsigned int size, const vpColor &color, unsigned int thickness=1)
 
void displayDotLine (const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1)
 
void displayLine (const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1)
 
void displayPoint (const vpImagePoint &ip, const vpColor &color, unsigned int thickness=1)
 
void displayRectangle (const vpImagePoint &topLeft, unsigned int width, unsigned int height, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
void displayRectangle (const vpImagePoint &topLeft, const vpImagePoint &bottomRight, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
void displayRectangle (const vpRect &rectangle, const vpColor &color, bool fill=false, unsigned int thickness=1)
 
bool getClick (bool blocking=true)
 
bool getClick (vpImagePoint &ip, bool blocking=true)
 
bool getClick (vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
bool getClickUp (vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
 
bool getKeyboardEvent (bool blocking=true)
 
bool getKeyboardEvent (std::string &key, bool blocking)
 
bool getPointerMotionEvent (vpImagePoint &ip)
 
bool getPointerPosition (vpImagePoint &ip)
 
void waitForInit ()
 
void setScale (vpScaleType scaleType, unsigned int width, unsigned int height)
 

Protected Attributes

HANDLE hThread
 
DWORD threadId
 
bool iStatus
 
vpWin32Window window
 
RECT roi
 
bool m_displayHasBeenInitialized
 
int m_windowXPosition
 
int m_windowYPosition
 
unsigned int m_width
 
unsigned int m_height
 
std::string m_title
 
unsigned int m_scale
 
vpScaleType m_scaleType
 

Static Protected Attributes

static const int MAX_INIT_DELAY = 5000
 

Detailed Description

Display for windows using GDI (available on any windows 32 platform).

GDI stands for Graphics Device Interface and is a core component of Microsoft Windows operating systems used for displaying graphics in a window.

The example below shows how to display an image with this video device.

#include <visp3/gui/vpDisplayGDI.h>
#include <visp3/io/vpImageIo.h>
int main()
{
#if defined(VISP_HAVE_GDI)
vpImage<unsigned char> I; // Grey level image
// Read an image in PGM P5 format
#ifdef _WIN32
vpImageIo::read(I, "C:/temp/ViSP-images/Klimt/Klimt.pgm");
#else
vpImageIo::read(I, "/local/soft/ViSP/ViSP-images/Klimt/Klimt.pgm");
#endif
// Initialize the display with the image I. Display and image are
// now link together.
d.init(I);
// Specify the window location
// Set the display window title
vpDisplay::setTitle(I, "My GDI display");
// Set the display background with image I content
// Draw a red rectangle in the display overlay (foreground)
vpDisplay::displayRectangle(I, 10, 10, 100, 20, vpColor::red, true);
// Draw a red rectangle in the display overlay (foreground)
vpImagePoint topLeftCorner;
topLeftCorner.set_i(50);
topLeftCorner.set_j(10);
vpDisplay::displayRectangle(I, topLeftCorner, 100, 20, vpColor::green, true);
// Flush the foreground and background display
// Get non blocking keyboard events
std::cout << "Check keyboard events..." << std::endl;
char key[10];
bool ret;
for (int i=0; i< 200; i++) {
bool ret = vpDisplay::getKeyboardEvent(I, key, false);
if (ret)
std::cout << "keyboard event: key: " << "\"" << key << "\"" << std::endl;
}
// Get a blocking keyboard event
std::cout << "Wait for a keyboard event..." << std::endl;
ret = vpDisplay::getKeyboardEvent(I, key, true);
std::cout << "keyboard event: " << ret << std::endl;
if (ret)
std::cout << "key: " << "\"" << key << "\"" << std::endl;
// Wait for a click in the display window
std::cout << "Wait for a button click..." << std::endl;
#endif
}
Examples:
AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displaySequence.cpp, fernClassifier.cpp, grab1394CMU.cpp, grabDirectShow.cpp, grabDirectShowMulti.cpp, grabDisk.cpp, grabFlyCapture.cpp, grabRealSense.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, imageSequenceReader.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testClick.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplays.cpp, testFeatureSegment.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testRobotBebop2.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, testVirtuoseWithGlove.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-autothreshold.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-blob-auto-tracker.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-event-keyboard.cpp, tutorial-export-image.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-franka-acquire-calib-data.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-bebop2.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-realsense-T265.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-structure-core.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-image-display-scaled-auto.cpp, tutorial-image-display-scaled-manu.cpp, tutorial-image-display.cpp, tutorial-image-filter.cpp, tutorial-image-simulator.cpp, tutorial-image-viewer.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-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-structure-core.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.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-munkres-assignment.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, tutorial-pose-from-qrcode-image.cpp, tutorial-template-tracker.cpp, tutorial-video-reader.cpp, tutorial-video-recorder.cpp, tutorial-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 128 of file vpDisplayGDI.h.

Member Enumeration Documentation

◆ vpScaleType

enum vpDisplay::vpScaleType
inherited

Values that could be applied to a display to down scale the size of the display.

Enumerator
SCALE_AUTO 

Auto down scaling factor computed fom the screen resolution.

SCALE_1 

Display and image have the same size.

SCALE_2 

Display width and height is down scaled by 2 wrt the image size.

SCALE_3 

Display width and height is down scaled by 3 wrt the image size.

SCALE_4 

Display width and height is down scaled by 4 wrt the image size.

SCALE_5 

Display width and height is down scaled by 5 wrt the image size.

SCALE_6 

Display width and height is down scaled by 6 wrt the image size.

SCALE_7 

Display width and height is down scaled by 7 wrt the image size.

SCALE_8 

Display width and height is down scaled by 8 wrt the image size.

SCALE_9 

Display width and height is down scaled by 9 wrt the image size.

SCALE_10 

Display width and height is down scaled by 10 wrt the image size.

SCALE_DEFAULT 

Display and image have the same size. Similar to vpDisplay::SCALE_1.

Definition at line 182 of file vpDisplay.h.

Constructor & Destructor Documentation

◆ vpDisplayGDI() [1/6]

vpDisplayGDI::vpDisplayGDI ( )

Basic constructor.

Definition at line 55 of file vpDisplayGDI.cpp.

◆ vpDisplayGDI() [2/6]

vpDisplayGDI::vpDisplayGDI ( int  winx,
int  winy,
const std::string &  title = "" 
)

Constructor : Initialize a display.

Parameters
winx,winyThe window is set at position x,y (column index, row index).
titleWindow's title.

Definition at line 65 of file vpDisplayGDI.cpp.

References vpDisplay::m_title, vpDisplay::m_windowXPosition, and vpDisplay::m_windowYPosition.

◆ vpDisplayGDI() [3/6]

vpDisplayGDI::vpDisplayGDI ( vpImage< unsigned char > &  I,
vpScaleType  scaleType 
)

Constructor : Initialize a display to visualize a grayscale image (8 bits).

Parameters
IImage to be displayed (note that image has to be initialized).
scaleType: If this parameter is set to:

Definition at line 154 of file vpDisplayGDI.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpDisplayWin32::init(), and vpDisplay::setScale().

◆ vpDisplayGDI() [4/6]

vpDisplayGDI::vpDisplayGDI ( vpImage< unsigned char > &  I,
int  winx = -1,
int  winy = -1,
const std::string &  title = "",
vpScaleType  scaleType = SCALE_DEFAULT 
)

Constructor : Initialize a display to visualize a grayscale image (8 bits).

Parameters
IImage to be displayed (note that image has to be initialized).
winx,winyThe window is set at position x,y (column index, row index).
titleWindow's title.
scaleType: If this parameter is set to:

Definition at line 183 of file vpDisplayGDI.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpDisplayWin32::init(), and vpDisplay::setScale().

◆ vpDisplayGDI() [5/6]

vpDisplayGDI::vpDisplayGDI ( vpImage< vpRGBa > &  I,
vpScaleType  scaleType 
)

Constructor : Initialize a display to visualize a RGBa image (32 bits).

Parameters
I: image to be displayed (note that image has to be initialized).
scaleType: If this parameter is set to:

Definition at line 97 of file vpDisplayGDI.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpDisplayWin32::init(), and vpDisplay::setScale().

◆ vpDisplayGDI() [6/6]

vpDisplayGDI::vpDisplayGDI ( vpImage< vpRGBa > &  I,
int  winx = -1,
int  winy = -1,
const std::string &  title = "",
vpScaleType  scaleType = SCALE_DEFAULT 
)

Constructor : Initialize a display to visualize a RGBa image (32 bits).

Parameters
I: image to be displayed (note that image has to be initialized).
winx,winyThe window is set at position x,y (column index, row index).
titleWindow's title.
scaleType: If this parameter is set to:

Definition at line 126 of file vpDisplayGDI.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpDisplayWin32::init(), and vpDisplay::setScale().

◆ ~vpDisplayGDI()

vpDisplayGDI::~vpDisplayGDI ( )
virtual

Basic destructor.

Definition at line 194 of file vpDisplayGDI.cpp.

Member Function Documentation

◆ clearDisplay()

void vpDisplayWin32::clearDisplay ( const vpColor color = vpColor::white)
inherited

Clears the display.

Parameters
color: the color to fill the display with

Definition at line 833 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ close() [1/2]

void vpDisplay::close ( vpImage< unsigned char > &  I)
staticinherited

◆ close() [2/2]

void vpDisplay::close ( vpImage< vpRGBa > &  I)
staticinherited

Close the display attached to I.

Definition at line 51 of file vpDisplay_rgba.cpp.

◆ closeDisplay()

void vpDisplayWin32::closeDisplay ( )
inherited

◆ computeAutoScale()

unsigned int vpDisplay::computeAutoScale ( unsigned int  width,
unsigned int  height 
)
inherited

Computes the down scaling factor that should be applied to the window size to display the image given the resolution of the screen.

Parameters
width,height: Image size.
Returns

Definition at line 246 of file vpDisplay.cpp.

Referenced by vpDisplay::setScale().

◆ display() [1/2]

void vpDisplay::display ( const vpImage< unsigned char > &  I)
staticinherited

Display image I.

Warning
Display has to be initialized.
Suppress the overlay drawing.
Parameters
I: Image to display.
See also
init(), close()
Examples:
AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, fernClassifier.cpp, grab1394CMU.cpp, grab1394Two.cpp, grabDirectShow.cpp, grabDirectShowMulti.cpp, grabDisk.cpp, grabFlyCapture.cpp, grabOpenCV.cpp, grabRealSense.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2.cpp, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, keyboardControlBebop2.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6FourPoints2DCamVelocityLs_des.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityLs_cur.cpp, servoViper850FourPoints2DArtVelocityLs_des.cpp, servoViper850FourPoints2DCamVelocityLs_cur.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, testClick.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplays.cpp, testFeatureSegment.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testRobotAfma6Pose.cpp, testRobotBebop2.cpp, testRobotViper850Pose.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, testVirtuoseWithGlove.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-autothreshold.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-blob-auto-tracker.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-event-keyboard.cpp, tutorial-export-image.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-franka-acquire-calib-data.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-bebop2.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-multiple-realsense.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense-T265.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-rgbd-D435-structurecore.cpp, tutorial-grabber-structure-core.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-camera.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-simulator.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-keypoint-SIFT.cpp, tutorial-matching-keypoint.cpp, tutorial-matching-surf-deprecated.cpp, tutorial-matching-surf-homography-deprecated.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-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-structure-core.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.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-munkres-assignment.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, tutorial-pose-from-qrcode-image.cpp, tutorial-template-tracker.cpp, tutorial-video-reader.cpp, tutorial-video-recorder.cpp, tutorial-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 782 of file vpDisplay_uchar.cpp.

Referenced by vpVirtualGrabber::acquire(), vpDot2::defineDots(), vpWireFrameSimulator::getExternalImage(), vpWireFrameSimulator::getInternalImage(), vpPlot::init(), vpMbTracker::initClick(), vpDisplayOpenCV::on_mouse(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpSimulatorAfma6::setPosition(), vpMeEllipse::track(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

◆ display() [2/2]

void vpDisplay::display ( const vpImage< vpRGBa > &  I)
staticinherited

Display image I.

Warning
Display has to be initialized.
Suppress the overlay drawing.
Parameters
I: Image to display.
See also
init(), close()

Definition at line 780 of file vpDisplay_rgba.cpp.

◆ displayArrow() [1/5]

void vpDisplayWin32::displayArrow ( const vpImagePoint ip1,
const vpImagePoint ip2,
const vpColor color = vpColor::white,
unsigned int  w = 4,
unsigned int  h = 2,
unsigned int  thickness = 1 
)
protectedinherited

Display an arrow from image point ip1 to image point ip2.

Parameters
ip1,ip2: Initial and final image point.
color: Arrow color.
w,h: Width and height of the arrow.
thickness: Thickness of the lines used to display the arrow.

Definition at line 820 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayArrow() [2/5]

void vpDisplay::displayArrow ( const vpImage< unsigned char > &  I,
const vpImagePoint ip1,
const vpImagePoint ip2,
const vpColor color = vpColor::white,
unsigned int  w = 4,
unsigned int  h = 2,
unsigned int  thickness = 1 
)
staticinherited

Display an arrow from image point ip1 to image point ip2.

Parameters
I: The image associated to the display.
ip1,ip2: Initial and final image points.
color: Arrow color.
w,h: Width and height of the arrow.
thickness: Thickness of the lines used to display the arrow.
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, and testDisplays.cpp.

Definition at line 61 of file vpDisplay_uchar.cpp.

Referenced by vpMeLine::computeRhoTheta(), vpMbDepthNormalTracker::display(), vpProjectionDisplay::displayCamera(), vpMbtFaceDepthNormal::displayFeature(), vpMeTracker::initTracking(), vpMeTracker::track(), and vpMbGenericTracker::track().

◆ displayArrow() [3/5]

void vpDisplay::displayArrow ( const vpImage< unsigned char > &  I,
int  i1,
int  j1,
int  i2,
int  j2,
const vpColor color = vpColor::white,
unsigned int  w = 4,
unsigned int  h = 2,
unsigned int  thickness = 1 
)
staticinherited

Display an arrow from image point (i1,j1) to image point (i2,j2).

Parameters
I: The image associated to the display.
i1,j1: Initial image point.
i2,j2: Final image point.
color: Arrow color.
w,h: Width and height of the arrow.
thickness: Thickness of the lines used to display the arrow.

Definition at line 77 of file vpDisplay_uchar.cpp.

◆ displayArrow() [4/5]

void vpDisplay::displayArrow ( const vpImage< vpRGBa > &  I,
const vpImagePoint ip1,
const vpImagePoint ip2,
const vpColor color = vpColor::white,
unsigned int  w = 4,
unsigned int  h = 2,
unsigned int  thickness = 1 
)
staticinherited

Display an arrow from image point ip1 to image point ip2.

Parameters
I: The image associated to the display.
ip1,ip2: Initial and final image points.
color: Arrow color.
w,h: Width and height of the arrow.
thickness: Thickness of the lines used to display the arrow.

Definition at line 61 of file vpDisplay_rgba.cpp.

◆ displayArrow() [5/5]

void vpDisplay::displayArrow ( const vpImage< vpRGBa > &  I,
int  i1,
int  j1,
int  i2,
int  j2,
const vpColor color = vpColor::white,
unsigned int  w = 4,
unsigned int  h = 2,
unsigned int  thickness = 1 
)
staticinherited

Display an arrow from image point (i1,j1) to image point (i2,j2).

Parameters
I: The image associated to the display.
i1,j1: Initial image point.
i2,j2: Final image point.
color: Arrow color.
w,h: Width and height of the arrow.
thickness: Thickness of the lines used to display the arrow.

Definition at line 77 of file vpDisplay_rgba.cpp.

◆ displayCamera() [1/2]

void vpDisplay::displayCamera ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix cMo,
const vpCameraParameters cam,
double  size,
const vpColor color,
unsigned int  thickness 
)
staticinherited

Display the projection of an object camera represented by a cone in the image.

Parameters
I: The image associated to the display.
cMo: Homogeneous matrix that gives the transformation between the camera frame and the object frame to project in the image.
cam: Camera intrinsic parameters.
size: Size of the object camera.
color: Color used to display the camera in the image.
thickness: Thickness of the graphics drawing.

Definition at line 96 of file vpDisplay_uchar.cpp.

Referenced by vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

◆ displayCamera() [2/2]

void vpDisplay::displayCamera ( const vpImage< vpRGBa > &  I,
const vpHomogeneousMatrix cMo,
const vpCameraParameters cam,
double  size,
const vpColor color,
unsigned int  thickness 
)
staticinherited

Display the projection of an object camera represented by a cone in the image.

Parameters
I: The image associated to the display.
cMo: Homogeneous matrix that gives the transformation between the camera frame and the object frame to project in the image.
cam: Camera intrinsic parameters.
size: Size of the object camera.
color: Color used to display the camera in the image.
thickness: Thickness of the graphics drawing.

Definition at line 96 of file vpDisplay_rgba.cpp.

◆ displayCharString() [1/5]

void vpDisplayWin32::displayCharString ( const vpImagePoint ip,
const char *  text,
const vpColor color = vpColor::green 
)
protectedinherited

Displays a string.

Parameters
ip: its top left point's coordinates
text: The string to display
color: The text's color

Definition at line 791 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayCharString() [2/5]

void vpDisplay::displayCharString ( const vpImage< unsigned char > &  I,
const vpImagePoint ip,
const char *  string,
const vpColor color 
)
staticinherited

Display a string at the image point ip location. Use rather displayText() that does the same.

To select the font used to display the string, use setFont().

Parameters
I: Image associated to the display.
ip: Upper left image point location of the string in the display.
string: String to display in overlay.
color: String color.
See also
setFont(), displayText()

Definition at line 115 of file vpDisplay_uchar.cpp.

◆ displayCharString() [3/5]

void vpDisplay::displayCharString ( const vpImage< unsigned char > &  I,
int  i,
int  j,
const char *  string,
const vpColor color 
)
staticinherited

Display a string at the image point (i,j) location. Use rather displayText() that does the same.

To select the font used to display the string, use setFont().

Parameters
I: Image associated to the display.
i,j: Upper left image point location of the string in the display.
string: String to display in overlay.
color: String color.
See also
setFont(), displayText()

Definition at line 134 of file vpDisplay_uchar.cpp.

◆ displayCharString() [4/5]

void vpDisplay::displayCharString ( const vpImage< vpRGBa > &  I,
const vpImagePoint ip,
const char *  string,
const vpColor color 
)
staticinherited

Display a string at the image point ip location. Use rather displayText() that does the same.

To select the font used to display the string, use setFont().

Parameters
I: Image associated to the display.
ip: Upper left image point location of the string in the display.
string: String to display in overlay.
color: String color.
See also
setFont(), displayText()

Definition at line 115 of file vpDisplay_rgba.cpp.

◆ displayCharString() [5/5]

void vpDisplay::displayCharString ( const vpImage< vpRGBa > &  I,
int  i,
int  j,
const char *  string,
const vpColor color 
)
staticinherited

Display a string at the image point (i,j) location. Use rather displayText() that does the same.

To select the font used to display the string, use setFont().

Parameters
I: Image associated to the display.
i,j: Upper left image point location of the string in the display.
string: String to display in overlay.
color: String color.
See also
setFont(), displayText()

Definition at line 134 of file vpDisplay_rgba.cpp.

◆ displayCircle() [1/5]

void vpDisplayWin32::displayCircle ( const vpImagePoint center,
unsigned int  radius,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
protectedinherited

Display a circle.

Parameters
center: Circle center position.
radius: Circle radius.
color: Circle color.
fill: When set to true fill the circle.
thickness: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 777 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayCircle() [2/5]

void vpDisplay::displayCircle ( const vpImage< unsigned char > &  I,
const vpImagePoint center,
unsigned int  radius,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a circle.

Parameters
I: The image associated to the display.
center: Circle center position.
radius: Circle radius.
color: Circle color.
fill: When set to true fill the circle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the circle. This parameter is only useful when fill is set to false.
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, testDisplays.cpp, testKeyPoint-2.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-image-display-scaled-auto.cpp, tutorial-image-display-scaled-manu.cpp, tutorial-image-display.cpp, and tutorial-munkres-assignment.cpp.

Definition at line 152 of file vpDisplay_uchar.cpp.

Referenced by vpFeatureSegment::display(), vpProjectionDisplay::display(), vpKeyPoint::displayMatching(), and vpDot2::trackAndDisplay().

◆ displayCircle() [3/5]

void vpDisplay::displayCircle ( const vpImage< unsigned char > &  I,
int  i,
int  j,
unsigned int  radius,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a circle.

Parameters
I: The image associated to the display.
i,j: Circle center position.
radius: Circle radius.
color: Circle color.
fill: When set to true fill the circle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 170 of file vpDisplay_uchar.cpp.

◆ displayCircle() [4/5]

void vpDisplay::displayCircle ( const vpImage< vpRGBa > &  I,
const vpImagePoint center,
unsigned int  radius,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a circle.

Parameters
I: The image associated to the display.
center: Circle center position.
radius: Circle radius.
color: Circle color.
fill: When set to true fill the circle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 151 of file vpDisplay_rgba.cpp.

◆ displayCircle() [5/5]

void vpDisplay::displayCircle ( const vpImage< vpRGBa > &  I,
int  i,
int  j,
unsigned int  radius,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a circle.

Parameters
I: The image associated to the display.
i,j: Circle center position.
radius: Circle radius.
color: Circle color.
fill: When set to true fill the circle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 169 of file vpDisplay_rgba.cpp.

◆ displayCross() [1/5]

void vpDisplayWin32::displayCross ( const vpImagePoint ip,
unsigned int  size,
const vpColor color,
unsigned int  thickness = 1 
)
protectedinherited

Display a cross at the image point ip location.

Parameters
ip: Cross location.
size: Size (width and height) of the cross.
color: Cross color.
thickness: Thickness of the lines used to display the cross.

Definition at line 805 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayCross() [2/5]

void vpDisplay::displayCross ( const vpImage< unsigned char > &  I,
const vpImagePoint ip,
unsigned int  size,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a cross at the image point ip location.

Parameters
I: The image associated to the display.
ip: Cross location.
size: Size (width and height) of the cross.
color: Cross color.
thickness: Thickness of the lines used to display the cross.
Examples:
AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, poseVirtualVS.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6FourPoints2DCamVelocityLs_des.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Segment2DCamVelocity.cpp, servoBebop2.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityLs_cur.cpp, servoViper850FourPoints2DArtVelocityLs_des.cpp, servoViper850FourPoints2DCamVelocityLs_cur.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, sonarPioneerReader.cpp, testDisplays.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testNurbs.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-draw-cross.cpp, tutorial-klt-tracker-live-v4l2.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-surf-homography-deprecated.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, and tutorial-pose-from-qrcode-image.cpp.

Definition at line 184 of file vpDisplay_uchar.cpp.

Referenced by vpMbtDistanceCylinder::computeInteractionMatrixError(), vpDot2::defineDots(), vpKltOpencv::display(), vpDot2::display(), vpDot::display(), vpMeNurbs::display(), vpMbEdgeKltTracker::display(), vpMeSite::display(), vpMeLine::display(), vpMbKltTracker::display(), vpKeyPoint::display(), vpCalibration::displayData(), vpMbEdgeTracker::displayFeaturesOnImage(), vpCalibration::displayGrid(), vpKeyPoint::displayMatching(), vpPose::displayModel(), vpFeatureDisplay::displayPoint(), vpMbtDistanceKltCylinder::displayPrimitive(), vpMbtDistanceKltPoints::displayPrimitive(), vpMeSite::getQueryList(), vpTemplateTrackerZone::initClick(), vpPolygon::initClick(), vpMbTracker::initClick(), vpMeNurbs::initTracking(), vpMeLine::initTracking(), vpMeEllipse::initTracking(), vpMeEllipse::leastSquareRobust(), vpMeEllipse::plugHoles(), vpMeLine::sample(), vpMeEllipse::sample(), vpDot2::searchDotsInArea(), vpMeLine::seekExtremities(), vpMeNurbs::seekExtremities(), vpKltOpencv::suppressFeature(), vpDot2::track(), vpDot::track(), and vpMbGenericTracker::track().

◆ displayCross() [3/5]

void vpDisplay::displayCross ( const vpImage< unsigned char > &  I,
int  i,
int  j,
unsigned int  size,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a cross at the image point (i,j) location.

Parameters
I: The image associated to the display.
i,j: Cross location.
size: Size (width and height) of the cross.
color: Cross color.
thickness: Thickness of the lines used to display the cross.

Definition at line 198 of file vpDisplay_uchar.cpp.

◆ displayCross() [4/5]

void vpDisplay::displayCross ( const vpImage< vpRGBa > &  I,
const vpImagePoint ip,
unsigned int  size,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a cross at the image point ip location.

Parameters
I: The image associated to the display.
ip: Cross location.
size: Size (width and height) of the cross.
color: Cross color.
thickness: Thickness of the lines used to display the cross.

Definition at line 183 of file vpDisplay_rgba.cpp.

◆ displayCross() [5/5]

void vpDisplay::displayCross ( const vpImage< vpRGBa > &  I,
int  i,
int  j,
unsigned int  size,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a cross at the image point (i,j) location.

Parameters
I: The image associated to the display.
i,j: Cross location.
size: Size (width and height) of the cross.
color: Cross color.
thickness: Thickness of the lines used to display the cross.

Definition at line 197 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [1/9]

void vpDisplayWin32::displayDotLine ( const vpImagePoint ip1,
const vpImagePoint ip2,
const vpColor color,
unsigned int  thickness = 1 
)
protectedinherited

Display a dashed line from image point ip1 to image point ip2.

Warning
This line is a dashed line only if the thickness is equal to 1.
Parameters
ip1,ip2: Initial and final image points.
color: Line color.
thickness: Line thickness.

Definition at line 695 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayDotLine() [2/9]

void vpDisplay::displayDotLine ( const vpImage< unsigned char > &  I,
const vpImagePoint ip1,
const vpImagePoint ip2,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a dashed line from image point ip1 to image point ip2.

Parameters
I: The image associated to the display.
ip1,ip2: Initial and final image points.
color: Line color.
thickness: Dashed line thickness.
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, testDisplayPolygonLines.cpp, and testDisplays.cpp.

Definition at line 211 of file vpDisplay_uchar.cpp.

Referenced by vpDot2::trackAndDisplay().

◆ displayDotLine() [3/9]

void vpDisplay::displayDotLine ( const vpImage< unsigned char > &  I,
int  i1,
int  j1,
int  i2,
int  j2,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a dashed line from image point (i1,j1) to image point (i2,j2).

Parameters
I: The image associated to the display.
i1,j1Initial image point.
i2,j2Final image point.
color: Line color.
thickness: Dashed line thickness.

Definition at line 225 of file vpDisplay_uchar.cpp.

◆ displayDotLine() [4/9]

void vpDisplay::displayDotLine ( const vpImage< unsigned char > &  I,
const std::vector< vpImagePoint > &  ips,
bool  closeTheShape,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display dashed lines for the list of image points.

Parameters
I: The image associated to the display.
ips: Vector of image points.
closeTheShape: If true, display a dashed line from the first and last image points.
color: Line color.
thickness: Dashed line thickness.

Definition at line 240 of file vpDisplay_uchar.cpp.

◆ displayDotLine() [5/9]

void vpDisplay::displayDotLine ( const vpImage< unsigned char > &  I,
const std::list< vpImagePoint > &  ips,
bool  closeTheShape,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display dashed lines for the list of image points.

Parameters
I: The image associated to the display.
ips: List of image points.
closeTheShape: If true, display a dashed line from the first and last image points.
color: Line color.
thickness: Dashed line thickness.

Definition at line 262 of file vpDisplay_uchar.cpp.

References vpImagePoint::distance().

◆ displayDotLine() [6/9]

void vpDisplay::displayDotLine ( const vpImage< vpRGBa > &  I,
const vpImagePoint ip1,
const vpImagePoint ip2,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a dashed line from image point ip1 to image point ip2.

Parameters
I: The image associated to the display.
ip1,ip2: Initial and final image points.
color: Line color.
thickness: Dashed line thickness.

Definition at line 210 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [7/9]

void vpDisplay::displayDotLine ( const vpImage< vpRGBa > &  I,
int  i1,
int  j1,
int  i2,
int  j2,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a dashed line from image point (i1,j1) to image point (i2,j2).

Parameters
I: The image associated to the display.
i1,j1Initial image point.
i2,j2Final image point.
color: Line color.
thickness: Dashed line thickness.

Definition at line 224 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [8/9]

void vpDisplay::displayDotLine ( const vpImage< vpRGBa > &  I,
const std::vector< vpImagePoint > &  ips,
bool  closeTheShape,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display the dashed lines formed by the list of image points

Parameters
I: The image associated to the display.
ips: Vector of image points.
closeTheShape: If true, display a dashed line from the first and last image points.
color: Line color.
thickness: Dashed line thickness.

Definition at line 239 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [9/9]

void vpDisplay::displayDotLine ( const vpImage< vpRGBa > &  I,
const std::list< vpImagePoint > &  ips,
bool  closeTheShape,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display the dashed lines formed by the list of image points

Parameters
I: The image associated to the display.
ips: List of image points.
closeTheShape: If true, display a dashed line from the first and last image points.
color: Line color.
thickness: Dashed line thickness.

Definition at line 261 of file vpDisplay_rgba.cpp.

References vpImagePoint::distance().

◆ displayEllipse() [1/4]

void vpDisplay::displayEllipse ( const vpImage< unsigned char > &  I,
const vpImagePoint center,
const double &  coef1,
const double &  coef2,
const double &  coef3,
bool  use_normalized_centered_moments,
const vpColor color,
unsigned int  thickness = 1,
bool  display_center = false,
bool  display_arc = false 
)
staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters
I: Image to consider.
center: Center $(u_c, v_c)$ of the ellipse.
coef1,coef2,coef3: Depending on the parameter use_normalized_centered_moments these parameters are:
  • second order centered moments of the ellipse normalized by its area (i.e., such that $n_{ij} = \mu_{ij}/a$ where $\mu_{ij}$ are the centered moments and a the area) expressed in pixels.
  • the major and minor axis lenght in pixels and the excentricity of the ellipse in radians: $a, b, e$.
use_normalized_centered_moments: When false, the parameters coef1, coef2, coef3 are the parameters $a, b, e$. When true, the parameters coef1, coef2, coef3 are rather the normalized centered moments $n_{20}, n_{11}, n_{02}$ expressed in pixels. In that case, we compute the parameters a, b and e from the centered moments.
color: Ellipse color.
thickness: Ellipse thickness.
display_center: Display a cross at the center of the ellipse.
display_arc: Display a line between the center and the first arc extremity and a line between the center and the second arc extremity.

The following example shows how to use for example this function to display the result of a tracking.

vpMeEllipse ellipse;
...
vpDisplay::display(I);
ellipse.track(I);
ellipse.get_nij()[0], ellipse.get_nij()[1], ellipse.get_nij()[2],
true, vpColor::orange, 1);

Definition at line 319 of file vpDisplay_uchar.cpp.

Referenced by vpMbtDistanceCircle::display(), vpMbEdgeKltTracker::display(), vpMbKltTracker::display(), vpMbEdgeTracker::display(), vpMeEllipse::display(), vpFeatureDisplay::displayEllipse(), vpDisplay::displayEllipse(), and vpMbGenericTracker::track().

◆ displayEllipse() [2/4]

void vpDisplay::displayEllipse ( const vpImage< unsigned char > &  I,
const vpImagePoint center,
const double &  coef1,
const double &  coef2,
const double &  coef3,
const double &  smallalpha,
const double &  highalpha,
bool  use_normalized_centered_moments,
const vpColor color,
unsigned int  thickness = 1,
bool  display_center = false,
bool  display_arc = false 
)
staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters
I: Image to consider.
center: Center $(u_c, v_c)$ of the ellipse.
coef1,coef2,coef3: Depending on the parameter use_normalized_centered_moments these parameters are:
  • second order centered moments of the ellipse normalized by its area (i.e., such that $n_{ij} = \mu_{ij}/a$ where $\mu_{ij}$ are the centered moments and a the area) expressed in pixels.
  • the major and minor axis lenght in pixels and the excentricity of the ellipse in radians: $a, b, e$.
smallalpha: Smallest $ alpha $ angle in rad (0 for a complete ellipse).
highalpha: Highest $ alpha $ angle in rad (2 $ \Pi $ for a complete ellipse).
use_normalized_centered_moments: When false, the parameters coef1, coef2, coef3 are the parameters $a, b, e$. When true, the parameters coef1, coef2, coef3 are rather the normalized centered moments $n_{20}, n_{11}, n_{02}$ expressed in pixels. In that case, we compute the parameters a, b and e from the centered moments.
color: Ellipse color.
thickness: Ellipse thickness.
display_center: Display a cross at the center of the ellipse.
display_arc: Display a line between the center and the first arc extremity and a line between the center and the second arc extremity.

The following example shows how to use for example this function to display the result of a tracking.

vpMeEllipse ellipse;
...
vpDisplay::display(I);
ellipse.track(I);
ellipse.get_nij()[0], ellipse.get_nij()[1], ellipse.get_nij()[2],
ellipse.getSmallestAngle(), ellipse.getHighestAngle(),
true, vpColor::orange, 1);

Definition at line 366 of file vpDisplay_uchar.cpp.

◆ displayEllipse() [3/4]

void vpDisplay::displayEllipse ( const vpImage< vpRGBa > &  I,
const vpImagePoint center,
const double &  coef1,
const double &  coef2,
const double &  coef3,
bool  use_normalized_centered_moments,
const vpColor color,
unsigned int  thickness = 1,
bool  display_center = false,
bool  display_arc = false 
)
staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters
I: Image to consider.
center: Center $(u_c, v_c)$ of the ellipse.
coef1,coef2,coef3: Depending on the parameter use_normalized_centered_moments these parameters are:
  • second order centered moments of the ellipse normalized by its area (i.e., such that $n_{ij} = \mu_{ij}/a$ where $\mu_{ij}$ are the centered moments and a the area) expressed in pixels.
  • the major and minor axis lenght in pixels and the excentricity of the ellipse in radians: $a, b, e$.
use_normalized_centered_moments: When false, the parameters coef1, coef2, coef3 are the parameters $a, b, e$. When true, the parameters coef1, coef2, coef3 are rather the normalized centered moments $n_{20}, n_{11}, n_{02}$ expressed in pixels. In that case, we compute the parameters a, b and e from the centered moments.
color: Ellipse color.
thickness: Ellipse thickness.
display_center: Display a cross at the center of the ellipse.
display_arc: Display a line between the center and the first arc extremity and a line between the center and the second arc extremity.

The following example shows how to use for example this function to display the result of a tracking.

vpMeEllipse ellipse;
...
vpDisplay::display(I);
ellipse.track(I);
ellipse.get_nij()[0], ellipse.get_nij()[1], ellipse.get_nij()[2],
true, vpColor::orange, 1);

Definition at line 318 of file vpDisplay_rgba.cpp.

References vpDisplay::displayEllipse().

◆ displayEllipse() [4/4]

void vpDisplay::displayEllipse ( const vpImage< vpRGBa > &  I,
const vpImagePoint center,
const double &  coef1,
const double &  coef2,
const double &  coef3,
const double &  smallalpha,
const double &  highalpha,
bool  use_normalized_centered_moments,
const vpColor color,
unsigned int  thickness = 1,
bool  display_center = false,
bool  display_arc = false 
)
staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters
I: Image to consider.
center: Center $(u_c, v_c)$ of the ellipse.
coef1,coef2,coef3: Depending on the parameter use_normalized_centered_moments these parameters are:
  • second order centered moments of the ellipse normalized by its area (i.e., such that $n_{ij} = \mu_{ij}/a$ where $\mu_{ij}$ are the centered moments and a the area) expressed in pixels.
  • the major and minor axis lenght in pixels and the excentricity of the ellipse in radians: $a, b, e$.
smallalpha: Smallest $ alpha $ angle in rad (0 for a complete ellipse).
highalpha: Highest $ alpha $ angle in rad (2 $ \Pi $ for a complete ellipse).
use_normalized_centered_moments: When false, the parameters coef1, coef2, coef3 are the parameters $a, b, e$. When true, the parameters coef1, coef2, coef3 are rather the normalized centered moments $n_{20}, n_{11}, n_{02}$ expressed in pixels. In that case, we compute the parameters a, b and e from the centered moments.
color: Ellipse color.
thickness: Ellipse thickness.
display_center: Display a cross at the center of the ellipse.
display_arc: Display a line between the center and the first arc extremity and a line between the center and the second arc extremity.

The following example shows how to use for example this function to display the result of a tracking.

vpMeEllipse ellipse;
...
vpDisplay::display(I);
ellipse.track(I);
ellipse.get_nij()[0], ellipse.get_nij()[1], ellipse.get_nij()[2],
ellipse.getSmallestAngle(), ellipse.getHighestAngle(),
true, vpColor::orange, 1);

Definition at line 365 of file vpDisplay_rgba.cpp.

◆ displayFrame() [1/2]

void vpDisplay::displayFrame ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix cMo,
const vpCameraParameters cam,
double  size,
const vpColor color = vpColor::none,
unsigned int  thickness = 1,
const vpImagePoint offset = vpImagePoint(0, 0) 
)
staticinherited

Display the projection of an object frame represented by 3 arrows in the image. Red, green and blue arrows correspond to frame X, Y and Z axis respectively.

Parameters
I: The image associated to the display.
cMo: Homogeneous matrix that gives the transformation between the camera frame and the object frame to project in the image.
cam: Camera intrinsic parameters.
size: Size of the object frame.
color: Color used to display the frame in the image.
thickness: the thickness of the line.
offset: Offset in pixels applied to the frame origin location in the image.
Examples:
grabRealSense2_T265.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, servoFrankaPBVS.cpp, servoSimu4Points.cpp, servoSimuCylinder.cpp, servoSimuSphere.cpp, testDisplays.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testVirtuoseWithGlove.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.cpp, tutorial-apriltag-detector-live-T265-realsense.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-rs2.cpp, tutorial-mb-generic-tracker-apriltag-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-structure-core.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.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, and tutorial-pose-from-qrcode-image.cpp.

Definition at line 390 of file vpDisplay_uchar.cpp.

Referenced by vpPose::display(), vpMbTracker::initClick(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

◆ displayFrame() [2/2]

void vpDisplay::displayFrame ( const vpImage< vpRGBa > &  I,
const vpHomogeneousMatrix cMo,
const vpCameraParameters cam,
double  size,
const vpColor color = vpColor::none,
unsigned int  thickness = 1,
const vpImagePoint offset = vpImagePoint(0, 0) 
)
staticinherited

Display the projection of an object frame represented by 3 arrows in the image. Red, green and blue arrows correspond to frame X, Y and Z axis respectively.

Parameters
I: The image associated to the display.
cMo: Homogeneous matrix that gives the transformation between the camera frame and the object frame to project in the image.
cam: Camera intrinsic parameters.
size: Size of the object frame.
color: Color used to display the frame in the image.
thickness: the thickness of the line.
offset: Offset in pixels applied to the frame origin location in the image.

Definition at line 389 of file vpDisplay_rgba.cpp.

◆ displayImage() [1/2]

void vpDisplayWin32::displayImage ( const vpImage< vpRGBa > &  I)
inherited

Display the color image I in RGBa format (32bits).

Warning
Display has to be initialized.
suppres the overlay drawing
Parameters
I: Image to display.
See also
init(), closeDisplay()

Definition at line 184 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayImage() [2/2]

void vpDisplayWin32::displayImage ( const vpImage< unsigned char > &  I)
inherited

Display the gray level image I (8bits).

Warning
Display has to be initialized.
suppres the overlay drawing
Parameters
I: Image to display.
See also
init(), closeDisplay()

Definition at line 235 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayImageROI() [1/2]

void vpDisplayWin32::displayImageROI ( const vpImage< unsigned char > &  I,
const vpImagePoint iP,
unsigned int  width,
unsigned int  height 
)
inherited

Display a selection of the gray level image I (8bits).

Warning
Display has to be initialized.
Suppress the overlay drawing in the region of interest.
Parameters
I: Image to display.
iP: Top left corner of the region of interest
width: Width of the region of interest
height: Height of the region of interest
See also
init(), closeDisplay()

Definition at line 263 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayImageROI() [2/2]

void vpDisplayWin32::displayImageROI ( const vpImage< vpRGBa > &  I,
const vpImagePoint iP,
unsigned int  width,
unsigned int  height 
)
inherited

Display a selection of the color image I in RGBa format (32bits).

Warning
Display has to be initialized.
Suppress the overlay drawing in the region of interest.
Parameters
I: Image to display.
iP: Top left corner of the region of interest
width: Width of the region of interest
height: Height of the region of interest
See also
init(), closeDisplay()

Definition at line 212 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayLine() [1/9]

void vpDisplayWin32::displayLine ( const vpImagePoint ip1,
const vpImagePoint ip2,
const vpColor color,
unsigned int  thickness = 1 
)
protectedinherited

Display a line from image point ip1 to image point ip2.

Parameters
ip1,ip2: Initial and final image points.
color: Line color.
thickness: Line thickness.

Definition at line 678 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayLine() [2/9]

void vpDisplay::displayLine ( const vpImage< unsigned char > &  I,
const vpImagePoint ip1,
const vpImagePoint ip2,
const vpColor color,
unsigned int  thickness = 1,
bool  segment = true 
)
staticinherited

Display a line from image point ip1 to image point ip2.

Parameters
I: The image associated to the display.
ip1,ip2: Initial and final image points.
color: Line color.
thickness: Line thickness.
segmentIf true (default) display the segment between the two image points. If false, display the line passing through the two image points.
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, grabRealSense2_T265.cpp, manDisplay.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, servoBebop2.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, testDisplayPolygonLines.cpp, testDisplays.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testRealSense2_D435_align.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, tutorial-draw-line.cpp, tutorial-flood-fill.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-matching-keypoint-homography.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-matching-keypoint.cpp, tutorial-matching-surf-deprecated.cpp, tutorial-matching-surf-homography-deprecated.cpp, and tutorial-munkres-assignment.cpp.

Definition at line 406 of file vpDisplay_uchar.cpp.

References vpImagePoint::get_i(), and vpImagePoint::get_j().

Referenced by vpVirtualGrabber::acquire(), vpMbDepthDenseTracker::display(), vpMbDepthNormalTracker::display(), vpTemplateTrackerZone::display(), vpFeatureSegment::display(), vpMbtFaceDepthDense::display(), vpMbtFaceDepthNormal::display(), vpMbtDistanceKltCylinder::display(), vpMbtDistanceLine::display(), vpMbtDistanceKltPoints::display(), vpPolygon::display(), vpMbtDistanceCylinder::display(), vpMbEdgeKltTracker::display(), vpHistogram::display(), vpMeLine::display(), vpMbKltTracker::display(), vpMbEdgeTracker::display(), vpWireFrameSimulator::display_scene(), vpFeatureDisplay::displayLine(), vpDisplay::displayLine(), vpKeyPoint::displayMatching(), vpWireFrameSimulator::displayTrajectory(), vpWireFrameSimulator::getExternalImage(), vpTemplateTrackerZone::initClick(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpMbGenericTracker::track(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

◆ displayLine() [3/9]

void vpDisplay::displayLine ( const vpImage< unsigned char > &  I,
int  i1,
int  j1,
int  i2,
int  j2,
const vpColor color,
unsigned int  thickness = 1,
bool  segment = true 
)
staticinherited

Display a line from image point (i1,j1) to image point (i2,j2).

Parameters
I: The image associated to the display.
i1,j1Initial image point.
i2,j2Final image point.
color: Line color.
thickness: Line thickness.
segmentIf true (default) display the segment between the two image points. If false, display the line passing through the two image points.

Definition at line 422 of file vpDisplay_uchar.cpp.

References vpImagePoint::get_i(), vpImagePoint::get_j(), vpImage< Type >::getHeight(), and vpImage< Type >::getWidth().

◆ displayLine() [4/9]

void vpDisplay::displayLine ( const vpImage< unsigned char > &  I,
const std::vector< vpImagePoint > &  ips,
bool  closeTheShape,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display the lines formed by the list of image points.

Parameters
I: The image associated to the display.
ips: Vector of image points.
closeTheShape: If true, display a line from the first and last image points.
color: Line color.
thickness: Line thickness.

Definition at line 488 of file vpDisplay_uchar.cpp.

◆ displayLine() [5/9]

void vpDisplay::displayLine ( const vpImage< unsigned char > &  I,
const std::list< vpImagePoint > &  ips,
bool  closeTheShape,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display the lines formed by the list of image points.

Parameters
I: The image associated to the display.
ips: List of image points.
closeTheShape: If true, display a line from the first and last image points.
color: Line color.
thickness: Line thickness.

Definition at line 509 of file vpDisplay_uchar.cpp.

References vpImagePoint::distance().

◆ displayLine() [6/9]

void vpDisplay::displayLine ( const vpImage< vpRGBa > &  I,
const vpImagePoint ip1,
const vpImagePoint ip2,
const vpColor color,
unsigned int  thickness = 1,
bool  segment = true 
)
staticinherited

Display a line from image point ip1 to image point ip2.

Parameters
I: The image associated to the display.
ip1,ip2: Initial and final image points.
color: Line color.
thickness: Line thickness.
segmentIf true (default) display the segment between the two image points. If false, display the line passing through the two image points.

Definition at line 404 of file vpDisplay_rgba.cpp.

References vpDisplay::displayLine(), vpImagePoint::get_i(), and vpImagePoint::get_j().

◆ displayLine() [7/9]

void vpDisplay::displayLine ( const vpImage< vpRGBa > &  I,
int  i1,
int  j1,
int  i2,
int  j2,
const vpColor color,
unsigned int  thickness = 1,
bool  segment = true 
)
staticinherited

Display a line from image point (i1,j1) to image point (i2,j2).

Parameters
I: The image associated to the display.
i1,j1Initial image point.
i2,j2Final image point.
color: Line color.
thickness: Line thickness.
segmentIf true (default) display the segment between the two image points. If false, display the line passing through the two image points.

Definition at line 420 of file vpDisplay_rgba.cpp.

References vpImagePoint::get_i(), vpImagePoint::get_j(), vpImage< Type >::getHeight(), and vpImage< Type >::getWidth().

◆ displayLine() [8/9]

void vpDisplay::displayLine ( const vpImage< vpRGBa > &  I,
const std::vector< vpImagePoint > &  ips,
bool  closeTheShape,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display the lines formed by the list of image points.

Parameters
I: The image associated to the display.
ips: Vector of image points.
closeTheShape: If true, draw a line from the first and last image points.
color: Line color.
thickness: Line thickness.

Definition at line 487 of file vpDisplay_rgba.cpp.

◆ displayLine() [9/9]

void vpDisplay::displayLine ( const vpImage< vpRGBa > &  I,
const std::list< vpImagePoint > &  ips,
bool  closeTheShape,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display the lines formed by the list of image points.

Parameters
I: The image associated to the display.
ips: List of image points.
closeTheShape: If true, draw a line from the first and last image points.
color: Line color.
thickness: Line thickness.

Definition at line 509 of file vpDisplay_rgba.cpp.

References vpImagePoint::distance().

◆ displayPoint() [1/5]

void vpDisplayWin32::displayPoint ( const vpImagePoint ip,
const vpColor color,
unsigned int  thickness = 1 
)
protectedinherited

Display a point at the image point ip location.

Parameters
ip: Point location.
color: Point color.
thickness: Point thickness.

Definition at line 661 of file vpDisplayWin32.cpp.

References vpDisplay::m_scale, vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayPoint() [2/5]

void vpDisplay::displayPoint ( const vpImage< unsigned char > &  I,
const vpImagePoint ip,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a point at the image point ip location.

Parameters
I: The image associated to the display.
ip: Point location.
color: Point color.
thickness: Thickness of the point
Examples:
servoAfma6Points2DCamVelocityEyeToHand.cpp, testDisplays.cpp, trackDot.cpp, trackDot2.cpp, and tutorial-draw-point.cpp.

Definition at line 537 of file vpDisplay_uchar.cpp.

Referenced by vpDot2::display(), vpDot::display(), vpWireFrameSimulator::displayTrajectory(), vpWireFrameSimulator::getExternalImage(), vpDot2::getFreemanChain(), vpMbTracker::initClick(), vpDot::operator==(), vpDot2::searchDotsInArea(), vpMeNurbs::seekExtremitiesCanny(), and vpMeSite::track().

◆ displayPoint() [3/5]

void vpDisplay::displayPoint ( const vpImage< unsigned char > &  I,
int  i,
int  j,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a point at the image point (i,j) location.

Parameters
I: The image associated to the display.
i,j: Point location.
color: Point color.
thickness: Thickness of the point

Definition at line 550 of file vpDisplay_uchar.cpp.

◆ displayPoint() [4/5]

void vpDisplay::displayPoint ( const vpImage< vpRGBa > &  I,
const vpImagePoint ip,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a point at the image point ip location.

Parameters
I: The image associated to the display.
ip: Point location.
color: Point color.
thickness: Thickness of the point

Definition at line 537 of file vpDisplay_rgba.cpp.

◆ displayPoint() [5/5]

void vpDisplay::displayPoint ( const vpImage< vpRGBa > &  I,
int  i,
int  j,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a point at the image point (i,j) location.

Parameters
I: The image associated to the display.
i,j: Point location.
color: Point color.
thickness: Thickness of the point

Definition at line 550 of file vpDisplay_rgba.cpp.

◆ displayPolygon() [1/2]

void vpDisplay::displayPolygon ( const vpImage< unsigned char > &  I,
const std::vector< vpImagePoint > &  vip,
const vpColor color,
unsigned int  thickness = 1,
bool  closed = true 
)
staticinherited

Display a polygon defined by a vector of image points.

Parameters
I: The image associated to the display.
vip: Vector of image point that define the vertexes of the polygon.
color: Line color.
thickness: Line thickness.
closed: When true display a closed polygon with a segment between first and last image point.
Examples:
mbot-apriltag-ibvs.cpp, servoBebop2.cpp, and testDisplays.cpp.

Definition at line 564 of file vpDisplay_uchar.cpp.

◆ displayPolygon() [2/2]

void vpDisplay::displayPolygon ( const vpImage< vpRGBa > &  I,
const std::vector< vpImagePoint > &  vip,
const vpColor color,
unsigned int  thickness = 1,
bool  closed = true 
)
staticinherited

Display a polygon defined by a vector of image points.

Parameters
I: The image associated to the display.
vip: Vector of image point that define the vertexes of the polygon.
color: Line color.
thickness: Line thickness.
closed: When true display a closed polygon with a segment between first and last image point.

Definition at line 563 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [1/15]

void vpDisplayWin32::displayRectangle ( const vpImagePoint topLeft,
unsigned int  width,
unsigned int  height,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
protectedinherited

Display a rectangle with topLeft as the top-left corner and width and height the rectangle size.

Parameters
topLeft: Top-left corner of the rectangle.
width,height: Rectangle size.
color: Rectangle color.
fill: When set to true fill the rectangle.
thickness: Thickness of the four lines used to display the rectangle.
Warning
The thickness can not be set if the display uses the d3d library.

Definition at line 716 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayRectangle() [2/15]

void vpDisplayWin32::displayRectangle ( const vpImagePoint topLeft,
const vpImagePoint bottomRight,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
protectedinherited

Display a rectangle.

Parameters
topLeft: Top-left corner of the rectangle.
bottomRight: Bottom-right corner of the rectangle.
color: Rectangle color.
fill: When set to true fill the rectangle.
thickness: Thickness of the four lines used to display the rectangle.
Warning
The thickness can not be set if the display uses the d3d library.

Definition at line 736 of file vpDisplayWin32.cpp.

References vpImagePoint::get_i(), vpImagePoint::get_j(), vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayRectangle() [3/15]

void vpDisplayWin32::displayRectangle ( const vpRect rectangle,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
protectedinherited

Display a rectangle.

Parameters
rectangle: Rectangle characteristics.
color: Rectangle color.
fill: When set to true fill the rectangle.
thickness: Thickness of the four lines used to display the rectangle.
Warning
The thickness can not be set if the display uses the d3d library.

Definition at line 757 of file vpDisplayWin32.cpp.

References vpRect::getHeight(), vpRect::getLeft(), vpRect::getTop(), vpRect::getWidth(), vpImagePoint::set_i(), vpImagePoint::set_j(), vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ displayRectangle() [4/15]

void vpDisplay::displayRectangle ( const vpImage< unsigned char > &  I,
const vpImagePoint topLeft,
unsigned int  width,
unsigned int  height,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle with topLeft as the top-left corner and width and height the rectangle size.

Parameters
I: The image associated to the display.
topLeft: Top-left corner of the rectangle.
width,height: Rectangle size.
color: Rectangle color.
fill: When set to true fill the rectangle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, fernClassifier.cpp, keyPointSurf.cpp, manDisplay.cpp, planarObjectDetector.cpp, testDisplays.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageTemplateMatching.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-dnn-object-detection-live.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, and tutorial-image-viewer.cpp.

Definition at line 586 of file vpDisplay_uchar.cpp.

Referenced by vpDot2::searchDotsInArea(), and vpMeNurbs::seekExtremitiesCanny().

◆ displayRectangle() [5/15]

void vpDisplay::displayRectangle ( const vpImage< unsigned char > &  I,
const vpImagePoint topLeft,
const vpImagePoint bottomRight,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle with topLeft as the top-left corner and width and height the rectangle size.

Parameters
I: The image associated to the display.
topLeft: Top-left corner of the rectangle.
bottomRight: Bottom-right corner of the rectangle.
color: Rectangle color.
fill: When set to true fill the rectangle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 668 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [6/15]

void vpDisplay::displayRectangle ( const vpImage< unsigned char > &  I,
const vpRect rectangle,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle with topLeft as the top-left corner and width and height the rectangle size.

Parameters
I: The image associated to the display.
rectangle: Rectangle characteristics.
color: Rectangle color.
fill: When set to true fill the rectangle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 627 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [7/15]

void vpDisplay::displayRectangle ( const vpImage< unsigned char > &  I,
const vpImagePoint center,
float  angle,
unsigned int  width,
unsigned int  height,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle defined by its center, its orientation (angle) and its size.

Parameters
I: Image associated to the display.
center: Rectangle center point.
angle: Angle in radians width an horizontal axis oriented from left to right.
width,height: Rectangle size.
color: Rectangle color.
thickness: Thickness of the four lines used to display the rectangle.

Definition at line 646 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [8/15]

void vpDisplay::displayRectangle ( const vpImage< unsigned char > &  I,
int  i,
int  j,
unsigned int  width,
unsigned int  height,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle with (i,j) as the top-left corner and width and height the rectangle size.

Parameters
I: The image associated to the display.
i,j: Top-left corner of the rectangle.
width,height: Rectangle size.
color: Rectangle color.
fill: When set to true fill the rectangle.
thickness: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 606 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [9/15]

void vpDisplay::displayRectangle ( const vpImage< unsigned char > &  I,
unsigned int  i,
unsigned int  j,
float  angle,
unsigned int  width,
unsigned int  height,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle defined by its center, its orientation (angle) and its size.

Parameters
I: Image associated to the display.
i,j: Rectangle center point.
angle: Angle in radians width an horizontal axis oriented from left to right.
width,height: Rectangle size.
color: Rectangle color.
thickness: Thickness of the four lines used to display the rectangle.

Definition at line 688 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [10/15]

void vpDisplay::displayRectangle ( const vpImage< vpRGBa > &  I,
const vpImagePoint topLeft,
unsigned int  width,
unsigned int  height,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle with topLeft as the top-left corner and width and height the rectangle size.

Parameters
I: The image associated to the display.
topLeft: Top-left corner of the rectangle.
width,height: Rectangle size.
color: Rectangle color.
fill: When set to true fill the rectangle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 585 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [11/15]

void vpDisplay::displayRectangle ( const vpImage< vpRGBa > &  I,
const vpImagePoint topLeft,
const vpImagePoint bottomRight,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle with topLeft as the top-left corner and width and height the rectangle size.

Parameters
I: The image associated to the display.
topLeft: Top-left corner of the rectangle.
bottomRight: Bottom-right corner of the rectangle.
color: Rectangle color.
fill: When set to true fill the rectangle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 667 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [12/15]

void vpDisplay::displayRectangle ( const vpImage< vpRGBa > &  I,
const vpRect rectangle,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle with topLeft as the top-left corner and width and height the rectangle size.

Parameters
I: The image associated to the display.
rectangle: Rectangle characteristics.
color: Rectangle color.
fill: When set to true fill the rectangle. When vpDisplayOpenCV is used, and color alpha channel is set, filling feature can handle transparency. See vpColor header class documentation.
thickness: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 626 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [13/15]

void vpDisplay::displayRectangle ( const vpImage< vpRGBa > &  I,
const vpImagePoint center,
float  angle,
unsigned int  width,
unsigned int  height,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle defined by its center, its orientation (angle) and its size.

Parameters
I: Image associated to the display.
center: Rectangle center point.
angle: Angle in radians width an horizontal axis oriented from left to right.
width,height: Rectangle size.
color: Rectangle color.
thickness: Thickness of the four lines used to display the rectangle.

Definition at line 645 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [14/15]

void vpDisplay::displayRectangle ( const vpImage< vpRGBa > &  I,
int  i,
int  j,
unsigned int  width,
unsigned int  height,
const vpColor color,
bool  fill = false,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle with (i,j) as the top-left corner and width and height the rectangle size.

Parameters
I: The image associated to the display.
i,j: Top-left corner of the rectangle.
width,height: Rectangle size.
color: Rectangle color.
fill: When set to true fill the rectangle.
thickness: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 605 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [15/15]

void vpDisplay::displayRectangle ( const vpImage< vpRGBa > &  I,
unsigned int  i,
unsigned int  j,
float  angle,
unsigned int  width,
unsigned int  height,
const vpColor color,
unsigned int  thickness = 1 
)
staticinherited

Display a rectangle defined by its center, its orientation (angle) and its size.

Parameters
I: Image associated to the display.
i,j: Rectangle center point.
angle: Angle in radians width an horizontal axis oriented from left to right.
width,height: Rectangle size.
color: Rectangle color.
thickness: Thickness of the four lines used to display the rectangle.

Definition at line 686 of file vpDisplay_rgba.cpp.

◆ displayROI() [1/2]

void vpDisplay::displayROI ( const vpImage< unsigned char > &  I,
const vpRect roi 
)
staticinherited

Update the display with the content of the image that is in the region of interest.

Parameters
I: Image.
roi: Region of interest.
Examples:
testDisplayRoi.cpp.

Definition at line 788 of file vpDisplay_uchar.cpp.

◆ displayROI() [2/2]

void vpDisplay::displayROI ( const vpImage< vpRGBa > &  I,
const vpRect roi 
)
staticinherited

Update the display with the content of the image that is in the region of interest.

Parameters
I: Image.
roi: Region of interest.

Definition at line 786 of file vpDisplay_rgba.cpp.

◆ displayText() [1/4]

void vpDisplay::displayText ( const vpImage< unsigned char > &  I,
const vpImagePoint ip,
const std::string &  s,
const vpColor color 
)
staticinherited

Display a string at the image point ip location.

To select the font used to display the string, use setFont().

Parameters
I: Image associated to the display.
ip: Upper left image point location of the string in the display.
s: String to display in overlay.
color: String color.
See also
setFont()
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, fernClassifier.cpp, grabFlyCapture.cpp, grabRealSense.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2MultiCpp11Thread.cpp, keyboardControlBebop2.cpp, manDisplay.cpp, manGeometricFeatures.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, planarObjectDetector.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoBebop2.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoSimu4Points.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testDisplayPolygonLines.cpp, testDisplays.cpp, testForceTorqueAti.cpp, testForceTorqueAtiNetFTSensor.cpp, testForceTorqueIitSensor.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageTemplateMatching.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testRealSense2_D435.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testVirtuoseWithGlove.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.cpp, tutorial-apriltag-detector-live-T265-realsense.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-text.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-franka-acquire-calib-data.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-bebop2.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense-T265.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-structure-core.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-grabber-v4l2.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-filter.cpp, tutorial-klt-tracker-live-v4l2.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-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-structure-core.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.cpp, tutorial-munkres-assignment.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.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 videoReader.cpp.

Definition at line 706 of file vpDisplay_uchar.cpp.

Referenced by vpVirtualGrabber::acquire(), vpKltOpencv::display(), vpMbEdgeKltTracker::display(), vpMbKltTracker::display(), vpMbtDistanceKltCylinder::displayPrimitive(), vpMbtDistanceKltPoints::displayPrimitive(), vpMbTracker::initClick(), vpImageQueue< Type >::record(), vpKltOpencv::suppressFeature(), and vpMbGenericTracker::track().

◆ displayText() [2/4]

void vpDisplay::displayText ( const vpImage< unsigned char > &  I,
int  i,
int  j,
const std::string &  s,
const vpColor color 
)
staticinherited

Display a string at the image point (i,j) location.

To select the font used to display the string, use setFont().

Parameters
I: Image associated to the display.
i,j: Upper left image point location of the string in the display.
s: String to display in overlay.
color: String color.
See also
setFont()

Definition at line 724 of file vpDisplay_uchar.cpp.

◆ displayText() [3/4]

void vpDisplay::displayText ( const vpImage< vpRGBa > &  I,
const vpImagePoint ip,
const std::string &  s,
const vpColor color 
)
staticinherited

Display a string at the image point ip location.

To select the font used to display the string, use setFont().

Parameters
I: Image associated to the display.
ip: Upper left image point location of the string in the display.
s: String to display in overlay.
color: String color.
See also
setFont()

Definition at line 704 of file vpDisplay_rgba.cpp.

◆ displayText() [4/4]

void vpDisplay::displayText ( const vpImage< vpRGBa > &  I,
int  i,
int  j,
const std::string &  s,
const vpColor color 
)
staticinherited

Display a string at the image point (i,j) location.

To select the font used to display the string, use setFont().

Parameters
I: Image associated to the display.
i,j: Upper left image point location of the string in the display.
s: String to display in overlay.
color: String color.
See also
setFont()

Definition at line 722 of file vpDisplay_rgba.cpp.

◆ flush() [1/2]

void vpDisplay::flush ( const vpImage< unsigned char > &  I)
staticinherited

Flushes the output buffer associated to image I display. It's necessary to use this function to see the results of any drawing.

Warning
This function is particular and must be called to show the overlay. Because it's time spending, use it parcimoniously.
#include <visp3/core/vpColor.h>
#include <visp3/core/vpDisplay.h>
#include <visp3/core/vpImage.h>
#include <visp3/core/vpImagePoint.h>
#include <visp3/gui/vpDisplayGDI.h>
int main() {
d.init(I);
vpDisplay::display(I); // display the image
vpImagePoint center;
unsigned int radius = 100;
vpDisplay::flush(I); // Mendatory to display the requested features.
}
See also
flushROI()
Examples:
AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, fernClassifier.cpp, grab1394CMU.cpp, grab1394Two.cpp, grabDirectShow.cpp, grabDirectShowMulti.cpp, grabDisk.cpp, grabFlyCapture.cpp, grabOpenCV.cpp, grabRealSense.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2.cpp, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, keyboardControlBebop2.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6FourPoints2DCamVelocityLs_des.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityLs_cur.cpp, servoViper850FourPoints2DArtVelocityLs_des.cpp, servoViper850FourPoints2DCamVelocityLs_cur.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, testClick.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplays.cpp, testFeatureSegment.cpp, testForceTorqueAti.cpp, testForceTorqueAtiNetFTSensor.cpp, testForceTorqueIitSensor.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testRobotAfma6Pose.cpp, testRobotBebop2.cpp, testRobotViper850Pose.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, testVirtuoseWithGlove.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-autothreshold.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-blob-auto-tracker.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-event-keyboard.cpp, tutorial-export-image.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-franka-acquire-calib-data.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-bebop2.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-multiple-realsense.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense-T265.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-rgbd-D435-structurecore.cpp, tutorial-grabber-structure-core.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-camera.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-simulator.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-keypoint-SIFT.cpp, tutorial-matching-keypoint.cpp, tutorial-matching-surf-deprecated.cpp, tutorial-matching-surf-homography-deprecated.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-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-structure-core.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.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-munkres-assignment.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.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, tutorial-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 758 of file vpDisplay_uchar.cpp.

Referenced by vpVirtualGrabber::acquire(), vpMbtDistanceCylinder::computeInteractionMatrixError(), vpDot2::defineDots(), vpMbtDistanceCircle::displayMovingEdges(), vpDot2::getFreemanChain(), vpTemplateTrackerZone::initClick(), vpPolygon::initClick(), vpMbTracker::initClick(), vpMeNurbs::initTracking(), vpMeLine::initTracking(), vpMeEllipse::initTracking(), vpDot2::searchDotsInArea(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpSimulatorAfma6::setPosition(), vpMeLine::track(), vpMeEllipse::track(), vpDot2::trackAndDisplay(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

◆ flush() [2/2]

void vpDisplay::flush ( const vpImage< vpRGBa > &  I)
staticinherited

Flushes the output buffer associated to image I display. It's necessary to use this function to see the results of any drawing.

Warning
This function is particular and must be called to show the overlay. Because it's time spending, use it parcimoniously.
#include <visp3/core/vpColor.h>
#include <visp3/core/vpDisplay.h>
#include <visp3/core/vpImage.h>
#include <visp3/core/vpImagePoint.h>
#include <visp3/gui/vpDisplayGDI.h>
int main() {
vpImage<vpRGBa> I(240, 380);
d.init(I);
vpDisplay::display(I); // display the image
vpImagePoint center;
unsigned int radius = 100;
vpDisplay::flush(I); // Mendatory to display the requested features.
}
See also
flushROI()

Definition at line 756 of file vpDisplay_rgba.cpp.

◆ flushDisplay()

void vpDisplayWin32::flushDisplay ( )
inherited

flush the Win32 buffer It's necessary to use this function to see the results of any drawing

Definition at line 619 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ flushDisplayROI()

void vpDisplayWin32::flushDisplayROI ( const vpImagePoint iP,
unsigned int  width,
unsigned int  height 
)
inherited

flush the Win32 buffer It's necessary to use this function to see the results of any drawing

Definition at line 633 of file vpDisplayWin32.cpp.

References vpImagePoint::get_u(), vpImagePoint::get_v(), vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ flushROI() [1/2]

void vpDisplay::flushROI ( const vpImage< unsigned char > &  I,
const vpRect roi 
)
staticinherited

Flushes the output buffer associated to image I display. It's necessary to use this function to see the results of any drawing.

Warning
This function is particular and must be called to show the overlay. Because it's time spending, use it parcimoniously.
See also
flush()
Examples:
testDisplayRoi.cpp.

Definition at line 769 of file vpDisplay_uchar.cpp.

◆ flushROI() [2/2]

void vpDisplay::flushROI ( const vpImage< vpRGBa > &  I,
const vpRect roi 
)
staticinherited

Flushes the output buffer associated to image I display. It's necessary to use this function to see the results of any drawing.

Warning
This function is particular and must be called to show the overlay. Because it's time spending, use it parcimoniously.
See also
flush()

Definition at line 767 of file vpDisplay_rgba.cpp.

◆ getClick() [1/11]

bool vpDisplayWin32::getClick ( bool  blocking = true)
protectedinherited

Wait for a click from one of the mouse button.

Parameters
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
  • true if a button was clicked. This is always the case if blocking is set to true.
  • false if no button was clicked. This can occur if blocking is set to false.

Definition at line 290 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ getClick() [2/11]

bool vpDisplayWin32::getClick ( vpImagePoint ip,
bool  blocking = true 
)
protectedinherited

Wait for a click from one of the mouse button and get the position of the clicked image point.

Parameters
ip[out] : The coordinates of the clicked image point.
blocking[in] : true for a blocking behaviour waiting a mouse button click, false for a non blocking behaviour.
Returns
  • true if a button was clicked. This is always the case if blocking is set to true.
  • false if no button was clicked. This can occur if blocking is set to false.

Definition at line 327 of file vpDisplayWin32.cpp.

References vpDisplay::m_scale, vpImagePoint::set_u(), vpImagePoint::set_v(), vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ getClick() [3/11]

bool vpDisplayWin32::getClick ( vpImagePoint ip,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
protectedinherited

Wait for a mouse button click and get the position of the clicked pixel. The button used to click is also set.

Parameters
ip[out] : The coordinates of the clicked image point.
button[out] : The button used to click.
blocking[in] :
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
true if a mouse button is pressed, false otherwise. If a button is pressed, the location of the mouse pointer is updated in ip.

Definition at line 372 of file vpDisplayWin32.cpp.

References vpDisplay::m_scale, vpImagePoint::set_u(), vpImagePoint::set_v(), vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ getClick() [4/11]

bool vpDisplay::getClick ( const vpImage< unsigned char > &  I,
bool  blocking = true 
)
staticinherited

Wait for a click from one of the mouse button.

Parameters
I[in] : The displayed image.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
  • true if a button was clicked. This is always the case if blocking is set to true.
  • false if no button was clicked. This can occur if blocking is set to false.
Examples:
BSpline.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, fernClassifier.cpp, grab1394CMU.cpp, grabFlyCapture.cpp, grabOpenCV.cpp, grabRealSense.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, planarObjectDetector.cpp, plot2d.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testClick.cpp, testComedi.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplays.cpp, testForceTorqueAti.cpp, testForceTorqueAtiNetFTSensor.cpp, testForceTorqueIitSensor.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_imu.cpp, testOccipitalStructure_Core_pcl.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, testVirtuoseWithGlove.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-autothreshold.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-blob-auto-tracker.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-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-franka-acquire-calib-data.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-multiple-realsense.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-rgbd-D435-structurecore.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-ibvs-4pts-display.cpp, tutorial-ibvs-4pts-image-tracking.cpp, tutorial-ibvs-4pts-ogre-tracking.cpp, tutorial-ibvs-4pts-plotter-continuous-gain-adaptive.cpp, tutorial-ibvs-4pts-plotter-gain-adaptive.cpp, tutorial-ibvs-4pts-plotter.cpp, tutorial-ibvs-4pts-wireframe-camera.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-simulator.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-keypoint-SIFT.cpp, tutorial-matching-keypoint.cpp, tutorial-matching-surf-deprecated.cpp, tutorial-matching-surf-homography-deprecated.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-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-structure-core.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.cpp, tutorial-munkres-assignment.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.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, tutorial-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 807 of file vpDisplay_uchar.cpp.

Referenced by vpVirtualGrabber::acquire(), vpDot2::defineDots(), vpDisplay::getClick(), vpPlot::getPixelValue(), vpTemplateTrackerZone::initClick(), vpPolygon::initClick(), vpMbTracker::initClick(), vpMeNurbs::initTracking(), vpMeLine::initTracking(), vpMeEllipse::initTracking(), vpDot2::initTracking(), vpDot::initTracking(), vpWireFrameSimulator::navigation(), vpImageQueue< Type >::record(), and vpMeEllipse::track().

◆ getClick() [5/11]

bool vpDisplay::getClick ( const vpImage< unsigned char > &  I,
vpImagePoint ip,
bool  blocking = true 
)
staticinherited

Wait for a click from one of the mouse button and get the position of the clicked image point.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the clicked image point.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
true if a mouse button is pressed, false otherwise. If a button is pressed, the location of the mouse pointer is updated in ip.

Definition at line 827 of file vpDisplay_uchar.cpp.

◆ getClick() [6/11]

bool vpDisplay::getClick ( const vpImage< unsigned char > &  I,
vpImagePoint ip,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
staticinherited

Wait for a mouse button click and get the position of the clicked image point. The button used to click is also set.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the clicked image point.
button[out] : The button used to click.
blocking[in] :
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
true if a mouse button is pressed, false otherwise. If a button is pressed, the location of the mouse pointer is updated in ip.

Definition at line 852 of file vpDisplay_uchar.cpp.

◆ getClick() [7/11]

bool vpDisplay::getClick ( const vpImage< unsigned char > &  I,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
staticinherited

Wait for a mouse button click and get the position of the clicked image point. The button used to click is also set.

Parameters
I[in] : The displayed image.
button[out] : The button used to click.
blocking[in] :
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
true if a mouse button is pressed, false otherwise.

Definition at line 874 of file vpDisplay_uchar.cpp.

References vpDisplay::getClick().

◆ getClick() [8/11]

bool vpDisplay::getClick ( const vpImage< vpRGBa > &  I,
bool  blocking = true 
)
staticinherited

Wait for a click from one of the mouse button.

Parameters
I[in] : The displayed image.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
  • true if a button was clicked. This is always the case if blocking is set to true.
  • false if no button was clicked. This can occur if blocking is set to false.

Definition at line 805 of file vpDisplay_rgba.cpp.

◆ getClick() [9/11]

bool vpDisplay::getClick ( const vpImage< vpRGBa > &  I,
vpImagePoint ip,
bool  blocking = true 
)
staticinherited

Wait for a click from one of the mouse button and get the position of the clicked image point.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the clicked image point.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
true if a mouse button is pressed, false otherwise. If a button is pressed, the location of the mouse pointer is updated in ip.

Definition at line 825 of file vpDisplay_rgba.cpp.

◆ getClick() [10/11]

bool vpDisplay::getClick ( const vpImage< vpRGBa > &  I,
vpImagePoint ip,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
staticinherited

Wait for a mouse button click and get the position of the clicked image point. The button used to click is also set.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the clicked image point.
button[out] : The button used to click.
blocking[in] :
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
true if a mouse button is pressed, false otherwise. If a button is pressed, the location of the mouse pointer is updated in ip.

Definition at line 850 of file vpDisplay_rgba.cpp.

◆ getClick() [11/11]

bool vpDisplay::getClick ( const vpImage< vpRGBa > &  I,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
staticinherited

Wait for a mouse button click and get the position of the clicked image point. The button used to click is also set.

Parameters
I[in] : The displayed image.
button[out] : The button used to click.
blocking[in] :
  • When set to true, this method waits until a mouse button is pressed and then returns always true.
  • When set to false, returns true only if a mouse button is pressed, otherwise returns false.
Returns
true if a mouse button is pressed, false otherwise.

Definition at line 872 of file vpDisplay_rgba.cpp.

References vpDisplay::getClick().

◆ getClickUp() [1/5]

bool vpDisplayWin32::getClickUp ( vpImagePoint ip,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
protectedinherited

Wait for a mouse button click release and get the position of the image point were the click release occurs. The button used to click is also set. Same method as getClick(unsigned int&, unsigned int&, vpMouseButton::vpMouseButtonType &, bool).

Parameters
ip[out] : Position of the clicked image point.
button[in] : Button used to click.
blocking[in] : true for a blocking behaviour waiting a mouse button click, false for a non blocking behaviour.
Returns
  • true if a button was clicked. This is always the case if blocking is set to true.
  • false if no button was clicked. This can occur if blocking is set to false.
See also
getClick(vpImagePoint &, vpMouseButton::vpMouseButtonType &, bool)

Definition at line 420 of file vpDisplayWin32.cpp.

References vpDisplay::m_scale, vpImagePoint::set_u(), vpImagePoint::set_v(), vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ getClickUp() [2/5]

bool vpDisplay::getClickUp ( const vpImage< unsigned char > &  I,
vpImagePoint ip,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
staticinherited

Wait for a mouse button click release and get the position of the clicked image point. The button used to click is also set.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the clicked image point.
button[out] : The clicked button.
blocking[in] :
  • When set to true, this method waits until a mouse button is released and then returns always true.
  • When set to false, returns true only if a mouse button is released, otherwise returns false.
Returns
true if a mouse button is released, false otherwise. If a button is released, the location of the mouse pointer is updated in ip.
Examples:
testClick.cpp.

Definition at line 900 of file vpDisplay_uchar.cpp.

Referenced by vpDisplay::getClickUp(), and vpWireFrameSimulator::navigation().

◆ getClickUp() [3/5]

bool vpDisplay::getClickUp ( const vpImage< unsigned char > &  I,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
staticinherited

Wait for a mouse button click release and get the position of the clicked image point. The button used to click is also set.

Parameters
I[in] : The displayed image.
button[out] : The clicked button.
blocking[in] :
  • When set to true, this method waits until a mouse button is released and then returns always true.
  • When set to false, returns true only if a mouse button is released, otherwise returns false.
Returns
true if a mouse button is released, false otherwise.

Definition at line 922 of file vpDisplay_uchar.cpp.

References vpDisplay::getClickUp().

◆ getClickUp() [4/5]

bool vpDisplay::getClickUp ( const vpImage< vpRGBa > &  I,
vpImagePoint ip,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
staticinherited

Wait for a mouse button click release and get the position of the clicked image point. The button used to click is also set.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the clicked image point.
button[out] : The clicked button.
blocking[in] :
  • When set to true, this method waits until a mouse button is released and then returns always true.
  • When set to false, returns true only if a mouse button is released, otherwise returns false.
Returns
true if a mouse button is released, false otherwise. If a button is released, the location of the mouse pointer is updated in ip.

Definition at line 898 of file vpDisplay_rgba.cpp.

◆ getClickUp() [5/5]

bool vpDisplay::getClickUp ( const vpImage< vpRGBa > &  I,
vpMouseButton::vpMouseButtonType button,
bool  blocking = true 
)
staticinherited

Wait for a mouse button click release and get the position of the clicked image point. The button used to click is also set.

Parameters
I[in] : The displayed image.
button[out] : The clicked button.
blocking[in] :
  • When set to true, this method waits until a mouse button is released and then returns always true.
  • When set to false, returns true only if a mouse button is released, otherwise returns false.
Returns
true if a mouse button is released, false otherwise.

Definition at line 920 of file vpDisplay_rgba.cpp.

References vpDisplay::getClickUp().

◆ getDownScalingFactor() [1/3]

unsigned int vpDisplay::getDownScalingFactor ( )
inlineinherited

Return the value of the down scale factor applied to the image in order to reduce the size of the window used to display the image.

Examples:
mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-grabber-ids-ueye.cpp, and tutorial-template-tracker.cpp.

Definition at line 235 of file vpDisplay.h.

Referenced by vpImageQueue< Type >::record().

◆ getDownScalingFactor() [2/3]

unsigned int vpDisplay::getDownScalingFactor ( const vpImage< unsigned char > &  I)
staticinherited

Return the value of the down scale factor applied to the image in order to reduce the size of the window used to display the image.

Parameters
I: Image associated to the display window.
Exceptions
vpDisplayException::notInitializedError: If the video device is not initialized.

Definition at line 1294 of file vpDisplay_uchar.cpp.

◆ getDownScalingFactor() [3/3]

unsigned int vpDisplay::getDownScalingFactor ( const vpImage< vpRGBa > &  I)
staticinherited

Return the value of the down scale factor applied to the image in order to reduce the size of the window used to display the image.

Parameters
I: Image associated to the display window.
Exceptions
vpDisplayException::notInitializedError: If the video device is not initialized.

Definition at line 1285 of file vpDisplay_rgba.cpp.

◆ getHeight()

unsigned int vpDisplay::getHeight ( ) const
inlineinherited

Return the display height.

See also
getWidth()

Definition at line 240 of file vpDisplay.h.

◆ getImage() [1/3]

void vpDisplayWin32::getImage ( vpImage< vpRGBa > &  I)
virtualinherited

Gets the displayed image (if overlay, if any).

Parameters
I: Image to fill.

Implements vpDisplay.

Definition at line 865 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ getImage() [2/3]

void vpDisplay::getImage ( const vpImage< unsigned char > &  Isrc,
vpImage< vpRGBa > &  Idest 
)
staticinherited

Get the window pixmap and put it in vpRGBa image.

The code below shows how to use this method.

#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>
#include <visp3/io/vpImageIo.h>
int main()
{
vpImage<unsigned char> I(240, 320); // Create a black grey level image
vpImage<vpRGBa> Ioverlay;
// 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
// Draw a red rectangle in the display overlay (foreground)
vpDisplay::displayRectangle(I, 10, 10, 100, 20, vpColor::red, true);
// Flush the foreground and background display
// Updates the color image with the original loaded image and the overlay
vpDisplay::getImage(I, Ioverlay);
// Write the color image on the disk
std::string ofilename("overlay.ppm");
vpImageIo::write(Ioverlay, ofilename);
// Wait for a click in the display window
#ifdef VISP_HAVE_DISPLAY
delete d;
#endif
}
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, manGeometricFeatures.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, sonarPioneerReader.cpp, tutorial-export-image.cpp, tutorial-flood-fill.cpp, and tutorial-image-viewer.cpp.

Definition at line 144 of file vpDisplay.cpp.

References vpImageConvert::convert(), and vpImage< Type >::display.

Referenced by vpDisplay::getImage().

◆ getImage() [3/3]

void vpDisplay::getImage ( const vpImage< vpRGBa > &  Isrc,
vpImage< vpRGBa > &  Idest 
)
staticinherited

Get the window pixmap and put it in vpRGBa image.

The code below shows how to use this method.

#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>
#include <visp3/io/vpImageIo.h>
int main()
{
vpImage<vpRGBa> I(240, 320); // Create a black RGB color image
vpImage<vpRGBa> Ioverlay;
// 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
// Draw a red rectangle in the display overlay (foreground)
vpDisplay::displayRectangle(I, 10, 10, 100, 20, vpColor::red, true);
// Flush the foreground and background display
// Updates the color image with the original loaded image and the overlay
vpDisplay::getImage(I, Ioverlay);
// Write the color image on the disk
std::string ofilename("overlay.ppm");
vpImageIo::write(Ioverlay, ofilename);
// Wait for a click in the display window
#ifdef VISP_HAVE_DISPLAY
delete d;
#endif
}

Definition at line 217 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpDisplay::getImage().

◆ getKeyboardEvent() [1/8]

bool vpDisplayWin32::getKeyboardEvent ( bool  blocking = true)
protectedinherited

Get a keyboard event.

Parameters
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a key is pressed and then returns always true.
  • When set to false, returns true only if a key is pressed, otherwise returns false.
Returns
  • true if a key was pressed. This is always the case if blocking is set to true.
  • false if no key was pressed. This can occur if blocking is set to false.

Definition at line 462 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ getKeyboardEvent() [2/8]

bool vpDisplayWin32::getKeyboardEvent ( std::string &  key,
bool  blocking 
)
protectedinherited

Get a keyboard event.

Parameters
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a key is pressed and then returns always true.
  • When set to false, returns true only if a key is pressed, otherwise returns false.
key[out]: If possible, an ISO Latin-1 character corresponding to the keyboard key.
Returns
  • true if a key was pressed. This is always the case if blocking is set to true.
  • false if no key was pressed. This can occur if blocking is set to false.

Definition at line 498 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ getKeyboardEvent() [3/8]

bool vpDisplay::getKeyboardEvent ( const vpImage< unsigned char > &  I,
bool  blocking = true 
)
staticinherited

Get a keyboard event.

Parameters
I[in] : The displayed image.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a key is pressed and then returns always true.
  • When set to false, returns true only if a key is pressed, otherwise returns false.
Returns
  • true if a key was pressed. This is always the case if blocking is set to true.
  • false if no key was pressed. This can occur if blocking is set to false.

Below you will find an example showing how to use this method.

#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 image
#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;
#else
std::cout << "Sorry, no video device is available" << std::endl;
return -1;
#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
// Flush the foreground and background display
// Wait for keyboard event
std::cout << "Waiting a keyboard event..." << std::endl;
std::cout << "A keyboard event was detected" << std::endl;
// Non blocking keyboard event loop
int cpt_event = 0;
std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
do {
bool event = vpDisplay::getKeyboardEvent(I, false);
if (event) {
std::cout << "A keyboard event was detected" << std::endl;
cpt_event ++;
}
vpTime::wait(5); // wait 5 ms
} while(cpt_event < 5);
#ifdef VISP_HAVE_DISPLAY
delete d;
#endif
}
Examples:
tutorial-event-keyboard.cpp.

Definition at line 1011 of file vpDisplay_uchar.cpp.

◆ getKeyboardEvent() [4/8]

bool vpDisplay::getKeyboardEvent ( const vpImage< unsigned char > &  I,
std::string &  key,
bool  blocking = true 
)
staticinherited

Get a keyboard event.

Parameters
I[in] : The displayed image.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a key is pressed and then returns always true.
  • When set to false, returns true only if a key is pressed, otherwise returns false.
key[out]: If possible, an ISO Latin-1 character corresponding to the keyboard key.
Returns
  • true if a key was pressed. This is always the case if blocking is set to true.
  • false if no key was pressed. This can occur if blocking is set to false.

Below you will find an example showing how to use this method.

#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 image
#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;
#else
std::cout << "Sorry, no video device is available" << std::endl;
return -1;
#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
// Flush the foreground and background display
// Wait for keyboard event
std::cout << "Waiting a keyboard event..." << std::endl;
std::cout << "A keyboard event was detected" << std::endl;
// Non blocking keyboard event loop
int cpt_event = 0;
std::string key;
std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
do {
bool event = vpDisplay::getKeyboardEvent(I, key, false);
if (event) {
std::cout << "Key detected: " << key << std::endl;
cpt_event ++;
}
vpTime::wait(5); // wait 5 ms
} while(cpt_event < 5);
#ifdef VISP_HAVE_DISPLAY
delete d;
#endif
}

Definition at line 1102 of file vpDisplay_uchar.cpp.

◆ getKeyboardEvent() [5/8]

bool vpDisplay::getKeyboardEvent ( const vpImage< unsigned char > &  I,
char *  key,
bool  blocking = true 
)
staticinherited

Get a keyboard event.

Parameters
I[in] : The displayed image.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a key is pressed and then returns always true.
  • When set to false, returns true only if a key is pressed, otherwise returns false.
key[out]: If possible, an ISO Latin-1 character corresponding to the keyboard key.
Returns
  • true if a key was pressed. This is always the case if blocking is set to true.
  • false if no key was pressed. This can occur if blocking is set to false.

Below you will find an example showing how to use this method.

#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 image
#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;
#else
std::cout << "Sorry, no video device is available" << std::endl;
return -1;
#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
// Flush the foreground and background display
// Wait for keyboard event
std::cout << "Waiting a keyboard event..." << std::endl;
std::cout << "A keyboard event was detected" << std::endl;
// Non blocking keyboard event loop
int cpt_event = 0;
char key[10];
std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
do {
bool event = vpDisplay::getKeyboardEvent(I, &key[0], false);
if (event) {
std::cout << "Key detected: " << key << std::endl;
cpt_event ++;
}
vpTime::wait(5); // wait 5 ms
} while(cpt_event < 5);
#ifdef VISP_HAVE_DISPLAY
delete d;
#endif
}

Definition at line 1193 of file vpDisplay_uchar.cpp.

◆ getKeyboardEvent() [6/8]

bool vpDisplay::getKeyboardEvent ( const vpImage< vpRGBa > &  I,
bool  blocking = true 
)
staticinherited

Get a keyboard event.

Parameters
I[in] : The displayed image.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a key is pressed and then returns always true.
  • When set to false, returns true only if a key is pressed, otherwise returns false.
Returns
  • true if a key was pressed. This is always the case if blocking is set to true.
  • false if no key was pressed. This can occur if blocking is set to false.

Below you will find an example showing how to use this method.

#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<vpRGBa> I(240, 320); // Create a black image
#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;
#else
std::cout << "Sorry, no video device is available" << std::endl;
return -1;
#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
// Flush the foreground and background display
// Wait for keyboard event
std::cout << "Waiting a keyboard event..." << std::endl;
std::cout << "A keyboard event was detected" << std::endl;
// Non blocking keyboard event loop
int cpt_event = 0;
std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
do {
bool event = vpDisplay::getKeyboardEvent(I, false);
if (event) {
std::cout << "A keyboard event was detected" << std::endl; cpt_event ++;
}
vpTime::wait(5); // wait 5 ms
} while(cpt_event < 5);
#ifdef VISP_HAVE_DISPLAY
delete d;
#endif
}

Definition at line 1008 of file vpDisplay_rgba.cpp.

◆ getKeyboardEvent() [7/8]

bool vpDisplay::getKeyboardEvent ( const vpImage< vpRGBa > &  I,
std::string &  key,
bool  blocking = true 
)
staticinherited

Get a keyboard event.

Parameters
I[in] : The displayed image.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a key is pressed and then returns always true.
  • When set to false, returns true only if a key is pressed, otherwise returns false.
key[out]: If possible, an ISO Latin-1 character corresponding to the keyboard key.
Returns
  • true if a key was pressed. This is always the case if blocking is set to true.
  • false if no key was pressed. This can occur if blocking is set to false.

Below you will find an example showing how to use this method.

#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<vpRGBa> I(240, 320); // Create a black image
#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;
#else
std::cout << "Sorry, no video device is available" << std::endl;
return -1;
#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
// Flush the foreground and background display
// Wait for keyboard event
std::cout << "Waiting a keyboard event..." << std::endl;
std::cout << "A keyboard event was detected" << std::endl;
// Non blocking keyboard event loop
int cpt_event = 0;
std::string key;
std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
do {
bool event = vpDisplay::getKeyboardEvent(I, key, false);
if (event) {
std::cout << "Key detected: " << key << std::endl;
cpt_event ++;
}
vpTime::wait(5); // wait 5 ms
} while(cpt_event < 5);
#ifdef VISP_HAVE_DISPLAY
delete d;
#endif
}

Definition at line 1099 of file vpDisplay_rgba.cpp.

◆ getKeyboardEvent() [8/8]

bool vpDisplay::getKeyboardEvent ( const vpImage< vpRGBa > &  I,
char *  key,
bool  blocking = true 
)
staticinherited

Get a keyboard event.

Parameters
I[in] : The displayed image.
blocking[in] : Blocking behavior.
  • When set to true, this method waits until a key is pressed and then returns always true.
  • When set to false, returns true only if a key is pressed, otherwise returns false.
key[out]: If possible, an ISO Latin-1 character corresponding to the keyboard key.
Returns
  • true if a key was pressed. This is always the case if blocking is set to true.
  • false if no key was pressed. This can occur if blocking is set to false.

Below you will find an example showing how to use this method.

#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<vpRGBa> I(240, 320); // Create a black image
#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;
#else
std::cout << "Sorry, no video device is available" << std::endl;
return -1;
#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
// Flush the foreground and background display
// Wait for keyboard event
std::cout << "Waiting a keyboard event..." << std::endl;
std::cout << "A keyboard event was detected" << std::endl;
// Non blocking keyboard event loop
int cpt_event = 0;
char key[10];
std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
do {
bool event = vpDisplay::getKeyboardEvent(I, &key[Ø], false);
if (event) {
std::cout << "Key detected: " << key << std::endl;
cpt_event ++;
}
vpTime::wait(5); // wait 5 ms
} while(cpt_event < 5);
#ifdef VISP_HAVE_DISPLAY
delete d;
#endif
}

Definition at line 1190 of file vpDisplay_rgba.cpp.

◆ getPointerMotionEvent() [1/3]

bool vpDisplayWin32::getPointerMotionEvent ( vpImagePoint ip)
protectedinherited

Get the coordinates of the mouse pointer.

Parameters
ip[out] : The coordinates of the mouse pointer.
Returns
true if a pointer motion event was received, false otherwise.
Exceptions
vpDisplayException::notInitializedError: If the display was not initialized.

Definition at line 530 of file vpDisplayWin32.cpp.

References vpDisplay::m_scale, vpImagePoint::set_u(), vpImagePoint::set_v(), vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ getPointerMotionEvent() [2/3]

bool vpDisplay::getPointerMotionEvent ( const vpImage< unsigned char > &  I,
vpImagePoint ip 
)
staticinherited

Get the coordinates of the mouse pointer.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the mouse pointer.
Returns
true if a pointer motion event was received, false otherwise.

Definition at line 1207 of file vpDisplay_uchar.cpp.

◆ getPointerMotionEvent() [3/3]

bool vpDisplay::getPointerMotionEvent ( const vpImage< vpRGBa > &  I,
vpImagePoint ip 
)
staticinherited

Get the coordinates of the mouse pointer.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the mouse pointer.
Returns
true if a pointer motion event was received, false otherwise.

Definition at line 1204 of file vpDisplay_rgba.cpp.

◆ getPointerPosition() [1/3]

bool vpDisplayWin32::getPointerPosition ( vpImagePoint ip)
protectedinherited

Get the coordinates of the mouse pointer.

Parameters
ip[out] : The coordinates of the mouse pointer.
Returns
true.
Exceptions
vpDisplayException::notInitializedError: If the display was not initialized.

Definition at line 560 of file vpDisplayWin32.cpp.

References vpDisplay::m_scale, vpImagePoint::set_u(), vpImagePoint::set_v(), vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ getPointerPosition() [2/3]

bool vpDisplay::getPointerPosition ( const vpImage< unsigned char > &  I,
vpImagePoint ip 
)
staticinherited

Get the coordinates of the mouse pointer.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the mouse pointer.
Returns
true.
Examples:
testClick.cpp.

Definition at line 1221 of file vpDisplay_uchar.cpp.

Referenced by vpPlot::getPixelValue(), vpPlot::navigate(), and vpWireFrameSimulator::navigation().

◆ getPointerPosition() [3/3]

bool vpDisplay::getPointerPosition ( const vpImage< vpRGBa > &  I,
vpImagePoint ip 
)
staticinherited

Get the coordinates of the mouse pointer.

Parameters
I[in] : The displayed image.
ip[out] : The coordinates of the mouse pointer.
Returns
true.

Definition at line 1218 of file vpDisplay_rgba.cpp.

◆ getScreenHeight()

unsigned int vpDisplayWin32::getScreenHeight ( )
inherited

Gets the screen vertical resolution.

Definition at line 895 of file vpDisplayWin32.cpp.

References vpDisplayWin32::getScreenSize().

◆ getScreenSize()

void vpDisplayWin32::getScreenSize ( unsigned int &  w,
unsigned int &  h 
)
inherited

Gets screen resolution.

Parameters
w,h: Horizontal and vertical screen resolution.

Definition at line 876 of file vpDisplayWin32.cpp.

Referenced by vpDisplayWin32::getScreenHeight(), and vpDisplayWin32::getScreenWidth().

◆ getScreenWidth()

unsigned int vpDisplayWin32::getScreenWidth ( )
inherited

Gets the screen horizontal resolution.

Definition at line 885 of file vpDisplayWin32.cpp.

References vpDisplayWin32::getScreenSize().

◆ getWidth()

unsigned int vpDisplay::getWidth ( ) const
inlineinherited

Return the display width.

See also
getHeight()
Examples:
testVideoDeviceDual.cpp.

Definition at line 245 of file vpDisplay.h.

◆ getWindowXPosition()

int vpDisplay::getWindowXPosition ( ) const
inlineinherited

Return the position (along the horizontal axis) on the screen of the display window.

See also
getWindowYPosition()

Definition at line 251 of file vpDisplay.h.

Referenced by vpMbTracker::initClick().

◆ getWindowYPosition()

int vpDisplay::getWindowYPosition ( ) const
inlineinherited

Return the position (along the vertical axis) on the screen of the display window.

See also
getWindowXPosition()

Definition at line 256 of file vpDisplay.h.

Referenced by vpMbTracker::initClick().

◆ init() [1/3]

void vpDisplayWin32::init ( vpImage< unsigned char > &  I,
int  x = -1,
int  y = -1,
const std::string &  title = "" 
)
inherited

Constructor. Initialize a display to visualize a gray level image (8 bits).

Parameters
I: Image to be displayed (not that image has to be initialized)
x,y: The window is set at position x,y (column index, row index).
title: Window title.
Examples:
AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, displaySequence.cpp, fernClassifier.cpp, grab1394CMU.cpp, grabDirectShow.cpp, grabRealSense2_T265.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, planarObjectDetector.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, sonarPioneerReader.cpp, testDisplays.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testTrackDot.cpp, tutorial-grabber-structure-core.cpp, and tutorial-mb-generic-tracker-rgbd.cpp.

Definition at line 79 of file vpDisplayWin32.cpp.

References vpImage< Type >::display, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpDisplay::m_scale, vpDisplay::m_scaleType, vpDisplayException::notInitializedError, vpDisplay::setScale(), vpERROR_TRACE, and vpDisplayWin32::window.

Referenced by vpDisplayWin32::init(), and vpDisplayGDI().

◆ init() [2/3]

void vpDisplayWin32::init ( vpImage< vpRGBa > &  I,
int  x = -1,
int  y = -1,
const std::string &  title = "" 
)
inherited

Constructor. Initialize a display to visualize a RGBa level image (32 bits).

Parameters
I: Image to be displayed (not that image has to be initialized)
x,y: The window is set at position x,y (column index, row index).
title: Window title.

Definition at line 103 of file vpDisplayWin32.cpp.

References vpImage< Type >::display, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpDisplayWin32::init(), vpDisplay::m_scale, vpDisplay::m_scaleType, vpDisplayException::notInitializedError, vpDisplay::setScale(), vpERROR_TRACE, and vpDisplayWin32::window.

◆ init() [3/3]

void vpDisplayWin32::init ( unsigned int  width,
unsigned int  height,
int  x = -1,
int  y = -1,
const std::string &  title = "" 
)
inherited

Initialize the display size, position and title.

Parameters
width,height: Width and height of the window.
x,y: The window is set at position x,y (column index, row index).
title: Window title.

Definition at line 127 of file vpDisplayWin32.cpp.

References vpDisplayWin32::hThread, vpDisplayWin32::iStatus, vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, vpDisplay::m_scaleType, vpDisplay::m_title, vpDisplay::m_windowXPosition, vpDisplay::m_windowYPosition, vpDisplay::setScale(), vpDisplayWin32::threadId, and vpDisplayWin32::vpCreateWindow.

◆ isInitialised()

bool vpDisplay::isInitialised ( )
inlineinherited

Check if the display has been initialised

Returns
True if the display has been initialised, otherwise False

Definition at line 263 of file vpDisplay.h.

References vpColor::green, vpColor::none, and vpColor::white.

Referenced by vpPlot::setFont().

◆ setBackground() [1/2]

void vpDisplay::setBackground ( const vpImage< unsigned char > &  I,
const vpColor color 
)
staticinherited

Set the window background.

Parameters
I: Image associated to the display window.
colorBackground color.
Exceptions
vpDisplayException::notInitializedError: If the video device is not initialized.

Definition at line 1235 of file vpDisplay_uchar.cpp.

◆ setBackground() [2/2]

void vpDisplay::setBackground ( const vpImage< vpRGBa > &  I,
const vpColor color 
)
staticinherited

Set the window background.

Parameters
I: Image associated to the display window.
colorBackground color.
Exceptions
vpDisplayException::notInitializedError: If the video device is not initialized.

Definition at line 1232 of file vpDisplay_rgba.cpp.

◆ setDownScalingFactor() [1/2]

void vpDisplayWin32::setDownScalingFactor ( unsigned int  scale)
inlinevirtualinherited

Set the down scale factor applied to the image in order to reduce the display size.

Parameters
scale: Scale factor applied to display a rescaled image.

Reimplemented from vpDisplay.

Examples:
grabRealSense2_T265.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, and testRealSense2_T265_undistort.cpp.

Definition at line 152 of file vpDisplayWin32.h.

◆ setDownScalingFactor() [2/2]

void vpDisplayWin32::setDownScalingFactor ( vpScaleType  scaleType)
inlinevirtualinherited

Set the down scaling factor either in auto mode or set manually.

This method has to be called before display initialization.

#include <visp3/gui/vpDisplayGDI.h>
#include <visp3/gui/vpDisplayX.h>
int main()
{
vpImage<unsigned char> I(480, 640); // Black 640 by 480 image
#ifdef VISP_HAVE_X11
#elif defined VISP_HAVE_GDI
#endif
// Display in a 160 by 120 windows size
d.init(I);
vpDisplay::getClick(I); // wait for a click to quit
}

Reimplemented from vpDisplay.

Definition at line 157 of file vpDisplayWin32.h.

References vpColor::green, and vpColor::white.

◆ setFont() [1/3]

void vpDisplayWin32::setFont ( const std::string &  fontname)
inherited

Set the font used to display text.

Parameters
fontname: Name of the font.

Definition at line 612 of file vpDisplayWin32.cpp.

References vpERROR_TRACE.

◆ setFont() [2/3]

void vpDisplay::setFont ( const vpImage< unsigned char > &  I,
const std::string &  fontname 
)
staticinherited

Set the font of a text printed in the display overlay. To print a text you may use displayCharString().

Parameters
I: Image associated to the display window.
fontname: The expected font name.
Note
Under UNIX, the available fonts are given by the "xlsfonts" binary. To choose a font you can also use the "xfontsel" binary.
See also
displayText()

Definition at line 1253 of file vpDisplay_uchar.cpp.

Referenced by vpPlot::setFont().

◆ setFont() [3/3]

void vpDisplay::setFont ( const vpImage< vpRGBa > &  I,
const std::string &  fontname 
)
staticinherited

Set the font of a text printed in the display overlay. To print a text you may use displayCharString().

Parameters
I: Image associated to the display window.
fontname: The expected font name.
Note
Under UNIX, the available fonts are given by the "xlsfonts" binary. To choose a font you can also use the "xfontsel" binary.
See also
displayText()

Definition at line 1247 of file vpDisplay_rgba.cpp.

◆ setScale()

◆ setTitle() [1/3]

void vpDisplayWin32::setTitle ( const std::string &  windowtitle)
inherited

Changes the window's titlebar text

Parameters
windowtitle: Window title.

Definition at line 600 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ setTitle() [2/3]

◆ setTitle() [3/3]

void vpDisplay::setTitle ( const vpImage< vpRGBa > &  I,
const std::string &  windowtitle 
)
staticinherited

Set the windows title.

Note
This functionality is not implemented when vpDisplayOpenCV is used.
Parameters
I: Image associated to the display window.
windowtitle: Window title.

Definition at line 1256 of file vpDisplay_rgba.cpp.

◆ setWindowPosition() [1/3]

void vpDisplayWin32::setWindowPosition ( int  winx,
int  winy 
)
inherited

Changes the window's position.

Parameters
winx,winy: Position of the upper-left window's border in the screen.

Definition at line 585 of file vpDisplayWin32.cpp.

References vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

◆ setWindowPosition() [2/3]

void vpDisplay::setWindowPosition ( const vpImage< unsigned char > &  I,
int  winx,
int  winy 
)
staticinherited

Set the window position in the screen.

Parameters
I: Image associated to the display window.
winx,winy: Position of the upper-left window's border in the screen.
Exceptions
vpDisplayException::notInitializedError: If the video device is not initialized.
Examples:
servoSimu4Points.cpp, servoSimuCylinder.cpp, servoSimuSphere.cpp, and wireframeSimulator.cpp.

Definition at line 1280 of file vpDisplay_uchar.cpp.

◆ setWindowPosition() [3/3]

void vpDisplay::setWindowPosition ( const vpImage< vpRGBa > &  I,
int  winx,
int  winy 
)
staticinherited

Set the window position in the screen.

Parameters
I: Image associated to the display window.
winx,winy: Position of the upper-left window's border in the screen.
Exceptions
vpDisplayException::notInitializedError: If the video device is not initialized.

Definition at line 1271 of file vpDisplay_rgba.cpp.

◆ waitForInit()

Member Data Documentation

◆ hThread

HANDLE vpDisplayWin32::hThread
protectedinherited

Handle of the window's thread.

Definition at line 103 of file vpDisplayWin32.h.

Referenced by vpDisplayWin32::closeDisplay(), and vpDisplayWin32::init().

◆ iStatus

bool vpDisplayWin32::iStatus
protectedinherited

Initialization status.

Definition at line 109 of file vpDisplayWin32.h.

Referenced by vpDisplayWin32::closeDisplay(), and vpDisplayWin32::init().

◆ m_displayHasBeenInitialized

bool vpDisplay::m_displayHasBeenInitialized
protectedinherited

display has been initialized

Definition at line 210 of file vpDisplay.h.

Referenced by vpDisplayX::clearDisplay(), vpDisplayWin32::closeDisplay(), vpDisplayX::closeDisplay(), vpDisplayGTK::closeDisplay(), vpDisplayOpenCV::closeDisplay(), vpDisplayX::displayArrow(), vpDisplayGTK::displayArrow(), vpDisplayOpenCV::displayArrow(), vpDisplayX::displayCharString(), vpDisplayGTK::displayCharString(), vpDisplayOpenCV::displayCharString(), vpDisplayX::displayCircle(), vpDisplayGTK::displayCircle(), vpDisplayOpenCV::displayCircle(), vpDisplayX::displayCross(), vpDisplayGTK::displayCross(), vpDisplayOpenCV::displayCross(), vpDisplayX::displayDotLine(), vpDisplayGTK::displayDotLine(), vpDisplayOpenCV::displayDotLine(), vpDisplayX::displayImage(), vpDisplayGTK::displayImage(), vpDisplayOpenCV::displayImage(), vpDisplayX::displayImageROI(), vpDisplayGTK::displayImageROI(), vpDisplayOpenCV::displayImageROI(), vpDisplayX::displayLine(), vpDisplayGTK::displayLine(), vpDisplayOpenCV::displayLine(), vpDisplayX::displayPoint(), vpDisplayGTK::displayPoint(), vpDisplayOpenCV::displayPoint(), vpDisplayX::displayRectangle(), vpDisplayGTK::displayRectangle(), vpDisplayOpenCV::displayRectangle(), vpDisplayX::flushDisplay(), vpDisplayGTK::flushDisplay(), vpDisplayOpenCV::flushDisplay(), vpDisplayX::flushDisplayROI(), vpDisplayGTK::flushDisplayROI(), vpDisplayOpenCV::flushDisplayROI(), vpDisplayX::getClick(), vpDisplayGTK::getClick(), vpDisplayOpenCV::getClick(), vpDisplayX::getClickUp(), vpDisplayGTK::getClickUp(), vpDisplayOpenCV::getClickUp(), vpDisplayX::getImage(), vpDisplayGTK::getImage(), vpDisplayX::getKeyboardEvent(), vpDisplayGTK::getKeyboardEvent(), vpDisplayOpenCV::getKeyboardEvent(), vpDisplayX::getPointerMotionEvent(), vpDisplayGTK::getPointerMotionEvent(), vpDisplayOpenCV::getPointerMotionEvent(), vpDisplayX::getPointerPosition(), vpDisplayGTK::getPointerPosition(), vpDisplayOpenCV::getPointerPosition(), vpDisplayGTK::getScreenSize(), vpDisplayWin32::init(), vpDisplayX::init(), vpDisplayGTK::init(), vpDisplayOpenCV::init(), vpDisplay::setDownScalingFactor(), vpDisplayX::setFont(), vpDisplayGTK::setTitle(), vpDisplayX::setTitle(), vpDisplayGTK::setWindowPosition(), vpDisplayX::setWindowPosition(), vpDisplayOpenCV::setWindowPosition(), and vpDisplay::~vpDisplay().

◆ m_height

◆ m_scale

unsigned int vpDisplay::m_scale
protectedinherited

Definition at line 218 of file vpDisplay.h.

Referenced by vpDisplayX::displayCharString(), vpDisplayGTK::displayCharString(), vpDisplayOpenCV::displayCharString(), vpDisplayX::displayCircle(), vpDisplayGTK::displayCircle(), vpDisplayOpenCV::displayCircle(), vpDisplayX::displayDotLine(), vpDisplayGTK::displayDotLine(), vpDisplayOpenCV::displayDotLine(), vpDisplayX::displayImage(), vpDisplayGTK::displayImage(), vpDisplayOpenCV::displayImage(), vpDisplayX::displayImageROI(), vpDisplayGTK::displayImageROI(), vpDisplayOpenCV::displayImageROI(), vpDisplayX::displayLine(), vpDisplayGTK::displayLine(), vpDisplayOpenCV::displayLine(), vpDisplayWin32::displayPoint(), vpDisplayX::displayPoint(), vpDisplayGTK::displayPoint(), vpDisplayOpenCV::displayPoint(), vpDisplayX::displayRectangle(), vpDisplayGTK::displayRectangle(), vpDisplayOpenCV::displayRectangle(), vpDisplayX::flushDisplayROI(), vpDisplayWin32::getClick(), vpDisplayX::getClick(), vpDisplayGTK::getClick(), vpDisplayOpenCV::getClick(), vpDisplayWin32::getClickUp(), vpDisplayX::getClickUp(), vpDisplayGTK::getClickUp(), vpDisplayOpenCV::getClickUp(), vpDisplayWin32::getPointerMotionEvent(), vpDisplayX::getPointerMotionEvent(), vpDisplayGTK::getPointerMotionEvent(), vpDisplayOpenCV::getPointerMotionEvent(), vpDisplayWin32::getPointerPosition(), vpDisplayX::getPointerPosition(), vpDisplayGTK::getPointerPosition(), vpDisplayOpenCV::getPointerPosition(), vpDisplayWin32::init(), vpDisplayX::init(), vpDisplayGTK::init(), vpDisplayOpenCV::init(), and vpDisplay::setDownScalingFactor().

◆ m_scaleType

vpScaleType vpDisplay::m_scaleType
protectedinherited

◆ m_title

◆ m_width

◆ m_windowXPosition

◆ m_windowYPosition

◆ MAX_INIT_DELAY

const int vpDisplayWin32::MAX_INIT_DELAY = 5000
staticprotectedinherited

Maximum delay for window initialization.

Definition at line 100 of file vpDisplayWin32.h.

Referenced by vpDisplayWin32::waitForInit().

◆ roi

RECT vpDisplayWin32::roi
protectedinherited

Definition at line 115 of file vpDisplayWin32.h.

◆ threadId

DWORD vpDisplayWin32::threadId
protectedinherited

Id of the window's thread.

Definition at line 106 of file vpDisplayWin32.h.

Referenced by vpDisplayWin32::init().

◆ window