kis_pan_action.cpp

Go to the documentation of this file.

/* This file is part of the KDE project
 * SPDX-FileCopyrightText: 2012 Arjen Hiemstra <ahiemstra@heimr.nl>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#include "kis_pan_action.h"
 
#include <kis_debug.h>
#include <QMouseEvent>
#include <QApplication>
#include <QGesture>
 
#include <klocalizedstring.h>
 
#include <KoCanvasController.h>
 
#include <kis_canvas2.h>
 
#include "kis_input_manager.h"
 
class KisPanAction::Private
{
public:
    Private() : panDistance(10) { }
 
    QPointF averagePoint( QTouchEvent* event, int *outCount = nullptr );
 
    const int panDistance;
 
    QPointF lastPosition;
    QPointF originalPreferredCenter;
    int touchPointsCount { 0 };
};
 
KisPanAction::KisPanAction()
    : KisAbstractInputAction("Pan Canvas")
    , d(new Private)
{
    setName(i18n("Pan Canvas"));
    setDescription(i18n("The <i>Pan Canvas</i> action pans the canvas."));
 
    QHash<QString, int> shortcuts;
    shortcuts.insert(i18n("Pan Mode"), PanModeShortcut);
    shortcuts.insert(i18n("Pan Left"), PanLeftShortcut);
    shortcuts.insert(i18n("Pan Right"), PanRightShortcut);
    shortcuts.insert(i18n("Pan Up"), PanUpShortcut);
    shortcuts.insert(i18n("Pan Down"), PanDownShortcut);
    setShortcutIndexes(shortcuts);
}
 
KisPanAction::~KisPanAction()
{
    delete d;
}
 
int KisPanAction::priority() const
{
    return 5;
}
 
void KisPanAction::activate(int shortcut)
{
    Q_UNUSED(shortcut);
    QApplication::setOverrideCursor(Qt::OpenHandCursor);
}
 
void KisPanAction::deactivate(int shortcut)
{
    Q_UNUSED(shortcut);
    QApplication::restoreOverrideCursor();
}
 
void KisPanAction::begin(int shortcut, QEvent *event)
{
    KisAbstractInputAction::begin(shortcut, event);
 
    bool overrideCursor = true;
 
    switch (shortcut) {
        case PanModeShortcut: {
            QTouchEvent *tevent = dynamic_cast<QTouchEvent*>(event);
            if (tevent) {
                d->lastPosition = d->averagePoint(tevent, &d->touchPointsCount);
                break;
            }
 
            // Some QT wheel events are actually be touch pad pan events. From the QT docs:
            // "Wheel events are generated for both mouse wheels and trackpad scroll gestures."
            QWheelEvent *wheelEvent = dynamic_cast<QWheelEvent*>(event);
            if (wheelEvent) {
                inputManager()->canvas()->canvasController()->pan(-wheelEvent->pixelDelta());
                overrideCursor = false;
                break;
            }
 
            d->originalPreferredCenter = inputManager()->canvas()->canvasController()->preferredCenter();
 
            break;
        }
        case PanLeftShortcut:
            inputManager()->canvas()->canvasController()->pan(QPoint(d->panDistance, 0));
            break;
        case PanRightShortcut:
            inputManager()->canvas()->canvasController()->pan(QPoint(-d->panDistance, 0));
            break;
        case PanUpShortcut:
            inputManager()->canvas()->canvasController()->pan(QPoint(0, d->panDistance));
            break;
        case PanDownShortcut:
            inputManager()->canvas()->canvasController()->pan(QPoint(0, -d->panDistance));
            break;
    }
 
    if (overrideCursor) {
        QApplication::setOverrideCursor(Qt::ClosedHandCursor);
    }
}
 
void KisPanAction::end(QEvent *event)
{
    QApplication::restoreOverrideCursor();
    KisAbstractInputAction::end(event);
}
 
void KisPanAction::inputEvent(QEvent *event)
{
    switch (event->type()) {
        case QEvent::Gesture: {
            QGestureEvent *gevent = static_cast<QGestureEvent*>(event);
            if (gevent->activeGestures().at(0)->gestureType() == Qt::PanGesture) {
                QPanGesture *pan = static_cast<QPanGesture*>(gevent->activeGestures().at(0));
                inputManager()->canvas()->canvasController()->pan(-pan->delta().toPoint() * 0.2);
            }
            return;
        }
        case QEvent::TouchUpdate: {
            QTouchEvent *tevent = static_cast<QTouchEvent*>(event);
            int newTouchPointsCount;
            QPointF newPos = d->averagePoint(tevent, &newTouchPointsCount);
            // When the number of touch points have changed, the average point
            // of the touch points will produce a huge jump which we don't want
            // to happen when panning. This can happen when ending a 3-finger
            // pan gesture. So we only pan the canvas if the number of touch
            // points have not changed.
            if (newTouchPointsCount == d->touchPointsCount) {
                QPointF delta = newPos - d->lastPosition;
                inputManager()->canvas()->canvasController()->pan(-delta.toPoint());
            }
            d->lastPosition = newPos;
            d->touchPointsCount = newTouchPointsCount;
            return;
        }
        default:
            break;
    }
    KisAbstractInputAction::inputEvent(event);
}
 
void KisPanAction::cursorMovedAbsolute(const QPointF &startPos, const QPointF &pos)
{
    inputManager()->canvas()->canvasController()->setPreferredCenter(-pos + startPos + d->originalPreferredCenter);
}
 
QPointF KisPanAction::Private::averagePoint( QTouchEvent* event, int *outCount )
{
    QPointF result;
    int count = 0;
 
    Q_FOREACH ( QTouchEvent::TouchPoint point, event->touchPoints() ) {
        if( point.state() != Qt::TouchPointReleased ) {
            result += point.screenPos();
            count++;
        }
    }
 
    if (outCount) {
        *outCount = count;
    }
 
    if( count > 0 ) {
        return result / count;
    } else {
        return QPointF();
    }
}
 
bool KisPanAction::isShortcutRequired(int shortcut) const
{
    return shortcut == PanModeShortcut;
}
 
KisInputActionGroup KisPanAction::inputActionGroup(int shortcut) const
{
    Q_UNUSED(shortcut);
    return ViewTransformActionGroup;
}
 
bool KisPanAction::supportsHiResInputEvents(int shortcut) const
{
    Q_UNUSED(shortcut);
    return true;
}