Zoom Canvas implementation of KisAbstractInputAction. More...

#include <kis_zoom_action.h>

Inheritance diagram for KisZoomAction:

Classes
class	Private

Public Types
enum	Shortcuts { ZoomModeShortcut , DiscreteZoomModeShortcut , ZoomInShortcut , ZoomOutShortcut , Zoom100PctShortcut , FitToViewShortcut , FitToWidthShortcut , RelativeZoomModeShortcut , RelativeDiscreteZoomModeShortcut , FitToHeightShortcut , ZoomInToCursorShortcut , ZoomOutFromCursorShortcut }

Public Member Functions
void	activate (int shortcut) override

void	begin (int shortcut, QEvent *event=0) override

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

void	deactivate (int shortcut) override

KisInputActionGroup	inputActionGroup (int shortcut) const override

void	inputEvent (QEvent *event) override

bool	isShortcutRequired (int shortcut) const override

	KisZoomAction ()

int	priority () const override

bool	supportsHiResInputEvents (int shortcut) const override

	~KisZoomAction () override

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

virtual QString	description () const

virtual void	end (QEvent *event)

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 {nullptr}

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

Zoom Canvas implementation of KisAbstractInputAction.

The Zoom Canvas action zooms the canvas.

Definition at line 17 of file kis_zoom_action.h.

Member Enumeration Documentation

◆ Shortcuts

enum KisZoomAction::Shortcuts

The different behaviours for this action.

Enumerator
ZoomModeShortcut	Toggle zoom mode.
DiscreteZoomModeShortcut	Toggle discrete zoom mode.
ZoomInShortcut	Zoom in by a fixed amount.
ZoomOutShortcut	Zoom out by a fixed amount.
Zoom100PctShortcut	Reset zoom to 100%.
FitToViewShortcut	Zoom fit to page.
FitToWidthShortcut	Zoom fit to width.
RelativeZoomModeShortcut	Toggle zoom mode relative to cursor.
RelativeDiscreteZoomModeShortcut	Toggle discrete zoom mode relative to cursor.
FitToHeightShortcut	Zoom fit to height.
ZoomInToCursorShortcut	Zoom in to cursor.
ZoomOutFromCursorShortcut	Zoom out from cursor.

Definition at line 23 of file kis_zoom_action.h.

                   {
        ZoomModeShortcut, 
        DiscreteZoomModeShortcut, 
        ZoomInShortcut, 
        ZoomOutShortcut, 
        Zoom100PctShortcut, 
        FitToViewShortcut, 
        FitToWidthShortcut, 
        RelativeZoomModeShortcut, 
        RelativeDiscreteZoomModeShortcut, 
        FitToHeightShortcut, 
        ZoomInToCursorShortcut, 
        ZoomOutFromCursorShortcut 
    };

Constructor & Destructor Documentation

◆ KisZoomAction()

KisZoomAction::KisZoomAction ( )

explicit

Definition at line 64 of file kis_zoom_action.cpp.

    : KisAbstractInputAction("Zoom Canvas")
    , d(new Private(this))
{
    setName(i18n("Zoom Canvas"));
    setDescription(i18n("The <i>Zoom Canvas</i> action zooms the canvas."));
 
    QHash< QString, int > shortcuts;
    shortcuts.insert(i18n("Zoom Mode"), ZoomModeShortcut);
    shortcuts.insert(i18n("Discrete Zoom Mode"), DiscreteZoomModeShortcut);
    shortcuts.insert(i18n("Relative Zoom Mode"), RelativeZoomModeShortcut);
    shortcuts.insert(i18n("Relative Discrete Zoom Mode"), RelativeDiscreteZoomModeShortcut);
    shortcuts.insert(i18n("Zoom In"), ZoomInShortcut);
    shortcuts.insert(i18n("Zoom Out"), ZoomOutShortcut);
    shortcuts.insert(i18n("Zoom In To Cursor"), ZoomInToCursorShortcut);
    shortcuts.insert(i18n("Zoom Out From Cursor"), ZoomOutFromCursorShortcut);
    shortcuts.insert(i18n("Zoom to 100%"), Zoom100PctShortcut);
    shortcuts.insert(i18n("Fit to View"), FitToViewShortcut);
    shortcuts.insert(i18n("Fit to View Width"), FitToWidthShortcut);
    shortcuts.insert(i18n("Fit to View Height"), FitToHeightShortcut);
    setShortcutIndexes(shortcuts);
}

