mvIMPACT Acquire SDK C++
ImageDisplayWindow Class Reference

A class that can be used to display images in a window. More...

Public Member Functions

ImageDisplayGetImageDisplay (void)
 Returns a reference to the actual display object associated with this window. More...
 
TPreProcessMessage GetMessageHandler (void) const
 Returns the current message handler for this window. More...
 
 ImageDisplayWindow (const std::string &title)
 Creates a new window that can be used to display image data and displays it. More...
 
void SetMessageHandler (TPreProcessMessage handler)
 Installs a callback to handle the window messages. More...
 
void SetRefreshTime (int time_ms)
 Defines the refresh time in ms. More...
 
 ~ImageDisplayWindow ()
 destroys the display window and frees resources. More...
 

Detailed Description

A class that can be used to display images in a window.

Every instance of this class will create and display its own independent window. Internally it uses an instance of mvIMPACT::acquire::display::ImageDisplay to display image data. The internal display object can be accessed by calling mvIMPACT::acquire::display::ImageDisplayWindow::GetImageDisplay().

Constructor & Destructor Documentation

◆ ImageDisplayWindow()

ImageDisplayWindow ( const std::string &  title)
inlineexplicit

Creates a new window that can be used to display image data and displays it.

This is an example of how to use the GetImageDisplay class. More details about this example.

Parameters
[in]titleThe title of the window (will be displayed in the windows title bar).

◆ ~ImageDisplayWindow()

~ImageDisplayWindow ( )
inline

destroys the display window and frees resources.

Member Function Documentation

◆ GetImageDisplay()

ImageDisplay& GetImageDisplay ( void  )
inline

Returns a reference to the actual display object associated with this window.

◆ GetMessageHandler()

TPreProcessMessage GetMessageHandler ( void  ) const
inline

Returns the current message handler for this window.

See also
mvIMPACT::acquire::display::ImageDisplayWindow::SetMessageHandler()
Returns
The current message handler for this window.

◆ SetMessageHandler()

void SetMessageHandler ( TPreProcessMessage  handler)
inline

Installs a callback to handle the window messages.

See also
mvIMPACT::acquire::display::ImageDisplayWindow::GetMessageHandler()
Parameters
[in]handlerPointer to a function which is called by the windows procedure before the display update is done. If zero is passed here even the internal default handler will be disabled and WM_SIZE and WM_LBUTTONDBLCLK will no longer be handled internally.

◆ SetRefreshTime()

void SetRefreshTime ( int  time_ms)
inline

Defines the refresh time in ms.

This function can be used to define a refresh period that - when elapsed - will automatically repaint the window.

Parameters
[in]time_msThe refresh period for the window in ms. Passing 0 will disable the automatic repaint behaviour.

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