#include <vpDisplayD3D.h>

Inheritance diagram for vpDisplayD3D:

Public Member Functions
	vpDisplayD3D ()

	vpDisplayD3D (int winx, int winy, const char *title=NULL)

	vpDisplayD3D (vpImage< vpRGBa > &I, int winx=-1, int winy=-1, const char *title=NULL)

	vpDisplayD3D (vpImage< unsigned char > &I, int winx=-1, int winy=-1, const char *title=NULL)

virtual	~vpDisplayD3D ()

void	setTitle (const char *windowtitle)

void	setFont (const char *fontname)

void	setWindowPosition (int winx, int winy)

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

void	closeDisplay ()

void	displayImage (const vpImage< vpRGBa > &I)

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

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

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

void	flushDisplay ()

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

void	init (vpImage< unsigned char > &I, int winx=-1, int winy=-1, const char *title=NULL)

void	init (vpImage< vpRGBa > &I, int winx=-1, int winy=-1, const char *title=NULL)

void	init (unsigned int width, unsigned int height, int winx=-1, int winy=-1, const char *title=NULL)

void	getImage (vpImage< vpRGBa > &I)

unsigned int	getHeight () const

unsigned int	getWidth () const

bool	isInitialised ()

Static Public Member Functions
Display functionalities on gray level images.
static void	setTitle (const vpImage< unsigned char > &I, const char *windowtitle)

static void	setFont (const vpImage< unsigned char > &I, const char *font)

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

