#include <ImFusion/Navigation/ToolVisualizationAlgorithm.h>

Algorithm for the visualization of tools such as needles in MPRs and 3D view. More...

Inheritance diagram for ImFusion::ToolVisualizationAlgorithm:

Detailed Description

Algorithm for the visualization of tools such as needles in MPRs and 3D view.

Public Member Functions
	ToolVisualizationAlgorithm (TrackingStream trackingStream, SharedImageSet referenceImage)
void	compute () override
	Execute the algorithm.
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
TrackingStream *	trackingStream ()
	Returns the tracking stream to listen for position updates.
void	setRunning (bool b)
bool	isRunning () const
void	updateReference (const mat4 &m)
std::optional< mat4 >	lastToolMatrix ()
std::optional< mat4 >	rawToolMatrix ()
std::unique_ptr< TrackingInstrumentFiducialsData >	lastRawFiducialData ()
void	fixAbsolutePath (Parameter< std::string > &param)
Public Member Functions inherited from ImFusion::Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual OwningDataList	takeOutput ()
	Return any new Data that was created by the Algorithm during the last call to compute().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual int	status () const
	Indicates the status of the last call to compute().
virtual bool	survivesDataDeletion (const Data *) const
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
Public Member Functions inherited from ImFusion::Configurable
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 ImFusion::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.

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory method to check for applicability or to create the algorithm.
Static Public Member Functions inherited from ImFusion::Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.

Public Attributes
Signal	matrixChanged
Parameter< std::string >	p_trackingTargetId {"trackingTargetId", "", this}
	Unique ID of instrument to be visualized.
Parameter< std::string >	p_trackingTargetRelId {"trackingTargetRelId", "", this}
	Unique ID of instrument used as relative tracking.
Parameter< std::string >	p_meshPath {"mesh", ":/TrackingPointer.obj", this}
	Path to tool mesh.
Parameter< bool >	p_useFaceNormals {"useFaceNormals", false, this}
	If tue, face normals will be used.
Parameter< bool >	p_autostart {"autostart", false, this}
	If true, start automatically.
Parameter< bool >	p_linkMPRs {"linkMPRs", true, this}
	If true, MPRs are linked.
Parameter< bool >	p_linkWithRot {"linkWithRot", true, this}
	If true, rotation will be included in linking.
Parameter< bool >	p_showRawFiducials {"showRawFiducials", false, this}
	If true, fiducials will also be shown.
Parameter< double >	p_qualityThreshold {"qualityThreshold", 0.2, this}
	Quality threshold for matrix updates.
Parameter< bool >	p_projectiveRendering {"projectiveRendering", false, this}
	Enables projective rendering of the mesh in the MPR views.
Parameter< bool >	p_snapToClosestAxis
	If p_snapToClosestAxis is enabled, the tool will snap to the closest axis of the view.
Parameter< bool >	p_ignoreInPlaneTranslation
	If p_ignoreInPlaneTranslation is enabled, the tool the in-plane translation of the view will be kept constant.
Public Attributes inherited from ImFusion::Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Public Types inherited from ImFusion::Algorithm
enum	Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...
Protected Member Functions inherited from ImFusion::Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.
Protected Member Functions inherited from ImFusion::SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.
Protected Attributes inherited from ImFusion::Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute().
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ compute()

void ImFusion::ToolVisualizationAlgorithm::compute ( )

overridevirtual

Execute the algorithm.

Implements ImFusion::Algorithm.

◆ configure()

void ImFusion::ToolVisualizationAlgorithm::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 ImFusion::Configurable.

Member Data Documentation

◆ p_snapToClosestAxis

Parameter<bool> ImFusion::ToolVisualizationAlgorithm::p_snapToClosestAxis

Initial value:

{"snapToClosestAxis",
                                            false,
                                            this}

If p_snapToClosestAxis is enabled, the tool will snap to the closest axis of the view.

◆ p_ignoreInPlaneTranslation

Parameter<bool> ImFusion::ToolVisualizationAlgorithm::p_ignoreInPlaneTranslation

Initial value:

{
            "ignoreInPlaneTranslation",
            false,
            this}

If p_ignoreInPlaneTranslation is enabled, the tool the in-plane translation of the view will be kept constant.

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

ImFusion/Navigation/ToolVisualizationAlgorithm.h

Detailed Description

Public Member Functions

Static Public Member Functions