Action.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
 *
 * 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 <HistoryItem.h>
#include <Application.h>

#include <QSet>
#include <QWidget>
#include <QString>
#include <QAction>


namespace camitk {

class ActionExtension;
class Property;

class CAMITK_API Action : public QObject {
    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:
    ApplyStatus trigger(QWidget* parent = nullptr);

    virtual ApplyStatus apply() = 0;

    ApplyStatus applyAndRegister();

public:


    ApplyStatus applyInPipeline();

    void setInputComponents(ComponentList inputs);

    void setInputComponent(Component* input);

    ComponentList getOutputComponents();

    Component* getOutputComponent();


    QAction* getQAction();

    QString getName() const {
        return name;
    };

    QString getDescription() const {
        return description;
    };

    QString getComponent() const {
        return component;
    };

    QString getFamily() const {
        return family;
    };

    QString getExtensionName() const;

    QStringList getTag() const {
        return tags;
    };

    bool getEmbedded() const {
        return isEmbedded;
    };


    virtual QWidget* getWidget();

    virtual QPixmap getIcon();

    const ComponentList getTargets() const;

    bool getAutoUpdateProperties() const;

    void setAutoUpdateProperties(bool);

    Q_INVOKABLE virtual Property* getProperty(QString name);

    virtual bool addParameter(Property*);


    void applyTargetPosition(Component* input, Component* target);

    void applyTargetPosition(Component* input, Component* target, Application::TargetPositionningPolicy policy);

protected:
    void setName(QString name);

    void setDescription(QString description);

    void setComponent(QString component);

    void setFamily(QString family);

    void addTag(QString tag);

    void setEmbedded(bool isEmbedded);

    void setIcon(QPixmap);

    QWidget* actionWidget;





private:
    QString name;

    QString description;

    QString component;

    QString family;

    QStringList tags;

    bool isEmbedded;

    ActionExtension* extension;

    QPixmap icon;

    QAction* qAction;

    QMap<QString, Property*> parameterMap;

    ComponentList targetComponents;

    bool autoUpdateProperties;


    HistoryItem* item;

    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") //TODO use svn version?

#endif // ACTION_H