basetool.h

/*
 
Pencil2D - Traditional Animation Software
Copyright (C) 2005-2007 Patrick Corrieri & Pascal Naidon
Copyright (C) 2012-2020 Matthew Chiawen Chang
 
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; version 2 of the License.
 
This program 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 General Public License for more details.
 
*/
 
#ifndef BASETOOL_H
#define BASETOOL_H
 
#include <QObject>
#include <QString>
#include <QCursor>
#include <QPainter>
#include <QHash>
#include <QSet>
#include <QEvent>
#include "pencildef.h"
#include "toolproperties.h"
#include "layer.h"
 
class QPixmap;
class Editor;
class ScribbleArea;
class QEnterEvent;
class QKeyEvent;
class QMouseEvent;
class QTabletEvent;
class PointerEvent;
 
const int ON = 1;
const int OFF = 0;
const int DISABLED = -1;
 
 
class BaseTool : public QObject
{
    Q_OBJECT
protected:
    explicit BaseTool(QObject* parent);
    virtual ~BaseTool();
public:
    static QString TypeName(ToolType);
    QString typeName() { return TypeName(type()); }
 
    void initialize(Editor* editor);
 
    virtual ToolType type() const = 0;
 
    virtual ToolProperties& toolProperties() = 0;
    virtual void loadSettings() = 0;
    void saveSettings();
    void resetSettings();
 
    virtual QCursor cursor();
 
    virtual void pointerPressEvent(PointerEvent*) = 0;
    virtual void pointerMoveEvent(PointerEvent*) = 0;
    virtual void pointerReleaseEvent(PointerEvent*) = 0;
    virtual void pointerDoubleClickEvent(PointerEvent*);
 
    // return true if handled
    virtual bool keyPressEvent(QKeyEvent*) { return false; }
    virtual bool keyReleaseEvent(QKeyEvent*) { return false; }
 
    virtual bool enterEvent(QEnterEvent*) { return false; }
    virtual bool leaveEvent(QEvent*) { return false; }
 
    virtual void clearToolData() {}
 
    virtual bool isActive() const;
 
    virtual void paint(QPainter& painter, const QRect& blitRect) { Q_UNUSED(painter) Q_UNUSED(blitRect) }
 
    virtual bool leavingThisTool();
 
    virtual bool enteringThisTool() { return true; }
 
    bool isPropertyEnabled(int rawType);
    bool isDrawingTool();
 
signals:
    bool isActiveChanged(ToolType, bool);
 
protected:
    Editor* editor() { return mEditor; }
    QHash<int, QSet<Layer::LAYER_TYPE>> mPropertyUsed;
 
    Editor* mEditor = nullptr;
    ScribbleArea* mScribbleArea = nullptr;
    QList<QMetaObject::Connection> mActiveConnections;
 
};
 
#endif // BASETOOL_H