32 #include <Component.h>
42 class ActionExtension;
220 #define CAMITK_WINDOWS_SYSTEM_ERROR_SAFEGUARD ERROR
232 #ifdef CAMITK_WINDOWS_SYSTEM_ERROR_SAFEGUARD
233 #define ERROR CAMITK_WINDOWS_SYSTEM_ERROR_SAFEGUARD
237 static QString getStatusAsString(ApplyStatus);
289 void setInputComponent(
Component* input);
312 virtual QAction* getQAction(
Component* target =
nullptr);
335 QString getExtensionName()
const;
372 virtual QWidget* getWidget();
375 virtual QPixmap getIcon();
381 void updateTargets();
387 bool getAutoUpdateProperties()
const;
390 void setAutoUpdateProperties(
bool);
408 virtual bool addParameter(
Property*);
436 void setName(QString name);
442 void setComponent(QString component);
445 void setFamily(QString family);
448 void addTag(QString tag);
451 void setEmbedded(
bool isEmbedded);
454 void setIcon(QPixmap);
563 void preProcessInPipeline();
569 void postProcessInPipeline();
#define CAMITK_API
Definition: CamiTKAPI.h:49
const char * description
Definition: applications/cepgenerator/main.cpp:38
This class describes what is a generic Action extension.
Definition: ActionExtension.h:57
Action class is an abstract class that enables you to build a action (generally on a component).
Definition: Action.h:208
QStringList tags
the name of the tag called this action
Definition: Action.h:478
ApplyStatus
describes what happened during the application of an algorithm (i.e. results of the apply method)
Definition: Action.h:224
@ ERROR
apply() failed : an error occured (usually it means that the apply() was interrupted)
Definition: Action.h:226
@ SUCCESS
everything went according to plan
Definition: Action.h:225
@ ABORTED
the action was aborted before completion
Definition: Action.h:228
@ WARNING
some (partial) error occured during the application of the algorithm
Definition: Action.h:227
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 usin...
QString getFamily() const
the name of the family in which this action is associated
Definition: Action.h:330
QString getName() const
get the name of the action
Definition: Action.h:315
QString description
the descriptionof the action
Definition: Action.h:469
ComponentList targetComponents
The list of valid (regarding the component property) components for which this action is called.
Definition: Action.h:504
QPixmap icon
the Action pixmap icon
Definition: Action.h:487
ComponentList topLevelSelectedComponents
The list of top level selected components before running the action This list is used to deduce the n...
Definition: Action.h:524
HistoryItem * item
Definition: Action.h:519
ComponentList outputComponents
List returned by getOutputComponents()
Definition: Action.h:555
QString getComponent() const
the name of the component class that can be used by this action
Definition: Action.h:325
QAction * qAction
the corresponding QAction
Definition: Action.h:490
QString component
the name of the component class that can be used by this action
Definition: Action.h:472
bool autoUpdateProperties
Should the properties/parameters of this action be automatically updated when the user change somethi...
Definition: Action.h:507
QString name
the name of the action
Definition: Action.h:466
QStringList getTag() const
the name of the tag called this action
Definition: Action.h:338
ComponentList aliveBeforeComponents
In case of a pipeline application of the Action (i.e.
Definition: Action.h:550
ActionExtension * extension
the extension in which this action is declared and registered
Definition: Action.h:484
bool getEmbedded() const
argument use to know if the widget is embedded or not
Definition: Action.h:343
QString family
the name of the family in which this action is associated
Definition: Action.h:475
QWidget * actionWidget
the action widget
Definition: Action.h:457
QMap< QString, Property * > parameterMap
list of CamiTK property decorating the dynamic properties (action parameters)
Definition: Action.h:493
QString getDescription() const
the description of the action
Definition: Action.h:320
bool isEmbedded
is the widget embedded or not
Definition: Action.h:481
TargetPositionningPolicy
: Policy to determine how a newly instantiated component's frame should be initialized regarding of i...
Definition: Application.h:88
A Component represents something that could be included in the explorer view, the interactive 3D view...
Definition: sdk/libraries/core/component/Component.h:302
HistoryItem class describes the entry of an action used in a pipeline, in the history.
Definition: HistoryItem.h:61
This class describes a property that can be used in components and actions or any class that needs to...
Definition: Property.h:280
Definition: Action.cpp:35
QSizePolicy policy(QSizePolicy::Expanding, QSizePolicy::Expanding)
QList< Component * > ComponentList
A list of Component.
Definition: CamiTKAPI.h:127