KisZoomAction Class Reference

Zoom Canvas implementation of KisAbstractInputAction. More...

#include <kis_zoom_action.h>

Inheritance diagram for KisZoomAction:

Classes
class	Private

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

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
void	end (QEvent *event) 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 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 {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.
ZoomInToCursorShortcut	Zoom in to cursor.
ZoomOutFromCursorShortcut	Zoom out from cursor.
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.
ZoomInShortcut	Zoom in by a fixed amount.
ZoomOutShortcut	Zoom out by a fixed amount.

Definition at line 23 of file kis_zoom_action.h.

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

Constructor & Destructor Documentation

KisZoomAction()

KisZoomAction::KisZoomAction ( )

explicit

Definition at line 45 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 68 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 78 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.

Firstly, try to handle native gestures and touch events

Reimplemented from KisAbstractInputAction.

Definition at line 94 of file kis_zoom_action.cpp.

{
    KisAbstractInputAction::begin(shortcut, event);
 
    if (event
        && (event->type() == QEvent::NativeGesture || event->type() == QEvent::TouchBegin
            || event->type() == QEvent::TouchUpdate)
        && (shortcut == ZoomModeShortcut || shortcut == RelativeZoomModeShortcut || shortcut == DiscreteZoomModeShortcut
            || shortcut == RelativeDiscreteZoomModeShortcut)) {
        using Flag = KisCanvasNavigationActionStrategyNativeGesture::Flag;
        using Flags = KisCanvasNavigationActionStrategyNativeGesture::Flags;
 
        Flags flags;
        flags.setFlag(Flag::PanEnabled);
        flags.setFlag(Flag::ZoomEnabled);
        flags.setFlag(Flag::ZoomDescrete,
                      shortcut == DiscreteZoomModeShortcut || shortcut == RelativeDiscreteZoomModeShortcut);
 
        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;
    }
 
    switch(shortcut) {
        case ZoomModeShortcut:
        case RelativeZoomModeShortcut: {
            d->startZoom = inputManager()->canvas()->coordinatesConverter()->zoom();
            d->mode = (Shortcuts)shortcut;
            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, KisZoomAction::Private::actionStrategy, 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, 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 220 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 88 of file kis_zoom_action.cpp.

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

end()

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

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

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

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

{
    if(!event) {
        return;
    }
 
    if (d->actionStrategy && d->actionStrategy->supportsEvent(event)) {
        d->actionStrategy->inputEvent(event);
        return;
    } else {
        KisAbstractInputAction::inputEvent(event);
    }
}

References KisZoomAction::Private::actionStrategy, d, and KisAbstractInputAction::inputEvent().

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 284 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 73 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 289 of file kis_zoom_action.cpp.

{
    Q_UNUSED(shortcut);
    return true;
}

Member Data Documentation

d

Private* const KisZoomAction::d {nullptr}

private

Definition at line 57 of file kis_zoom_action.h.

{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