#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, const unsigned int width, const unsigned int height)

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

void	flushDisplay ()

void	flushDisplayROI (const vpImagePoint &iP, const unsigned int width, const 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, const 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)

static void	displayLine (const vpImage< unsigned char > &I, int i1, int j1, int i2, int j2, const vpColor &color, unsigned int thickness=1)

static void	displayLine (const vpImage< unsigned char > &I, const std::vector< vpImagePoint > &ips, const 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_centered_moments, const vpColor &color, unsigned int thickness=1)

static void	displayEllipse (const vpImage< unsigned char > &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)

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)

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, const 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)

static void	displayLine (const vpImage< vpRGBa > &I, int i1, int j1, int i2, int j2, const vpColor &color, unsigned int thickness=1)

static void	displayLine (const vpImage< vpRGBa > &I, const std::vector< vpImagePoint > &ips, const 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)

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)

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)

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/core/vpConfig.h>
#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
  vpDisplayGDI d;
  // Initialize the display with the image I. Display and image are
  // now link together.
  d.init(I);
  // Specify the window location
  vpDisplay::setWindowPosition(I, 400, 100);
  // Set the display window title
  vpDisplay::setTitle(I, "My GDI display");
  // Set the display background with image I content
  vpDisplay::display(I);
  // 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
  vpDisplay::flush(I);
  // 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;
    vpTime::wait(40);
  }
  // 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;
  vpDisplay::getClick(I);
#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, imageSequenceReader.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtKltMultiTracking.cpp, mbtKltTracking.cpp, photometricVisualServoing.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoBiclopsPoint2DArtVelocity.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, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testAprilTag.cpp, testClick.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplays.cpp, testFeatureSegment.cpp, testImageResize.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testRealSense2_SR300.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testSurfKeyPoint.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.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-connected-components.cpp, tutorial-contour.cpp, tutorial-contrast-sharpening.cpp, tutorial-count-coins.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flood-fill.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-realsense.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-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, tutorial-mb-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-tracking.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 129 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 176 of file vpDisplay.h.

Constructor & Destructor Documentation

◆ vpDisplayGDI() [1/6]

vpDisplayGDI::vpDisplayGDI ( )

Basic constructor.

Definition at line 55 of file vpDisplayGDI.cpp.

Referenced by vpPlot::init().

◆ vpDisplayGDI() [2/6]

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

Constructor : Initialize a display.

Parameters

winx,winy	The window is set at position x,y (column index, row index).
title	Window'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

I Image to be displayed (note that image has to be initialized).

scaleType

: If this parameter is set to:

vpDisplay::SCALE_AUTO, the display size is adapted to ensure the image is fully displayed in the screen;
vpDisplay::SCALE_DEFAULT or vpDisplay::SCALE_1, the display size is the same than the image size.
vpDisplay::SCALE_2, the display size is downscaled by 2 along the lines and the columns.
vpDisplay::SCALE_3, the display size is downscaled by 3 along the lines and the columns.
vpDisplay::SCALE_4, the display size is downscaled by 4 along the lines and the columns.
vpDisplay::SCALE_5, the display size is downscaled by 5 along the lines and the columns.

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

I	Image to be displayed (note that image has to be initialized).
winx,winy	The window is set at position x,y (column index, row index).
title	Window's title.
scaleType	: If this parameter is set to: vpDisplay::SCALE_AUTO, the display size is adapted to ensure the image is fully displayed in the screen; vpDisplay::SCALE_DEFAULT or vpDisplay::SCALE_1, the display size is the same than the image size. vpDisplay::SCALE_2, the display size is downscaled by 2 along the lines and the columns. vpDisplay::SCALE_3, the display size is downscaled by 3 along the lines and the columns. vpDisplay::SCALE_4, the display size is downscaled by 4 along the lines and the columns. vpDisplay::SCALE_5, the display size is downscaled by 5 along the lines and the columns.

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:

vpDisplay::SCALE_AUTO, the display size is adapted to ensure the image is fully displayed in the screen;
vpDisplay::SCALE_DEFAULT or vpDisplay::SCALE_1, the display size is the same than the image size.
vpDisplay::SCALE_2, the display size is downscaled by 2 along the lines and the columns.
vpDisplay::SCALE_3, the display size is downscaled by 3 along the lines and the columns.
vpDisplay::SCALE_4, the display size is downscaled by 4 along the lines and the columns.
vpDisplay::SCALE_5, the display size is downscaled by 5 along the lines and the columns.

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,winy	The window is set at position x,y (column index, row index).
title	Window's title.
scaleType	: If this parameter is set to: vpDisplay::SCALE_AUTO, the display size is adapted to ensure the image is fully displayed in the screen; vpDisplay::SCALE_DEFAULT or vpDisplay::SCALE_1, the display size is the same than the image size. vpDisplay::SCALE_2, the display size is downscaled by 2 along the lines and the columns. vpDisplay::SCALE_3, the display size is downscaled by 3 along the lines and the columns. vpDisplay::SCALE_4, the display size is downscaled by 4 along the lines and the columns. vpDisplay::SCALE_5, the display size is downscaled by 5 along the lines and the columns.

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 the display attached to I.

