Pan Canvas implementation of KisAbstractInputAction. More...

#include <kis_pan_action.h>

Inheritance diagram for KisPanAction:

Classes
class	Private

Public Types
enum	Shortcut { PanModeShortcut , PanLeftShortcut , PanRightShortcut , PanUpShortcut , PanDownShortcut }

Public Member Functions
void	activate (int shortcut) override

void	begin (int shortcut, QEvent *event) override

void	cursorMovedAbsolute (const QPointF &lastPos, const QPointF &pos) override

void	deactivate (int shortcut) override

void	end (QEvent *event) override

KisInputActionGroup	inputActionGroup (int shortcut) const override

void	inputEvent (QEvent *event) override

bool	isShortcutRequired (int shortcut) const override

	KisPanAction ()

int	priority () const override

bool	supportsHiResInputEvents (int shortcut) const override

	~KisPanAction () override

Public Member Functions inherited from KisAbstractInputAction
virtual bool	canIgnoreModifiers () const

virtual QString	description () const

virtual QString	id () const

virtual bool	isAvailable () const

	KisAbstractInputAction (const QString &id)

virtual QString	name () const

virtual QHash< QString, int >	shortcutIndexes () const

virtual bool	trySwitchShortcut (int oldShortcut, int newShortcut)

virtual	~KisAbstractInputAction ()

Private Attributes
Private *const	d

Additional Inherited Members
Public Attributes inherited from KisAbstractInputAction
QString	description

QString	id

QHash< QString, int >	indexes

QPointF	lastCursorPosition

QString	name

QPointF	startCursorPosition

Static Public Attributes inherited from KisAbstractInputAction
static KisInputManager *	inputManager

Protected Member Functions inherited from KisAbstractInputAction
virtual void	cursorMoved (const QPointF &lastPos, const QPointF &pos)

QPoint	eventPos (const QEvent *event)

QPointF	eventPosF (const QEvent *event)

KisInputManager *	inputManager () const

void	setDescription (const QString &description)

void	setName (const QString &name)

void	setShortcutIndexes (const QHash< QString, int > &indexes)

Detailed Description

Pan Canvas implementation of KisAbstractInputAction.

The Pan Canvas action pans the canvas.

Definition at line 17 of file kis_pan_action.h.

Member Enumeration Documentation

◆ Shortcut

enum KisPanAction::Shortcut

The different behaviours for this action.

Enumerator
PanModeShortcut	Toggle the pan mode.
PanLeftShortcut	Pan left by a fixed amount.
PanRightShortcut	Pan right by a fixed amount.
PanUpShortcut	Pan up by a fixed amount.
PanDownShortcut	Pan down by a fixed amount.

Definition at line 23 of file kis_pan_action.h.

                  {
        PanModeShortcut, 
        PanLeftShortcut, 
        PanRightShortcut, 
        PanUpShortcut, 
        PanDownShortcut 
    };

Constructor & Destructor Documentation

◆ KisPanAction()

KisPanAction::KisPanAction ( )

explicit

Definition at line 38 of file kis_pan_action.cpp.

    : 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);
}

References PanDownShortcut, PanLeftShortcut, PanModeShortcut, PanRightShortcut, PanUpShortcut, KisAbstractInputAction::setDescription(), KisAbstractInputAction::setName(), and KisAbstractInputAction::setShortcutIndexes().

◆ ~KisPanAction()

KisPanAction::~KisPanAction ( )

override

Definition at line 54 of file kis_pan_action.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ activate()

void KisPanAction::activate ( int shortcut )

overridevirtual

The method is called when the action is yet to be started, that is, e.g. the user has pressed all the modifiers for the action but hasn't started painting yet. This method is a right place to show the user what is going to happen, e.g. change the cursor.

Reimplemented from KisAbstractInputAction.

Definition at line 64 of file kis_pan_action.cpp.

