Action.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifndef ACTION_H
#define ACTION_H
 
// -- Core stuff
#include "CamiTKAPI.h"
#include "InterfacePersistence.h"
 
#include <QSet>
#include <QWidget>
#include <QString>
#include <QAction>
#include <QEvent>
 
 
namespace camitk {
 
// This simplify the user vision of her/his code.
// This can be used for future generative processing
#define CamiTKActionDeclaration(X) extern "C"
#define CamiTKActionImplementation(X) extern "C"
 
class ActionExtension;
class Property;
class HistoryItem;
class ImageComponent;
class Component;

 
class CAMITK_API Action : public QObject, public InterfacePersistence {
    Q_OBJECT
 
public:

    Action(ActionExtension*);

    ~Action() override;
 
#ifdef ERROR
#define CAMITK_WINDOWS_SYSTEM_ERROR_SAFEGUARD ERROR
#undef ERROR
#endif
    enum ApplyStatus {
        SUCCESS,    
        ERROR,      
        WARNING,    
        ABORTED,    
        TRIGGERED  
    };
 
#ifdef CAMITK_WINDOWS_SYSTEM_ERROR_SAFEGUARD
#define ERROR CAMITK_WINDOWS_SYSTEM_ERROR_SAFEGUARD
#endif

    static QString getStatusAsString(ApplyStatus);
 
public slots:
    camitk::Action::ApplyStatus trigger(QWidget* parent = nullptr);

    virtual camitk::Action::ApplyStatus apply() = 0;

    camitk::Action::ApplyStatus applyAndRegister();
 
public:


    ApplyStatus applyInPipeline();

    void setInputComponents(ComponentList inputs);

    void setInputComponent(Component* input);

    ComponentList getOutputComponents();

    Component* getOutputComponent();


    virtual QAction* getQAction(Component* target = nullptr);

    QString getName() const {
        return name;
    };

    QString getDescription() const {
        return description;
    };

    QString getComponentClassName() const {
        return componentClassName;
    };

    QString getFamily() const {
        return family;
    };

    QString getExtensionName() const;

    QStringList getTag() const {
        return tags;
    };

    bool getEmbedded() const {
        return isEmbedded;
    };



    virtual QWidget* getWidget();

    void setDefaultWidgetButtonVisibility(bool);

    void setDefaultWidgetApplyButtonText(QString);

    virtual QPixmap getIcon();

    const ComponentList getTargets() const;

    void updateTargets();

    bool getAutoUpdateProperties() const;

    void setAutoUpdateProperties(bool);

    Q_INVOKABLE virtual camitk::Property* getProperty(QString name);

    virtual QVariant getParameterValue(const QString& name) const;

    virtual bool setParameterValue(const QString& name, QVariant newValue);

    virtual QString getParameterValueAsString(const QString& name) const;

    virtual bool addParameter(Property*);

    virtual QVariant toVariant() const override;

    virtual void fromVariant(const QVariant&) override;

    virtual QUuid getUuid() const override;

    virtual bool setUuid(QUuid) override;

 
protected:
    void setName(QString name);

    void setDescription(QString description);

    void setComponentClassName(QString componentClassName);

    void setFamily(QString family);

    void addTag(QString tag);

    void setEmbedded(bool isEmbedded);

    void setIcon(QPixmap);

    QWidget* actionWidget;

    const ActionExtension* getExtension() const;

    void refreshApplication();
 
private:
    QString name;

    QString description;
 
    // the unique id of the action
    QUuid uuid;

    QString componentClassName;

    QString family;

    QStringList tags;

    bool isEmbedded;

    bool defaultWidgetButtonVisibility;

    QString defaultWidgetApplyButtonText;

    ActionExtension* extension;

    QPixmap icon;

    QAction* qAction;

    QMap<QString, Property*> parameterMap;

    ComponentList targetComponents;

    bool autoUpdateProperties;



    HistoryItem* historyItem;

    ComponentList topLevelSelectedComponents;

    void preProcess();

    void postProcess();



    ComponentList aliveBeforeComponents;

    ComponentList outputComponents;
 

    void preProcessInPipeline();

    void postProcessInPipeline();
};
 
}
 
// -------------------- declare the interface for QPluginLoader --------------------
Q_DECLARE_INTERFACE(camitk::Action, "TIMC-IMAG.Action/2.1")
 
#endif // ACTION_H