Examples:: displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, manDisplay.cpp, SickLDMRS-Process.cpp, testDisplayRoi.cpp, testRealSense2_SR300.cpp, and testVideoDevice.cpp.

Definition at line 13 of file vpDisplay_uchar.cpp.

◆ close() [2/2]

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

staticinherited

Close the display attached to I.

Definition at line 13 of file vpDisplay_rgba.cpp.

◆ closeDisplay()

void vpDisplayWin32::closeDisplay ( )

inherited

Closes the display. Destroys the window.

Definition at line 844 of file vpDisplayWin32.cpp.

References vpDisplayWin32::hThread, vpDisplayWin32::iStatus, vpDisplay::m_displayHasBeenInitialized, vpDisplayWin32::waitForInit(), and vpDisplayWin32::window.

Referenced by vpDisplayWin32::~vpDisplayWin32().

◆ 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 247 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, grabV4l2.cpp, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtKltMultiTracking.cpp, mbtKltTracking.cpp, photometricVisualServoing.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBiclopsPoint2DArtVelocity.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, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent-SR300.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testAprilTag.cpp, testClick.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplays.cpp, testFeatureSegment.cpp, testImageResize.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testRealSense2_SR300.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testRobotAfma6Pose.cpp, testRobotViper850Pose.cpp, testSurfKeyPoint.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.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-connected-components.cpp, tutorial-contour.cpp, tutorial-contrast-sharpening.cpp, tutorial-count-coins.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flood-fill.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-grabber-v4l2.cpp, tutorial-ibvs-4pts-display.cpp, tutorial-ibvs-4pts-image-tracking.cpp, tutorial-ibvs-4pts-ogre-tracking.cpp, tutorial-ibvs-4pts-wireframe-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-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, tutorial-mb-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-tracking.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 639 of file vpDisplay_uchar.cpp.

◆ 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 636 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 23 of file vpDisplay_uchar.cpp.

Referenced by vpMeLine::computeRhoTheta(), vpProjectionDisplay::displayCamera(), vpMbtFaceDepthNormal::displayFeature(), vpMeTracker::initTracking(), and vpMeTracker::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 39 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 23 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 39 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 58 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 58 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()

Examples:: sonarPioneerReader.cpp.

Definition at line 77 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 96 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 77 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 96 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 rectangle.
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.cpp, tutorial-image-display-scaled-auto.cpp, tutorial-image-display-scaled-manu.cpp, and tutorial-image-display.cpp.

Definition at line 112 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 rectangle.
thickness	: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 128 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 rectangle.
thickness	: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 111 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 rectangle.
thickness	: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 127 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, poseVirtualVS.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Segment2DCamVelocity.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent-SR300.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, sonarPioneerReader.cpp, testDisplays.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testNurbs.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, tutorial-apriltag-detector.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2.cpp, tutorial-klt-tracker-live-v4l2.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-surf-homography-deprecated.cpp, and tutorial-pose-from-qrcode-image.cpp.

Definition at line 142 of file vpDisplay_uchar.cpp.

Referenced by vpMbtDistanceCylinder::computeInteractionMatrixError(), vpDot2::defineDots(), vpKltOpencv::display(), vpDot2::display(), vpPlanarObjectDetector::display(), vpDot::display(), vpKeyPointSurf::display(), vpMeNurbs::display(), vpMeSite::display(), vpMeLine::display(), vpFernClassifier::display(), vpMeEllipse::display(), vpKeyPoint::display(), vpCalibration::displayData(), vpCalibration::displayGrid(), vpKeyPoint::displayMatching(), vpPose::displayModel(), vpFeatureDisplay::displayPoint(), vpMbtDistanceKltCylinder::displayPrimitive(), vpMbtDistanceKltPoints::displayPrimitive(), vpMeSite::getQueryList(), vpTemplateTrackerZone::initClick(), vpPolygon::initClick(), vpMbTracker::initClick(), vpMeEllipse::initTracking(), vpMeNurbs::initTracking(), vpMeLine::initTracking(), vpMeEllipse::printParameters(), vpMeLine::sample(), vpDot2::searchDotsInArea(), vpMeLine::seekExtremities(), vpMeNurbs::seekExtremities(), vpKltOpencv::suppressFeature(), vpDot2::track(), vpDot::track(), and vpMeEllipse::~vpMeEllipse().

