SolAR::api::display::I2DOverlay Class Reference

Draws 2D information on top of an image. UUID: 62b8b0b5-9344-40e6-a288-e609eb3ff0f1 More...

#include <I2DOverlay.h>

Inheritance diagram for SolAR::api::display::I2DOverlay:

Collaboration diagram for SolAR::api::display::I2DOverlay:

Public Member Functions
	I2DOverlay ()=default
	I2DOverlay default constructor.
virtual	~I2DOverlay ()=default
	I2DOverlay default destructor.
virtual void	drawCircle (const SolAR::datastructure::Point2Df &point, SRef< SolAR::datastructure::Image > displayImage)=0
	Draw one Circle. More...
virtual void	drawCircles (const std::vector< SolAR::datastructure::Point2Df > &points, SRef< SolAR::datastructure::Image > displayImage)=0
	Draw Circles. Draw all the circles stored in the vector std::vector <Point2Df> & points on image displayImage with specified radius, thickness and colors (defined in the configuration file). More...
virtual void	drawCircles (const std::vector< SolAR::datastructure::Keypoint > &keypoints, SRef< SolAR::datastructure::Image > displayImage)=0
	Draw Circles. Draw all the circles stored in the vector std::vector <Keypoint> & keypoints on image displayImage with specified radius, thickness and colors (defined in the configuration file). More...
virtual void	drawContour (const SolAR::datastructure::Contour2Df &contours, SRef< SolAR::datastructure::Image > displayImage)=0
	Draw a Contour. Draw a contour on image displayImage. More...
virtual void	drawContours (const std::vector< SolAR::datastructure::Contour2Df > &contours, SRef< SolAR::datastructure::Image > displayImage)=0
	Draw Contours. Draw all the contours stored in the vector std::vector <Contour2Df> & contours on image displayImage. More...
virtual void	drawSBPattern (const SolAR::datastructure::SquaredBinaryPattern &pattern, SRef< SolAR::datastructure::Image > displayImage)=0
	Draw a Squared Binary Pattern. More...

Detailed Description

Draws 2D information on top of an image. UUID: 62b8b0b5-9344-40e6-a288-e609eb3ff0f1

This class provides drawing methods to overlay 2D debug informations on top of an image.

Member Function Documentation

drawCircle()

virtual void SolAR::api::display::I2DOverlay::drawCircle ( const SolAR::datastructure::Point2Df &  point, SRef< SolAR::datastructure::Image >  displayImage  )

pure virtual

Draw one Circle.

Draw a circle on the image displayImage center on the point with specified radius and thickness.

Parameters

[in]	point	The position of the circle to draw
[in,out]	displayImage	The image on which the the circles will be drawn.

drawCircles() [1/2]

virtual void SolAR::api::display::I2DOverlay::drawCircles ( const std::vector< SolAR::datastructure::Keypoint > &  keypoints, SRef< SolAR::datastructure::Image >  displayImage  )

pure virtual

Draw Circles. Draw all the circles stored in the vector std::vector <Keypoint> & keypoints on image displayImage with specified radius, thickness and colors (defined in the configuration file).

Parameters

[in]	keypoint	The positions of the circles to draw
[in,out]	displayImage	The image on which the circles will be drawn.

drawCircles() [2/2]

virtual void SolAR::api::display::I2DOverlay::drawCircles ( const std::vector< SolAR::datastructure::Point2Df > &  points, SRef< SolAR::datastructure::Image >  displayImage  )

pure virtual

Draw Circles. Draw all the circles stored in the vector std::vector <Point2Df> & points on image displayImage with specified radius, thickness and colors (defined in the configuration file).

Parameters

[in]	point	The positions of the circles to draw
[in,out]	displayImage	The image on which the circles will be drawn.

drawContour()

virtual void SolAR::api::display::I2DOverlay::drawContour ( const SolAR::datastructure::Contour2Df &  contours, SRef< SolAR::datastructure::Image >  displayImage  )

pure virtual

Draw a Contour. Draw a contour on image displayImage.

Parameters

[in]	contour	The contour in 2D to draw with specified radius, thickness and colors (defined in the configuration file).
[in,out]	displayImage	The image on which the contours will be drawn.

drawContours()

virtual void SolAR::api::display::I2DOverlay::drawContours ( const std::vector< SolAR::datastructure::Contour2Df > &  contours, SRef< SolAR::datastructure::Image >  displayImage  )

pure virtual

Draw Contours. Draw all the contours stored in the vector std::vector <Contour2Df> & contours on image displayImage.

Parameters

[in]	contours	The vector of contours in 2D to draw with specified radius, thickness and colors (defined in the configuration file).
[in,out]	displayImage	The image on which the contours will be drawn.

drawSBPattern()

virtual void SolAR::api::display::I2DOverlay::drawSBPattern ( const SolAR::datastructure::SquaredBinaryPattern &  pattern, SRef< SolAR::datastructure::Image >  displayImage  )

pure virtual

Draw a Squared Binary Pattern.

Parameters

[in]	pattern	The squared binary pattern to display.
[in,out]	displayImage	The image on which the squared binary pattern will be drawn (on the whole image).

---

The documentation for this class was generated from the following file:

• interfaces/api/display/I2DOverlay.h