LinkPose Class Reference

#include <ImFusion/Base/LinkPose.h>

Synchronizes the pose matrix across multiple Data instances. More...

Inheritance diagram for LinkPose:

Detailed Description

Synchronizes the pose matrix across multiple Data instances.

Their relative pose to each other on link time is maintained.

Classes
struct	LinkHandler
struct	LinkItem

Public Types
typedef void(LinkPose::*	TransformationChangedFn) (const Data *data)
Public Types inherited from Algorithm
enum	Status {   Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,   IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,   UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...

Public Member Functions
	LinkPose (const DataList &data)
	Constructor with data list, pose linking starts right away.
	~LinkPose () override
	Destructor, stops the linking of the transformation.
void	compute () override
	Unused compute method of the Algorithm interface.
bool	paused () const
	Returns the flag for temporarily pause linking to improve performance.
void	setPaused (bool value)
	Sets the flag for temporarily pause linking to improve performance.
bool	accepts (const Data &data) const override
	Checks whether the given Data instance is supported.
void	add (Data &data) override
	Add the given Data instance to the link.
void	remove (Data *data) override
	Remove the given Data instance from the link.
std::vector< Data * >	data () const override
	Return list of all linked Data instances.
std::string	uiTitle () const override
	Return a title of the link type for displaying in the UI.
std::string	uiIconPath () const override
	Return a path to an icon representing the link type to display in the UI.
Public Member Functions inherited from 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 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.

Static Public Member Functions
static void	registerHandler (LinkHandler handler)
	Registers a new handler for linking a specific data type. Will be added at the end of the list, i.e. will take precedence over previously registered handlers.
static bool	createCompatible (const DataList &data, Algorithm **a=0)
	Algorithm factory method.
Static Public Member Functions inherited from Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.

Protected Member Functions
void	transformationChanged (const Data *data)
	Called when any of the data transformations have changed.
Protected Member Functions inherited from 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 SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

Static Protected Member Functions
static bool	registerDefaultHandlers ()
	Registers the default link handlers.

Protected Attributes
std::vector< LinkItem >	m_links
	list of Data links
bool	m_block
	Prevents redundant listener calls during update.
bool	m_paused
	temporarily pause linking to improve performance
Protected Attributes inherited from 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 Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Static Protected Attributes
static std::vector< LinkHandler >	m_handlers
	List of link handlers. Handlers are search back to front and the first one that is compatible is used.
static bool	m_defaultsAreRegistered
	Whether registerDefaults was already called.

Additional Inherited Members
Public Attributes inherited from 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 Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Member Function Documentation

compute()

void compute ( )

overridevirtual

Unused compute method of the Algorithm interface.

Implements Algorithm.

accepts()

bool accepts ( const Data & data ) const

overridevirtual

Checks whether the given Data instance is supported.

Implements DataLink.

add()

void add ( Data & data )

overridevirtual

Add the given Data instance to the link.

Implements DataLink.

remove()

void remove ( Data * data )

overridevirtual

Remove the given Data instance from the link.

Implements DataLink.

data()

std::vector< Data * > data ( ) const

overridevirtual

Return list of all linked Data instances.

Implements DataLink.

uiTitle()

std::string uiTitle ( ) const

overridevirtual

Return a title of the link type for displaying in the UI.

Implements DataLink.

uiIconPath()

std::string uiIconPath ( ) const

overridevirtual

Return a path to an icon representing the link type to display in the UI.

Implements DataLink.

---

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

• ImFusion/Base/LinkPose.h