◆ 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 156 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 141 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 155 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [1/7]

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/7]

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 169 of file vpDisplay_uchar.cpp.

Referenced by vpDot2::trackAndDisplay().

◆ displayDotLine() [3/7]

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,j1	Initial image point.
i2,j2	Final image point.
color	: Line color.
thickness	: Dashed line thickness.

Definition at line 183 of file vpDisplay_uchar.cpp.

◆ displayDotLine() [4/7]

void vpDisplay::displayDotLine	(	const vpImage< unsigned char > &	I,
		const std::vector< vpImagePoint > &	ips,
		const 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 197 of file vpDisplay_uchar.cpp.

◆ displayDotLine() [5/7]

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 168 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [6/7]

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,j1	Initial image point.
i2,j2	Final image point.
color	: Line color.
thickness	: Dashed line thickness.

Definition at line 182 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [7/7]

void vpDisplay::displayDotLine	(	const vpImage< vpRGBa > &	I,
		const std::vector< vpImagePoint > &	ips,
		const 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 196 of file vpDisplay_rgba.cpp.

◆ 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_centered_moments,
		const vpColor &	color,
		unsigned int	thickness = `1`
	)

staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters

I	: Image to consider.
center	: Center of the ellipse.
coef1,coef2,coef3	: Depending on the parameter use_centered_moments these parameters are: the centered moments expressed in pixels: $\mu_{20}, \mu_{11}, \mu_{02}$ ; the major and minor axis lenght in pixels and the excentricity of the ellipse in radians: .
use_centered_moments	: When false, the parameters coef1, coef2, coef3 are the parameters . When true, the parameters coef1, coef2, coef3 are rather the centered moments $\mu_{20}, \mu_{11}, \mu_{02}$ expressed in pixels. In that case, we compute the parameters a, b and e from the centered moments.
color	: Drawings color.
thickness	: Drawings thickness.

All the points $(u_\theta,v_\theta)$ on the ellipse are drawn thanks to its parametric representation:

$\left(\begin{array}{c} u_\theta \\ v_\theta \end{array} \right) = \left(\begin{array}{c} u_c \\ v_c \end{array} \right) + \left(\begin{array}{cc} \cos(e) & -\sin(e) \\ \sin(e) & \cos(e) \end{array} \right) \left(\begin{array}{c} a \cos(\theta) \\ b \sin(\theta) \end{array} \right)$

with $0 \leq \theta \leq 2\pi$ .

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);
vpDisplay::displayEllipse(I, ellipse.getCenter(), ellipse.get_mu20(),
                          ellipse.get_mu11(), ellipse.get_mu02(), true, vpColor::orange, 1);
vpDisplay::flush(I);

Definition at line 258 of file vpDisplay_uchar.cpp.

References vpMath::rad().

Referenced by vpMbtDistanceCircle::display(), and vpDisplay::displayEllipse().

◆ 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 &	theta1,
		const double &	theta2,
		bool	use_centered_moments,
		const vpColor &	color,
		unsigned int	thickness = `1`
	)

staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters

I	: Image to consider.
center	: Center of the ellipse.
coef1,coef2,coef3	: Depending on the parameter use_centered_moments these parameters are: the centered moments expressed in pixels: $\mu_{20}, \mu_{11}, \mu_{02}$ ; the major and minor axis lenght in pixels and the excentricity of the ellipse in radians: .
theta1,theta2	: Angles $(\theta_1, \theta_2)$ in radians used to select a portion of the ellipse. If theta1=0 and theta2=vpMath::rad(360) all the ellipse is displayed.
use_centered_moments	: When false, the parameters coef1, coef2, coef3 are the parameters . When true, the parameters coef1, coef2, coef3 are rather the centered moments $\mu_{20}, \mu_{11}, \mu_{02}$ expressed in pixels. In that case, we compute the parameters a, b and e from the centered moments.
color	: Drawings color.
thickness	: Drawings thickness.

All the points $(u_\theta,v_\theta)$ on the ellipse are drawn thanks to its parametric representation:

$\left(\begin{array}{c} u_\theta \\ v_\theta \end{array} \right) = \left(\begin{array}{c} u_c \\ v_c \end{array} \right) + \left(\begin{array}{cc} \cos(e) & -\sin(e) \\ \sin(e) & \cos(e) \end{array} \right) \left(\begin{array}{c} a \cos(\theta) \\ b \sin(\theta) \end{array} \right)$

