#include <visp3/gui/vpDisplayX.h>

Inheritance diagram for vpDisplayX:

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
	vpDisplayX ()

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

	vpDisplayX (vpImage< unsigned char > &I, vpScaleType type)

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

	vpDisplayX (vpImage< vpRGBa > &I, vpScaleType type)

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

virtual	~vpDisplayX () VP_OVERRIDE

void	getImage (vpImage< vpRGBa > &I) VP_OVERRIDE

unsigned int	getScreenDepth ()

unsigned int	getScreenHeight () VP_OVERRIDE

void	getScreenSize (unsigned int &width, unsigned int &height) VP_OVERRIDE

unsigned int	getScreenWidth () VP_OVERRIDE

void	init (vpImage< unsigned char > &I, int win_x=-1, int win_y=-1, const std::string &win_title="") VP_OVERRIDE

void	init (vpImage< vpRGBa > &I, int win_x=-1, int win_y=-1, const std::string &win_title="") VP_OVERRIDE

void	init (unsigned int win_width, unsigned int win_height, int win_x=-1, int win_y=-1, const std::string &win_title="") VP_OVERRIDE

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

virtual void	setDownScalingFactor (unsigned int scale)

virtual void	setDownScalingFactor (vpScaleType scaleType)

Static Public Member Functions
Static public vpDisplay functionalities on gray level images.
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	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	displayCamera (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color, unsigned int thickness)

static void	displayCircle (const vpImage< unsigned char > &I, const vpImageCircle &circle, const vpColor &color, bool fill=false, unsigned int thickness=1)

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

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

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

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

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

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

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

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

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

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

static void	displayFrame (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color=vpColor::none, unsigned int thickness=1, const vpImagePoint &offset=vpImagePoint(0, 0), const std::string &frameName="", const vpColor &textColor=vpColor::black, const vpImagePoint &textOffset=vpImagePoint(15, 15))

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

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

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

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

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

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

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

static void	displayPolygon (const vpImage< unsigned char > &I, const vpPolygon &polygon, const vpColor &color, unsigned int thickness=1, bool closed=true)

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 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 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 void	getImage (const vpImage< unsigned char > &Is, vpImage< vpRGBa > &Id)

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 void	setBackground (const vpImage< unsigned char > &I, const vpColor &color)

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 public vpDisplay functionalities on 32 bits color images.
static unsigned int	getDownScalingFactor (const vpImage< vpRGBa > &I)

static void	close (vpImage< vpRGBa > &I)

static void	display (const vpImage< vpRGBa > &I)

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	displayCamera (const vpImage< vpRGBa > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color, unsigned int thickness)

static void	displayCircle (const vpImage< vpRGBa > &I, const vpImageCircle &circle, const vpColor &color, bool fill=false, unsigned int thickness=1)

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

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

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

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

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

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

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

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

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

static void	displayEllipse (const vpImage< vpRGBa > &I, const vpImagePoint &center, const double &coef1, const double &coef2, const double &coef3, const double &theta1, const double &theta2, bool use_centered_moments, const vpColor &color, unsigned int thickness=1, bool display_center=false, bool display_arc=false)

static void	displayFrame (const vpImage< vpRGBa > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color=vpColor::none, unsigned int thickness=1, const vpImagePoint &offset=vpImagePoint(0, 0), const std::string &frameName="", const vpColor &textColor=vpColor::black, const vpImagePoint &textOffset=vpImagePoint(15, 15))

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

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

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

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

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

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

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

static void	displayPolygon (const vpImage< vpRGBa > &I, const vpPolygon &polygon, const vpColor &color, unsigned int thickness=1, bool closed=true)

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 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 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 void	getImage (const vpImage< vpRGBa > &Is, vpImage< vpRGBa > &Id)

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 void	setBackground (const vpImage< vpRGBa > &I, const vpColor &color)

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)

Protected Member Functions
void	clearDisplay (const vpColor &color=vpColor::white) VP_OVERRIDE

void	closeDisplay () VP_OVERRIDE

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

void	displayCircle (const vpImagePoint &center, unsigned int radius, const vpColor &color, bool fill=false, unsigned int thickness=1) VP_OVERRIDE

void	displayCross (const vpImagePoint &ip, unsigned int size, const vpColor &color, unsigned int thickness=1) VP_OVERRIDE

void	displayDotLine (const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1) VP_OVERRIDE

void	displayImage (const vpImage< unsigned char > &I) VP_OVERRIDE

void	displayImage (const vpImage< vpRGBa > &I) VP_OVERRIDE

void	displayImage (const unsigned char *I)

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

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

void	displayLine (const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1) VP_OVERRIDE

void	displayPoint (const vpImagePoint &ip, const vpColor &color, unsigned int thickness=1) VP_OVERRIDE

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

void	displayRectangle (const vpImagePoint &topLeft, const vpImagePoint &bottomRight, const vpColor &color, bool fill=false, unsigned int thickness=1) VP_OVERRIDE

void	displayRectangle (const vpRect &rectangle, const vpColor &color, bool fill=false, unsigned int thickness=1) VP_OVERRIDE

void	displayText (const vpImagePoint &ip, const std::string &text, const vpColor &color=vpColor::green) VP_OVERRIDE

void	flushDisplay () VP_OVERRIDE

void	flushDisplayROI (const vpImagePoint &iP, unsigned int width, unsigned int height) VP_OVERRIDE

bool	getClick (bool blocking=true) VP_OVERRIDE

bool	getClick (vpImagePoint &ip, bool blocking=true) VP_OVERRIDE

bool	getClick (vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking=true) VP_OVERRIDE

bool	getClickUp (vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking=true) VP_OVERRIDE

bool	getKeyboardEvent (bool blocking=true) VP_OVERRIDE

bool	getKeyboardEvent (std::string &key, bool blocking=true) VP_OVERRIDE

bool	getPointerMotionEvent (vpImagePoint &ip) VP_OVERRIDE

bool	getPointerPosition (vpImagePoint &ip) VP_OVERRIDE

void	setFont (const std::string &font) VP_OVERRIDE

void	setTitle (const std::string &title) VP_OVERRIDE

void	setWindowPosition (int win_x, int win_y) VP_OVERRIDE

Deprecated functions
void	setScale (vpScaleType scaleType, unsigned int width, unsigned int height)

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 VP_DEPRECATED void	displayCharString (const vpImage< unsigned char > &I, const vpImagePoint &ip, const char *string, const vpColor &color)

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

static VP_DEPRECATED void	displayCharString (const vpImage< vpRGBa > &I, const vpImagePoint &ip, const char *string, const vpColor &color)

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

Detailed Description

Use the X11 console to display images on unix-like OS. Thus to enable this class X11 should be installed. Installation instructions are provided here https://visp.inria.fr/3rd_x11.

This class define the X11 console to display images It also define method to display some geometric feature (point, line, circle) in the image.

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

#include <visp3/core/vpImagePoint.h>
#include <visp3/gui/vpDisplayX.h>
#include <visp3/io/vpImageIo.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
  vpImage<unsigned char> I; // Grey level image
 
  // Read an image in PGM P5 format
  vpImageIo::read(I, "/local/soft/ViSP/ViSP-images/Klimt/Klimt.pgm");
 
#if defined(VISP_HAVE_X11)
  vpDisplayX d;
 
  // Initialize the display with the image I. Display and image are
  // now link together.
  d.init(I);
#endif
 
  // Specify the window location
  vpDisplay::setWindowPosition(I, 400, 100);
 
  // Set the display window title
  vpDisplay::setTitle(I, "My X11 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);
}