References DiscreteZoomModeShortcut, FitToHeightShortcut, FitToViewShortcut, FitToWidthShortcut, RelativeDiscreteZoomModeShortcut, RelativeZoomModeShortcut, KisAbstractInputAction::setDescription(), KisAbstractInputAction::setName(), KisAbstractInputAction::setShortcutIndexes(), Zoom100PctShortcut, ZoomInShortcut, ZoomInToCursorShortcut, ZoomModeShortcut, ZoomOutFromCursorShortcut, and ZoomOutShortcut.

◆ ~KisZoomAction()

KisZoomAction::~KisZoomAction ( )

override

Definition at line 87 of file kis_zoom_action.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ activate()

void KisZoomAction::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 97 of file kis_zoom_action.cpp.

{
    if (shortcut == DiscreteZoomModeShortcut ||
        shortcut == RelativeDiscreteZoomModeShortcut) {
        QApplication::setOverrideCursor(KisCursor::zoomDiscreteCursor());
    } else /* if (shortcut == SmoothZoomModeShortcut) */ {
        QApplication::setOverrideCursor(KisCursor::zoomSmoothCursor());
    }
}

References DiscreteZoomModeShortcut, RelativeDiscreteZoomModeShortcut, KisCursor::zoomDiscreteCursor(), and KisCursor::zoomSmoothCursor().

◆ begin()

void KisZoomAction::begin	(	int	shortcut,
		QEvent *	event = 0 )

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 113 of file kis_zoom_action.cpp.

{
    KisAbstractInputAction::begin(shortcut, event);
 
    d->lastDistance = 0.f;
 
    switch(shortcut) {
        case ZoomModeShortcut:
        case RelativeZoomModeShortcut: {
            d->startZoom = inputManager()->canvas()->coordinatesConverter()->zoom();
            d->mode = (Shortcuts)shortcut;
            d->lastPosition = QPoint();
            d->actionStillPoint = inputManager()->canvas()->coordinatesConverter()->makeWidgetStillPoint(eventPosF(event));
            break;
        }
        case DiscreteZoomModeShortcut:
        case RelativeDiscreteZoomModeShortcut:
            d->startZoom = inputManager()->canvas()->coordinatesConverter()->zoom();
            d->lastDiscreteZoomDistance = 0;
            d->mode = (Shortcuts)shortcut;
            d->actionStillPoint = inputManager()->canvas()->coordinatesConverter()->makeWidgetStillPoint(eventPosF(event));
            break;
        case ZoomInShortcut:
        case ZoomOutShortcut:
        case ZoomInToCursorShortcut:
        case ZoomOutFromCursorShortcut: {
            KoCanvasControllerWidget *controller =
                dynamic_cast<KoCanvasControllerWidget *>(inputManager()->canvas()->canvasController());
            KIS_SAFE_ASSERT_RECOVER_RETURN(controller);
 
            QPoint pt;
            if (shortcut == ZoomInToCursorShortcut || shortcut == ZoomOutFromCursorShortcut) {
                pt = eventPos(event);
                if (pt.isNull()) {
                    pt = controller->mapFromGlobal(QCursor::pos());
                }
            }
 
            if (shortcut == ZoomInToCursorShortcut || shortcut == ZoomInShortcut) {
                if (pt.isNull()) {
                    controller->zoomIn();
                } else {
                    controller->zoomIn(inputManager()->canvas()->coordinatesConverter()->makeWidgetStillPoint(pt));
                }
            } else {
                if (pt.isNull()) {
                    controller->zoomOut();
                } else {
                    controller->zoomOut(inputManager()->canvas()->coordinatesConverter()->makeWidgetStillPoint(pt));
                }
            }
            break;
        }
        case Zoom100PctShortcut: {
            KoCanvasControllerWidget *controller =
                dynamic_cast<KoCanvasControllerWidget *>(inputManager()->canvas()->canvasController());
            controller->setZoom(KoZoomMode::ZOOM_CONSTANT, 1.0);
            break;
        }
        case FitToViewShortcut: {
            KoCanvasControllerWidget *controller =
                dynamic_cast<KoCanvasControllerWidget *>(inputManager()->canvas()->canvasController());
            controller->setZoom(KoZoomMode::ZOOM_PAGE, 1.0);
            break;
        }
        case FitToWidthShortcut: {
            KoCanvasControllerWidget *controller =
                dynamic_cast<KoCanvasControllerWidget *>(inputManager()->canvas()->canvasController());
            controller->setZoom(KoZoomMode::ZOOM_WIDTH, 1.0);
            break;
        }
        case FitToHeightShortcut: {
            KoCanvasControllerWidget *controller =
                dynamic_cast<KoCanvasControllerWidget *>(inputManager()->canvas()->canvasController());
            controller->setZoom(KoZoomMode::ZOOM_HEIGHT, 1.0);
            break;
        }
        }
}