with $\theta_1 \leq \theta \leq \theta_2$ .

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);
vpDisplay::displayEllipse(I, ellipse.getCenter(), ellipse.get_mu20(),
                          ellipse.get_mu11(), ellipse.get_mu02(),
                          ellipse.getSmallestAngle(),
ellipse.getHighestAngle(), true, vpColor::orange, 1); vpDisplay::flush(I);

Definition at line 318 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_centered_moments,
		const vpColor &	color,
		unsigned int	thickness = `1`
	)

staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters

I	: Image to consider.
center	: Center of the ellipse.
coef1,coef2,coef3	: Depending on the parameter use_centered_moments these parameters are: the centered moments expressed in pixels: $\mu_{20}, \mu_{11}, \mu_{02}$ ; the major and minor axis lenght in pixels and the excentricity of the ellipse in radians: .
use_centered_moments	: When false, the parameters coef1, coef2, coef3 are the parameters . When true, the parameters coef1, coef2, coef3 are rather the centered moments $\mu_{20}, \mu_{11}, \mu_{02}$ expressed in pixels. In that case, we compute the parameters a, b and e from the centered moments.
color	: Drawings color.
thickness	: Drawings thickness.

All the points $(u_\theta,v_\theta)$ on the ellipse are drawn thanks to its parametric representation:

$\left(\begin{array}{c} u_\theta \\ v_\theta \end{array} \right) = \left(\begin{array}{c} u_c \\ v_c \end{array} \right) + \left(\begin{array}{cc} \cos(e) & -\sin(e) \\ \sin(e) & \cos(e) \end{array} \right) \left(\begin{array}{c} a \cos(\theta) \\ b \sin(\theta) \end{array} \right)$

with $0 \leq \theta \leq 2\pi$ .

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);
vpDisplay::displayEllipse(I, ellipse.getCenter(), ellipse.get_mu20(),
                          ellipse.get_mu11(), ellipse.get_mu02(), true, vpColor::orange, 1);
vpDisplay::flush(I);

Definition at line 257 of file vpDisplay_rgba.cpp.

References vpDisplay::displayEllipse(), and vpMath::rad().

◆ displayEllipse() [4/4]

void vpDisplay::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`
	)

staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters

I	: Image to consider.
center	: Center of the ellipse.
coef1,coef2,coef3	: Depending on the parameter use_centered_moments these parameters are: the centered moments expressed in pixels: $\mu_{20}, \mu_{11}, \mu_{02}$ ; the major and minor axis lenght in pixels and the excentricity of the ellipse in radians: .
theta1,theta2	: Angles $(\theta_1, \theta_2)$ in radians used to select a portion of the ellipse. If theta1=0 and theta2=vpMath::rad(360) all the ellipse is displayed.
use_centered_moments	: When false, the parameters coef1, coef2, coef3 are the parameters . When true, the parameters coef1, coef2, coef3 are rather the centered moments $\mu_{20}, \mu_{11}, \mu_{02}$ expressed in pixels. In that case, we compute the parameters a, b and e from the centered moments.
color	: Drawings color.
thickness	: Drawings thickness.

All the points $(u_\theta,v_\theta)$ on the ellipse are drawn thanks to its parametric representation:

$\left(\begin{array}{c} u_\theta \\ v_\theta \end{array} \right) = \left(\begin{array}{c} u_c \\ v_c \end{array} \right) + \left(\begin{array}{cc} \cos(e) & -\sin(e) \\ \sin(e) & \cos(e) \end{array} \right) \left(\begin{array}{c} a \cos(\theta) \\ b \sin(\theta) \end{array} \right)$

with $\theta_1 \leq \theta \leq \theta_2$ .

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);
vpDisplay::displayEllipse(I, ellipse.getCenter(), ellipse.get_mu20(),
                          ellipse.get_mu11(), ellipse.get_mu02(),
                          ellipse.getSmallestAngle(),
                          ellipse.getHighestAngle(), true, vpColor::orange, 1);
vpDisplay::flush(I);

Definition at line 318 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.

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:: mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtKltMultiTracking.cpp, mbtKltTracking.cpp, servoSimu4Points.cpp, servoSimuCylinder.cpp, servoSimuSphere.cpp, testAprilTag.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, tutorial-mb-tracker.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-tracking.cpp, and tutorial-pose-from-qrcode-image.cpp.

Definition at line 340 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.

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 340 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,
		const unsigned int	width,
		const 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,
		const unsigned int	width,
		const 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/7]

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/7]

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

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.

Examples:: displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, testDisplayPolygonLines.cpp, testDisplays.cpp, testKeyPoint-3.cpp, testKeyPoint-4.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, and tutorial-matching-surf-homography-deprecated.cpp.

Definition at line 354 of file vpDisplay_uchar.cpp.

Referenced by vpVirtualGrabber::acquire(), vpTemplateTrackerZone::display(), vpFeatureSegment::display(), vpMbtDistanceLine::display(), vpMbtDistanceKltCylinder::display(), vpMbtDistanceKltPoints::display(), vpPolygon::display(), vpMbtDistanceCylinder::display(), vpPlanarObjectDetector::display(), vpHistogram::display(), vpMeLine::display(), vpMeEllipse::display(), vpWireFrameSimulator::display_scene(), vpFeatureDisplay::displayEllipse(), vpFeatureDisplay::displayLine(), vpKeyPoint::displayMatching(), vpWireFrameSimulator::displayTrajectory(), vpWireFrameSimulator::getExternalImage(), vpTemplateTrackerZone::initClick(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

◆ displayLine() [3/7]

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

staticinherited

Display a line 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	: Line color.
thickness	: Line thickness.

Definition at line 368 of file vpDisplay_uchar.cpp.

◆ displayLine() [4/7]

void vpDisplay::displayLine	(	const vpImage< unsigned char > &	I,
		const std::vector< vpImagePoint > &	ips,
		const 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 381 of file vpDisplay_uchar.cpp.

◆ displayLine() [5/7]

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

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.

Definition at line 353 of file vpDisplay_rgba.cpp.

◆ displayLine() [6/7]

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

staticinherited

Display a line 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	: Line color.
thickness	: Line thickness.

Definition at line 367 of file vpDisplay_rgba.cpp.

◆ displayLine() [7/7]

void vpDisplay::displayLine	(	const vpImage< vpRGBa > &	I,
		const std::vector< vpImagePoint > &	ips,
		const 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 380 of file vpDisplay_rgba.cpp.

◆ 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, and trackDot2.cpp.

Definition at line 401 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 414 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 400 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 413 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`
	)

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.