{
    Q_UNUSED(shortcut);
    QApplication::setOverrideCursor(Qt::OpenHandCursor);
}

◆ begin()

void KisPanAction::begin	(	int	shortcut,
		QEvent *	event )

overridevirtual

Begin the action.

Parameters

shortcut	The index of the behaviour to trigger.
event	The mouse event that has triggered this action. Is null for keyboard-activated actions.

Firstly, try to handle native gestures and touch events

Reimplemented from KisAbstractInputAction.

Definition at line 76 of file kis_pan_action.cpp.

{
    KisAbstractInputAction::begin(shortcut, event);
 
    if (event
        && (event->type() == QEvent::NativeGesture || event->type() == QEvent::TouchBegin
            || event->type() == QEvent::TouchUpdate)
        && shortcut == PanModeShortcut) {
 
        using Flag = KisCanvasNavigationActionStrategyNativeGesture::Flag;
        using Flags = KisCanvasNavigationActionStrategyNativeGesture::Flags;
 
        Flags flags;
        flags.setFlag(Flag::PanEnabled);
 
        if (event->type() == QEvent::NativeGesture) {
            d->actionStrategy.reset(new KisCanvasNavigationActionStrategyNativeGesture(flags, eventPosF(event), inputManager()->canvas()));
        } else {
            const QTouchEvent *tevent = static_cast<const QTouchEvent*>(event);
            d->actionStrategy.reset(new KisCanvasNavigationActionStrategyTouch(flags, tevent, inputManager()->canvas()));
        }
 
        // native gestures don't have cursor tracking by the OS, so they shouldn't show any cursor
        QApplication::restoreOverrideCursor();
        return;
    }
 
    bool overrideCursor = true;
 
    switch (shortcut) {
        case PanModeShortcut: {
            if (event->type() == QEvent::Wheel) {
                // 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 = static_cast<QWheelEvent*>(event);
                inputManager()->canvas()->canvasController()->pan(-wheelEvent->pixelDelta());
 
                // native gestures don't have cursor tracking by the OS, so they shouldn't show any cursor
                QApplication::restoreOverrideCursor();
 
                return;
            } else {
                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);
    }
}

References KisPanAction::Private::actionStrategy, KisAbstractInputAction::begin(), Private::canvas, KisInputManager::canvas(), KoCanvasBase::canvasController(), d, KisAbstractInputAction::eventPosF(), KisAbstractInputAction::inputManager, KisPanAction::Private::originalPreferredCenter, KoCanvasController::pan(), KisPanAction::Private::panDistance, PanDownShortcut, PanLeftShortcut, PanModeShortcut, PanRightShortcut, PanUpShortcut, and KoCanvasController::preferredCenter().

◆ cursorMovedAbsolute()

void KisPanAction::cursorMovedAbsolute	(	const QPointF &	lastPos,
		const QPointF &	pos )

overridevirtual

Reimplemented from KisAbstractInputAction.

Definition at line 168 of file kis_pan_action.cpp.

{
    inputManager()->canvas()->canvasController()->setPreferredCenter(-pos + startPos + d->originalPreferredCenter);
}

References KisInputManager::canvas(), KoCanvasBase::canvasController(), d, KisAbstractInputAction::inputManager, KisPanAction::Private::originalPreferredCenter, and KoCanvasController::setPreferredCenter().

◆ deactivate()

void KisPanAction::deactivate ( int shortcut )

overridevirtual

The method is called when the action is not a candidate for the starting anymore. The action should revert everything that was done in activate() method.

See also: activate()

Reimplemented from KisAbstractInputAction.

Definition at line 70 of file kis_pan_action.cpp.

{
    Q_UNUSED(shortcut);
    QApplication::restoreOverrideCursor();
}

◆ end()

void KisPanAction::end ( QEvent * event )

overridevirtual

End the action.

Parameters

event The mouse event that has finished this action. Is null for keyboard-activated actions.

Reimplemented from KisAbstractInputAction.

Definition at line 145 of file kis_pan_action.cpp.

{
    d->actionStrategy.reset();
    QApplication::restoreOverrideCursor();
    KisAbstractInputAction::end(event);
}

References KisPanAction::Private::actionStrategy, d, and KisAbstractInputAction::end().

◆ inputActionGroup()

KisInputActionGroup KisPanAction::inputActionGroup ( int shortcut ) const

overridevirtual

Returns: the group of the action the specified shortcut belongs to

Reimplemented from KisAbstractInputAction.

Definition at line 178 of file kis_pan_action.cpp.

{
    Q_UNUSED(shortcut);
    return ViewTransformActionGroup;
}

References ViewTransformActionGroup.

◆ inputEvent()

void KisPanAction::inputEvent ( QEvent * event )

overridevirtual

Process an input event.

By default handles MouseMove events and passes the data to a convenience cursorMoved() method

Parameters

event An event to process.

Reimplemented from KisAbstractInputAction.

Definition at line 152 of file kis_pan_action.cpp.

{
    if(!event) {
        return;
    }
 
    if (d->actionStrategy && d->actionStrategy->supportsEvent(event)) {
        d->actionStrategy->inputEvent(event);
    } else if (event->type() == QEvent::Wheel) {
        QWheelEvent *wheelEvent = static_cast<QWheelEvent*>(event);
        inputManager()->canvas()->canvasController()->pan(-wheelEvent->pixelDelta());
    } else {
        KisAbstractInputAction::inputEvent(event);
    }
}

References KisPanAction::Private::actionStrategy, KisInputManager::canvas(), KoCanvasBase::canvasController(), d, KisAbstractInputAction::inputEvent(), KisAbstractInputAction::inputManager, and KoCanvasController::pan().

◆ isShortcutRequired()

bool KisPanAction::isShortcutRequired ( int shortcut ) const

overridevirtual

Return true when the specified shortcut is required for basic user interaction. This is used by the configuration system to prevent basic actions like painting from being removed.

Parameters

shortcut The shortcut index to check.

Returns: True if the shortcut is required, false if not.

Reimplemented from KisAbstractInputAction.

Definition at line 173 of file kis_pan_action.cpp.

{
    return shortcut == PanModeShortcut;
}

References PanModeShortcut.

◆ priority()

int KisPanAction::priority ( ) const

overridevirtual

The priority for this action.

Priority determines how "important" the action is and is used to resolve conflicts when multiple actions can be activated.

Reimplemented from KisAbstractInputAction.

Definition at line 59 of file kis_pan_action.cpp.

{
    return 5;
}

◆ supportsHiResInputEvents()

bool KisPanAction::supportsHiResInputEvents ( int shortcut ) const

overridevirtual

Returns true if the action can handle HiRes flow of move events which is generated by the tablet. If the function returns false, some of the events will be dropped or postponed. For most of the actions in Krita (except of real painting) it is perfectly acceptable, so 'false' is the default value.

Reimplemented from KisAbstractInputAction.

Definition at line 184 of file kis_pan_action.cpp.

{
    Q_UNUSED(shortcut);
    return true;
}

Member Data Documentation

◆ d

Private* const KisPanAction::d

private

Definition at line 52 of file kis_pan_action.h.

The documentation for this class was generated from the following files:

libs/ui/input/kis_pan_action.h
libs/ui/input/kis_pan_action.cpp

Classes

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Shortcut

Constructor & Destructor Documentation

◆ KisPanAction()

◆ ~KisPanAction()

Member Function Documentation

◆ activate()

◆ begin()

◆ cursorMovedAbsolute()

◆ deactivate()

◆ end()

◆ inputActionGroup()

◆ inputEvent()

◆ isShortcutRequired()

◆ priority()

◆ supportsHiResInputEvents()

Member Data Documentation

◆ d