ImFusion SDK 4.3
LinkSelection Class Reference

#include <ImFusion/Base/LinkSelection.h>

Synchronizes the selection of multiple Selectables. More...

+ Inheritance diagram for LinkSelection:

Detailed Description

Synchronizes the selection of multiple Selectables.

Public Member Functions

 LinkSelection (const std::vector< Data * > &data)
 Create a link containing a list of data.
 
bool accepts (const Data &data) const override
 Checks whether the given Data instance is supported.
 
void add (Data &data) override
 Add a Selectable Data to 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 SignalReceiver
 SignalReceiver ()=default
 Default constructor.
 
 SignalReceiver (const SignalReceiver &other)
 Copy constructor, does not copy any existing signal connections from other.
 
SignalReceiveroperator= (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.
 

Additional Inherited Members

- Protected Member Functions inherited from SignalReceiver
void disconnectAll ()
 Disconnects all existing connections.
 

Constructor & Destructor Documentation

◆ LinkSelection()

LinkSelection ( const std::vector< Data * > & data)
explicit

Create a link containing a list of data.

If any of the data are not Selectable, or have different values returned from Selectable::size(), the link will be empty.

Member Function Documentation

◆ 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 a Selectable Data to link.

If data is not Selectable, or has a different Selectable::size() to any other data already in the link, this function will do nothing.

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:
Search Tab / S to search, Esc to close