#include <ImFusion/GL/GlScalarBarOverlay.h>

Overlay for displaying one or multiple named scalar values represented as colored bars. More...

Inheritance diagram for GlScalarBarOverlay:

Detailed Description

Overlay for displaying one or multiple named scalar values represented as colored bars.

Displays the given title and scalar value in the form of

<Title Bar 1> [bar describing value by width and color] <Value Bar 1>

<Title Bar 2> [bar describing value by width and color] <Value Bar 2>

Public Types
enum class	RenderMode { All = 0 , MainOnly = 1 , Auto = 2 , EllipsisPoints = 3 , None = 4 }

Public Member Functions
	GlScalarBarOverlay ()
	Construct text overlay.

	~GlScalarBarOverlay () override
	Destructor.

int	numBars () const
	Returns the number of bars to show.

void	setNumBars (int value)
	Sets the number of bars to show.

RenderMode	renderMode () const
	Returns the visibility mode of the quality bars.

void	setRenderMode (RenderMode mode)
	Sets the visibility mode of the quality bars.

void	setBarValue (int index, const std::string &title, double value, vec2 range, bool active=true)
	Sets the configuration of the bar with their given index.

void	setTimeoutInterval (int intervalMs)
	Sets the timeout inteval in milliseconds after which the values are considered to be outdated and set inactive If intervalMs is zero, no timeout is considered.

int	timeoutInterval () const
	Returns the timeout interval for active bar values.

bool	showsNormalizedValue () const
	Whether to normalize the input value to its range in the text label.

void	setShowsNormalizedValue (bool newVal)

void	render (const GL::Viewport &viewport) override
	Render quality overlay.

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 Enumeration Documentation

◆ RenderMode

enum class RenderMode

strong

Enumerator
All	show all quality bars
MainOnly	show only main tracking quality (or first)
Auto	show all until 3 tracking sequence, collapse to 1 otherwise
EllipsisPoints	hide bars and show ellipsis points
None	show no tracking quality bar and no interaction

Member Function Documentation

◆ setBarValue()

void setBarValue	(	int	index,
		const std::string &	title,
		double	value,
		vec2	range,
		bool	active = true )

Sets the configuration of the bar with their given index.

Parameters

index	Index of the bar to configure
title	Title of the bar.
value	Scalar value of the bar to represent.
range	Value range of value.
active	Flag if values are considered active (color rendering) or inactive (grayed out bars)

◆ timeoutInterval()

int timeoutInterval ( ) const

Returns the timeout interval for active bar values.

Whether to normalize the input value to its range in the text label

◆ render()

void render ( const GL::Viewport & viewport )

overridevirtual

Render quality overlay.

Implements GlOverlay.

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

ImFusion/GL/GlScalarBarOverlay.h