Examples: AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, SickLDMRS-Process.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, grab1394Two.cpp, grabDisk.cpp, grabFlyCapture.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2.cpp, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, keyboardControlBebop2.cpp, kinectAcquisition.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbot-apriltag-2D-half-vs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, perfGenericTracker.cpp, photometricMappingVisualServoing.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, poseVirtualVS.cpp, readRealSenseData.cpp, saveRealSenseData.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6MegaposePBVS.cpp, servoAfma6Segment2DCamVelocity.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPixhawkDroneIBVS.cpp, servoPololuPtuPoint2DJointVelocity.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoUniversalRobotsIBVS.cpp, servoUniversalRobotsPBVS.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityLs_cur.cpp, servoViper850FourPoints2DArtVelocityLs_des.cpp, servoViper850FourPoints2DCamVelocityLs_cur.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testClick.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplayScaled.cpp, testDisplays.cpp, testFeatureSegment.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testGenericTrackerDeterminist.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testPolygon.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testRobotAfma6Pose.cpp, testRobotBebop2.cpp, testRobotViper850Pose.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, testVirtuoseWithGlove.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.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-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-draw-cross.cpp, tutorial-draw-frame.cpp, tutorial-draw-line.cpp, tutorial-draw-point.cpp, tutorial-draw-rectangle.cpp, tutorial-draw-text.cpp, tutorial-event-keyboard.cpp, tutorial-export-image.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-bebop2.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-realsense-T265.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-rgbd-D435-structurecore.cpp, tutorial-grabber-structure-core.cpp, tutorial-grabber-v4l2.cpp, tutorial-hsv-range-tuner.cpp, tutorial-hsv-segmentation-pcl-viewer.cpp, tutorial-hsv-segmentation-pcl.cpp, tutorial-hsv-segmentation.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-colormap.cpp, tutorial-image-display-scaled-auto.cpp, tutorial-image-display-scaled-manu.cpp, tutorial-image-display.cpp, tutorial-image-filter.cpp, tutorial-image-simulator.cpp, tutorial-image-viewer.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-webcam.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-megapose-live-single-object-tracking.cpp, tutorial-munkres-assignment.cpp, tutorial-panda3d-renderer.cpp, tutorial-pose-from-planar-object.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, tutorial-pose-from-qrcode-image.cpp, tutorial-template-tracker.cpp, tutorial-video-manipulation.cpp, tutorial-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 134 of file vpDisplayX.h.

Member Enumeration Documentation

◆ vpScaleType

enum vpDisplay::vpScaleType

inherited

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

Enumerator
SCALE_AUTO	Auto down scaling factor computed fom the screen resolution.
SCALE_1	Display and image have the same size.
SCALE_2	Display width and height is down scaled by 2 wrt the image size.
SCALE_3	Display width and height is down scaled by 3 wrt the image size.
SCALE_4	Display width and height is down scaled by 4 wrt the image size.
SCALE_5	Display width and height is down scaled by 5 wrt the image size.
SCALE_6	Display width and height is down scaled by 6 wrt the image size.
SCALE_7	Display width and height is down scaled by 7 wrt the image size.
SCALE_8	Display width and height is down scaled by 8 wrt the image size.
SCALE_9	Display width and height is down scaled by 9 wrt the image size.
SCALE_10	Display width and height is down scaled by 10 wrt the image size.
SCALE_DEFAULT	Display and image have the same size. Similar to vpDisplay::SCALE_1.

Definition at line 182 of file vpDisplay.h.

Constructor & Destructor Documentation

◆ vpDisplayX() [1/6]

vpDisplayX::vpDisplayX ( )

Basic constructor.

To initialize the window position, title and size you may call init(vpImage<unsigned char> &, int, int, const std::string &) or init(vpImage<vpRGBa> &, int, int, const std::string &).

#include <visp3/core/vpImage.h>
#include <visp3/gui/vpDisplayX.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
  vpDisplayX d;
  vpImage<unsigned char> I(240, 384);
  d.init(I, 100, 200, "My display");
}

Definition at line 1780 of file vpDisplayX.cpp.

◆ vpDisplayX() [2/6]

vpDisplayX::vpDisplayX	(	int	x,
		int	y,
		const std::string &	title = `""`
	)

Constructor that just initialize the display position in the screen and the display title.

Parameters

x,y	: The window is set at position x,y (column index, row index).
title	: Window title.

To initialize the display size, you need to call init().

#include <visp3/core/vpImage.h>
#include <visp3/gui/vpDisplayX.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
  vpDisplayX d(100, 200, "My display");
  vpImage<unsigned char> I(240, 384);
  d.init(I);
}

Definition at line 1749 of file vpDisplayX.cpp.

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

◆ vpDisplayX() [3/6]

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

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)

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 down scaled by 2 along the lines and the columns.
vpDisplay::SCALE_3, the display size is down scaled by 3 along the lines and the columns.
vpDisplay::SCALE_4, the display size is down scaled by 4 along the lines and the columns.
vpDisplay::SCALE_5, the display size is down scaled by 5 along the lines and the columns.

Definition at line 1636 of file vpDisplayX.cpp.

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

◆ vpDisplayX() [4/6]

vpDisplayX::vpDisplayX	(	vpImage< unsigned char > &	I,
		int	x = `-1`,
		int	y = `-1`,
		const std::string &	title = `""`,
		vpScaleType	scaleType = `SCALE_DEFAULT`
	)

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.
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 down scaled by 2 along the lines and the columns. vpDisplay::SCALE_3, the display size is down scaled by 3 along the lines and the columns. vpDisplay::SCALE_4, the display size is down scaled by 4 along the lines and the columns. vpDisplay::SCALE_5, the display size is down scaled by 5 along the lines and the columns.

Definition at line 1664 of file vpDisplayX.cpp.

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

◆ vpDisplayX() [5/6]

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

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

Parameters