References KisZoomAction::Private::actionStillPoint, KisAbstractInputAction::begin(), Private::canvas, KisInputManager::canvas(), KoCanvasBase::canvasController(), KisCanvas2::coordinatesConverter, d, DiscreteZoomModeShortcut, KisAbstractInputAction::eventPos(), KisAbstractInputAction::eventPosF(), FitToHeightShortcut, FitToViewShortcut, FitToWidthShortcut, KisAbstractInputAction::inputManager, KIS_SAFE_ASSERT_RECOVER_RETURN, KisZoomAction::Private::lastDiscreteZoomDistance, KisZoomAction::Private::lastDistance, KisZoomAction::Private::lastPosition, KisCoordinatesConverter::makeWidgetStillPoint(), KisZoomAction::Private::mode, RelativeDiscreteZoomModeShortcut, RelativeZoomModeShortcut, KoCanvasControllerWidget::setZoom(), KisZoomAction::Private::startZoom, KoZoomHandler::zoom(), Zoom100PctShortcut, KoZoomMode::ZOOM_CONSTANT, KoZoomMode::ZOOM_HEIGHT, KoZoomMode::ZOOM_PAGE, KoZoomMode::ZOOM_WIDTH, KoCanvasController::zoomIn(), ZoomInShortcut, ZoomInToCursorShortcut, ZoomModeShortcut, KoCanvasController::zoomOut(), ZoomOutFromCursorShortcut, and ZoomOutShortcut.

◆ cursorMovedAbsolute()

void KisZoomAction::cursorMovedAbsolute	(	const QPointF &	startPos,
		const QPointF &	pos )

overridevirtual

Reimplemented from KisAbstractInputAction.

Definition at line 293 of file kis_zoom_action.cpp.

{
    QPointF diff = -(pos - startPos);
 
    const int stepCont = 100;
    const int stepDisc = 50;
 
    if (d->mode == ZoomModeShortcut ||
        d->mode == RelativeZoomModeShortcut) {
 
        KisConfig cfg(true);
 
        const qreal logDistance = std::pow(2.0, qreal(cfg.zoomHorizontal() ? -diff.x() : diff.y()) / qreal(stepCont));
 
        qreal newZoom = 1.0;
        if (cfg.readEntry<bool>("InvertMiddleClickZoom", false)) {
            newZoom = d->startZoom / logDistance;
        } else {
            newZoom = d->startZoom * logDistance;
        }
 
        KoCanvasControllerWidget *controller =
            dynamic_cast<KoCanvasControllerWidget *>(inputManager()->canvas()->canvasController());
        KIS_SAFE_ASSERT_RECOVER_RETURN(controller);
 
        if (d->mode == ZoomModeShortcut) {
            controller->setZoom(KoZoomMode::ZOOM_CONSTANT, newZoom);
        } else {
            controller->setZoom(KoZoomMode::ZOOM_CONSTANT, newZoom, d->actionStillPoint);
        }
 
    } else if (d->mode == DiscreteZoomModeShortcut ||
               d->mode == RelativeDiscreteZoomModeShortcut) {
 
        KoCanvasControllerWidget *controller =
            dynamic_cast<KoCanvasControllerWidget *>(inputManager()->canvas()->canvasController());
        KIS_SAFE_ASSERT_RECOVER_RETURN(controller);
 
        KisConfig cfg(true);
 
        qreal axisDiff = qreal(cfg.zoomHorizontal() ? -diff.x() : diff.y());
        qreal currentDiff = axisDiff / stepDisc - d->lastDiscreteZoomDistance;
 
        const bool zoomIn = currentDiff > 0;
        while (qAbs(currentDiff) > 1.0) {
            if (zoomIn) {
                if (d->mode == RelativeDiscreteZoomModeShortcut) {
                    controller->zoomIn(d->actionStillPoint);
                } else {
                    controller->zoomIn();
                }
            } else {
                if (d->mode == RelativeDiscreteZoomModeShortcut) {
                    controller->zoomOut(d->actionStillPoint);
                } else {
                    controller->zoomOut();
                }
            }
            d->lastDiscreteZoomDistance += zoomIn ? 1.0 : -1.0;
            currentDiff = axisDiff / stepDisc - d->lastDiscreteZoomDistance;
        }
    }
}

