Computer Assited Medical Intervention Tool Kit
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Slots | Public Member Functions | Private Attributes | List of all members
MultiPicking Class Reference

This action allows the user to store a list of picked pixels. More...

#include <MultiPicking.h>

+ Inheritance diagram for MultiPicking:

Public Slots

virtual ApplyStatus apply ()
 method called when the action is applied (nothing to do here, everything will be done by the widget)
- Public Slots inherited from camitk::Action
virtual ApplyStatus apply ()=0
 This method is called when the action has to be applied on the target list (get the target lists using getTargets())
ApplyStatus trigger (QWidget *parent=NULL)
 This method triggers the action.

Public Member Functions

virtual QWidget * getWidget ()
 Returns NULL as this action has no parameters.
 MultiPicking (ActionExtension *)
 Default Constructor.
virtual ~MultiPicking ()
 Default Destructor.
- Public Member Functions inherited from camitk::Action
 Action (ActionExtension *)
 Default Constructor: the ActionExtension is needed.
bool getAutoUpdateProperties () const
 auto update properties
void setAutoUpdateProperties (bool)
 are the properties to be udpated every time the user makes a change in the widget (default is false)?
virtual ~Action ()
 Destructor.
QAction * getQAction ()
 Get the corresponding QAction.
QString getName () const
 the name of the component class that can be used by this action
QString getDescription () const
 the description of the action
QString getComponent () const
 the name of the component class that can be used by this action
QString getFamily () const
 the name of the family in which this action is associated
QString getExtensionName () const
 the name of the extension in the family in which this action is associated
QStringList getTag () const
 the name of the tag called this action
bool getEmbedded () const
 argument use to know if the widget is embedded or not
virtual QPixmap getIcon ()
 the icon to personalize the action (no icon by default)
const ComponentList getTargets () const
 the currently selected and valid (regarding the component property) components, for which this action is called
virtual ApplyStatus applyInPipeline ()
 This method encapsulates the apply() method.
virtual void setInputComponents (ComponentList inputs)
 Specify the input Component(s) Only applyInPipeline() should be called with this method (maybe apply), but not trigger() as its first intruction is to clear the target components list !!!
virtual void setInputComponent (Component *input)
 Specify the input Components in case of only one Component.
virtual ComponentList getOutputComponents ()
 Returns the output Component(s)
virtual ComponentgetOutputComponent ()
 Returns the output Components in case of only one Component.

Private Attributes

MultiPickingWidgetactionWidget
 the widget component

Additional Inherited Members

- Public Types inherited from camitk::Action
enum  ApplyStatus {
  SUCCESS, ERROR, WARNING, ABORTED,
  TRIGGERED
}
 describes what happened during the application of an algorithm (i.e. results of the apply method) More...
- Protected Member Functions inherited from camitk::Action
void setName (QString name)
void setDescription (QString description)
 the description of the action
void setComponent (QString component)
 the name of the component class that can be used by this action
void setFamily (QString family)
 the name of the family in which this action is associated
void addTag (QString tag)
 add a tag to the tags list of this action
void setEmbedded (bool isEmbedded)
 set the embedded property (an action is embedded by default, unless specified otherwise by explicitly calling this method with false)
void setIcon (QPixmap)
 set the Pixmap
virtual void preProcess ()
virtual void postProcess ()
 Set the right output component list so that the method getOutputComponents() can be called TODO: save the Action History.
- Protected Attributes inherited from camitk::Action
QWidget * actionWidget
 the action widget

Detailed Description

This action allows the user to store a list of picked pixels.

Constructor & Destructor Documentation

MultiPicking::MultiPicking ( ActionExtension extension)
virtual MultiPicking::~MultiPicking ( )
inlinevirtual

Default Destructor.

Member Function Documentation

virtual ApplyStatus MultiPicking::apply ( )
inlinevirtualslot

method called when the action is applied (nothing to do here, everything will be done by the widget)

QWidget * MultiPicking::getWidget ( )
virtual

Returns NULL as this action has no parameters.

Reimplemented from camitk::Action.

References actionWidget, camitk::Action::getTargets(), and MultiPickingWidget::updateComponent().

Member Data Documentation

MultiPickingWidget* MultiPicking::actionWidget
private

the widget component

Referenced by getWidget(), and MultiPicking().


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