Definition at line 427 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`
	)

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.

Definition at line 425 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.
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, testAprilTag.cpp, testDisplays.cpp, testSurfKeyPoint.cpp, tutorial-apriltag-detector.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, and tutorial-image-viewer.cpp.

Definition at line 447 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.
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 525 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.
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 486 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 505 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 467 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 545 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.
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 445 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.
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 523 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.
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 484 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 503 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 465 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 542 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 645 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 642 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, grabV4l2MultiCpp11Thread.cpp, manDisplay.cpp, mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtKltMultiTracking.cpp, mbtKltTracking.cpp, planarObjectDetector.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent-SR300.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, templateTracker.cpp, testAprilTag.cpp, testDisplayPolygonLines.cpp, testDisplays.cpp, testForceTorqueAti.cpp, testImageResize.cpp, testRealSense2_SR300.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-connected-components.cpp, tutorial-contour.cpp, tutorial-contrast-sharpening.cpp, tutorial-count-coins.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flood-fill.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-realsense.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-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, tutorial-mb-tracker.cpp, tutorial-pose-from-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, and tutorial-video-recorder.cpp.

Definition at line 563 of file vpDisplay_uchar.cpp.

Referenced by vpVirtualGrabber::acquire(), vpKltOpencv::display(), vpMbtDistanceKltCylinder::displayPrimitive(), vpMbtDistanceKltPoints::displayPrimitive(), vpMbTracker::initClick(), and vpKltOpencv::suppressFeature().

◆ 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 581 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 560 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 578 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() {
  vpImage<unsigned char> I(240, 380);
  vpDisplayGDI d;
  d.init(I);
  vpDisplay::display(I); // display the image
  vpImagePoint center;
  unsigned int radius = 100;
  vpDisplay::displayCircle(I, center, radius, vpColor::red);
  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, grabV4l2.cpp, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtKltMultiTracking.cpp, mbtKltTracking.cpp, photometricVisualServoing.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBiclopsPoint2DArtVelocity.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, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent-SR300.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testAprilTag.cpp, testClick.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplays.cpp, testFeatureSegment.cpp, testForceTorqueAti.cpp, testImageResize.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testRealSense2_SR300.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testRobotAfma6Pose.cpp, testRobotViper850Pose.cpp, testSurfKeyPoint.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.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-connected-components.cpp, tutorial-contour.cpp, tutorial-contrast-sharpening.cpp, tutorial-count-coins.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flood-fill.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-grabber-v4l2.cpp, tutorial-ibvs-4pts-display.cpp, tutorial-ibvs-4pts-image-tracking.cpp, tutorial-ibvs-4pts-ogre-tracking.cpp, tutorial-ibvs-4pts-wireframe-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-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, tutorial-mb-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-tracking.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 615 of file vpDisplay_uchar.cpp.

Referenced by vpVirtualGrabber::acquire(), vpMbtDistanceCylinder::computeInteractionMatrixError(), vpDot2::defineDots(), vpMbtDistanceCircle::displayMovingEdges(), vpDot2::getFreemanChain(), vpTemplateTrackerZone::initClick(), vpPolygon::initClick(), vpMbTracker::initClick(), vpMeEllipse::initTracking(), vpMeNurbs::initTracking(), vpMeLine::initTracking(), vpDot2::searchDotsInArea(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpSimulatorAfma6::setPosition(), vpMeEllipse::track(), vpMeLine::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);
  vpDisplayGDI d;
  d.init(I);
  vpDisplay::display(I); // display the image
  vpImagePoint center;
  unsigned int radius = 100;
  vpDisplay::displayCircle(I, center, radius, vpColor::red);
  vpDisplay::flush(I); // Mendatory to display the requested features.
}

See also: flushROI()

Definition at line 612 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,
		const unsigned int	width,
		const 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 626 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 623 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, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtKltMultiTracking.cpp, mbtKltTracking.cpp, photometricVisualServoing.cpp, planarObjectDetector.cpp, plot2d.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBiclopsPoint2DArtVelocity.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, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent-SR300.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testAprilTag.cpp, testClick.cpp, testComedi.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplays.cpp, testForceTorqueAti.cpp, testImageResize.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testRealSense2_SR300.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testSurfKeyPoint.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.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-connected-components.cpp, tutorial-contour.cpp, tutorial-contrast-sharpening.cpp, tutorial-count-coins.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flood-fill.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-grabber-v4l2.cpp, tutorial-ibvs-4pts-display.cpp, tutorial-ibvs-4pts-image-tracking.cpp, tutorial-ibvs-4pts-ogre-tracking.cpp, tutorial-ibvs-4pts-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-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, tutorial-mb-tracker.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-tracking.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 664 of file vpDisplay_uchar.cpp.

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

◆ 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 684 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 709 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 731 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 661 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 681 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 706 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 728 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 757 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 779 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 754 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 776 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:: mbtEdgeKltMultiTracking.cpp, mbtEdgeMultiTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtKltMultiTracking.cpp, testKeyPoint-2.cpp, and testKeyPoint-4.cpp.

Definition at line 229 of file vpDisplay.h.

◆ 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 1151 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 1141 of file vpDisplay_rgba.cpp.

◆ getHeight()

unsigned int vpDisplay::getHeight ( ) const

inlineinherited

Return the display height.

See also: getWidth()

Definition at line 234 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;
  vpDisplay *d;
  // Depending on the detected third party libraries, we instantiate here the
  // first video device which is available
#if defined(VISP_HAVE_X11)
  d = new vpDisplayX;
#elif defined(VISP_HAVE_GTK)
  d = new vpDisplayGTK;
#elif defined(VISP_HAVE_GDI)
  d = new vpDisplayGDI;
#elif defined(VISP_HAVE_D3D9)
  d = new vpDisplayD3D;
#elif defined(VISP_HAVE_OPENCV)
  d = new vpDisplayOpenCV;
#endif
  // Initialize the display with the image I. Display and image are
  // now link together.
#ifdef VISP_HAVE_DISPLAY
  d->init(I);
#endif
  // Set the display background with image I content
  vpDisplay::display(I);
  // Draw a red rectangle in the display overlay (foreground)
  vpDisplay::displayRectangle(I, 10, 10, 100, 20, vpColor::red, true);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // 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
  vpDisplay::getClick(I);
#ifdef VISP_HAVE_DISPLAY
  delete d;
#endif
}

Examples:: displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, manGeometricFeatures.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, sonarPioneerReader.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/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<vpRGBa> I(240, 320); // Create a black RGB color image
  vpImage<vpRGBa> Ioverlay;
  vpDisplay *d;
  // Depending on the detected third party libraries, we instantiate here the
  // first video device which is available
#if defined(VISP_HAVE_X11)
  d = new vpDisplayX;
#elif defined(VISP_HAVE_GTK)
  d = new vpDisplayGTK;
#elif defined(VISP_HAVE_GDI)
  d = new vpDisplayGDI;
#elif defined(VISP_HAVE_D3D9)
  d = new vpDisplayD3D;
#elif defined(VISP_HAVE_OPENCV)
  d = new vpDisplayOpenCV;
#endif
  // Initialize the display with the image I. Display and image are
  // now link together.
#ifdef VISP_HAVE_DISPLAY
  d->init(I);
#endif
  // Set the display background with image I content
  vpDisplay::display(I);
  // Draw a red rectangle in the display overlay (foreground)
  vpDisplay::displayRectangle(I, 10, 10, 100, 20, vpColor::red, true);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // 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
  vpDisplay::getClick(I);
#ifdef VISP_HAVE_DISPLAY
  delete d;
#endif
}

Definition at line 218 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
  vpDisplay *d;
#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
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  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 868 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
  vpDisplay *d;
#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
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  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 959 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
  vpDisplay *d;
#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
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  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 1050 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
  vpDisplay *d;
#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
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  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 864 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
  vpDisplay *d;
#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
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  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 955 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
  vpDisplay *d;
#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
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  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 1046 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 1064 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 1060 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 1078 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 1074 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 239 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 245 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 250 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, keyPointSurf.cpp, kinectAcquisition.cpp, planarObjectDetector.cpp, sonarPioneerReader.cpp, testDisplays.cpp, testImageResize.cpp, testRealSense2_SR300.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, and testTrackDot.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 257 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.
color	Background color.

Exceptions

vpDisplayException::notInitializedError : If the video device is not initialized.

Definition at line 1092 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.
color	Background color.

Exceptions

vpDisplayException::notInitializedError : If the video device is not initialized.

Definition at line 1088 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.

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
  vpDisplayX d;
#elif defined VISP_HAVE_GDI
  vpDisplayGDI d;
#endif
  // Display in a 160 by 120 windows size
  d.setDownScalingFactor(vpDisplay::SCALE_4);
  d.init(I);
  vpDisplay::display(I);
  vpDisplay::flush(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 1110 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 1103 of file vpDisplay_rgba.cpp.

◆ setScale()

void vpDisplay::setScale	(	vpScaleType	scaleType,
		unsigned int	width,
		unsigned int	height
	)

protectedinherited

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

Definition at line 260 of file vpDisplay.cpp.

References vpDisplay::computeAutoScale(), vpDisplay::SCALE_1, vpDisplay::SCALE_10, vpDisplay::SCALE_2, vpDisplay::SCALE_3, vpDisplay::SCALE_4, vpDisplay::SCALE_5, vpDisplay::SCALE_6, vpDisplay::SCALE_7, vpDisplay::SCALE_8, vpDisplay::SCALE_9, vpDisplay::SCALE_AUTO, vpDisplay::SCALE_DEFAULT, and vpDisplay::setDownScalingFactor().

Referenced by vpDisplayWin32::init(), vpDisplayGTK::init(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpDisplayGDI(), vpDisplayGTK::vpDisplayGTK(), vpDisplayOpenCV::vpDisplayOpenCV(), and vpDisplayX::vpDisplayX().

◆ 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]

void vpDisplay::setTitle	(	const vpImage< unsigned char > &	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.

Examples:: tutorial-barcode-detector-live.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-ibvs-4pts-ogre-tracking.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-video-reader.cpp, and tutorial-viewer.cpp.

Definition at line 1122 of file vpDisplay_uchar.cpp.

◆ 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 1112 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 1137 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 1127 of file vpDisplay_rgba.cpp.

◆ waitForInit()

void vpDisplayWin32::waitForInit ( )

protectedinherited

If the window is not initialized yet, wait a little (MAX_INIT_DELAY).

Exceptions

notInitializedError : the window isn't initialized

Definition at line 162 of file vpDisplayWin32.cpp.

References vpDisplayWin32::MAX_INIT_DELAY, vpDisplayException::notInitializedError, and vpDisplayWin32::window.

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 204 of file vpDisplay.h.

◆ m_height

unsigned int vpDisplay::m_height

protectedinherited

Definition at line 210 of file vpDisplay.h.

Referenced by vpDisplayX::clearDisplay(), vpDisplayGTK::displayImage(), vpDisplayX::displayImage(), vpDisplayOpenCV::displayImage(), vpDisplayX::displayImageROI(), vpDisplayOpenCV::displayImageROI(), vpDisplayGTK::getImage(), vpDisplayX::getImage(), vpDisplayGTK::init(), vpDisplayX::init(), and vpDisplayOpenCV::init().

◆ m_scale

unsigned int vpDisplay::m_scale

protectedinherited

Definition at line 212 of file vpDisplay.h.

◆ m_scaleType

vpScaleType vpDisplay::m_scaleType

protectedinherited

Definition at line 213 of file vpDisplay.h.

Referenced by vpDisplayWin32::init(), vpDisplayGTK::init(), vpDisplayX::init(), vpDisplayOpenCV::init(), and vpDisplay::setDownScalingFactor().

◆ m_title

std::string vpDisplay::m_title

protectedinherited

Definition at line 211 of file vpDisplay.h.

Referenced by vpDisplayOpenCV::closeDisplay(), vpDisplayOpenCV::flushDisplay(), vpDisplayOpenCV::flushDisplayROI(), vpDisplayWin32::init(), vpDisplayGTK::init(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpDisplayGTK::setTitle(), vpDisplayX::setTitle(), vpDisplayOpenCV::setWindowPosition(), vpDisplayGDI(), vpDisplayGTK::vpDisplayGTK(), vpDisplayOpenCV::vpDisplayOpenCV(), and vpDisplayX::vpDisplayX().

◆ m_width

unsigned int vpDisplay::m_width

protectedinherited

Definition at line 209 of file vpDisplay.h.

Referenced by vpDisplayX::clearDisplay(), vpDisplayGTK::displayImage(), vpDisplayX::displayImage(), vpDisplayOpenCV::displayImage(), vpDisplayX::displayImageROI(), vpDisplayOpenCV::displayImageROI(), vpDisplayGTK::getImage(), vpDisplayX::getImage(), vpDisplayGTK::init(), vpDisplayX::init(), and vpDisplayOpenCV::init().

◆ m_windowXPosition

int vpDisplay::m_windowXPosition

protectedinherited

display position

Definition at line 206 of file vpDisplay.h.

Referenced by vpDisplayWin32::init(), vpDisplayGTK::init(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpDisplayOpenCV::setWindowPosition(), vpDisplayGDI(), vpDisplayGTK::vpDisplayGTK(), vpDisplayOpenCV::vpDisplayOpenCV(), and vpDisplayX::vpDisplayX().

◆ m_windowYPosition

int vpDisplay::m_windowYPosition

protectedinherited

display position

Definition at line 208 of file vpDisplay.h.

Referenced by vpDisplayWin32::init(), vpDisplayGTK::init(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpDisplayOpenCV::setWindowPosition(), vpDisplayGDI(), vpDisplayGTK::vpDisplayGTK(), vpDisplayOpenCV::vpDisplayOpenCV(), and vpDisplayX::vpDisplayX().

◆ 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

vpWin32Window vpDisplayWin32::window

protectedinherited

The window.

Definition at line 112 of file vpDisplayWin32.h.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ vpScaleType

Constructor & Destructor Documentation

◆ vpDisplayGDI() [1/6]

◆ vpDisplayGDI() [2/6]

◆ vpDisplayGDI() [3/6]

◆ vpDisplayGDI() [4/6]

◆ vpDisplayGDI() [5/6]

◆ vpDisplayGDI() [6/6]

◆ ~vpDisplayGDI()

Member Function Documentation

◆ clearDisplay()

◆ close() [1/2]

◆ close() [2/2]

◆ closeDisplay()

◆ computeAutoScale()

◆ display() [1/2]

◆ display() [2/2]

◆ displayArrow() [1/5]

◆ displayArrow() [2/5]

◆ displayArrow() [3/5]

◆ displayArrow() [4/5]

◆ displayArrow() [5/5]

◆ displayCamera() [1/2]

◆ displayCamera() [2/2]

◆ displayCharString() [1/5]

◆ displayCharString() [2/5]

◆ displayCharString() [3/5]

◆ displayCharString() [4/5]

◆ displayCharString() [5/5]

◆ displayCircle() [1/5]

◆ displayCircle() [2/5]

◆ displayCircle() [3/5]

◆ displayCircle() [4/5]

◆ displayCircle() [5/5]

◆ displayCross() [1/5]

◆ displayCross() [2/5]

◆ displayCross() [3/5]

◆ displayCross() [4/5]

◆ displayCross() [5/5]

◆ displayDotLine() [1/7]

◆ displayDotLine() [2/7]

◆ displayDotLine() [3/7]

◆ displayDotLine() [4/7]

◆ displayDotLine() [5/7]

◆ displayDotLine() [6/7]

◆ displayDotLine() [7/7]

◆ displayEllipse() [1/4]

◆ displayEllipse() [2/4]

◆ displayEllipse() [3/4]

◆ displayEllipse() [4/4]

◆ displayFrame() [1/2]

◆ displayFrame() [2/2]

◆ displayImage() [1/2]

◆ displayImage() [2/2]

◆ displayImageROI() [1/2]

◆ displayImageROI() [2/2]

◆ displayLine() [1/7]

◆ displayLine() [2/7]

◆ displayLine() [3/7]

◆ displayLine() [4/7]

◆ displayLine() [5/7]

◆ displayLine() [6/7]

◆ displayLine() [7/7]

◆ displayPoint() [1/5]

◆ displayPoint() [2/5]

◆ displayPoint() [3/5]

◆ displayPoint() [4/5]

◆ displayPoint() [5/5]

◆ displayPolygon() [1/2]

◆ displayPolygon() [2/2]

◆ displayRectangle() [1/15]

◆ displayRectangle() [2/15]