ImFusion SDK 4.3
GlVitalsOverlay Class Reference

#include <ImFusion/GL/GlVitalsOverlay.h>

Overlay illustrating the ECG and other vitals data signals together with the current focus frame. More...

+ Inheritance diagram for GlVitalsOverlay:

Detailed Description

Overlay illustrating the ECG and other vitals data signals together with the current focus frame.

Public Member Functions

void render (const GL::Viewport &viewport) override
 Renders the vitals overlay on top of the image or stream.
 
void updateSignal (const SharedImageSet *sis)
 Updates the signals to be shown on top of a SharedImageSet with vitals data.
 
void updateSignal (const VitalsDataComponent &dc, std::optional< double > horizontalRangeSeconds={})
 Updates the signals to be shown for streaming use.
 
void clearSignal ()
 Clears the signals to be shown.
 
- Public Member Functions inherited from GlOverlay
 GlOverlay (int widthHint, int heightHint, int minWidthHint, int minHeightHint)
 Instantiate a new GlOverlay with the given size hints.
 
virtual void setVisible (bool visible)
 Set overlay visibility.
 
virtual bool visible () const
 Return overlay visibility.
 
virtual void setSizeHint (int width, int height)
 Sets the preferred size of the overlay for a DPI scaling of 1.0.
 
virtual int sizeHintWidth () const
 Gets the preferred width of the overlay.
 
virtual int sizeHintHeight () const
 Gets the preferred height of the overlay.
 
virtual void setMinimalSizeHint (int width, int height)
 Sets the minimal size of the overlay for a DPI scaling of 1.0.
 
virtual int minimalSizeHintWidth () const
 Gets the minimal width of the overlay.
 
virtual int minimalSizeHintHeight () const
 Gets the minimal height of the overlay.
 
virtual void update ()
 updates any intermediate data the overlay uses for rendering
 

Additional Inherited Members

- Public Attributes inherited from GlOverlay
Signal< int, int > m_sizeChangedSignal
 Signal emitted when the size hint has changed.
 
Signal< int, int > m_minSizeChangedSignal
 Signal emitted when the minimum size hint has changed.
 
- Protected Attributes inherited from GlOverlay
bool m_visible = true
 Overlay visibility.
 
int m_sizeHintWidth = 0
 
int m_sizeHintHeight = 0
 
int m_minSizeHintWidth = 0
 
int m_minSizeHintHeight = 0
 

Member Function Documentation

◆ render()

void render ( const GL::Viewport & viewport)
overridevirtual

Renders the vitals overlay on top of the image or stream.

The rendering information is updated on the updateSignal() methods. Needs to be called from the main thread.

Implements GlOverlay.

◆ updateSignal() [1/2]

void updateSignal ( const SharedImageSet * sis)
threadsafe

Updates the signals to be shown on top of a SharedImageSet with vitals data.

Will use image set timestamps as bounds for signal to be drawn, and its focus for a current frame indicator line. If there is an active selection, it will draw a selection box as well.

Can be called concurrently from any thread.

◆ updateSignal() [2/2]

void updateSignal ( const VitalsDataComponent & dc,
std::optional< double > horizontalRangeSeconds = {} )
threadsafe

Updates the signals to be shown for streaming use.

To ensure constant horizontal scaling, the total number of seconds to be used to scale may be provided. If the signals are shorter than the specified range, they are shown left-aligned and the remaining time range of the plot is left empty. If the signals are longer than the range, the most recent portion of the signals is shown. If no horizontal range is given, the whole signal will be fit into the overlay.

Can be called concurrently from any thread.

◆ clearSignal()

void clearSignal ( )
threadsafe

Clears the signals to be shown.

Can be called concurrently from any thread.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close