ImFusion SDK 4.3
GlLiftChartOverlay Class Reference

#include <ImFusion/GL/GlLiftChartOverlay.h>

Overlay displaying a LIFT chart. More...

+ Inheritance diagram for GlLiftChartOverlay:

Detailed Description

Overlay displaying a LIFT chart.

A LIFT chart consists of a frame representing the whole dataset, and of a set of bars inside this frame, each representing an object (typically, annotations). The top of the frame corresponds to the farthest point of the dataset (as seen from the view that contains this overlay), while the bottom corresponds to the closest. The ends of each bar correspond to the closest and farthest points of the corresponding objects, relative to the frame. Additionally, a horizontal line marks the current slice shown in the view, also relative to the frame. The number next to this line is the frame number as computed by GlSlice::currentSlice. See LiftChartOverlayController for a usage example (with InteractiveLiftChartOverlay).

Public Member Functions

void setView (GlSliceView *view)
 
GlSliceViewview () const
 
void addBar (const GlObject *object, const vec3 &color)
 Adds a bar corresponding to object to the overlay (it will be rendered with color).
 
void removeBar (const GlObject *object)
 Removes the bar corresponding to object from the overlay.
 
void changeBarColor (const GlObject *object, const vec3 &color)
 Changes the rendering color of the bar corresponding to object.
 
void clear ()
 Removes all bars from the overlay.
 
void render (const GL::Viewport &viewport) override
 render the overlay with the given width and height
 
- 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

◆ changeBarColor()

void changeBarColor ( const GlObject * object,
const vec3 & color )

Changes the rendering color of the bar corresponding to object.

Does nothing if the overlay does not contain such a bar.

◆ render()

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

render the overlay with the given width and height

Implements GlOverlay.


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