TrackingStreamDisplayOptions Class Reference

#include <ImFusion/Stream/TrackingStreamDisplayOptions.h>

Display options for a TrackingStream. More...

Inheritance diagram for TrackingStreamDisplayOptions:

Detailed Description

Display options for a TrackingStream.

All instruments are rendered as a tracking sequence with the same tracking sequence display options.

Public Types
enum class	MatrixConvention { RawMatrix , CalibrationOnly , RegistrationOnly , CalibrationRegistration }
enum class	TrackingHistory { None , Limited , Unlimited }

Public Member Functions
bool	operator== (const TrackingStreamDisplayOptions &rhs) const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
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 DataComponent< TrackingStreamDisplayOptions >
std::unique_ptr< DataComponentBase >	clone () const override
	Creates a clone of this data component.
std::unique_ptr< Subclass >	cloneDerived () const
bool	assign (const DataComponentBase &other) override
	Assigns the content of other to this data component.
bool	equals (const DataComponentBase &other) const override
	Compares this data component to other for equality.
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 Attributes
Parameter< TrackingHistory >	p_trackingHistory = {"trackingHistory", TrackingHistory::Limited, this}
	Tracking history option.
Parameter< int >	p_historyLength = {"historyLength", 100, this}
	Length of tracking sequence in TrackingHistory::Limited mode (ignored otherwise).
Parameter< MatrixConvention >	p_matrixConvention = {"matrixConvention", MatrixConvention::CalibrationRegistration, this}
	Convention if calibration and/or registration should be considered in visualization.
GlTrackingSequence::DisplayOptions	m_trackingSequenceDisplayOptions
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Enumeration Documentation

MatrixConvention

enum class MatrixConvention

strong

Enumerator
RawMatrix	Use raw matrices for visualization.
CalibrationOnly	Consider only calibration but no registration for visualization.
RegistrationOnly	Consider only registration but no calibration for visualization.
CalibrationRegistration	Consider calibration and registration for visualization.

TrackingHistory

enum class TrackingHistory

strong

Enumerator
None	Tracking sequence is of size 1 (no line drawn).
Limited	Tracking sequence of fixed size.
Unlimited	Unlimited tracking sequence (new tracking data is always appended).

Member Function Documentation

id()

std::string id ( ) const

overridevirtual

Returns a unique string identifier for this type of data component.

Note

To avoid conflicts make sure to include potential plugin names into this ID. Due to the modular architecture of the ImFusion library, uniqueness of IDs cannot be checked at compile time. However, DataComponentFactory will check the uniqueness of the ID during registration.

Implements DataComponentBase.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

---

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

• ImFusion/Stream/TrackingStreamDisplayOptions.h