References KisZoomAction::Private::actionStillPoint, KisInputManager::canvas(), KoCanvasBase::canvasController(), d, DiscreteZoomModeShortcut, KisAbstractInputAction::inputManager, KIS_SAFE_ASSERT_RECOVER_RETURN, KisZoomAction::Private::lastDiscreteZoomDistance, KisZoomAction::Private::mode, KisConfig::readEntry(), RelativeDiscreteZoomModeShortcut, RelativeZoomModeShortcut, KoCanvasControllerWidget::setZoom(), KisZoomAction::Private::startZoom, KoZoomMode::ZOOM_CONSTANT, KisConfig::zoomHorizontal(), KoCanvasController::zoomIn(), ZoomModeShortcut, and KoCanvasController::zoomOut().

◆ deactivate()

void KisZoomAction::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 107 of file kis_zoom_action.cpp.

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

◆ inputActionGroup()

KisInputActionGroup KisZoomAction::inputActionGroup ( int shortcut ) const

overridevirtual

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

Reimplemented from KisAbstractInputAction.

Definition at line 368 of file kis_zoom_action.cpp.

{
    Q_UNUSED(shortcut);
    return ViewTransformActionGroup;
}

References ViewTransformActionGroup.

◆ inputEvent()

void KisZoomAction::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 193 of file kis_zoom_action.cpp.

