TrackingStreamProperties Class Reference

#include <ImFusion/Stream/TrackingStreamProperties.h>

Dialog for adjusting properties of a tracked shared image set. More...

Inheritance diagram for TrackingStreamProperties:

Detailed Description

Dialog for adjusting properties of a tracked shared image set.

Public Slots
void	updateGUI ()
	Update GUI from image set information.
void	setCenterReg ()
	Adjust registration pose to center of tracking sequence.
void	buttonBoxClicked (QAbstractButton *button)
	Resolve which button has been clicked.

Public Member Functions
	TrackingStreamProperties (TrackingStreamPropertiesAlgorithm *alg)
	Constructor, backs up original values of the image set.
	~TrackingStreamProperties () override
	Destructor.
void	init () override
	Initialization method of algorithm controller.
std::vector< Location >	supportedLocations () const override
	Returns the list of locations in which this controller is allowed to be placed by the parent MainWindowBase.
Location	preferredLocation () const override
	Returns the preferred location in which the parent MainWindowBase should place this controller.
void	onTransformationChanged (const Data *data)
	The registration matrix may change from outside, this is handled here.
Public Member Functions inherited from AlgorithmController
	AlgorithmController (Algorithm *algorithm)
	Creates a new AlgorithmController wrapping the given algorithm, which must not be null.
const Algorithm *	algorithm () const
	Returns the underlying Algorithm instance.
Algorithm *	algorithm ()
void	showInputData ()
	Shows the input data in the DisplayWidget.
InputDataVisibility	showsInputData ()
	Checks if the input data is currently visible in the DisplayWidget.
void	showHelp ()
	Attempts to open the user documentation page for the underlying algorithm.
std::optional< Filesystem::Path >	helpPath () const
	Returns the path to the user documentation page if it is available, std::nullopt otherwise.
std::string	title () const override
	Returns the original factory name of the underlying Algorithm.
Public Member Functions inherited from Controller
void	setMainWindowBase (MainWindowBase *mw)
	Complete the initialization by providing the parent MainWindowBase instance hosting the controller by setting m_main and m_disp and eventually call init().
virtual void	onSelectedDataChanged (const DataList &)
	Called by MainWindowBase in the case that the selection in the data model has changed.
virtual void	onVisibleDataChanged (const DataList &)
	Called by MainWindowBase in the case that the currently visible data has changed.
virtual void	onLocationChanged (Location newLocation)
	Callback function called by the parent MainWindowBase/ControllerDecorator whenever the place was changed.
Location	location () const
	Convenience function to query the current controller Location from the parent ControllerDecorator.
ControllerDecorator *	getDecorator () const
	Convenience function to return m_main->getControllerDecorator(this) if m_main is set or nullptr otherwise.
template<typename T>
T *	getDecorator () const
	Convenience function to dynamic_cast the return value of getDecorator() to a derived type.
Public Member Functions inherited from Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.
virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.
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
void	accept () override
	Accept the dialog.
void	reject () override
	Cancel the dialog, restoring original sweep properties.
void	reset ()
	Reset all values to original ones.
void	updateCal (const mat4 &mat)
	Update calibration pose and issue parent window redraw.
void	updateReg (const mat4 &mat)
	Update registration pose and issue parent window redraw.
void	resetValues ()
	Used both by reset and reject.
TransformationMatrixWidget *	createCalibrationMatrixWidget (QWidget *parent)
	Creates the calibration matrix widget (needed as virtual function so that it can be overridden by SweepProperties)
Protected Member Functions inherited from AlgorithmController
virtual void	closeAlgorithm (bool executed=false)
	Removes the algorithm from the ApplicationController and closes the controller.
virtual void	onAlgorithmParametersChanged ()
	Callback called when the Algorithm's signalParametersChanged signal was emitted.
virtual void	onAlgorithmOutputChanged ()
	Callback called when the Algorithm's signalOutputChanged signal was emitted.
virtual void	duplicateAlgorithmOnSelectedData () const
	Instantiates a new copy of underlying Algorithm on the currently selected Data in the DataModel and adds it to the ApplicationController.
void	addToDataAndAnnotationModels (OwningDataList data)
	Adds the contents of data to the DataModel of the parent MainWindowBase.
Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

Protected Attributes
TransformationMatrixWidget *	m_calibMatWidget = nullptr
TransformationMatrixWidget *	m_regMatWidget = nullptr
std::unique_ptr< InstrumentCalibrationDataComponent >	m_calOrig
	Original calibration matrix.
mat4	m_regOrig = mat4::Identity()
	Original registration matrix.
std::string	m_mainInstrumentOrig = ""
TrackingStreamPropertiesAlgorithm *	m_alg = nullptr
	Algorithm instance.
Protected Attributes inherited from AlgorithmController
Algorithm *	m_algorithm = nullptr
	The underlying algorithm.
Protected Attributes inherited from Controller
MainWindowBase *	m_main = nullptr
	The parent MainWindowBase instance hosting this Controller.
DisplayWidgetMulti *	m_disp = nullptr
	The main DisplayWidget instance, convenience shortcut for m_main->display().
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Additional Inherited Members
Public Types inherited from AlgorithmController
enum class	InputDataVisibility { None = 0 , All = 1 , Some = 2 }
	Enumeration of possible return values for showsInputData(). More...
Public Types inherited from Controller
enum class	Location : int {   Unknown = -1 , Naked = 0 , PrimaryDock = 1 , SecondaryDock = 2 ,   Detached = 3 , ToolBar = 4 , UserLocation = 100 }
	Enumeration of possible placement/decoration options of a Controller. More...
Public Attributes inherited from Controller
Signal	signalTitleChanged
	Signal emitted when the title() has changed.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Member Function Documentation

init()

void init ( )

overridevirtual

Initialization method of algorithm controller.

Implements Controller.

supportedLocations()

std::vector< Location > supportedLocations ( ) const

inlineoverridevirtual

Returns the list of locations in which this controller is allowed to be placed by the parent MainWindowBase.

If the controller should not be placed/wrapped by the host but stand by itself you should return a list containing only Location::Naked.

Reimplemented from Controller.

preferredLocation()

Location preferredLocation ( ) const

inlineoverridevirtual

Returns the preferred location in which the parent MainWindowBase should place this controller.

If the controller should not be placed/wrapped by the host but stand by itself you should return Location::Naked.

Reimplemented from Controller.

---

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

• ImFusion/Stream/TrackingStreamProperties.h