Computer Assited Medical Intervention Tool Kit  version 5.0
PMLExplorerAction Class Reference

#include <PMLExplorerAction.h>

+ Inheritance diagram for PMLExplorerAction:
+ Collaboration diagram for PMLExplorerAction:

Public Slots

virtual camitk::Action::ApplyStatus apply ()
 this method is automatically called when the action is triggered. More...
 
- Public Slots inherited from camitk::Action
virtual camitk::Action::ApplyStatus apply ()=0
 This method is called when the action has to be applied on the target list (get the target lists using getTargets()) It calls the algorithm of your action on the target list of components. More...
 
camitk::Action::ApplyStatus applyAndRegister ()
 This method is called whenever the action has to be applied on the target list (like the apply()) method AND registered within the application history of actions. More...
 
camitk::Action::ApplyStatus trigger (QWidget *parent=nullptr)
 This method triggers the action. More...
 

Public Member Functions

 PMLExplorerAction (camitk::ActionExtension *)
 Default Constructor. More...
 
virtual ~PMLExplorerAction ()
 Default Destructor. More...
 
Reimplemented from camitk::Action class

Returns a QTreeWidget that displays in a tree view the PML component structure.

QWidget * getWidget ()
 This method has to be redefined in your Action only if: More...
 
- Public Member Functions inherited from camitk::Action
 Action (ActionExtension *)
 Default Constructor: the ActionExtension is needed. More...
 
 ~Action () override
 Destructor. More...
 
virtual QAction * getQAction (Component *target=nullptr)
 Get the corresponding QAction. More...
 
QString getName () const
 get the name of the action More...
 
QString getDescription () const
 the description of the action More...
 
QString getComponent () const
 the name of the component class that can be used by this action More...
 
QString getFamily () const
 the name of the family in which this action is associated More...
 
QString getExtensionName () const
 the name of the extension in the family in which this action is associated More...
 
QStringList getTag () const
 the name of the tag called this action More...
 
bool getEmbedded () const
 argument use to know if the widget is embedded or not More...
 
virtual QPixmap getIcon ()
 the icon to personalize the action (no icon by default) More...
 
const ComponentList getTargets () const
 the currently selected and valid (regarding the component property) components, for which this action is called More...
 
void updateTargets ()
 update the target list using the currently selected components More...
 
bool getAutoUpdateProperties () const
 
void setAutoUpdateProperties (bool)
 are the properties to be udpated every time the user makes a change in the widget (default is false)? More...
 
virtual Q_INVOKABLE camitk::PropertygetProperty (QString name)
 Get a Property given its name. More...
 
virtual bool addParameter (Property *)
 Add a new parameter to the action, using the CamiTK property class. More...
 
void applyTargetPosition (Component *input, Component *target)
 Change the target frame according to the default frame policy regarding the input's one. More...
 
void applyTargetPosition (Component *input, Component *target, Application::TargetPositionningPolicy policy)
 Change the target frame according to a given frame policy regarding the input's one. More...
 
ApplyStatus applyInPipeline ()
 This method encapsulates the apply() method. More...
 
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 !!! More...
 
void setInputComponent (Component *input)
 Specify the input Components in case of only one Component. More...
 
ComponentList getOutputComponents ()
 Returns the output Component(s) More...
 
ComponentgetOutputComponent ()
 Returns the output Components in case of only one Component. More...
 

Private Attributes

PMLExplorerWidgetpmlExplorerWidget
 The widget of this action. More...
 

Additional Inherited Members

- Public Types inherited from camitk::Action
enum  ApplyStatus {
  SUCCESS, ERROR, WARNING, ABORTED,
  TRIGGERED
}
 
- Static Public Member Functions inherited from camitk::Action
static QString getStatusAsString (ApplyStatus)
 
- Protected Member Functions inherited from camitk::Action
void setName (QString name)
 
void setDescription (QString description)
 the description of the action More...
 
void setComponent (QString component)
 the name of the component class that can be used by this action More...
 
void setFamily (QString family)
 the name of the family in which this action is associated More...
 
void addTag (QString tag)
 add a tag to the tags list of this action More...
 
void setEmbedded (bool isEmbedded)
 set the embedded property (an action is embedded by default, unless specified otherwise by explicitly calling this method with false) More...
 
void setIcon (QPixmap)
 set the Pixmap More...
 
- Protected Attributes inherited from camitk::Action
QWidget * actionWidget
 the action widget More...
 

Constructor & Destructor Documentation

◆ PMLExplorerAction()

PMLExplorerAction::PMLExplorerAction ( camitk::ActionExtension extension)

Default Constructor.

References camitk::Action::addTag(), pmlExplorerWidget, camitk::Action::setComponent(), camitk::Action::setDescription(), camitk::Action::setFamily(), and camitk::Action::setName().

+ Here is the call graph for this function:

◆ ~PMLExplorerAction()

PMLExplorerAction::~PMLExplorerAction ( )
virtual

Default Destructor.

References pmlExplorerWidget.

Member Function Documentation

◆ apply

Action::ApplyStatus PMLExplorerAction::apply ( )
virtualslot

this method is automatically called when the action is triggered.

Call getTargets() method to get the list of components to use.

Note
getTargets() is automatically filtered so that it only contains compatible components, i.e., instances of PMLExploreAction (or a subclass).

References camitk::Action::SUCCESS.

◆ getWidget()

QWidget * PMLExplorerAction::getWidget ( )
virtual

This method has to be redefined in your Action only if:

  • you do not have any widget to control your action (i.e. getWidget() will have to return nullptr),
  • you do not use the default ActionWidget but another one.

In the second case, it is strongly recommanded to have a code similar to this:

QWidget *MyAction::getWidget() {
// build or update the widget
if (!myWidget)
myWidget = new MyVerySpecialActionWidget(this);
else
// MyVerySpecialActionWidget should have an update() method
myWidget->update();
return myWidget;
}

The update() method in MyVerySpecialActionWidget is used in case the selection has changed since the last time the widget was shown (a change in the selection often means the targets or the parameter values have changed, the UI should be refreshed as well).

Reimplemented from camitk::Action.

References camitk::Action::getTargets(), pmlExplorerWidget, and PMLExplorerWidget::updateTarget().

+ Here is the call graph for this function:

Member Data Documentation

◆ pmlExplorerWidget

PMLExplorerWidget* PMLExplorerAction::pmlExplorerWidget
private

The widget of this action.

Based on a Qt TreeView widget, allows to explore the PML structure.

Referenced by getWidget(), PMLExplorerAction(), and ~PMLExplorerAction().


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