Detailed Description

Controller for recording and synchronizing any combination of ImageStreams and TrackingStreams.

Provides additional functionality beyond algorithm configuration:

Starts and stops recording, and triggers capture events in manual mode (CaptureMode::OnRequest).
Automatically removes previously recorded data from the DataModel when StreamRecorderAlgorithm::numberOfDataToKeep() limits the number of stored recordings.
Monitors the status flag of the first TrackingStream to detect button press events for toggling recording.

Public Slots
void	onStartStop ()
	Starts or stops recording.

void	onCaptureNextSample ()
	Sends a capture command to the StreamRecorder for the next sample.

Public Member Functions
	StreamRecorderController (StreamRecorderAlgorithm *algorithm)

void	init () override
	Initializes the GUI based on the algorithm input.

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 std::vector< Location >	supportedLocations () const
	Returns the list of locations in which this controller is allowed to be placed by the parent MainWindowBase.

virtual Location	preferredLocation () const
	Returns the preferred location in which the parent MainWindowBase should place this controller.

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	onAlgorithmParametersChanged () override
	Callback triggered when the Algorithm emits signalParametersChanged. Updates the GUI.

void	onAlgorithmOutputChanged () override
	Callback triggered when recording stops, e.g. due to a recording limit being reached.

Protected Member Functions inherited from AlgorithmController
virtual void	closeAlgorithm (bool executed=false)
	Removes the algorithm from the ApplicationController and closes the controller.

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.

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.

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.

Member Function Documentation

◆ init()

void init ( )

overridevirtual

Initializes the GUI based on the algorithm input.

If only one type of stream (ImageStream or TrackingStream) is used, UI elements related to unused features, such as those specific to the non-recorded stream type or combination of streams, are omitted.

Implements Controller.

◆ onCaptureNextSample

void onCaptureNextSample ( )

slot

Sends a capture command to the StreamRecorder for the next sample.

Note: Only available when StreamRecorderAlgorithm::m_captureMode is set to CaptureMode::OnRequest.

◆ onAlgorithmParametersChanged()

void onAlgorithmParametersChanged ( )

overrideprotectedvirtual

Callback triggered when the Algorithm emits signalParametersChanged. Updates the GUI.

Reimplemented from AlgorithmController.

◆ onAlgorithmOutputChanged()

void onAlgorithmOutputChanged ( )

overrideprotectedvirtual

Callback triggered when recording stops, e.g. due to a recording limit being reached.

Reimplemented from AlgorithmController.

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

ImFusion/Stream/StreamRecorderController.h

Detailed Description

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ init()

◆ onCaptureNextSample

◆ onAlgorithmParametersChanged()

◆ onAlgorithmOutputChanged()