#include <ImFusion/GL/GlOffscreenIndicatorsOverlay.h>

The GlOffscreenIndicatorOverlay provides indicators to data that is outside of the current view area. More...

Inheritance diagram for GlOffscreenIndicatorsOverlay:

Detailed Description

The GlOffscreenIndicatorOverlay provides indicators to data that is outside of the current view area.

See also: OffscreenIndicatorOverlay.

Public Member Functions
	GlOffscreenIndicatorsOverlay (GlSliceView *view)

void	render (const GL::Viewport &viewport) override
	render the overlay with the given width and height

void	setVisibleData (const DataList &data, std::vector< std::unique_ptr< SharedImage > > thumbnails)
	Sets the data that is currently visible in view.

void	setHoveredData (const Data *data)
	Highlight the indicator for the given data.

Data *	indicatorAt (const vec2 &point, int width, int height)
	Returns the indicator at the given position if any.

bool	boundingBox (const Data data, vec3 center, vec3 *extent=nullptr) const
	Returns the bounding box of data in world coordinates.

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

render the overlay with the given width and height

Implements GlOverlay.

◆ setVisibleData()

void setVisibleData	(	const DataList &	data,
		std::vector< std::unique_ptr< SharedImage > >	thumbnails )

Sets the data that is currently visible in view.

Only indicators to the data in the list are rendered. The thumbnails list must have the same length as the data list and provides an icon for each data (can be 0 if not icon is available).

◆ setHoveredData()

void setHoveredData ( const Data * data )

Highlight the indicator for the given data.

Only one indicator can be highlighted at a time. 0 clears any highlighting.

◆ indicatorAt()

Data * indicatorAt	(	const vec2 &	point,
		int	width,
		int	height )

Returns the indicator at the given position if any.

point must be in overlay coordinates.

◆ boundingBox()

bool boundingBox	(	const Data *	data,
		vec3 *	center,
		vec3 *	extent = nullptr ) const

Returns the bounding box of data in world coordinates.

TODO: would be nicer to have that in the Data class

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

ImFusion/GL/GlOffscreenIndicatorsOverlay.h