I : Image to be displayed (not 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 down scaled by 2 along the lines and the columns.
vpDisplay::SCALE_3, the display size is down scaled by 3 along the lines and the columns.
vpDisplay::SCALE_4, the display size is down scaled by 4 along the lines and the columns.
vpDisplay::SCALE_5, the display size is down scaled by 5 along the lines and the columns.

Definition at line 1690 of file vpDisplayX.cpp.

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

◆ vpDisplayX() [6/6]

vpDisplayX::vpDisplayX	(	vpImage< vpRGBa > &	I,
		int	x = `-1`,
		int	y = `-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 (not that image has to be initialized).
x,y	: The window is set at position x,y (column index, row index).
title	: Window 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 down scaled by 2 along the lines and the columns. vpDisplay::SCALE_3, the display size is down scaled by 3 along the lines and the columns. vpDisplay::SCALE_4, the display size is down scaled by 4 along the lines and the columns. vpDisplay::SCALE_5, the display size is down scaled by 5 along the lines and the columns.

Definition at line 1717 of file vpDisplayX.cpp.

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

◆ ~vpDisplayX()

vpDisplayX::~vpDisplayX ( )

virtual

Destructor.

Definition at line 1785 of file vpDisplayX.cpp.

References closeDisplay().

Member Function Documentation

◆ clearDisplay()

void vpDisplayX::clearDisplay ( const vpColor & color = vpColor::white )

protected

Set the window backgroud to color.

Parameters

color : Background color.

Definition at line 2102 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_height, vpDisplay::m_width, and vpDisplayException::notInitializedError.

◆ close() [1/2]

BEGIN_VISP_NAMESPACE 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, testDisplayRoi.cpp, testDisplayScaled.cpp, testPolygon.cpp, testRealSense2_D435.cpp, and testRealSense2_SR300.cpp.

Definition at line 47 of file vpDisplay_uchar.cpp.

◆ close() [2/2]

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

staticinherited

Close the display attached to I.

Definition at line 47 of file vpDisplay_rgba.cpp.

◆ closeDisplay()

void vpDisplayX::closeDisplay ( )

protected

Close the window.

See also: init()

Definition at line 2057 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized.

Referenced by ~vpDisplayX().

◆ 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 249 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, SickLDMRS-Process.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, grab1394CMU.cpp, grab1394Two.cpp, grabDirectShow.cpp, grabDirectShowMulti.cpp, grabDisk.cpp, grabFlyCapture.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2.cpp, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, keyboardControlBebop2.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, perfGenericTracker.cpp, photometricMappingVisualServoing.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, poseVirtualVS.cpp, readRealSenseData.cpp, saveRealSenseData.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6AprilTagIBVS.cpp, servoAfma6AprilTagPBVS.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6FourPoints2DCamVelocityLs_cur_integrator.cpp, servoAfma6FourPoints2DCamVelocityLs_des.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6MegaposePBVS.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPixhawkDroneIBVS.cpp, servoPololuPtuPoint2DJointVelocity.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoUniversalRobotsIBVS.cpp, servoUniversalRobotsPBVS.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityLs_cur.cpp, servoViper850FourPoints2DArtVelocityLs_des.cpp, servoViper850FourPoints2DCamVelocityLs_cur.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testClick.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplayScaled.cpp, testDisplays.cpp, testFeatureSegment.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testGenericTrackerDeterminist.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testParticleFilter.cpp, testPolygon.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testRobotAfma6Pose.cpp, testRobotBebop2.cpp, testRobotViper850Pose.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, testVirtuoseWithGlove.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.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-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-draw-circle.cpp, tutorial-draw-cross.cpp, tutorial-draw-frame.cpp, tutorial-draw-line.cpp, tutorial-draw-point.cpp, tutorial-draw-rectangle.cpp, tutorial-draw-text.cpp, tutorial-event-keyboard.cpp, tutorial-export-image.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-bebop2.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-multiple-realsense.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense-T265.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-rgbd-D435-structurecore.cpp, tutorial-grabber-structure-core.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-grabber-v4l2.cpp, tutorial-hsv-range-tuner.cpp, tutorial-hsv-segmentation-pcl-viewer.cpp, tutorial-hsv-segmentation-pcl.cpp, tutorial-hsv-segmentation.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-colormap.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-SIFT.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-webcam.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-megapose-live-single-object-tracking.cpp, tutorial-munkres-assignment.cpp, tutorial-npz.cpp, tutorial-panda3d-renderer.cpp, tutorial-pf-curve-fitting-all.cpp, tutorial-pf-curve-fitting-lms.cpp, tutorial-pf-curve-fitting-pf.cpp, tutorial-pf.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, tutorial-pose-from-qrcode-image.cpp, tutorial-template-tracker.cpp, tutorial-ukf.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, tutorial-video-recorder.cpp, tutorial-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 830 of file vpDisplay_uchar.cpp.

Referenced by vpDot2::defineDots(), vpWireFrameSimulator::getExternalImage(), vpWireFrameSimulator::getInternalImage(), vpPlot::init(), vpMbTracker::initClick(), vpMbGenericTracker::initFromPose(), vpDisplayFactory::impl::makeDisplayGridHelper(), vpDisplayOpenCV::on_mouse(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpSimulatorAfma6::setPosition(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

◆ display() [2/2]

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

staticinherited

Display image I.

Warning: Display has to be initialized.; Suppress the overlay drawing.

Parameters

I	: Image to display.

See also: init(), close()

Definition at line 828 of file vpDisplay_rgba.cpp.

◆ displayArrow() [1/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, testDisplayScaled.cpp, testDisplays.cpp, and tutorial-panda3d-renderer.cpp.

Definition at line 57 of file vpDisplay_uchar.cpp.

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

◆ displayArrow() [2/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 73 of file vpDisplay_uchar.cpp.

◆ displayArrow() [3/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 57 of file vpDisplay_rgba.cpp.

◆ displayArrow() [4/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 73 of file vpDisplay_rgba.cpp.

◆ displayArrow() [5/5]

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

protected

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 2119 of file vpDisplayX.cpp.

References displayLine(), vpImagePoint::distance(), vpImagePoint::get_i(), vpImagePoint::get_j(), vpDisplay::m_displayHasBeenInitialized, vpDisplayException::notInitializedError, vpImagePoint::set_i(), vpImagePoint::set_j(), and vpMath::sqr().

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

◆ displayCharString() [1/4]

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

staticinherited

Deprecated:: 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 112 of file vpDisplay_uchar.cpp.

◆ displayCharString() [2/4]

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

staticinherited

Deprecated:: 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 131 of file vpDisplay_uchar.cpp.

◆ displayCharString() [3/4]

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

staticinherited

Deprecated:: 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 112 of file vpDisplay_rgba.cpp.

◆ displayCharString() [4/4]

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

staticinherited

Deprecated:: 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 131 of file vpDisplay_rgba.cpp.

◆ displayCircle() [1/7]

void vpDisplay::displayCircle	(	const vpImage< unsigned char > &	I,
		const vpImageCircle &	circle,
		const vpColor &	color,
		bool	fill = `false`,
		unsigned int	thickness = `1`
	)

staticinherited

Display a circle.

Parameters

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

Examples: displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, testDisplayScaled.cpp, testDisplays.cpp, testKeyPoint-2.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-draw-circle.cpp, tutorial-image-display-scaled-auto.cpp, tutorial-image-display-scaled-manu.cpp, tutorial-image-display.cpp, and tutorial-munkres-assignment.cpp.

Definition at line 149 of file vpDisplay_uchar.cpp.

References vpImageCircle::getCenter(), and vpImageCircle::getRadius().

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

◆ displayCircle() [2/7]

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

staticinherited

Display a circle.

Parameters

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

Definition at line 167 of file vpDisplay_uchar.cpp.

◆ displayCircle() [3/7]

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

staticinherited

Display a circle.

Parameters

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

Definition at line 185 of file vpDisplay_uchar.cpp.

◆ displayCircle() [4/7]

void vpDisplay::displayCircle	(	const vpImage< vpRGBa > &	I,
		const vpImageCircle &	circle,
		const vpColor &	color,
		bool	fill = `false`,
		unsigned int	thickness = `1`
	)

staticinherited

Display a circle.

Parameters

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

Definition at line 148 of file vpDisplay_rgba.cpp.

References vpImageCircle::getCenter(), and vpImageCircle::getRadius().

◆ displayCircle() [5/7]

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

staticinherited

Display a circle.

Parameters

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

Definition at line 166 of file vpDisplay_rgba.cpp.

◆ displayCircle() [6/7]

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

staticinherited

Display a circle.

Parameters

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

Definition at line 184 of file vpDisplay_rgba.cpp.

◆ displayCircle() [7/7]

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

protected

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 2191 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ displayCross() [1/5]

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

staticinherited

Display a cross at the image point ip location.

Parameters

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

Examples: AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, poseVirtualVS.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6FourPoints2DCamVelocityLs_cur_integrator.cpp, servoAfma6FourPoints2DCamVelocityLs_des.cpp, servoAfma6MegaposePBVS.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Segment2DCamVelocity.cpp, servoBebop2.cpp, servoPixhawkDroneIBVS.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityLs_cur.cpp, servoViper850FourPoints2DArtVelocityLs_des.cpp, servoViper850FourPoints2DCamVelocityLs_cur.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, sonarPioneerReader.cpp, testDisplayScaled.cpp, testDisplays.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testNurbs.cpp, testPolygon.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector.cpp, tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-draw-cross.cpp, tutorial-klt-tracker-live-v4l2.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, tutorial-megapose-live-single-object-tracking.cpp, tutorial-pf-curve-fitting-all.cpp, tutorial-pf-curve-fitting-pf.cpp, tutorial-pf.cpp, tutorial-pose-from-planar-object.cpp, tutorial-pose-from-qrcode-image.cpp, and tutorial-ukf.cpp.

Definition at line 199 of file vpDisplay_uchar.cpp.

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

◆ displayCross() [2/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 213 of file vpDisplay_uchar.cpp.

◆ displayCross() [3/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 198 of file vpDisplay_rgba.cpp.

◆ displayCross() [4/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 212 of file vpDisplay_rgba.cpp.

◆ displayCross() [5/5]

void vpDisplayX::displayCross	(	const vpImagePoint &	ip,
		unsigned int	cross_size,
		const vpColor &	color,
		unsigned int	thickness = `1`
	)

protected

Display a cross at the image point ip location.

Parameters

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

Definition at line 2211 of file vpDisplayX.cpp.

References displayLine(), vpImagePoint::get_i(), vpImagePoint::get_j(), vpDisplay::m_displayHasBeenInitialized, vpDisplayException::notInitializedError, vpImagePoint::set_i(), and vpImagePoint::set_j().

◆ displayDotLine() [1/9]

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

staticinherited

Display dashed lines for the list of image points.

Parameters

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

Definition at line 281 of file vpDisplay_uchar.cpp.

References vpImagePoint::distance().

◆ displayDotLine() [2/9]

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

staticinherited

Display dashed lines for the list of image points.

Parameters

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

Definition at line 255 of file vpDisplay_uchar.cpp.

◆ displayDotLine() [3/9]

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

staticinherited

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

Parameters

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

Examples: displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, testDisplayPolygonLines.cpp, testDisplayScaled.cpp, and testDisplays.cpp.

Definition at line 226 of file vpDisplay_uchar.cpp.

Referenced by vpDot2::trackAndDisplay().

◆ displayDotLine() [4/9]

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

staticinherited

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

Parameters

I	: The image associated to the display.
i1,j1	Initial image point.
i2,j2	Final image point.
color	: Line color.
thickness	: Dashed line thickness.

Definition at line 240 of file vpDisplay_uchar.cpp.

◆ displayDotLine() [5/9]

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

staticinherited

Display the dashed lines formed by the list of image points

Parameters

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

Definition at line 279 of file vpDisplay_rgba.cpp.

References vpImagePoint::distance().

◆ displayDotLine() [6/9]

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

staticinherited

Display the dashed lines formed by the list of image points

Parameters

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

Definition at line 254 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [7/9]

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

staticinherited

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

Parameters

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

Definition at line 225 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [8/9]

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

staticinherited

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

Parameters

I	: The image associated to the display.
i1,j1	Initial image point.
i2,j2	Final image point.
color	: Line color.
thickness	: Dashed line thickness.

Definition at line 239 of file vpDisplay_rgba.cpp.

◆ displayDotLine() [9/9]

void vpDisplayX::displayDotLine	(	const vpImagePoint &	ip1,
		const vpImagePoint &	ip2,
		const vpColor &	color,
		unsigned int	thickness = `1`
	)

protected

Display a dashed 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 2242 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ displayEllipse() [1/4]

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

staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters

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

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

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

Definition at line 340 of file vpDisplay_uchar.cpp.

Referenced by vpMbtDistanceCircle::display(), vpMbEdgeKltTracker::display(), vpMbEdgeTracker::display(), vpMbKltTracker::display(), vpMeEllipse::displayEllipse(), vpDisplay::displayEllipse(), and vpFeatureDisplay::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 &	smallalpha,
		const double &	highalpha,
		bool	use_normalized_centered_moments,
		const vpColor &	color,
		unsigned int	thickness = `1`,
		bool	display_center = `false`,
		bool	display_arc = `false`
	)

staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters

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

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

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

Definition at line 387 of file vpDisplay_uchar.cpp.

◆ displayEllipse() [3/4]

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

staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters

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

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

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

Definition at line 338 of file vpDisplay_rgba.cpp.

References vpDisplay::displayEllipse().

◆ displayEllipse() [4/4]

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

staticinherited

Display an ellipse from its parameters expressed in pixels.

Parameters

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

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

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

Definition at line 385 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)`,
		const std::string &	frameName = `""`,
		const vpColor &	textColor = `vpColor::black`,
		const vpImagePoint &	textOffset = `vpImagePoint(15, 15)`
	)

staticinherited

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

Parameters

I	: The image associated to the display.
cMo	: Homogeneous matrix that gives the transformation between the camera frame and the object frame to project in the image.
cam	: Camera intrinsic parameters.
size	: Size of the object frame.
color	: Color used to display the frame in the image.
thickness	: the thickness of the line.
offset	: Offset in pixels applied to the frame origin location in the image.
frameName	: Text to display along side the origin of the frame.
textColor	: Color of the text associated to `frameName`.
textOffset	: Offset used to shift the text from the origin of the frame.

Examples: grabRealSense2_T265.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, perfGenericTracker.cpp, servoAfma6AprilTagPBVS.cpp, servoAfma6MegaposePBVS.cpp, servoFrankaPBVS.cpp, servoSimu4Points.cpp, servoSimuCylinder.cpp, servoSimuSphere.cpp, servoUniversalRobotsPBVS.cpp, testDisplays.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testGenericTrackerDeterminist.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testVirtuoseWithGlove.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-draw-frame.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-webcam.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-megapose-live-single-object-tracking.cpp, tutorial-pose-from-planar-object.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, and tutorial-pose-from-qrcode-image.cpp.

Definition at line 413 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)`,
		const std::string &	frameName = `""`,
		const vpColor &	textColor = `vpColor::black`,
		const vpImagePoint &	textOffset = `vpImagePoint(15, 15)`
	)

staticinherited

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

Parameters

I	: The image associated to the display.
cMo	: Homogeneous matrix that gives the transformation between the camera frame and the object frame to project in the image.
cam	: Camera intrinsic parameters.
size	: Size of the object frame.
color	: Color used to display the frame in the image.
thickness	: the thickness of the line.
offset	: Offset in pixels applied to the frame origin location in the image.
frameName	: Text to display along side the origin of the frame.
textColor	: Color of the text associated to `frameName`.
textOffset	: Offset used to shift the text from the origin of the frame.

Definition at line 411 of file vpDisplay_rgba.cpp.

◆ displayImage() [1/3]

void vpDisplayX::displayImage ( const unsigned char * bitmap )

protected

Display an image with a reference to the bitmap.

Warning: Display has to be initialized.; Suppress the overlay drawing.

Parameters

bitmap : Pointer to the image bitmap.

See also: init(), closeDisplay()

Definition at line 1989 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_height, vpDisplay::m_width, and vpDisplayException::notInitializedError.

◆ displayImage() [2/3]

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

protected

Display the gray level image I (8bits).

Warning: Display has to be initialized.; Suppress the overlay drawing.

Parameters

I	: Image to display.

See also: init(), closeDisplay()

Definition at line 1947 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_height, vpDisplay::m_scale, vpDisplay::m_width, and vpDisplayException::notInitializedError.

◆ displayImage() [3/3]

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

protected

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

Warning: Display has to be initialized.; Suppress the overlay drawing.

Parameters

I	: Image to display.

See also: init(), closeDisplay()

Definition at line 1968 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_height, vpDisplay::m_scale, vpDisplay::m_width, and vpDisplayException::notInitializedError.

◆ displayImageROI() [1/2]

void vpDisplayX::displayImageROI	(	const vpImage< unsigned char > &	I,
		const vpImagePoint &	iP,
		unsigned int	w,
		unsigned int	h
	)

protected

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
w,h	: Width and height of the region of interest

See also: init(), closeDisplay()

Definition at line 2014 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_height, vpDisplay::m_scale, vpDisplay::m_width, and vpDisplayException::notInitializedError.

◆ displayImageROI() [2/2]

void vpDisplayX::displayImageROI	(	const vpImage< vpRGBa > &	I,
		const vpImagePoint &	iP,
		unsigned int	w,
		unsigned int	h
	)

protected

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
w,h	: Width and height of the region of interest

See also: init(), closeDisplay()

Definition at line 2040 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_height, vpDisplay::m_scale, vpDisplay::m_width, and vpDisplayException::notInitializedError.

◆ displayLine() [1/9]

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

staticinherited

Display the lines formed by the list of image points.

Parameters

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

Definition at line 537 of file vpDisplay_uchar.cpp.

References vpImagePoint::distance().

◆ displayLine() [2/9]

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

staticinherited

Display the lines formed by the list of image points.

Parameters

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

Definition at line 512 of file vpDisplay_uchar.cpp.

◆ displayLine() [3/9]

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

staticinherited

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

Parameters

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

Examples: SickLDMRS-Process.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, grabRealSense2_T265.cpp, manDisplay.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, servoAfma6AprilTagIBVS.cpp, servoAfma6AprilTagPBVS.cpp, servoBebop2.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPixhawkDroneIBVS.cpp, servoUniversalRobotsIBVS.cpp, servoUniversalRobotsPBVS.cpp, sonarPioneerReader.cpp, testDisplayPolygonLines.cpp, testDisplayScaled.cpp, testDisplays.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testRealSense2_D435_align.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, tutorial-draw-line.cpp, tutorial-flood-fill.cpp, tutorial-ibvs-4pts-display.cpp, tutorial-ibvs-4pts-image-tracking.cpp, tutorial-ibvs-4pts-ogre-tracking.cpp, tutorial-ibvs-4pts-wireframe-camera.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, tutorial-ibvs-4pts-wireframe-robot-viper.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint.cpp, and tutorial-munkres-assignment.cpp.

Definition at line 429 of file vpDisplay_uchar.cpp.

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

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

◆ displayLine() [4/9]

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

staticinherited

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

Parameters

I	: The image associated to the display.
i1,j1	Initial image point.
i2,j2	Final image point.
color	: Line color.
thickness	: Line thickness.
segment	If true (default) display the segment between the two image points. If false, display the line passing through the two image points.

Definition at line 446 of file vpDisplay_uchar.cpp.

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

◆ displayLine() [5/9]

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

staticinherited

Display the lines formed by the list of image points.

Parameters

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

Definition at line 537 of file vpDisplay_rgba.cpp.

References vpImagePoint::distance().

◆ displayLine() [6/9]

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

staticinherited

Display the lines formed by the list of image points.

Parameters

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

Definition at line 511 of file vpDisplay_rgba.cpp.

◆ displayLine() [7/9]

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

staticinherited

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

Parameters

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

Definition at line 427 of file vpDisplay_rgba.cpp.

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

◆ displayLine() [8/9]

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

staticinherited

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

Parameters

I	: The image associated to the display.
i1,j1	Initial image point.
i2,j2	Final image point.
color	: Line color.
thickness	: Line thickness.
segment	If true (default) display the segment between the two image points. If false, display the line passing through the two image points.

Definition at line 444 of file vpDisplay_rgba.cpp.

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

◆ displayLine() [9/9]

void vpDisplayX::displayLine	(	const vpImagePoint &	ip1,
		const vpImagePoint &	ip2,
		const vpColor &	color,
		unsigned int	thickness = `1`
	)

protected

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 2262 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

Referenced by displayArrow(), and displayCross().

◆ displayPoint() [1/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, testDisplayScaled.cpp, testDisplays.cpp, testParticleFilter.cpp, testPolygon.cpp, trackDot.cpp, trackDot2.cpp, tutorial-draw-point.cpp, tutorial-pf-curve-fitting-all.cpp, and tutorial-pf-curve-fitting-pf.cpp.

Definition at line 567 of file vpDisplay_uchar.cpp.

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

◆ displayPoint() [2/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 580 of file vpDisplay_uchar.cpp.

◆ displayPoint() [3/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 567 of file vpDisplay_rgba.cpp.

◆ displayPoint() [4/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 580 of file vpDisplay_rgba.cpp.

◆ displayPoint() [5/5]

void vpDisplayX::displayPoint	(	const vpImagePoint &	ip,
		const vpColor &	color,
		unsigned int	thickness = `1`
	)

protected

Display a point at the image point ip location.

Parameters

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

Definition at line 2281 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ displayPolygon() [1/4]

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

staticinherited

Display a polygon defined by a vector of image points.

Parameters

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

Examples: mbot-apriltag-ibvs.cpp, servoBebop2.cpp, servoPixhawkDroneIBVS.cpp, testDisplays.cpp, and tutorial-pose-from-planar-object.cpp.

Definition at line 594 of file vpDisplay_uchar.cpp.

◆ displayPolygon() [2/4]

void vpDisplay::displayPolygon	(	const vpImage< unsigned char > &	I,
		const vpPolygon &	polygon,
		const vpColor &	color,
		unsigned int	thickness = `1`,
		bool	closed = `true`
	)

staticinherited

Display a polygon defined by a set of image points.

Parameters

I	: The image associated to the display.
polygon	: Polygon to display.
color	: Line color.
thickness	: Line thickness.
closed	: When true display a closed polygon with a segment between first and last image point.

Definition at line 608 of file vpDisplay_uchar.cpp.

◆ displayPolygon() [3/4]

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

staticinherited

Display a polygon defined by a vector of image points.

Parameters

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

Definition at line 593 of file vpDisplay_rgba.cpp.

◆ displayPolygon() [4/4]

void vpDisplay::displayPolygon	(	const vpImage< vpRGBa > &	I,
		const vpPolygon &	polygon,
		const vpColor &	color,
		unsigned int	thickness = `1`,
		bool	closed = `true`
	)

staticinherited

Display a polygon defined by a set of image points.

Parameters

I	: The image associated to the display.
polygon	: Polygon to display.
color	: Line color.
thickness	: Line thickness.
closed	: When true display a closed polygon with a segment between first and last image point.

Definition at line 607 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [1/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 690 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [2/15]

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

staticinherited

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

Parameters

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

Definition at line 712 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [3/15]

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

staticinherited

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

Parameters

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

Definition at line 630 of file vpDisplay_uchar.cpp.

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

◆ displayRectangle() [4/15]

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

staticinherited

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

Parameters

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

Definition at line 671 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [5/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 650 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [6/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 732 of file vpDisplay_uchar.cpp.

◆ displayRectangle() [7/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 689 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [8/15]

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

staticinherited

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

Parameters

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

Definition at line 711 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [9/15]

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

staticinherited

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

Parameters

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

Definition at line 629 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [10/15]

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

staticinherited

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

Parameters

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

Definition at line 670 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [11/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 649 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [12/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 730 of file vpDisplay_rgba.cpp.

◆ displayRectangle() [13/15]

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

protected

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. This parameter is only useful when fill is set to false.

Definition at line 2330 of file vpDisplayX.cpp.

References vpImagePoint::get_u(), vpImagePoint::get_v(), vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, vpDisplayException::notInitializedError, and vpMath::round().

◆ displayRectangle() [14/15]

void vpDisplayX::displayRectangle	(	const vpImagePoint &	topLeft,
		unsigned int	w,
		unsigned int	h,
		const vpColor &	color,
		bool	fill = `false`,
		unsigned int	thickness = `1`
	)

protected

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.
w,h	: Rectangle size in terms of width and height.
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 2304 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ displayRectangle() [15/15]

void vpDisplayX::displayRectangle	(	const vpRect &	rectangle,
		const vpColor &	color,
		bool	fill = `false`,
		unsigned int	thickness = `1`
	)

protected

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. This parameter is only useful when fill is set to false.

Definition at line 2359 of file vpDisplayX.cpp.

References vpRect::getHeight(), vpRect::getTopLeft(), vpRect::getWidth(), vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, vpDisplayException::notInitializedError, and vpMath::round().

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

Definition at line 836 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 834 of file vpDisplay_rgba.cpp.

◆ displayText() [1/5]

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, grabFlyCapture.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2MultiCpp11Thread.cpp, keyboardControlBebop2.cpp, manDisplay.cpp, manGeometricFeatures.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, perfGenericTracker.cpp, readRealSenseData.cpp, saveRealSenseData.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6AprilTagIBVS.cpp, servoAfma6AprilTagPBVS.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6FourPoints2DCamVelocityLs_cur_integrator.cpp, servoAfma6FourPoints2DCamVelocityLs_des.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6MegaposePBVS.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPixhawkDroneIBVS.cpp, servoPololuPtuPoint2DJointVelocity.cpp, servoSimu4Points.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoUniversalRobotsIBVS.cpp, servoUniversalRobotsPBVS.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testDisplayPolygonLines.cpp, testDisplayScaled.cpp, testDisplays.cpp, testForceTorqueAti.cpp, testForceTorqueAtiNetFTSensor.cpp, testForceTorqueIitSensor.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageTemplateMatching.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testParticleFilter.cpp, testPolygon.cpp, testRealSense2_D435.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testVirtuoseWithGlove.cpp, trackMeEllipse.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.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-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-draw-text.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-bebop2.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense-T265.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-structure-core.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-grabber-v4l2.cpp, tutorial-hsv-range-tuner.cpp, tutorial-hsv-segmentation-pcl-viewer.cpp, tutorial-hsv-segmentation-pcl.cpp, tutorial-hsv-segmentation.cpp, tutorial-ibvs-4pts-image-tracking.cpp, tutorial-ibvs-4pts-ogre-tracking.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, tutorial-ibvs-4pts-wireframe-robot-viper.cpp, tutorial-image-filter.cpp, tutorial-klt-tracker-live-v4l2.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-webcam.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-megapose-live-single-object-tracking.cpp, tutorial-munkres-assignment.cpp, tutorial-npz.cpp, tutorial-panda3d-renderer.cpp, tutorial-pf-curve-fitting-all.cpp, tutorial-pf-curve-fitting-lms.cpp, tutorial-pf-curve-fitting-pf.cpp, tutorial-pf.cpp, tutorial-pose-from-planar-object.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, tutorial-pose-from-qrcode-image.cpp, tutorial-simu-pioneer-continuous-gain-adaptive.cpp, tutorial-simu-pioneer-continuous-gain-constant.cpp, tutorial-simu-pioneer-pan.cpp, tutorial-simu-pioneer.cpp, tutorial-template-tracker.cpp, tutorial-ukf.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, tutorial-video-recorder.cpp, and videoReader.cpp.

Definition at line 750 of file vpDisplay_uchar.cpp.

Referenced by vpDetectorDNNOpenCV::DetectedFeatures2D::display(), vpKltOpencv::display(), vpMbEdgeKltTracker::display(), vpMbKltTracker::display(), vpMbtDistanceKltCylinder::displayPrimitive(), vpMbtDistanceKltPoints::displayPrimitive(), vpMbTracker::initClick(), and vpMbGenericTracker::initFromPose().

◆ displayText() [2/5]

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

◆ displayText() [3/5]

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

◆ displayText() [4/5]

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

◆ displayText() [5/5]

void vpDisplayX::displayText	(	const vpImagePoint &	ip,
		const std::string &	text,
		const vpColor &	color = `vpColor::green`
	)

protected

Display a string at the image point ip location.

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

Parameters

ip	: Upper left image point location of the string in the display.
text	: String to display in overlay.
color	: String color.

See also: setFont()

Definition at line 2172 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ 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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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); // Mandatory to display the requested features.
}

See also: flushROI()

Examples: AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, SickLDMRS-Process.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, grab1394CMU.cpp, grab1394Two.cpp, grabDirectShow.cpp, grabDirectShowMulti.cpp, grabDisk.cpp, grabFlyCapture.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2.cpp, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, keyboardControlBebop2.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, perfGenericTracker.cpp, photometricMappingVisualServoing.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, poseVirtualVS.cpp, readRealSenseData.cpp, saveRealSenseData.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6AprilTagIBVS.cpp, servoAfma6AprilTagPBVS.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6FourPoints2DCamVelocityLs_cur_integrator.cpp, servoAfma6FourPoints2DCamVelocityLs_des.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6MegaposePBVS.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPixhawkDroneIBVS.cpp, servoPololuPtuPoint2DJointVelocity.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoUniversalRobotsIBVS.cpp, servoUniversalRobotsPBVS.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityLs_cur.cpp, servoViper850FourPoints2DArtVelocityLs_des.cpp, servoViper850FourPoints2DCamVelocityLs_cur.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testClick.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplayScaled.cpp, testDisplays.cpp, testFeatureSegment.cpp, testForceTorqueAti.cpp, testForceTorqueAtiNetFTSensor.cpp, testForceTorqueIitSensor.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testGenericTrackerDeterminist.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testParticleFilter.cpp, testPolygon.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testRobotAfma6Pose.cpp, testRobotBebop2.cpp, testRobotViper850Pose.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, testVirtuoseWithGlove.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.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-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-draw-circle.cpp, tutorial-draw-cross.cpp, tutorial-draw-frame.cpp, tutorial-draw-line.cpp, tutorial-draw-point.cpp, tutorial-draw-rectangle.cpp, tutorial-draw-text.cpp, tutorial-event-keyboard.cpp, tutorial-export-image.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-bebop2.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-multiple-realsense.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense-T265.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-rgbd-D435-structurecore.cpp, tutorial-grabber-structure-core.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-grabber-v4l2.cpp, tutorial-hsv-range-tuner.cpp, tutorial-hsv-segmentation-pcl-viewer.cpp, tutorial-hsv-segmentation-pcl.cpp, tutorial-hsv-segmentation.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-colormap.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-SIFT.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-webcam.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-megapose-live-single-object-tracking.cpp, tutorial-munkres-assignment.cpp, tutorial-npz.cpp, tutorial-panda3d-renderer.cpp, tutorial-pf-curve-fitting-all.cpp, tutorial-pf-curve-fitting-lms.cpp, tutorial-pf-curve-fitting-pf.cpp, tutorial-pf.cpp, tutorial-pose-from-planar-object.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, tutorial-pose-from-qrcode-image.cpp, tutorial-simu-pioneer-continuous-gain-adaptive.cpp, tutorial-simu-pioneer-continuous-gain-constant.cpp, tutorial-simu-pioneer-pan.cpp, tutorial-simu-pioneer.cpp, tutorial-template-tracker.cpp, tutorial-ukf.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, tutorial-video-recorder.cpp, tutorial-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 806 of file vpDisplay_uchar.cpp.

Referenced by vpMbtDistanceCylinder::computeInteractionMatrixError(), vpDot2::defineDots(), vpMbtDistanceCircle::displayMovingEdges(), vpTemplateTrackerZone::initClick(), vpPolygon::initClick(), vpMbTracker::initClick(), vpMbGenericTracker::initFromPose(), vpMeLine::initTracking(), vpMeNurbs::initTracking(), vpMeEllipse::initTracking(), vpDisplayFactory::impl::makeDisplayGridHelper(), vpDot2::searchDotsInArea(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpSimulatorAfma6::setPosition(), 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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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); // Mandatory to display the requested features.
}

See also: flushROI()

Definition at line 804 of file vpDisplay_rgba.cpp.

◆ flushDisplay()

void vpDisplayX::flushDisplay ( )

protected

Flushes the X buffer. It's necessary to use this function to see the results of any drawing.

Definition at line 2071 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, and vpDisplayException::notInitializedError.

◆ flushDisplayROI()

void vpDisplayX::flushDisplayROI	(	const vpImagePoint &	iP,
		unsigned int	w,
		unsigned int	h
	)

protected

Flushes a part of the X buffer. It's necessary to use this function to see the results of any drawing.

Parameters

iP	: Top left corner of the region of interest
w,h	: Width and height of the region of interest

Definition at line 2088 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ 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 817 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 parsimoniously.

See also: flush()

Definition at line 815 of file vpDisplay_rgba.cpp.

◆ getClick() [1/11]

bool vpDisplayX::getClick ( bool blocking = true )

protected

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 2389 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ getClick() [2/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, grab1394CMU.cpp, grabFlyCapture.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2MultiCpp11Thread.cpp, imageSequenceReader.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, photometricMappingVisualServoing.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, plot2d.cpp, readRealSenseData.cpp, saveRealSenseData.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6AprilTagIBVS.cpp, servoAfma6AprilTagPBVS.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6FourPoints2DCamVelocityLs_cur_integrator.cpp, servoAfma6FourPoints2DCamVelocityLs_des.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6MegaposePBVS.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPixhawkDroneIBVS.cpp, servoPololuPtuPoint2DJointVelocity.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoUniversalRobotsIBVS.cpp, servoUniversalRobotsPBVS.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testClick.cpp, testComedi.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplayScaled.cpp, testDisplays.cpp, testForceTorqueAti.cpp, testForceTorqueAtiNetFTSensor.cpp, testForceTorqueIitSensor.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint.cpp, testMouseEvent.cpp, testNurbs.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_imu.cpp, testOccipitalStructure_Core_pcl.cpp, testParticleFilter.cpp, testPolygon.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, testVirtuoseWithGlove.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.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-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-draw-circle.cpp, tutorial-draw-cross.cpp, tutorial-draw-frame.cpp, tutorial-draw-line.cpp, tutorial-draw-point.cpp, tutorial-draw-rectangle.cpp, tutorial-draw-text.cpp, tutorial-export-image.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-flood-fill.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-multiple-realsense.cpp, tutorial-grabber-opencv-threaded.cpp, tutorial-grabber-rgbd-D435-structurecore.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-hsv-range-tuner.cpp, tutorial-hsv-segmentation-pcl-viewer.cpp, tutorial-hsv-segmentation-pcl.cpp, tutorial-hsv-segmentation.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-colormap.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-SIFT.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-webcam.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-megapose-live-single-object-tracking.cpp, tutorial-munkres-assignment.cpp, tutorial-npz.cpp, tutorial-panda3d-renderer.cpp, tutorial-pf-curve-fitting-all.cpp, tutorial-pf-curve-fitting-lms.cpp, tutorial-pf-curve-fitting-pf.cpp, tutorial-pose-from-planar-object.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, tutorial-pose-from-qrcode-image.cpp, tutorial-simu-pioneer-continuous-gain-adaptive.cpp, tutorial-simu-pioneer-continuous-gain-constant.cpp, tutorial-simu-pioneer-pan.cpp, tutorial-simu-pioneer.cpp, tutorial-template-tracker.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, tutorial-video-recorder.cpp, tutorial-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 855 of file vpDisplay_uchar.cpp.

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

◆ getClick() [3/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 875 of file vpDisplay_uchar.cpp.

◆ getClick() [4/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 900 of file vpDisplay_uchar.cpp.

◆ getClick() [5/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 922 of file vpDisplay_uchar.cpp.

References vpDisplay::getClick().

◆ getClick() [6/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 853 of file vpDisplay_rgba.cpp.

◆ getClick() [7/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 873 of file vpDisplay_rgba.cpp.

◆ getClick() [8/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 898 of file vpDisplay_rgba.cpp.

◆ getClick() [9/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 920 of file vpDisplay_rgba.cpp.

References vpDisplay::getClick().

◆ getClick() [10/11]

bool vpDisplayX::getClick	(	vpImagePoint &	ip,
		bool	blocking = `true`
	)

protected

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 2419 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ getClick() [11/11]

bool vpDisplayX::getClick	(	vpImagePoint &	ip,
		vpMouseButton::vpMouseButtonType &	button,
		bool	blocking = `true`
	)

protected

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 2452 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ getClickUp() [1/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 948 of file vpDisplay_uchar.cpp.

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

◆ getClickUp() [2/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 970 of file vpDisplay_uchar.cpp.

References vpDisplay::getClickUp().

◆ getClickUp() [3/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 946 of file vpDisplay_rgba.cpp.

◆ getClickUp() [4/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 968 of file vpDisplay_rgba.cpp.

References vpDisplay::getClickUp().

◆ getClickUp() [5/5]

bool vpDisplayX::getClickUp	(	vpImagePoint &	ip,
		vpMouseButton::vpMouseButtonType &	button,
		bool	blocking = `true`
	)

protected

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 2488 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ getDownScalingFactor() [1/3]

unsigned int vpDisplay::getDownScalingFactor ( )

inlineinherited

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

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

Definition at line 221 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. When display is not initialized, returns 1.

Parameters

I	: Image associated to the display window.

Definition at line 1352 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. When display is not initialized, returns 1.

Parameters

I	: Image associated to the display window.

Definition at line 1343 of file vpDisplay_rgba.cpp.

◆ getHeight()

unsigned int vpDisplay::getHeight ( ) const

inlineinherited

Return the display height.

See also: getWidth()

Examples: trackDot.cpp, trackDot2.cpp, and trackDot2WithAutoDetection.cpp.

Definition at line 226 of file vpDisplay.h.

◆ getImage() [1/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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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(HAVE_OPENCV_HIGHGUI)
  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, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, servoAfma6MegaposePBVS.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, sonarPioneerReader.cpp, testDisplayScaled.cpp, trackMeEllipse.cpp, tutorial-export-image.cpp, tutorial-flood-fill.cpp, tutorial-image-viewer.cpp, and tutorial-mb-generic-tracker-full.cpp.

Definition at line 140 of file vpDisplay.cpp.

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

Referenced by vpDisplay::getImage().

◆ getImage() [2/3]

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

staticinherited

Get the window pixmap and put it in vpRGBa image.

The code below shows how to use this method.

#include <visp3/gui/vpDisplayD3D.h>
#include <visp3/gui/vpDisplayGDI.h>
#include <visp3/gui/vpDisplayGTK.h>
#include <visp3/gui/vpDisplayOpenCV.h>
#include <visp3/gui/vpDisplayX.h>
#include <visp3/io/vpImageIo.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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(HAVE_OPENCV_HIGHGUI)
  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().

◆ getImage() [3/3]

void vpDisplayX::getImage ( vpImage< vpRGBa > & I )

virtual

Get the window pixmap and put it in vpRGBa image.

Implements vpDisplay.

Definition at line 2508 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_height, vpDisplay::m_width, and vpDisplayException::notInitializedError.

◆ getKeyboardEvent() [1/8]

bool vpDisplayX::getKeyboardEvent ( bool blocking = true )

protected

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.

Exceptions

vpDisplayException::notInitializedError : If the display was not initialized.

Definition at line 2569 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, and vpDisplayException::notInitializedError.

◆ getKeyboardEvent() [2/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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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(HAVE_OPENCV_HIGHGUI)
  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
}

Examples: tutorial-event-keyboard.cpp, tutorial-megapose-live-single-object-tracking.cpp, and tutorial-panda3d-renderer.cpp.

Definition at line 1063 of file vpDisplay_uchar.cpp.

◆ getKeyboardEvent() [3/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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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(HAVE_OPENCV_HIGHGUI)
  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 1253 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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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(HAVE_OPENCV_HIGHGUI)
  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 1158 of file vpDisplay_uchar.cpp.

◆ getKeyboardEvent() [5/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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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(HAVE_OPENCV_HIGHGUI)
  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 1060 of file vpDisplay_rgba.cpp.

◆ getKeyboardEvent() [6/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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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(HAVE_OPENCV_HIGHGUI)
  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 1250 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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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(HAVE_OPENCV_HIGHGUI)
  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 1155 of file vpDisplay_rgba.cpp.

◆ getKeyboardEvent() [8/8]

bool vpDisplayX::getKeyboardEvent	(	std::string &	key,
		bool	blocking = `true`
	)

protected

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.

Exceptions

vpDisplayException::notInitializedError : If the display was not initialized.

Definition at line 2605 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, and vpDisplayException::notInitializedError.

◆ getPointerMotionEvent() [1/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 1267 of file vpDisplay_uchar.cpp.

◆ getPointerMotionEvent() [2/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 1264 of file vpDisplay_rgba.cpp.

◆ getPointerMotionEvent() [3/3]

bool vpDisplayX::getPointerMotionEvent ( vpImagePoint & ip )

protected

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 2628 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ getPointerPosition() [1/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 1281 of file vpDisplay_uchar.cpp.

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

◆ getPointerPosition() [2/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 1278 of file vpDisplay_rgba.cpp.

◆ getPointerPosition() [3/3]

bool vpDisplayX::getPointerPosition ( vpImagePoint & ip )

protected

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 2651 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scale, and vpDisplayException::notInitializedError.

◆ getScreenDepth()

unsigned int vpDisplayX::getScreenDepth ( )

Gets the window depth (8, 16, 24, 32).

Definition at line 2521 of file vpDisplayX.cpp.

◆ getScreenHeight()

unsigned int vpDisplayX::getScreenHeight ( )

Gets the screen vertical resolution in pixels.

Examples: testDisplayScaled.cpp.

Definition at line 2542 of file vpDisplayX.cpp.

References getScreenSize().

◆ getScreenSize()

void vpDisplayX::getScreenSize	(	unsigned int &	w,
		unsigned int &	h
	)

Gets screen resolution in pixels.

Parameters

w,h	: Horizontal and vertical screen resolution.

Definition at line 2527 of file vpDisplayX.cpp.

Referenced by getScreenHeight(), vpDisplayOpenCV::getScreenSize(), and getScreenWidth().

◆ getScreenWidth()

unsigned int vpDisplayX::getScreenWidth ( )

Gets the screen horizontal resolution in pixels.

Examples: testDisplayScaled.cpp.

Definition at line 2532 of file vpDisplayX.cpp.

References getScreenSize().

◆ getWidth()

unsigned int vpDisplay::getWidth ( ) const

inlineinherited

Return the display width.

See also: getHeight()

Examples: testVideoDeviceDual.cpp, trackDot.cpp, trackDot2.cpp, and trackDot2WithAutoDetection.cpp.

Definition at line 231 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 237 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 242 of file vpDisplay.h.

Referenced by vpMbTracker::initClick().

◆ init() [1/3]

void vpDisplayX::init	(	unsigned int	win_width,
		unsigned int	win_height,
		int	win_x = `-1`,
		int	win_y = `-1`,
		const std::string &	win_title = `""`
	)

Initialize the display size, position and title.

Parameters

win_width,win_height	: Width and height of the window.
win_x,win_y	: The window is set at position (win_x,win_y) with column index and row index respectively.
win_title	: Window title.

Definition at line 1855 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_height, vpDisplay::m_scale, vpDisplay::m_scaleType, vpDisplay::m_title, vpDisplay::m_width, vpDisplay::m_windowXPosition, vpDisplay::m_windowYPosition, and vpDisplay::setScale().

◆ init() [2/3]

void vpDisplayX::init	(	vpImage< unsigned char > &	I,
		int	win_x = `-1`,
		int	win_y = `-1`,
		const std::string &	win_title = `""`
	)

Initialize the display (size, position and title) of a gray level image.

Parameters

I	: Image to be displayed (not that image has to be initialized)
win_x,win_y	: The window is set at position (win_x,win_y) with column index and row index respectively.
win_title	: Window title.

Examples: displayX.cpp, displayXMulti.cpp, grab1394Two.cpp, grabDirectShowMulti.cpp, grabRealSense2_T265.cpp, kinectAcquisition.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, photometricMappingVisualServoing.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, readRealSenseData.cpp, saveRealSenseData.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, sonarPioneerReader.cpp, testDisplayPolygonLines.cpp, testDisplayRoi.cpp, testDisplayScaled.cpp, testDisplays.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testPolygon.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, tutorial-autothreshold.cpp, tutorial-connected-components.cpp, tutorial-contour.cpp, tutorial-contrast-sharpening.cpp, tutorial-count-coins.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-event-keyboard.cpp, tutorial-export-image.cpp, tutorial-flood-fill.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-multiple-realsense.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-megapose-live-single-object-tracking.cpp, and tutorial-video-recorder.cpp.

Definition at line 1798 of file vpDisplayX.cpp.

References vpImage< Type >::display, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scaleType, vpDisplay::m_title, vpDisplay::m_windowXPosition, vpDisplay::m_windowYPosition, vpDisplayException::notInitializedError, and vpDisplay::setScale().

Referenced by vpProjectionDisplay::init(), init(), vpDisplayX(), and vpRobotWireFrameSimulator::vpRobotWireFrameSimulator().

◆ init() [3/3]

void vpDisplayX::init	(	vpImage< vpRGBa > &	I,
		int	win_x = `-1`,
		int	win_y = `-1`,
		const std::string &	win_title = `""`
	)

Initialize the display (size, position and title) of a color image in RGBa format.

Parameters

I	: Image to be displayed (note that image has to be initialized)
win_x,win_y	: The window is set at position (win_x,win_y) with column index and row index respectively.
win_title	: Window title.

Definition at line 1827 of file vpDisplayX.cpp.

References vpImage< Type >::display, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), init(), vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_scaleType, vpDisplay::m_title, vpDisplay::m_windowXPosition, vpDisplay::m_windowYPosition, vpDisplayException::notInitializedError, and vpDisplay::setScale().

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

◆ 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 1295 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 1292 of file vpDisplay_rgba.cpp.

◆ setDownScalingFactor() [1/2]

void vpDisplay::setDownScalingFactor ( unsigned int scale )

virtualinherited

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

Examples: grabRealSense2_T265.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, testDisplayScaled.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_pcl.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_undistort.cpp, tutorial-autothreshold.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-grabber-ids-ueye.cpp, and tutorial-mb-generic-tracker-stereo.cpp.

Definition at line 233 of file vpDisplay.cpp.

References vpDisplay::m_displayHasBeenInitialized, and vpDisplay::m_scale.

Referenced by vpDisplay::setScale().

◆ setDownScalingFactor() [2/2]

void vpDisplay::setDownScalingFactor ( vpScaleType scaleType )

virtualinherited

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>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
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 in vpDisplayWin32.

Definition at line 335 of file vpDisplay.cpp.

References vpDisplay::m_displayHasBeenInitialized, and vpDisplay::m_scaleType.

◆ setFont() [1/3]

void vpDisplayX::setFont ( const std::string & fontname )

protected

Set the font used to display a text in overlay. The display is performed using displayText().

Parameters

fontname : The expected font name. The available fonts are given by the "xlsfonts" binary. To choose a font you can also use the "xfontsel" binary.

Note: Under UNIX, to know all the available fonts, use the "xlsfonts" binary in a terminal. You can also use the "xfontsel" binary.

See also: displayText()

Definition at line 1889 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, and vpDisplayException::notInitializedError.

◆ 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 displayText().

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 1313 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 displayText().

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 1307 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 262 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 vpDisplayGTK::init(), init(), vpDisplayOpenCV::init(), vpDisplayWin32::init(), vpDisplayWin32::setDownScalingFactor(), vpDisplayGDI::vpDisplayGDI(), vpDisplayGTK::vpDisplayGTK(), vpDisplayOpenCV::vpDisplayOpenCV(), and vpDisplayX().

◆ setTitle() [1/3]

void vpDisplayX::setTitle ( const std::string & title )

protected

Set the window title.

Parameters

title : Window title.

Definition at line 1905 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, vpDisplay::m_title, and vpDisplayException::notInitializedError.

◆ 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-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-draw-circle.cpp, tutorial-draw-cross.cpp, tutorial-draw-frame.cpp, tutorial-draw-line.cpp, tutorial-draw-point.cpp, tutorial-draw-rectangle.cpp, tutorial-draw-text.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-mb-generic-tracker-rgbd-blender.cpp, tutorial-megapose-live-single-object-tracking.cpp, tutorial-munkres-assignment.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, and tutorial-viewer.cpp.

Definition at line 1325 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 1316 of file vpDisplay_rgba.cpp.

◆ setWindowPosition() [1/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 1340 of file vpDisplay_uchar.cpp.

◆ setWindowPosition() [2/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 1331 of file vpDisplay_rgba.cpp.

◆ setWindowPosition() [3/3]

void vpDisplayX::setWindowPosition	(	int	win_x,
		int	win_y
	)

protected

Set the window position in the screen.

Parameters

win_x,win_y : Position of the upper-left window's border in the screen.

Exceptions

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

Definition at line 1926 of file vpDisplayX.cpp.

References vpDisplay::m_displayHasBeenInitialized, and vpDisplayException::notInitializedError.

Member Data Documentation

◆ m_displayHasBeenInitialized

bool vpDisplay::m_displayHasBeenInitialized

protectedinherited

display has been initialized

Definition at line 924 of file vpDisplay.h.

◆ m_height

unsigned int vpDisplay::m_height

protectedinherited

Definition at line 930 of file vpDisplay.h.

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

◆ m_scale

unsigned int vpDisplay::m_scale

protectedinherited

Definition at line 932 of file vpDisplay.h.

◆ m_scaleType

vpScaleType vpDisplay::m_scaleType

protectedinherited

Definition at line 933 of file vpDisplay.h.

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

◆ m_title

std::string vpDisplay::m_title

protectedinherited

Definition at line 931 of file vpDisplay.h.

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

◆ m_width

unsigned int vpDisplay::m_width

protectedinherited

Definition at line 929 of file vpDisplay.h.

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

◆ m_windowXPosition

int vpDisplay::m_windowXPosition

protectedinherited

display position

Definition at line 926 of file vpDisplay.h.

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

◆ m_windowYPosition

int vpDisplay::m_windowYPosition

protectedinherited

display position

Definition at line 928 of file vpDisplay.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Deprecated functions

Detailed Description

Member Enumeration Documentation

◆ vpScaleType

Constructor & Destructor Documentation

◆ vpDisplayX() [1/6]

◆ vpDisplayX() [2/6]

◆ vpDisplayX() [3/6]

◆ vpDisplayX() [4/6]

◆ vpDisplayX() [5/6]

◆ vpDisplayX() [6/6]

◆ ~vpDisplayX()

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

◆ displayCharString() [2/4]

◆ displayCharString() [3/4]

◆ displayCharString() [4/4]

◆ displayCircle() [1/7]

◆ displayCircle() [2/7]

◆ displayCircle() [3/7]

◆ displayCircle() [4/7]

◆ displayCircle() [5/7]

◆ displayCircle() [6/7]

◆ displayCircle() [7/7]

◆ displayCross() [1/5]

◆ displayCross() [2/5]

◆ displayCross() [3/5]

◆ displayCross() [4/5]

◆ displayCross() [5/5]

◆ displayDotLine() [1/9]

◆ displayDotLine() [2/9]

◆ displayDotLine() [3/9]

◆ displayDotLine() [4/9]

◆ displayDotLine() [5/9]

◆ displayDotLine() [6/9]

◆ displayDotLine() [7/9]

◆ displayDotLine() [8/9]

◆ displayDotLine() [9/9]

◆ displayEllipse() [1/4]

◆ displayEllipse() [2/4]

◆ displayEllipse() [3/4]

◆ displayEllipse() [4/4]

◆ displayFrame() [1/2]

◆ displayFrame() [2/2]

◆ displayImage() [1/3]

◆ displayImage() [2/3]

◆ displayImage() [3/3]

◆ displayImageROI() [1/2]

◆ displayImageROI() [2/2]

◆ displayLine() [1/9]

◆ displayLine() [2/9]

◆ displayLine() [3/9]

◆ displayLine() [4/9]

◆ displayLine() [5/9]

◆ displayLine() [6/9]

◆ displayLine() [7/9]

◆ displayLine() [8/9]

◆ displayLine() [9/9]

◆ displayPoint() [1/5]

◆ displayPoint() [2/5]

◆ displayPoint() [3/5]

◆ displayPoint() [4/5]