Solar
Public Member Functions | List of all members
SolAR::api::display::IImageViewer Class Referenceabstract

VDisplays an image in a window. UUID: B05F3DBB-F93D-465C-AEE1-FB58E1480C42 More...

#include <IImageViewer.h>

Inheritance diagram for SolAR::api::display::IImageViewer:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::display::IImageViewer:
Collaboration graph
[legend]

Public Member Functions

virtual FrameworkReturnCode display (const SRef< SolAR::datastructure::Image > img)=0
 this method displays an image contained in a Image object in a window More...
 
virtual FrameworkReturnCode displayKey (const SRef< SolAR::datastructure::Image > img, char &key)=0
 this method displays an image contained in a Image object in a window, and get the key code if pressed More...
 

Detailed Description

VDisplays an image in a window. UUID: B05F3DBB-F93D-465C-AEE1-FB58E1480C42

This class provides a viewer to display an image in a window.

Member Function Documentation

◆ display()

virtual FrameworkReturnCode SolAR::api::display::IImageViewer::display ( const SRef< SolAR::datastructure::Image img)
pure virtual

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

Parameters
[in]imgThe image to display in the window
Returns
FrameworkReturnCode::SUCCESS if the window is created, else FrameworkReturnCode::_ERROR

◆ displayKey()

virtual FrameworkReturnCode SolAR::api::display::IImageViewer::displayKey ( const SRef< SolAR::datastructure::Image img,
char &  key 
)
pure virtual

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

Parameters
[in]imgThe image to display in the window
[out]keyThe 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: