Displays an image in a dedicated window. UUID: 19ea4e13-7085-4e3f-92ca-93f200ffb01b More...

Inheritance diagram for SolAR::MODULES::OPENCV::SolARImageViewerOpencv:

Collaboration diagram for SolAR::MODULES::OPENCV::SolARImageViewerOpencv:

Public Member Functions
void	unloadComponent () override final

FrameworkReturnCode	display (const SRef< datastructure::Image > img) override
	this method displays an image contained in a Image object in a window More...

FrameworkReturnCode	displayKey (const SRef< datastructure::Image > img, char &key) override
	this method displays an image contained in a Image object in a window, get the key ascii code pressed. More...

Detailed Description

Displays an image in a dedicated window. UUID: 19ea4e13-7085-4e3f-92ca-93f200ffb01b

Properties

title	the title of the window on which the image will be displayed
	type: string; default: ""
width	the width of the window on which the image will be displayed (if <= 0, the width of the input image)
	type: int; range : [0..MAX INT]; default: 0
height	the height of the window on which the image will be displayed (if <= 0, the height of the input image)
	type: int; range : [0..MAX INT]; default: 0
exitKey	the key code to press to close the window. If negative, no key is defined to close the window
	type: int; range : [0..MAX INT]; default: 27
duration	The duration in milliseconds before closing the window. If negative or null, the window remains open
	type: uint; range : [0..MAX UINT]; default: 0

Member Function Documentation

FrameworkReturnCode SolAR::MODULES::OPENCV::SolARImageViewerOpencv::display ( const SRef< datastructure::Image > img )

override

this method displays an image contained in a Image object in a window

Parameters

[in] img The image to display in the window

Returns: FrameworkReturnCode::SUCCESS if the window is created, else FrameworkReturnCode::_ERROR

FrameworkReturnCode SolAR::MODULES::OPENCV::SolARImageViewerOpencv::displayKey	(	const SRef< datastructure::Image >	img,
		char &	key
	)

override

this method displays an image contained in a Image object in a window, get the key ascii code pressed.

Parameters

[in]	img	The image to display in the window
[out]	key	The pressed key ascii code, 0 if no key is pressed

Returns: FrameworkReturnCode::SUCCESS if the window is created, else FrameworkReturnCode::_ERROR

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