KisPanAction Class Reference

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	~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 36 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 52 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 62 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.

Reimplemented from KisAbstractInputAction.

Definition at line 74 of file kis_pan_action.cpp.

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

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

cursorMovedAbsolute()

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

overridevirtual

Reimplemented from KisAbstractInputAction.

Definition at line 160 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 68 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 120 of file kis_pan_action.cpp.

{
    QApplication::restoreOverrideCursor();
    KisAbstractInputAction::end(event);
}

References 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 193 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 126 of file kis_pan_action.cpp.

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

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

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 188 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 57 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 199 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