RAction.h

Go to the documentation of this file.

#ifndef RACTION_H
#define RACTION_H

#include <QKeyEvent>
#include <QList>
#include <QMap>
#include <QObject>
#include <QString>
#include <QSwipeGesture>
#include <QPanGesture>
#include <QPinchGesture>

#include "RDebug.h"
#include "REntity.h"
#include "RVector.h"

class RPropertyEvent;
class RGraphicsScene;
class RGraphicsView;
class RDocumentInterface;
class RCommandEvent;
class RCoordinateEvent;
class RDocument;
class REntityPickEvent;
class RMouseEvent;
class RWheelEvent;
class RGuiAction;
class RStorage;
class RTabletEvent;

class RAction {
public:
    enum ClickMode {
        PickCoordinate,
        PickEntity,
        PickingDisabled
    };

public:
    RAction(RGuiAction* guiAction = NULL);
    virtual ~RAction();

    void terminate();
    bool isTerminated();

    void setOverride();
    bool isOverride();

    void setNoState();
    bool hasNoState();

    void setUniqueGroup(const QString& ug);
    QString getUniqueGroup();

    void setOverrideBase(RAction* base);
    RAction* getOverrideBase();

    virtual RGuiAction* getGuiAction();

    void setGuiAction(RGuiAction* guiAction);

    QList<RGraphicsScene*> getGraphicsScenes();
    RDocument* getDocument();
    RDocumentInterface* getDocumentInterface();
    RStorage* getStorage();

    void setDocumentInterface(RDocumentInterface* di) {
        documentInterface = di;
    }

    void setClickMode(RAction::ClickMode m) {
        clickMode = m;
    }

    RAction::ClickMode getClickMode() {
        return clickMode;
    }

    virtual void beginEvent() = 0;
    virtual void setGraphicsView(RGraphicsView* view) = 0;
    virtual void finishEvent() = 0;
    virtual void suspendEvent() = 0;
    virtual void resumeEvent() = 0;
    virtual void escapeEvent() = 0;

    virtual void keyPressEvent(QKeyEvent& event) = 0;

    virtual void keyReleaseEvent(QKeyEvent& event) = 0;

    virtual void mousePressEvent(RMouseEvent& event) = 0;

    virtual void mouseMoveEvent(RMouseEvent& event) = 0;

    virtual void mouseReleaseEvent(RMouseEvent& event) = 0;

    virtual void mouseDoubleClickEvent(RMouseEvent& event) = 0;

    virtual void wheelEvent(RWheelEvent& event) = 0;

    virtual void tabletEvent(RTabletEvent& event) = 0;

    virtual void swipeGestureEvent(QSwipeGesture& gesture) = 0;

    virtual void panGestureEvent(QPanGesture& gesture) = 0;

    virtual void pinchGestureEvent(QPinchGesture& gesture) = 0;

    virtual void commandEvent(RCommandEvent& event) = 0;

    virtual void commandEventPreview(RCommandEvent& event) = 0;

    virtual void coordinateEvent(RCoordinateEvent& event) = 0;

    virtual void coordinateEventPreview(RCoordinateEvent& event) = 0;

    virtual void entityPickEvent(REntityPickEvent& event) = 0;

    virtual void entityPickEventPreview(REntityPickEvent& event) = 0;

    virtual void propertyChangeEvent(RPropertyEvent& event) = 0;

    RVector snap(RMouseEvent& event);

protected:
    bool terminated;
    bool override;

    bool noState;

    QString uniqueGroup;
    RAction::ClickMode clickMode;
    RGuiAction* guiAction;
    RAction* overrideBase;
    RDocumentInterface* documentInterface;
};

Q_DECLARE_METATYPE(RAction*)
Q_DECLARE_METATYPE(RAction::ClickMode)

#endif