iAFilterRegistry Class Reference

Registry for image filters. More...

#include <iAFilterRegistry.h>

Collaboration diagram for iAFilterRegistry:

Static Public Member Functions
static void	addFilterFactory (QSharedPointer< iAIFilterFactory > factory)
	Adds a given filter factory to the registry, which will be run with the default GUI runner. More...
static void	addFilterFactory (QSharedPointer< iAIFilterFactory > factory, QSharedPointer< iAIFilterRunnerGUIFactory > runner)
	Adds a given filter factory to the registry, which will be run with the runner for which the factory is supplied. More...
static QSharedPointer< iAFilter >	filter (QString const &name)
	Retrieve the filter with the given name. More...
static const QVector< QSharedPointer< iAIFilterFactory > > &	filterFactories ()
	Retrieve a list of all currently registered filter (factories) More...
static int	filterID (QString const &name)
	Retrieve the ID of the filter with the given name If there is no such filter, -1 is returned. More...
static QSharedPointer< iAIFilterRunnerGUIFactory >	filterRunner (int filterID)
	Retrieve the callback for a given factory (if the given factory does not have a callback, nullptr is returned). More...

Detailed Description

Registry for image filters.

Use REGISTER_FILTER and REGISTER_FILTER_WITH_RUNNER macros add a filter to the list of filters in this class. All filters registered with these macros will be added to the Filter menu (in a submenu according to their Category(), the menu entry will have the filter name; the menu entry will be disabled until a dataset is loaded. When a dataset is loaded, clicking the menu entry will result in execution of the filter with the currently active window as input. The class is meant to be used statically (Follows the singleton pattern), the creation of objects of this class is thus prohibited.

Member Function Documentation

addFilterFactory() [1/2]

void iAFilterRegistry::addFilterFactory ( QSharedPointer< iAIFilterFactory >  factory )

static

Adds a given filter factory to the registry, which will be run with the default GUI runner.

REGISTER_FILTER provide simplified access to this method.

addFilterFactory() [2/2]

void iAFilterRegistry::addFilterFactory ( QSharedPointer< iAIFilterFactory >  factory, QSharedPointer< iAIFilterRunnerGUIFactory >  runner  )

static

Adds a given filter factory to the registry, which will be run with the runner for which the factory is supplied.

REGISTER_FILTER_WITH_RUNNER provides simplified access to this method.

filter()

QSharedPointer< iAFilter > iAFilterRegistry::filter ( QString const &  name )

static

Retrieve the filter with the given name.

If there is no such filter, a "null" shared pointer is returned

filterFactories()

const QVector< QSharedPointer< iAIFilterFactory > > & iAFilterRegistry::filterFactories ( )

static

Retrieve a list of all currently registered filter (factories)

filterID()

int iAFilterRegistry::filterID ( QString const &  name )

static

Retrieve the ID of the filter with the given name If there is no such filter, -1 is returned.

filterRunner()

QSharedPointer< iAIFilterRunnerGUIFactory > iAFilterRegistry::filterRunner ( int  filterID )

static

Retrieve the callback for a given factory (if the given factory does not have a callback, nullptr is returned).

---

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

• core/src/iAFilterRegistry.h
• core/src/iAFilterRegistry.cpp