vpDisplayFactory Namespace Reference

Namespaces
	impl

Functions
vpDisplay *	allocateDisplay ()
template<typename T >
vpDisplay *	allocateDisplay (vpImage< T > &I, const int winx=-1, const int winy=-1, const std::string &title="", const vpDisplay::vpScaleType &scaleType=vpDisplay::SCALE_DEFAULT)
std::shared_ptr< vpDisplay >	createDisplay ()
template<typename T >
std::shared_ptr< vpDisplay >	createDisplay (vpImage< T > &I, const int winx=-1, const int winy=-1, const std::string &title="", const vpDisplay::vpScaleType &scaleType=vpDisplay::SCALE_DEFAULT)
template<typename... Args>
std::vector< std::shared_ptr< vpDisplay > >	makeDisplayGrid (unsigned int rows, unsigned int cols, unsigned int startX, unsigned int startY, unsigned int paddingX, unsigned int paddingY, Args &... args)

Function Documentation

allocateDisplay() [1/2]

vpDisplay* vpDisplayFactory::allocateDisplay

(

)

Return a newly allocated vpDisplay specialization if a GUI library is available or nullptr otherwise.

Returns

A newly allocated vpDisplay specialization if a GUI library is available or nullptr otherwise.

Examples

mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, tutorial-draw-circle.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-v4l2-threaded.cpp, tutorial-video-reader.cpp, and tutorial-video-recorder.cpp.

Definition at line 63 of file vpDisplayFactory.h.

allocateDisplay() [2/2]

template<typename T >

vpDisplay* vpDisplayFactory::allocateDisplay	(	vpImage< T > &	I,
		const int	winx = -1,
		const int	winy = -1,
		const std::string &	title = "",
		const vpDisplay::vpScaleType &	scaleType = vpDisplay::SCALE_DEFAULT
	)

Return a newly allocated vpDisplay specialization initialized with I if a GUI library is available or nullptr otherwise.

Template Parameters

T	: Any type that an image can handle and that can be displayed.

Parameters

[in]	I	: The image the display must be initialized with.
[in]	winx	: The horizontal position of the display on the screen.
[in]	winy	: The vertical position of the display on the screen.
[in]	title	: The title of the display.
[in]	scaleType	: If this parameter is set to: vpDisplay::SCALE_AUTO, the display size is adapted to ensure the image is fully displayed in the screen; vpDisplay::SCALE_DEFAULT or vpDisplay::SCALE_1, the display size is the same than the image size. vpDisplay::SCALE_2, the display size is down scaled by 2 along the lines and the columns. vpDisplay::SCALE_3, the display size is down scaled by 3 along the lines and the columns. vpDisplay::SCALE_4, the display size is down scaled by 4 along the lines and the columns. vpDisplay::SCALE_5, the display size is down scaled by 5 along the lines and the columns.

Returns

A newly allocated vpDisplay specialization initialized with I if a GUI library is available or nullptr otherwise.

Warning

The user must free the memory when the display is not used anymore.

Definition at line 104 of file vpDisplayFactory.h.

createDisplay() [1/2]

std::shared_ptr<vpDisplay> vpDisplayFactory::createDisplay

(

)

Return a smart pointer vpDisplay specialization if a GUI library is available or nullptr otherwise.

Returns

A smart pointer pointing to a vpDisplay specialization if a GUI library is available or nullptr otherwise.

Examples

pf-nonlinear-example.cpp.

Definition at line 137 of file vpDisplayFactory.h.

Referenced by vpDisplayFactory::impl::makeDisplayGridHelper().

createDisplay() [2/2]

template<typename T >

std::shared_ptr<vpDisplay> vpDisplayFactory::createDisplay	(	vpImage< T > &	I,
		const int	winx = -1,
		const int	winy = -1,
		const std::string &	title = "",
		const vpDisplay::vpScaleType &	scaleType = vpDisplay::SCALE_DEFAULT
	)

Return a smart pointer vpDisplay specialization initialized with I if a GUI library is available or nullptr otherwise.

Template Parameters

T	: Any type that an image can handle and that can be displayed.

Parameters

[in]	I	: The image the display must be initialized with.
[in]	winx	: The horizontal position of the display on the screen.
[in]	winy	: The vertical position of the display on the screen.
[in]	title	: The title of the display.
[in]	scaleType	: If this parameter is set to: vpDisplay::SCALE_AUTO, the display size is adapted to ensure the image is fully displayed in the screen; vpDisplay::SCALE_DEFAULT or vpDisplay::SCALE_1, the display size is the same than the image size. vpDisplay::SCALE_2, the display size is down scaled by 2 along the lines and the columns. vpDisplay::SCALE_3, the display size is down scaled by 3 along the lines and the columns. vpDisplay::SCALE_4, the display size is down scaled by 4 along the lines and the columns. vpDisplay::SCALE_5, the display size is down scaled by 5 along the lines and the columns.

Returns

A smart pointer pointing to a vpDisplay specialization initialized with I if a GUI library is available or nullptr otherwise.

Definition at line 177 of file vpDisplayFactory.h.

makeDisplayGrid()

template<typename... Args>

std::vector<std::shared_ptr<vpDisplay> > vpDisplayFactory::makeDisplayGrid	(	unsigned int	rows,
		unsigned int	cols,
		unsigned int	startX,
		unsigned int	startY,
		unsigned int	paddingX,
		unsigned int	paddingY,
		Args &...	args
	)

Create a grid of displays, given a set of images. All the displays will be initialized in the correct location with the content of the associated image and name. All the images should have been initialized before with the correct resolution. The display creation and image association will follow a row major order.

Template Parameters

Args	A sequence of display name (const std::string&) and ViSP image. The name should always come before the image. The image can be vpImage<unsigned char> or vpImage<vpRGBa>

Parameters

rows	Number of rows in the grid
cols	Number of columns in the grid
startX	The starting left position of the grid
startY	The starting top localization of the grid
paddingX	Horizontal padding between windows
paddingY	Vertical padding between windows
args	The name => image => name sequence

Returns

std::vector<std::shared_ptr<vpDisplay>> The allocated displays.

Exceptions

If	the grid dimensions and number of images do not match

Definition at line 279 of file vpDisplayFactory.h.

References vpDisplayFactory::impl::GridSettings::cols, vpDisplayFactory::impl::GridSettings::paddingX, vpDisplayFactory::impl::GridSettings::paddingY, vpDisplayFactory::impl::GridSettings::rows, vpDisplayFactory::impl::GridSettings::startX, and vpDisplayFactory::impl::GridSettings::startY.