{
    switch (event->type()) {
        case QEvent::TouchUpdate: {
            QTouchEvent *tevent = static_cast<QTouchEvent*>(event);
 
            if (tevent->touchPoints().count() != 2) {
                // Sanity check. The input state machine should only invoke
                // this action if there are 2 TouchPoints in the event.
                return;
            }
 
            // First, let's determine if we want to handle this event. Sadly
            // the coordinates of TouchPoints reported by Qt are not always
            // dependable. TouchPoints that are just getting released can be
            // off by a significant amount. So we stop the zoom as soon as the
            // user lifts a finger.
 
            QTouchEvent::TouchPoint tp0 = tevent->touchPoints().at(0);
            QTouchEvent::TouchPoint tp1 = tevent->touchPoints().at(1);
            if (tp0.state() == Qt::TouchPointReleased ||
                    tp1.state() == Qt::TouchPointReleased) {
                // Force a recomputation of the position on the next event.
                d->lastPosition = QPoint();
                return;
            }
 
            QPointF p0 = tp0.pos();
            QPointF p1 = tp1.pos();
 
            // Make sure none of the TouchPoints are too close together, which
            // throws off the zoom calculations. This also addresses a glitch
            // where a newly pressed TouchPoint can incorrectly report another
            // existing TouchPoint's coordinates instead of its own.
 
            if ((p0-p1).manhattanLength() < 10) {
                d->lastPosition = QPointF();
                return;
            }
 
            // If this is the first valid set of points that we are getting,
            // then use that as the reference for the zoom.
 
            if (d->lastPosition.isNull()) {
                d->lastPosition = p0;
                d->lastDistance = 0;
                return;
            }
 
            float dist = QLineF(p0, p1).length();
            float delta = qFuzzyCompare(1.0f, 1.0f + d->lastDistance) ? 1.f : dist / d->lastDistance;
 
            // Workaround: only apply the zoom delta if it's not too
            // outlandish. As explained above, TouchPoint coordinates are not
            // always 100% reliable.
 
            if(qAbs(delta) < 0.8f || qAbs(delta) > 1.2f) {
                // TouchPoint coordinates tend to converge toward correct
                // values over time, so assume that the new position is
                // likelier to be correct than the last and use that as the new
                // reference.
                d->lastPosition = p0;
                return;
            }
 
            KisCanvasController *controller = static_cast<KisCanvasController *>(inputManager()->canvas()->canvasController());
            const qreal newZoom = controller->canvas()->viewConverter()->zoom() * delta;
            KoViewTransformStillPoint adjustedStillPoint = d->actionStillPoint;
            adjustedStillPoint.second = p0;
            controller->setZoom(KoZoomMode::ZOOM_CONSTANT, newZoom, adjustedStillPoint);
            d->lastDistance = dist;
            d->lastPosition = p0;
            return;  // Don't try to update the cursor during a pinch-zoom
        }
        case QEvent::NativeGesture: {
            QNativeGestureEvent *gevent = static_cast<QNativeGestureEvent*>(event);
            if (gevent->gestureType() == Qt::ZoomNativeGesture) {
                KisCanvas2 *canvas = inputManager()->canvas();
                KisCanvasController *controller = static_cast<KisCanvasController*>(canvas->canvasController());
                const qreal delta = 1.0f + gevent->value();
                const qreal newZoom = controller->canvas()->viewConverter()->zoom() * delta;
                controller->setZoom(KoZoomMode::ZOOM_CONSTANT, newZoom, d->actionStillPoint);
            } else if (gevent->gestureType() == Qt::SmartZoomNativeGesture) {
                KisCanvas2 *canvas = inputManager()->canvas();
                KoCanvasController *controller = canvas->canvasController();
 
                if (controller->zoomState().mode != KoZoomMode::ZOOM_WIDTH) {
                    controller->setZoom(KoZoomMode::ZOOM_WIDTH, 1.0);
                } else {
                    controller->setZoom(KoZoomMode::ZOOM_CONSTANT, 1.0);
                }
            }
            return;
        }
        default:
            break;
    }
    KisAbstractInputAction::inputEvent(event);
}

References KisZoomAction::Private::actionStillPoint, Private::canvas, KoCanvasControllerWidget::canvas, KisInputManager::canvas(), KoCanvasBase::canvasController(), d, KisAbstractInputAction::inputEvent(), KisAbstractInputAction::inputManager, KisZoomAction::Private::lastDistance, KisZoomAction::Private::lastPosition, KoZoomState::mode, p0, p1, qFuzzyCompare(), KoCanvasControllerWidget::setZoom(), KoCanvasController::setZoom(), KoZoomMode::ZOOM_CONSTANT, KoZoomMode::ZOOM_WIDTH, and KoCanvasController::zoomState().

◆ isShortcutRequired()

bool KisZoomAction::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 357 of file kis_zoom_action.cpp.

{
    return shortcut == ZoomModeShortcut;
}

References ZoomModeShortcut.

◆ priority()

int KisZoomAction::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 92 of file kis_zoom_action.cpp.

{
    return 4;
}

◆ supportsHiResInputEvents()

bool KisZoomAction::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 362 of file kis_zoom_action.cpp.

{
    Q_UNUSED(shortcut);
    return true;
}

Member Data Documentation

◆ d

Private* const KisZoomAction::d {nullptr}

private

Definition at line 56 of file kis_zoom_action.h.

56{nullptr};

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

libs/ui/input/kis_zoom_action.h
libs/ui/input/kis_zoom_action.cpp

Classes

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Shortcuts

Constructor & Destructor Documentation

◆ KisZoomAction()

◆ ~KisZoomAction()

Member Function Documentation

◆ activate()

◆ begin()

◆ cursorMovedAbsolute()

◆ deactivate()

◆ inputActionGroup()

◆ inputEvent()

◆ isShortcutRequired()

◆ priority()

◆ supportsHiResInputEvents()

Member Data Documentation

◆ d