qSlicerSegmentEditorEffectFactory Class Reference

Singleton class managing segment editor effect plugins. More...

#include <Modules/Loadable/Segmentations/EditorEffects/qSlicerSegmentEditorEffectFactory.h>

Inheritance diagram for qSlicerSegmentEditorEffectFactory:

Collaboration diagram for qSlicerSegmentEditorEffectFactory:

Signals
void	effectRegistered (QString)
	Signals that a new effect has been registered. More...

Public Member Functions
Q_INVOKABLE QList< qSlicerSegmentEditorAbstractEffect * >	copyEffects (QList< qSlicerSegmentEditorAbstractEffect *> &effects)
	qSlicerSegmentEditorEffectFactory (QObject *parent=nullptr)
Q_INVOKABLE QList< qSlicerSegmentEditorAbstractEffect * >	registeredEffects ()
	Get list of registered effects. More...
Q_INVOKABLE bool	registerEffect (qSlicerSegmentEditorAbstractEffect *effect)
	~qSlicerSegmentEditorEffectFactory () override
	Private destructor made public to enable python wrapping. More...

Static Public Member Functions
static Q_INVOKABLE qSlicerSegmentEditorEffectFactory *	instance ()
static void	setInstance (qSlicerSegmentEditorEffectFactory *instance)
	Allows cleanup of the singleton at application exit. More...

Protected Attributes
QList< qSlicerSegmentEditorAbstractEffect * >	m_RegisteredEffects
	List of registered effect instances. More...

Friends
class	qSlicerSegmentEditorEffectFactoryCleanup

Detailed Description

Singleton class managing segment editor effect plugins.

Definition at line 39 of file qSlicerSegmentEditorEffectFactory.h.

Constructor & Destructor Documentation

qSlicerSegmentEditorEffectFactory()

qSlicerSegmentEditorEffectFactory::qSlicerSegmentEditorEffectFactory

(

QObject *

parent = nullptr

)

Private constructor made public to enable python wrapping IMPORTANT: Should not be used for creating effect handler! Use instance() instead.

~qSlicerSegmentEditorEffectFactory()

qSlicerSegmentEditorEffectFactory::~qSlicerSegmentEditorEffectFactory ( )

override

Private destructor made public to enable python wrapping.

Member Function Documentation

copyEffects()

Q_INVOKABLE QList<qSlicerSegmentEditorAbstractEffect*> qSlicerSegmentEditorEffectFactory::copyEffects

(

QList< qSlicerSegmentEditorAbstractEffect *> &

effects

)

Copy list of registered effects to the container in a segment editor widget. Effects that are already in the list (have the same name) will not be modified.

Returns

List of added effects (does not include effects that were already in the effects argument).

effectRegistered

void qSlicerSegmentEditorEffectFactory::effectRegistered ( QString  )

signal

Signals that a new effect has been registered.

instance()

static Q_INVOKABLE qSlicerSegmentEditorEffectFactory* qSlicerSegmentEditorEffectFactory::instance ( )

static

Instance getter for the singleton class

Returns

Instance object

registeredEffects()

Q_INVOKABLE QList<qSlicerSegmentEditorAbstractEffect*> qSlicerSegmentEditorEffectFactory::registeredEffects ( )

inline

Get list of registered effects.

Definition at line 57 of file qSlicerSegmentEditorEffectFactory.h.

registerEffect()

Q_INVOKABLE bool qSlicerSegmentEditorEffectFactory::registerEffect

(

qSlicerSegmentEditorAbstractEffect *

effect

)

Register a effect

Returns

True if effect registered successfully, false otherwise

setInstance()

static void qSlicerSegmentEditorEffectFactory::setInstance ( qSlicerSegmentEditorEffectFactory *  instance )

static

Allows cleanup of the singleton at application exit.

Friends And Related Function Documentation

qSlicerSegmentEditorEffectFactoryCleanup

friend class qSlicerSegmentEditorEffectFactoryCleanup

friend

Definition at line 82 of file qSlicerSegmentEditorEffectFactory.h.

Member Data Documentation

m_RegisteredEffects

QList<qSlicerSegmentEditorAbstractEffect*> qSlicerSegmentEditorEffectFactory::m_RegisteredEffects

protected

List of registered effect instances.

Definition at line 70 of file qSlicerSegmentEditorEffectFactory.h.

---

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

• Modules/Loadable/Segmentations/EditorEffects/qSlicerSegmentEditorEffectFactory.h