#include <ImFusion/GL/GlTrackingSequence.h>

Render-class for a TrackingSequence. More...

Inheritance diagram for GlTrackingSequence:

Detailed Description

Implements GlObject interface to be displayable in a view. The subclass DisplayOptions manages the visualization options of this rendered. These options are toggled in the GUI via the TrackingSequenceDisplayOptionsWidget.

Classes
class	DisplayOptions
	Record of settings to configure the appearance of a GlTrackingSequence. More...

Public Types
enum class	IndicatorType { None = 0 , CameraCone = 1 , CoordinateSystem = 2 }
	Specifies the type of indicator that will be shown at the focus point. More...

enum class	IndicatorVisibility { Focus = 0 , First = 1 , All = 2 }
	Specifies for which tracking samples the indicator should be shown. More...

enum class	ColorOptions { Quality = 0 , Time = 1 , Red = 2 , Cyan = 3 , Yellow = 4 , Green = 5 , Purple = 6 , Orange = 7 }
	Specifies the color scheme of the sequence. More...

Public Types inherited from GlObject
enum	RenderingOrderGroup { RenderingGroupRest , RenderingGroupMesh , RenderingGroupManipulator }
	Enumeration to determine rendering order of GlObjects in GlSliceView and GlVolumeView. More...

Public Member Functions
	GlTrackingSequence (TrackingSequence *trackingData)
	Ctor with TrackingSequence. Asserts that the TrackingSequence is not null.

TrackingSequence *	trackingSequence () const
	Getter for TrackingSequence.

void	setCustomDisplayOptions (DisplayOptions *options)
	Setter for display options.

DisplayOptions *	customDisplayOptions () const
	Returns the custom DisplayOptions for this class if they have been set via setCustomDisplayOptions, else nullptr.

void	draw (const GlView &view) override
	Draw the object in 3D space.

Geometry::AlignedBox	bounds () const override
	Returns added bounds of TrackingSequence and GlObject.

std::string	typeName () const override
	Return unique identifier for this object class used for serialization.

void	setDirty ()

Public Member Functions inherited from GlObject
virtual Geometry::AlignedBox	boundsSpherical () const
	Get the spherical bounds of this GlObject in world space.

virtual void	setMatrix (const mat4 &m)
	Set the modelview matrix of this object.

virtual const mat4 &	matrix () const
	Return the modelview matrix.

virtual void	setVisible (bool visible)
	Set object visibility.

virtual bool	visible () const
	Return object visibility.

virtual void	setAlwaysVisible (bool alwaysVisible)
	Set if object is always visible.

virtual bool	alwaysVisible () const
	Return if object is always visible.

RenderingOrderGroup	renderingOrder () const
	Return current rendering order value for this GlObject.

void	setRenderingOrder (RenderingOrderGroup group)
	Set rendering order value for this GlObject.

void	setDraw3DIn2DView (bool draw3DIn2DView)

void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.

void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.

Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.

void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().

void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.

	Configurable (const Configurable &rhs)

	Configurable (Configurable &&rhs) noexcept

Configurable &	operator= (const Configurable &)

Configurable &	operator= (Configurable &&) noexcept

Public Member Functions inherited from SignalReceiver
	SignalReceiver ()=default
	Default constructor.

	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.

SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.

virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.

Protected Member Functions
std::pair< std::vector< mat4 >, std::optional< mat4 > >	indicatorMatrices (IndicatorVisibility indicatorVisibility) const

void	setTrackingSequence (TrackingSequence *val)

DisplayOptions &	getOrCreatedisplayOptions ()

void	refreshPolyLines ()

void	refreshVisualization ()

Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

Protected Member Functions inherited from NotCopyable
	NotCopyable (NotCopyable &&) noexcept=default

NotCopyable &	operator= (NotCopyable &&) noexcept=default

	NotCopyable (const NotCopyable &)=delete

NotCopyable &	operator= (const NotCopyable &)=delete

Protected Attributes
TrackingSequence *	m_tracking = nullptr

bool	m_dirty = true

std::vector< vec3 >	m_uniformColors

std::vector< std::unique_ptr< GlPolyLine > >	m_polyLines

std::vector< std::unique_ptr< GlObject > >	m_visualizations

DisplayOptions *	m_displayOptions = nullptr

Protected Attributes inherited from GlObject
mat4	m_matrix = mat4::Identity()
	Modelview transformation matrix of this object.

bool	m_visible = true
	Object visibility.

bool	m_alwaysVisible = false
	Object always visible.

bool	m_draw3DIn2DView
	Draw 3D objects in 2D views. This is to render 3D objects in projective 2D views. Property is not serialized.

RenderingOrderGroup	m_renderingOrder = RenderingGroupRest

Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Additional Inherited Members
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' `signalValueChanged` signal was emitted.

Member Enumeration Documentation

◆ IndicatorType

enum class IndicatorType

strong

Specifies the type of indicator that will be shown at the focus point.

Enumerator
None	no indicator shown
CameraCone	a cone indicating the camera pose
CoordinateSystem	a cartesian coordinate system

◆ IndicatorVisibility

enum class IndicatorVisibility

strong

Specifies for which tracking samples the indicator should be shown.

Enumerator
Focus	show the indicator for the focus sample
First	show the indicator only for the first sample
All	show the indicator for all samples

◆ ColorOptions

enum class ColorOptions

strong

Specifies the color scheme of the sequence.

Enumerator
Quality	Colors the line according to the quality of each point in the tracking sequence. Falls-back to Yellow if the sequence has no quality information set.
Time	Colors the line according to the time-stamp values of the tracking sequence. Falls-back to Yellow if the sequence has no timestamp information set.

Member Function Documentation

◆ setCustomDisplayOptions()

void setCustomDisplayOptions ( DisplayOptions * options )

Setter for display options.

If not set (or if nullptr is passed), the DisplayOptions attached to the TrackingSequence will be used.

◆ draw()

void draw ( const GlView & view )

overridevirtual

Draw the object in 3D space.

Implements GlObject.

◆ bounds()

Geometry::AlignedBox bounds ( ) const

overridevirtual

Returns added bounds of TrackingSequence and GlObject.

Implements GlObject.

◆ typeName()

std::string typeName ( ) const

inlineoverridevirtual

Return unique identifier for this object class used for serialization.

Implements GlObject.

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

ImFusion/GL/GlTrackingSequence.h

Detailed Description

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ IndicatorType

◆ IndicatorVisibility

◆ ColorOptions

Member Function Documentation

◆ setCustomDisplayOptions()

◆ draw()

◆ bounds()

◆ typeName()