static void	getImage (const vpImage< unsigned char > &Is, vpImage< vpRGBa > &Id)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static bool	getKeyboardEvent (const vpImage< unsigned char > &I, char *string, 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	close (vpImage< unsigned char > &I)

static void	display (const vpImage< unsigned char > &I)

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

static void	displayFrame (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color, unsigned int thickness=1)

static void	displayROI (const vpImage< unsigned char > &I, const vpRect &roi)

static void	flush (const vpImage< unsigned char > &I)

static void	flushROI (const vpImage< unsigned char > &I, const vpRect &roi)

static void	setBackground (const vpImage< unsigned char > &I, const vpColor &color)

Display functionalities on color images.
static void	setTitle (const vpImage< vpRGBa > &I, const char *windowtitle)

static void	setFont (const vpImage< vpRGBa > &I, const char *font)

static void	setWindowPosition (const vpImage< vpRGBa > &I, int winx, int winy)

static void	getImage (const vpImage< vpRGBa > &Is, vpImage< vpRGBa > &Id)

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

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

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

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

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

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

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

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

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

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

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

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

static void	displayPoint (const vpImage< vpRGBa > &I, const vpImagePoint &ip, const vpColor &color)

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

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

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

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

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

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

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

static bool	getClick (const vpImage< vpRGBa > &I, bool blocking=true)

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

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

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

static bool	getKeyboardEvent (const vpImage< vpRGBa > &I, bool blocking=true)

static bool	getKeyboardEvent (const vpImage< vpRGBa > &I, char *string, bool blocking=true)

static bool	getPointerMotionEvent (const vpImage< vpRGBa > &I, vpImagePoint &ip)

static bool	getPointerPosition (const vpImage< vpRGBa > &I, vpImagePoint &ip)

static void	close (vpImage< vpRGBa > &I)

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

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

static void	displayFrame (const vpImage< vpRGBa > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, double size, const vpColor &color, unsigned int thickness=1)

static void	displayROI (const vpImage< vpRGBa > &I, const vpRect &roi)

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

static void	flushROI (const vpImage< vpRGBa > &I, const vpRect &roi)

static void	setBackground (const vpImage< vpRGBa > &I, const vpColor &color)

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

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

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

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

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

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

void	displayPoint (const vpImagePoint &ip, const vpColor &color)

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

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

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

bool	getClick (bool blocking=true)

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

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

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

bool	getKeyboardEvent (bool blocking=true)

bool	getKeyboardEvent (char *string, bool blocking)

bool	getPointerMotionEvent (vpImagePoint &ip)

bool	getPointerPosition (vpImagePoint &ip)

void	waitForInit ()

Protected Attributes
HANDLE	hThread

DWORD	threadId

bool	iStatus

vpWin32Window	window

RECT	roi

bool	displayHasBeenInitialized

int	windowXPosition

int	windowYPosition

unsigned int	width

unsigned int	height

std::string	title_

Static Protected Attributes
static const int	MAX_INIT_DELAY = 5000

Detailed Description

Display for windows using Direct3D.

Direct3D is part of the DirectX API available under Windows operating systems.

Warning: Requires DirectX9 SDK to compile and DirectX9 DLLs to run.

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

#include <visp/vpConfig.h>
#include <visp/vpImageIo.h>
#include <visp/vpDisplayD3D.h>
int main()
{
#if defined(VISP_HAVE_D3D9)
  vpImage<unsigned char> I; // Grey level image
  // Read an image in PGM P5 format
  vpImageIo::read(I, "C:/temp/ViSP-images/Klimt/Klimt.pgm");
  vpDisplayD3D d;
  // Initialize the display with the image I. Display and image are
  // now link together.
  d.init(I);
  // Specify the window location
  vpDisplay::setWindowPosition(I, 400, 100);
  // Set the display window title
  vpDisplay::setTitle(I, "My Direct 3D display");
  // Set the display background with image I content
  vpDisplay::display(I);
  // Draw a red rectangle in the display overlay (foreground)
  vpImagePoint topLeftCorner;
  topLeftCorner.set_i(10);
  topLeftCorner.set_j(20);
  vpDisplay::displayRectangle(I, topLeftCorner, 100, 20, vpColor::red, true);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for a click in the display window
  vpDisplay::getClick(I);
#endif
}

Examples:: AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoSimu4Points.cpp, servoSimuCylinder.cpp, servoSimuSphere.cpp, templateTracker.cpp, testClick.cpp, testDisplays.cpp, testMouseEvent.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, and wireframeSimulator.cpp.

Definition at line 109 of file vpDisplayD3D.h.

Constructor & Destructor Documentation

vpDisplayD3D::vpDisplayD3D ( )

vpDisplayD3D::vpDisplayD3D	(	int	winx,
		int	winy,
		const char *	title = `NULL`
	)

vpDisplayD3D::vpDisplayD3D	(	vpImage< vpRGBa > &	I,
		int	winx = `-1`,
		int	winy = `-1`,
		const char *	title = `NULL`
	)

vpDisplayD3D::vpDisplayD3D	(	vpImage< unsigned char > &	I,
		int	winx = `-1`,
		int	winy = `-1`,
		const char *	title = `NULL`
	)

virtual vpDisplayD3D::~vpDisplayD3D ( )

virtual

Member Function Documentation

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

virtualinherited

Clears the display.

Parameters

color : the color to fill the display with

Implements vpDisplay.

Definition at line 925 of file vpDisplayWin32.cpp.

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

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

staticinherited

Close the display attached to I.

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

Definition at line 2031 of file vpDisplay.cpp.

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

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

staticinherited

Close the display attached to I.

Definition at line 2372 of file vpDisplay.cpp.

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

void vpDisplayWin32::closeDisplay ( )

virtualinherited

Closes the display. Destroys the window.

Implements vpDisplay.

Definition at line 936 of file vpDisplayWin32.cpp.

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

Referenced by vpDisplayWin32::~vpDisplayWin32().

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

staticinherited

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

Examples:: AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, fernClassifier.cpp, grab1394CMU.cpp, grab1394Two.cpp, grabDirectShow.cpp, grabDirectShowMulti.cpp, grabDisk.cpp, grabOpenCV-2.cpp, grabOpenCV.cpp, grabV4l2.cpp, imageSequenceReader.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, Nurbs.cpp, photometricVisualServoing.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testClick.cpp, testDisplays.cpp, testFeatureSegment.cpp, testMouseEvent.cpp, testRobotAfma6Pose.cpp, testRobotViper850Pose.cpp, testSurfKeyPoint.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-blob-auto-tracker.cpp, tutorial-blob-tracker.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-opencv-bis.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-v4l2.cpp, tutorial-grabber-video.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-filter.cpp, tutorial-image-simulator.cpp, tutorial-image-viewer.cpp, tutorial-klt-tracker.cpp, tutorial-matching-surf-homography.cpp, tutorial-matching-surf.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-tracking.cpp, tutorial-template-tracker.cpp, tutorial-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 206 of file vpDisplay.cpp.

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

Referenced by vpDot2::defineDots(), vpWireFrameSimulator::getExternalImage(), vpWireFrameSimulator::getInternalImage(), vpPlot::init(), vpMbTracker::initClick(), vpSimulatorAfma6::setPosition(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

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

staticinherited

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

Definition at line 2169 of file vpDisplay.cpp.

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

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

protectedvirtualinherited

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.

Implements vpDisplay.

Definition at line 908 of file vpDisplayWin32.cpp.

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

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.

Definition at line 600 of file vpDisplay.cpp.

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

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 661 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayArrow(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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 630 of file vpDisplay.cpp.

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

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 699 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayArrow(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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 509 of file vpDisplay.cpp.

References vpMeterPixelConversion::convertPoint(), vpDisplay::displayLine(), and vpPoint::setWorldCoordinates().

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

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 561 of file vpDisplay.cpp.

References vpMeterPixelConversion::convertPoint(), vpDisplay::displayLine(), and vpPoint::setWorldCoordinates().

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

protectedvirtualinherited

Displays a string.

Parameters

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

Implements vpDisplay.

Definition at line 874 of file vpDisplayWin32.cpp.

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

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

staticinherited

Display a string at the image point ip location.

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

Definition at line 740 of file vpDisplay.cpp.

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

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

staticinherited

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

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

Definition at line 806 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayCharString(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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

staticinherited

Display a string at the image point ip location.

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

Definition at line 773 of file vpDisplay.cpp.

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

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

staticinherited

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

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

Definition at line 843 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayCharString(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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

protectedvirtualinherited

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.

Implements vpDisplay.

Definition at line 857 of file vpDisplayWin32.cpp.

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

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

staticinherited

Display a circle.

Parameters

I	: The image associated to the display.
center	: Circle center position.
radius	: Circle radius.
color	: Circle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 875 of file vpDisplay.cpp.

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

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

staticinherited

Display a circle.

Parameters

I	: The image associated to the display.
i,j	: Circle center position.
radius	: Circle radius.
color	: Circle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 937 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayCircle(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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

staticinherited

Display a circle.

Parameters

I	: The image associated to the display.
center	: Circle center position.
radius	: Circle radius.
color	: Circle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 905 of file vpDisplay.cpp.

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

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

staticinherited

Display a circle.

Parameters

I	: The image associated to the display.
i,j	: Circle center position.
radius	: Circle radius.
color	: Circle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the circle. This parameter is only useful when fill is set to false.

Definition at line 975 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayCircle(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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

protectedvirtualinherited

Display a cross at the image point ip location.

Parameters

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

Implements vpDisplay.

Definition at line 890 of file vpDisplayWin32.cpp.

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

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.

Definition at line 1006 of file vpDisplay.cpp.

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

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 1059 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayCross(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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 1033 of file vpDisplay.cpp.

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

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 1090 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayCross(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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

protectedvirtualinherited

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

Warning: This line is a dashed line only if the thickness is equal to 1.

Parameters

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

Implements vpDisplay.

Definition at line 763 of file vpDisplayWin32.cpp.

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

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.

Definition at line 1119 of file vpDisplay.cpp.

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

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 1174 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayDotLine(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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 1146 of file vpDisplay.cpp.

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

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 1206 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayDotLine(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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

staticinherited

Display the projection of an object frame represented by 3 arrows in the image.

Parameters

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

Examples:: mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, servoSimu4Points.cpp, servoSimuCylinder.cpp, servoSimuSphere.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-pose-from-points-image.cpp, and tutorial-pose-from-points-tracking.cpp.

Definition at line 371 of file vpDisplay.cpp.

References vpColor::blue, vpMeterPixelConversion::convertPoint(), vpDisplay::displayArrow(), vpColor::green, vpColor::none, vpTracker::p, vpColor::red, vpPoint::setWorldCoordinates(), and vpForwardProjection::track().

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

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

staticinherited

Display the projection of an object frame represented by 3 arrows in the image.

Parameters

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

Definition at line 441 of file vpDisplay.cpp.

References vpColor::blue, vpMeterPixelConversion::convertPoint(), vpDisplay::displayArrow(), vpColor::green, vpColor::none, vpTracker::p, vpColor::red, vpPoint::setWorldCoordinates(), and vpForwardProjection::track().

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

virtualinherited

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

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

Parameters

I	: Image to display.

See also: init(), closeDisplay()

Implements vpDisplay.

Definition at line 211 of file vpDisplayWin32.cpp.

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

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

virtualinherited

Display the gray level image I (8bits).

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

Parameters

I	: Image to display.

See also: init(), closeDisplay()

Implements vpDisplay.

Definition at line 263 of file vpDisplayWin32.cpp.

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

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

virtualinherited

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

Warning: Display has to be initialized.; Suppress the overlay drawing in the region of interest.

Parameters

I	: Image to display.
iP	: Top left corner of the region of interest
width	: Width of the region of interest
height	: Height of the region of interest

See also: init(), closeDisplay()

Implements vpDisplay.

Definition at line 291 of file vpDisplayWin32.cpp.

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

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

virtualinherited

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

Warning: Display has to be initialized.; Suppress the overlay drawing in the region of interest.

Parameters

I	: Image to display.
iP	: Top left corner of the region of interest
width	: Width of the region of interest
height	: Height of the region of interest

See also: init(), closeDisplay()

Implements vpDisplay.

Definition at line 240 of file vpDisplayWin32.cpp.

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

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

protectedvirtualinherited

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.

Implements vpDisplay.

Definition at line 743 of file vpDisplayWin32.cpp.

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

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

staticinherited

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

Parameters

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

Definition at line 1238 of file vpDisplay.cpp.

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

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

staticinherited

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

Parameters

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

Definition at line 1268 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayLine(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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

staticinherited

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

Parameters

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

Definition at line 1336 of file vpDisplay.cpp.

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

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

staticinherited

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

Parameters

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

Definition at line 1303 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayLine(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

void vpDisplayWin32::displayPoint	(	const vpImagePoint &	ip,
		const vpColor &	color
	)

protectedvirtualinherited

Display a point at the image point ip location.

Parameters

ip	: Point location.
color	: Point color.

Implements vpDisplay.

Definition at line 729 of file vpDisplayWin32.cpp.

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

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

staticinherited

Display a point at the image point ip location.

Parameters

I	: The image associated to the display.
ip	: Point location.
color	: Point color.

Definition at line 1363 of file vpDisplay.cpp.

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

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

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.

Definition at line 1410 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayPoint(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

void vpDisplay::displayPoint	(	const vpImage< vpRGBa > &	I,
		const vpImagePoint &	ip,
		const vpColor &	color
	)

staticinherited

Display a point at the image point ip location.

Parameters

I	: The image associated to the display.
ip	: Point location.
color	: Point color.

Definition at line 1386 of file vpDisplay.cpp.

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

void vpDisplay::displayPoint	(	const vpImage< vpRGBa > &	I,
		int	i,
		int	j,
		const vpColor &	color
	)

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.

Definition at line 1438 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayPoint(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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

protectedvirtualinherited

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

Parameters

topLeft	: Top-left corner of the rectangle.
width,height	: Rectangle size.
color	: Rectangle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the four lines used to display the rectangle.

Warning: The thickness can not be set if the display uses the d3d library.

Implements vpDisplay.

Definition at line 786 of file vpDisplayWin32.cpp.

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

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

protectedvirtualinherited

Display a rectangle.

Parameters

topLeft	: Top-left corner of the rectangle.
bottomRight	: Bottom-right corner of the rectangle.
color	: Rectangle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the four lines used to display the rectangle.

Warning: The thickness can not be set if the display uses the d3d library.

Implements vpDisplay.

Definition at line 809 of file vpDisplayWin32.cpp.

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

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

protectedvirtualinherited

Display a rectangle.

Parameters

rectangle	: Rectangle characteristics.
color	: Rectangle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the four lines used to display the rectangle.

Warning: The thickness can not be set if the display uses the d3d library.

Implements vpDisplay.

Definition at line 832 of file vpDisplayWin32.cpp.

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

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

staticinherited

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

Parameters

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

Definition at line 1474 of file vpDisplay.cpp.

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

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

staticinherited

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

Parameters

I	: The image associated to the display.
topLeft	: Top-left corner of the rectangle.
bottomRight	: Bottom-right corner of the rectangle.
color	: Rectangle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 1511 of file vpDisplay.cpp.

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

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

staticinherited

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

Parameters

I	: The image associated to the display.
rectangle	: Rectangle characteristics.
color	: Rectangle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 1546 of file vpDisplay.cpp.

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

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 1582 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayLine(), vpImagePoint::get_i(), vpImagePoint::get_j(), vpImagePoint::set_u(), vpImagePoint::set_v(), and vpERROR_TRACE.

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 1800 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayRectangle(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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 1840 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayLine(), vpImagePoint::set_u(), vpImagePoint::set_v(), and vpERROR_TRACE.

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

staticinherited

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

Parameters

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

Definition at line 1637 of file vpDisplay.cpp.

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

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

staticinherited

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

Parameters

I	: The image associated to the display.
topLeft	: Top-left corner of the rectangle.
bottomRight	: Bottom-right corner of the rectangle.
color	: Rectangle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 1672 of file vpDisplay.cpp.

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

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

staticinherited

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

Parameters

I	: The image associated to the display.
rectangle	: Rectangle characteristics.
color	: Rectangle color.
fill	: When set to true fill the rectangle.
thickness	: Thickness of the four lines used to display the rectangle. This parameter is only useful when fill is set to false.

Definition at line 1707 of file vpDisplay.cpp.

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

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 1743 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayLine(), vpImagePoint::get_i(), vpImagePoint::get_j(), vpImagePoint::set_u(), vpImagePoint::set_v(), and vpERROR_TRACE.

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 1892 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayRectangle(), vpImagePoint::set_i(), vpImagePoint::set_j(), and vpERROR_TRACE.

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 1931 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::displayLine(), vpImagePoint::set_u(), vpImagePoint::set_v(), and vpERROR_TRACE.

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

staticinherited

Definition at line 225 of file vpDisplay.cpp.

References vpException::dimensionError, vpImage< Type >::display, vpDisplay::displayImageROI(), vpImage< Type >::getHeight(), vpRect::getHeight(), vpRect::getLeft(), vpRect::getTop(), vpImage< Type >::getWidth(), vpRect::getWidth(), and vpERROR_TRACE.

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

staticinherited

Definition at line 2187 of file vpDisplay.cpp.

References vpException::dimensionError, vpImage< Type >::display, vpDisplay::displayImageROI(), vpImage< Type >::getHeight(), vpRect::getHeight(), vpRect::getLeft(), vpRect::getTop(), vpImage< Type >::getWidth(), vpRect::getWidth(), and vpERROR_TRACE.

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 <visp/vpDisplay.h>
#include <visp/vpDisplayGDI.h>
#include <visp/vpColor.h>
#include <visp/vpImage.h>
#include <visp/vpImagePoint.h>
int main() {
  vpImage<unsigned char> I(240, 380);
  vpDisplayGDI d;
  d.init(I);
  vpDisplay::display(I); // display the image
  vpImagePoint center;
  unsigned int radius = 100;
  vpDisplay::displayCircle(I, center, radius, vpColor::red);
  vpDisplay::flush(I); // Mendatory to display the requested features. 
}

Examples:: AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, fernClassifier.cpp, grab1394CMU.cpp, grab1394Two.cpp, grabDirectShow.cpp, grabDirectShowMulti.cpp, grabDisk.cpp, grabOpenCV-2.cpp, grabOpenCV.cpp, grabV4l2.cpp, imageSequenceReader.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Dots.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, Nurbs.cpp, photometricVisualServoing.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testClick.cpp, testDisplays.cpp, testFeatureSegment.cpp, testMouseEvent.cpp, testRobotAfma6Pose.cpp, testRobotViper850Pose.cpp, testSurfKeyPoint.cpp, testTrackDot.cpp, testVideoDevice.cpp, testVideoDeviceDual.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-blob-auto-tracker.cpp, tutorial-blob-tracker.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-opencv-bis.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-v4l2.cpp, tutorial-grabber-video.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-filter.cpp, tutorial-image-simulator.cpp, tutorial-image-viewer.cpp, tutorial-klt-tracker.cpp, tutorial-matching-surf-homography.cpp, tutorial-matching-surf.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-tracking.cpp, tutorial-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-viewer.cpp, videoReader.cpp, and wireframeSimulator.cpp.

Definition at line 1994 of file vpDisplay.cpp.

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

Referenced by vpMbtDistanceCylinder::computeInteractionMatrixError(), vpDot2::defineDots(), vpTemplateTrackerZone::initClick(), vpPolygon::initClick(), vpMbTracker::initClick(), vpTemplateTrackerZone::initFromPoints(), vpMeEllipse::initTracking(), vpMeNurbs::initTracking(), vpMeLine::initTracking(), vpDot2::searchDotsInArea(), vpSimulatorAfma6::setPosition(), vpMeEllipse::track(), vpMeLine::track(), vpDot2::trackAndDisplay(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

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 <visp/vpDisplay.h>
#include <visp/vpDisplayGDI.h>
#include <visp/vpColor.h>
#include <visp/vpImage.h>
#include <visp/vpImagePoint.h>
#include <visp/vpRGBa.h>
int main() {
  vpImage<vpRGBa> I(240, 380);
  vpDisplayGDI d;
  d.init(I);
  vpDisplay::display(I); // display the image
  vpImagePoint center;
  unsigned int radius = 100;
  vpDisplay::displayCircle(I, center, radius, vpColor::red);
  vpDisplay::flush(I); // Mendatory to display the requested features. 
}

Definition at line 2335 of file vpDisplay.cpp.

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

void vpDisplayWin32::flushDisplay ( )

virtualinherited

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

Implements vpDisplay.

Definition at line 670 of file vpDisplayWin32.cpp.

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

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

virtualinherited

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

Implements vpDisplay.

Definition at line 684 of file vpDisplayWin32.cpp.

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

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

staticinherited

Definition at line 2011 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::flushDisplayROI(), vpRect::getHeight(), vpRect::getTopLeft(), vpRect::getWidth(), and vpERROR_TRACE.

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

staticinherited

Definition at line 2352 of file vpDisplay.cpp.

References vpImage< Type >::display, vpDisplay::flushDisplayROI(), vpRect::getHeight(), vpRect::getTopLeft(), vpRect::getWidth(), and vpERROR_TRACE.

bool vpDisplayWin32::getClick ( bool blocking = true )

protectedvirtualinherited

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.

Implements vpDisplay.

Definition at line 318 of file vpDisplayWin32.cpp.

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

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

protectedvirtualinherited

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.

Implements vpDisplay.

Definition at line 357 of file vpDisplayWin32.cpp.

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

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

protectedvirtualinherited

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.

Implements vpDisplay.

Definition at line 404 of file vpDisplayWin32.cpp.

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

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.

Definition at line 2407 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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 2444 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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 2483 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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

staticinherited

Wait for a click.

Parameters

I	[in] : The displayed image.
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 2825 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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

staticinherited

Return true when a mouse button is pressed.

Parameters

I	[in] : The displayed image.
ip	[out] : The coordinates of the clicked image point.
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 2861 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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

staticinherited

Return true when a mouse button is pressed.

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 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 2899 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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

protectedvirtualinherited

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)

Implements vpDisplay.

Definition at line 456 of file vpDisplayWin32.cpp.

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

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.

Definition at line 2525 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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

staticinherited

Return true when a mouse button is released.

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 2940 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

unsigned int vpDisplay::getHeight ( ) const

inlineinherited

Return the display height.

See also: getWidth()

Definition at line 519 of file vpDisplay.h.

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

virtualinherited

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

Parameters

I	: Image to fill.

Implements vpDisplay.

Definition at line 957 of file vpDisplayWin32.cpp.

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

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 <visp/vpConfig.h>
#include <visp/vpImageIo.h>
#include <visp/vpDisplayX.h>
#include <visp/vpDisplayGTK.h>
#include <visp/vpDisplayGDI.h>
#include <visp/vpDisplayD3D.h>
#include <visp/vpDisplayOpenCV.h>
int main()
{
  vpImage<unsigned char> I(240, 320); // Create a black grey level image
  vpImage<vpRGBa> Ioverlay;
  vpDisplay *d;
  // Depending on the detected third party libraries, we instantiate here the
  // first video device which is available
#if defined(VISP_HAVE_X11)
  d = new vpDisplayX;
#elif defined(VISP_HAVE_GTK)
  d = new vpDisplayGTK;
#elif defined(VISP_HAVE_GDI)
  d = new vpDisplayGDI;
#elif defined(VISP_HAVE_D3D9)
  d = new vpDisplayD3D;
#elif defined(VISP_HAVE_OPENCV)
  d = new vpDisplayOpenCV;
#endif
  // Initialize the display with the image I. Display and image are
  // now link together.
#ifdef VISP_HAVE_DISPLAY
  d->init(I);
#endif
  // Set the display background with image I content
  vpDisplay::display(I);
  // Draw a red rectangle in the display overlay (foreground)
  vpDisplay::displayRectangle(I, 10, 10, 100, 20, vpColor::red, true);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Updates the color image with the original loaded image and the overlay
  vpDisplay::getImage(I, Ioverlay) ;
  // Write the color image on the disk
  std::string ofilename("overlay.ppm");
  vpImageIo::write(Ioverlay, ofilename) ;
  // Wait for a click in the display window
  vpDisplay::getClick(I);
#ifdef VISP_HAVE_DISPLAY
  delete d;
#endif
}

Examples:: displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, manDisplay.cpp, manGeometricFeatures.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, sonarPioneerReader.cpp, and tutorial-image-viewer.cpp.

Definition at line 324 of file vpDisplay.cpp.

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

Referenced by vpDisplay::getImage().

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 <visp/vpConfig.h>
#include <visp/vpImageIo.h>
#include <visp/vpDisplayX.h>
#include <visp/vpDisplayGTK.h>
#include <visp/vpDisplayGDI.h>
#include <visp/vpDisplayD3D.h>
#include <visp/vpDisplayOpenCV.h>
int main()
{
  vpImage<vpRGBa> I(240, 320); // Create a black RGB color image
  vpImage<vpRGBa> Ioverlay;
  vpDisplay *d;
  // Depending on the detected third party libraries, we instantiate here the
  // first video device which is available
#if defined(VISP_HAVE_X11)
  d = new vpDisplayX;
#elif defined(VISP_HAVE_GTK)
  d = new vpDisplayGTK;
#elif defined(VISP_HAVE_GDI)
  d = new vpDisplayGDI;
#elif defined(VISP_HAVE_D3D9)
  d = new vpDisplayD3D;
#elif defined(VISP_HAVE_OPENCV)
  d = new vpDisplayOpenCV;
#endif
  // Initialize the display with the image I. Display and image are
  // now link together.
#ifdef VISP_HAVE_DISPLAY
  d->init(I);
#endif
  // Set the display background with image I content
  vpDisplay::display(I);
  // Draw a red rectangle in the display overlay (foreground)
  vpDisplay::displayRectangle(I, 10, 10, 100, 20, vpColor::red, true);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Updates the color image with the original loaded image and the overlay
  vpDisplay::getImage(I, Ioverlay) ;
  // Write the color image on the disk
  std::string ofilename("overlay.ppm");
  vpImageIo::write(Ioverlay, ofilename) ;
  // Wait for a click in the display window
  vpDisplay::getClick(I);
#ifdef VISP_HAVE_DISPLAY
  delete d;
#endif
}

Definition at line 2286 of file vpDisplay.cpp.

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

bool vpDisplayWin32::getKeyboardEvent ( bool blocking = true )

protectedvirtualinherited

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.

Implements vpDisplay.

Definition at line 501 of file vpDisplayWin32.cpp.

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

bool vpDisplayWin32::getKeyboardEvent	(	char *	string,
		bool	blocking
	)

protectedvirtualinherited

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

Implements vpDisplay.

Definition at line 538 of file vpDisplayWin32.cpp.

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

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 <visp/vpConfig.h>
#include <visp/vpDisplayOpenCV.h>
#include <visp/vpDisplayX.h>
#include <visp/vpDisplayGTK.h>
#include <visp/vpDisplayGDI.h>
#include <visp/vpDisplayD3D.h>
int main()
{
  vpImage<unsigned char> I(240, 320); // Create a black image
  vpDisplay *d;
#if defined(VISP_HAVE_X11)
  d = new vpDisplayX;
#elif defined(VISP_HAVE_GTK)
  d = new vpDisplayGTK;
#elif defined(VISP_HAVE_GDI)
  d = new vpDisplayGDI;
#elif defined(VISP_HAVE_D3D9)
  d = new vpDisplayD3D;
#elif defined(VISP_HAVE_OPENCV)
  d = new vpDisplayOpenCV;
#else
  std::cout << "Sorry, no video device is available" << std::endl;
  return -1;
#endif
  // Initialize the display with the image I. Display and image are
  // now link together.
#ifdef VISP_HAVE_DISPLAY
  d->init(I);
#endif
  // Set the display background with image I content
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  std::cout << "A keyboard event was detected" << std::endl;
  // Non blocking keyboard event loop
  int cpt_event = 0;
  bool event;
  char key[10];
  std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
  do {
    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 2630 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

bool vpDisplay::getKeyboardEvent	(	const vpImage< unsigned char > &	I,
		char *	string,
		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.
string	[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 <visp/vpConfig.h>
#include <visp/vpDisplayOpenCV.h>
#include <visp/vpDisplayX.h>
#include <visp/vpDisplayGTK.h>
#include <visp/vpDisplayGDI.h>
#include <visp/vpDisplayD3D.h>
int main()
{
  vpImage<unsigned char> I(240, 320); // Create a black image
  vpDisplay *d;
#if defined(VISP_HAVE_X11)
  d = new vpDisplayX;
#elif defined(VISP_HAVE_GTK)
  d = new vpDisplayGTK;
#elif defined(VISP_HAVE_GDI)
  d = new vpDisplayGDI;
#elif defined(VISP_HAVE_D3D9)
  d = new vpDisplayD3D;
#elif defined(VISP_HAVE_OPENCV)
  d = new vpDisplayOpenCV;
#else
  std::cout << "Sorry, no video device is available" << std::endl;
  return -1;
#endif
  // Initialize the display with the image I. Display and image are
  // now link together.
#ifdef VISP_HAVE_DISPLAY
  d->init(I);
#endif
  // Set the display background with image I content
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  std::cout << "A keyboard event was detected" << std::endl;
  // Non blocking keyboard event loop
  int cpt_event = 0;
  bool event;
  char key[10];
  std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
  do {
    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 2737 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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 <visp/vpConfig.h>
#include <visp/vpDisplayOpenCV.h>
#include <visp/vpDisplayX.h>
#include <visp/vpDisplayGTK.h>
#include <visp/vpDisplayGDI.h>
#include <visp/vpDisplayD3D.h>
int main()
{
  vpImage<vpRGBa> I(240, 320); // Create a black RGB color image
  vpDisplay *d;
#if defined(VISP_HAVE_X11)
  d = new vpDisplayX;
#elif defined(VISP_HAVE_GTK)
  d = new vpDisplayGTK;
#elif defined(VISP_HAVE_GDI)
  d = new vpDisplayGDI;
#elif defined(VISP_HAVE_D3D9)
  d = new vpDisplayD3D;
#elif defined(VISP_HAVE_OPENCV)
  d = new vpDisplayOpenCV;
#else
  std::cout << "Sorry, no video device is available" << std::endl;
  return -1;
#endif
  // Initialize the display with the image I. Display and image are
  // now link together.
#ifdef VISP_HAVE_DISPLAY
  d->init(I);
#endif
  // Set the display background with image I content
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  std::cout << "A keyboard event was detected" << std::endl;
  // Non blocking keyboard event loop
  int cpt_event = 0;
  bool event;
  char key[10];
  std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
  do {
    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 3045 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

bool vpDisplay::getKeyboardEvent	(	const vpImage< vpRGBa > &	I,
		char *	string,
		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.
string	[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 <visp/vpConfig.h>
#include <visp/vpDisplayOpenCV.h>
#include <visp/vpDisplayX.h>
#include <visp/vpDisplayGTK.h>
#include <visp/vpDisplayGDI.h>
#include <visp/vpDisplayD3D.h>
int main()
{
  vpImage<vpRGBa> I(240, 320); // Create a black RGB color image
  vpDisplay *d;
#if defined(VISP_HAVE_X11)
  d = new vpDisplayX;
#elif defined(VISP_HAVE_GTK)
  d = new vpDisplayGTK;
#elif defined(VISP_HAVE_GDI)
  d = new vpDisplayGDI;
#elif defined(VISP_HAVE_D3D9)
  d = new vpDisplayD3D;
#elif defined(VISP_HAVE_OPENCV)
  d = new vpDisplayOpenCV;
#else
  std::cout << "Sorry, no video device is available" << std::endl;
  return -1;
#endif
  // Initialize the display with the image I. Display and image are
  // now link together.
#ifdef VISP_HAVE_DISPLAY
  d->init(I);
#endif
  // Set the display background with image I content
  vpDisplay::display(I);
  // Flush the foreground and background display
  vpDisplay::flush(I);
  // Wait for keyboard event
  std::cout << "Waiting a keyboard event..." << std::endl;
  vpDisplay::getKeyboardEvent(I, true);
  std::cout << "A keyboard event was detected" << std::endl;
  // Non blocking keyboard event loop
  int cpt_event = 0;
  bool event;
  char key[10];
  std::cout << "Enter a non blocking keyboard event detection loop..." << std::endl;
  do {
    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);
  delete d;
}

Definition at line 3150 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

bool vpDisplayWin32::getPointerMotionEvent ( vpImagePoint & ip )

protectedvirtualinherited

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.

Implements vpDisplay.

Definition at line 570 of file vpDisplayWin32.cpp.

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

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 2765 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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 3178 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

bool vpDisplayWin32::getPointerPosition ( vpImagePoint & ip )

protectedvirtualinherited

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.

Implements vpDisplay.

Definition at line 605 of file vpDisplayWin32.cpp.

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

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.

Definition at line 2794 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

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 3205 of file vpDisplay.cpp.

References vpImage< Type >::display, and vpERROR_TRACE.

unsigned int vpDisplay::getWidth ( ) const

inlineinherited

Return the display width.

See also: getHeight()

Definition at line 524 of file vpDisplay.h.

void vpDisplayWin32::init	(	vpImage< unsigned char > &	I,
		int	x = `-1`,
		int	y = `-1`,
		const char *	title = `NULL`
	)

virtualinherited

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.

Implements vpDisplay.

Examples:: AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, displayD3D.cpp, displaySequence.cpp, fernClassifier.cpp, grab1394CMU.cpp, grabDirectShow.cpp, keyPointSurf.cpp, kinectAcquisition.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, sonarPioneerReader.cpp, testDisplays.cpp, testSurfKeyPoint.cpp, testTrackDot.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, and tutorial-template-tracker.cpp.

Definition at line 94 of file vpDisplayWin32.cpp.

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

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

void vpDisplayWin32::init	(	vpImage< vpRGBa > &	I,
		int	x = `-1`,
		int	y = `-1`,
		const char *	title = `NULL`
	)

virtualinherited

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

Parameters

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

Implements vpDisplay.

Definition at line 121 of file vpDisplayWin32.cpp.

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

void vpDisplayWin32::init	(	unsigned int	width,
		unsigned int	height,
		int	x = `-1`,
		int	y = `-1`,
		const char *	title = `NULL`
	)

virtualinherited

Initialize the display size, position and title.

Parameters

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

Implements vpDisplay.

Definition at line 148 of file vpDisplayWin32.cpp.

References vpDisplay::displayHasBeenInitialized, vpDisplay::height, vpDisplayWin32::hThread, vpDisplayWin32::iStatus, vpDisplayWin32::threadId, vpDisplay::title_, vpDisplayWin32::vpCreateWindow, vpDisplay::width, vpDisplay::windowXPosition, and vpDisplay::windowYPosition.

bool vpDisplay::isInitialised ( )

inlineinherited

Check if the display has been initialised

Returns: True if the display has been initialised, otherwise False

Definition at line 564 of file vpDisplay.h.

Referenced by vpPlot::setFont().

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 178 of file vpDisplay.cpp.

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

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 2141 of file vpDisplay.cpp.

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

void vpDisplayWin32::setFont ( const char * fontname )

virtualinherited

Set the font used to display text.

Parameters

fontname : Name of the font.

Implements vpDisplay.

Definition at line 659 of file vpDisplayWin32.cpp.

References vpERROR_TRACE.

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

staticinherited

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

Parameters

I	: Image associated to the display window.
fontname	: The expected font name.

Note: Under UNIX, the available fonts are given by the "xlsfonts" binary. To choose a font you can also use the "xfontsel" binary.

See also: displayCharString()

Definition at line 99 of file vpDisplay.cpp.

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

void vpDisplay::setFont	(	const vpImage< vpRGBa > &	I,
		const char *	fontname
	)

staticinherited

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

Parameters

I	: Image associated to the display window.
fontname	: The expected font name.

Note: Under UNIX, the available fonts are given by the "xlsfonts" binary. To choose a font you can also use the "xfontsel" binary.

See also: displayCharString()

Definition at line 2114 of file vpDisplay.cpp.

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

void vpDisplayWin32::setTitle ( const char * windowtitle )

virtualinherited

Changes the window's titlebar text

Parameters

windowtitle : Window title.

Implements vpDisplay.

Definition at line 646 of file vpDisplayWin32.cpp.

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

void vpDisplay::setTitle	(	const vpImage< unsigned char > &	I,
		const char *	windowtitle
	)

staticinherited

Set the windows title.

Parameters

I	: Image associated to the display window.
windowtitle	: Window title.

Definition at line 122 of file vpDisplay.cpp.

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

void vpDisplay::setTitle	(	const vpImage< vpRGBa > &	I,
		const char *	windowtitle
	)

staticinherited

Set the windows title.

Parameters

I	: Image associated to the display window.
windowtitle	: Window title.

Definition at line 2056 of file vpDisplay.cpp.

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

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

virtualinherited

Changes the window's position.

Parameters

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

Implements vpDisplay.

Definition at line 629 of file vpDisplayWin32.cpp.

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

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.

Definition at line 150 of file vpDisplay.cpp.

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

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 2083 of file vpDisplay.cpp.

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

void vpDisplayWin32::waitForInit ( )

protectedinherited

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

Exceptions

notInitializedError : the window isn't initialized

Definition at line 186 of file vpDisplayWin32.cpp.

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

Member Data Documentation

bool vpDisplay::displayHasBeenInitialized

protectedinherited

display has been initialized

Definition at line 180 of file vpDisplay.h.

unsigned int vpDisplay::height

protectedinherited

HANDLE vpDisplayWin32::hThread

protectedinherited

Handle of the window's thread.

Definition at line 104 of file vpDisplayWin32.h.

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

bool vpDisplayWin32::iStatus

protectedinherited

Initialization status.

Definition at line 110 of file vpDisplayWin32.h.

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

const int vpDisplayWin32::MAX_INIT_DELAY = 5000

staticprotectedinherited

Maximum delay for window initialization.

Definition at line 101 of file vpDisplayWin32.h.

Referenced by vpDisplayWin32::waitForInit().

RECT vpDisplayWin32::roi

protectedinherited

Definition at line 116 of file vpDisplayWin32.h.

DWORD vpDisplayWin32::threadId

protectedinherited

Id of the window's thread.

Definition at line 107 of file vpDisplayWin32.h.

Referenced by vpDisplayWin32::init().

std::string vpDisplay::title_

protectedinherited

Definition at line 187 of file vpDisplay.h.

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

unsigned int vpDisplay::width

protectedinherited

vpWin32Window vpDisplayWin32::window

protectedinherited

The window.

Definition at line 113 of file vpDisplayWin32.h.

int vpDisplay::windowXPosition

protectedinherited

display position

Definition at line 182 of file vpDisplay.h.

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

int vpDisplay::windowYPosition

protectedinherited

display position

Definition at line 184 of file vpDisplay.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation