#include <kis_canvas_controller.h>

Inheritance diagram for KisCanvasController:

Classes
struct	Private

Public Slots
void	beginCanvasRotation ()

void	endCanvasRotation ()

void	mirrorCanvas (bool enable)

void	mirrorCanvasAroundCanvas (bool enable)

void	mirrorCanvasAroundCursor (bool enable)

void	resetCanvasRotation ()

void	rotateCanvas (qreal angle)

void	rotateCanvasLeft15 ()

void	rotateCanvasRight15 ()

qreal	rotation () const

void	setUsePrintResolutionMode (bool value)

void	slotSetWrapAroundModeAxis (WrapAroundAxis axis)

void	slotSetWrapAroundModeAxisH ()

void	slotSetWrapAroundModeAxisHV ()

void	slotSetWrapAroundModeAxisV ()

void	slotToggleLevelOfDetailMode (bool value)

void	slotTogglePixelGrid (bool value)

void	slotToggleWrapAroundMode (bool value)

Signals
void	documentSizeChanged ()

void	sigUsePrintResolutionModeChanged (bool value)

Public Member Functions
void	activate () override
	Reimplemented from KoCanvasController.

KisCanvasState	canvasState () const override

QPointF	currentCursorPosition () const override

qreal	effectiveCanvasResolutionX () const

qreal	effectiveCanvasResolutionY () const

void	ensureVisibleDoc (const QRectF &docRect, bool smooth) override
	Scrolls the content of the canvas so that the given rect is visible.

bool	eventFilter (QObject watched, QEvent event) override

void	keyPressEvent (QKeyEvent *event) override

	KisCanvasController (QPointer< KisView >parent, KoCanvasSupervisor observerProvider, KisKActionCollection actionCollection)

bool	levelOfDetailMode () const

QPointF	preferredCenter () const override
	Returns the currently set preferred center point in view coordinates (pixels)

void	resetScrollBars () override

void	restoreCanvasState (const KisPropertiesConfiguration &config)

void	rotateCanvas (qreal angle, const std::optional< KoViewTransformStillPoint > &stillPoint, bool isNativeGesture=false)

void	saveCanvasState (KisPropertiesConfiguration &config) const

void	setCanvas (KoCanvasBase *canvas) override

void	setPreferredCenter (const QPointF &viewPoint) override

void	syncOnImageResolutionChange ()

void	syncOnImageSizeChange (const QPointF &oldStillPoint, const QPointF &newStillPoint)

void	syncOnReferencesChange (const QRectF &referencesRect)

void	updateScreenResolution (QWidget *parentWidget)

bool	usePrintResolutionMode ()

void	wheelEvent (QWheelEvent *event) override

bool	wrapAroundMode () const

WrapAroundAxis	wrapAroundModeAxis () const

void	zoomIn () override

void	zoomIn (const KoViewTransformStillPoint &widgetStillPoint) override
	zooms in keeping `stillPoint` not moved.

void	zoomOut () override

void	zoomOut (const KoViewTransformStillPoint &widgetStillPoint) override
	zooms out keeping `stillPoint` not moved.

KoZoomState	zoomState () const override

	~KisCanvasController () override

Public Member Functions inherited from KoCanvasControllerWidget
void	activate ()

KoCanvasBase *	canvas () const override

virtual void	changeCanvasWidget (QWidget *widget)

	KoCanvasControllerWidget (KisKActionCollection actionCollection, KoCanvasSupervisor observerProvider, QWidget *parent=0)

void	pan (const QPoint &distance) override

virtual void	panDown () override

virtual void	panLeft () override

virtual void	panRight () override

virtual void	panUp () override

KoCanvasControllerWidget::Private *	priv ()

	Private (KoCanvasControllerWidget qq, KoCanvasSupervisor observerProvider)

QPoint	scrollBarValue () const override

void	scrollContentsBy (int dx, int dy) override

void	setCanvas (KoCanvasBase *canvas) override

void	setScrollBarValue (const QPoint &value) override

void	setToolOptionWidgets (const QList< QPointer< QWidget > > &widgets)

void	setZoom (KoZoomMode::Mode mode, qreal zoom) override

void	setZoom (KoZoomMode::Mode mode, qreal zoom, const KoViewTransformStillPoint &stillPoint)

void	setZoom (KoZoomMode::Mode mode, qreal zoom, qreal resolutionX, qreal resolutionY)

void	setZoom (KoZoomMode::Mode mode, qreal zoom, qreal resolutionX, qreal resolutionY, const std::optional< KoViewTransformStillPoint > &docStillPoint)

void	unsetCanvas ()

void	zoomTo (const QRect &rect) override
	zoom so that rect is exactly visible (as close as possible)

	~KoCanvasControllerWidget () override

Public Member Functions inherited from KoCanvasController
KisKActionCollection *	actionCollection () const

	KoCanvasController (KisKActionCollection *actionCollection)

	Private ()

virtual	~KoCanvasController ()

Protected Member Functions
void	updateCanvasOffsetInternal (const QPointF &newOffset) override

void	updateCanvasWidgetSizeInternal (const QSize &newSize) override

void	updateCanvasZoomInternal (KoZoomMode::Mode mode, qreal zoom, qreal resolutionX, qreal resolutionY, const std::optional< KoViewTransformStillPoint > &docStillPoint) override

void	zoomToInternal (const QRect &viewRect) override

Protected Member Functions inherited from KoCanvasControllerWidget
void	dragEnterEvent (QDragEnterEvent *event) override
	reimplemented from QWidget

void	dragLeaveEvent (QDragLeaveEvent *event) override
	reimplemented from QWidget

void	dragMoveEvent (QDragMoveEvent *event) override
	reimplemented from QWidget

void	dropEvent (QDropEvent *event) override
	reimplemented from QWidget

void	emitSignals (const KisCanvasState &oldState, const KisCanvasState &newState)

bool	focusNextPrevChild (bool next) override
	reimplemented from QWidget

void	paintEvent (QPaintEvent *event) override
	reimplemented from QWidget

void	resizeEvent (QResizeEvent *resizeEvent) override
	reimplemented from QWidget

bool	viewportEvent (QEvent *event) override
	reimplemented from QAbstractScrollArea

Protected Member Functions inherited from KoCanvasController
void	setDocumentOffset (const QPoint &offset)

Private Member Functions
void	mirrorCanvasImpl (const std::optional< KoViewTransformStillPoint > &stillPoint, bool enable)

void	zoomInImpl (const std::optional< KoViewTransformStillPoint > &stillPoint)

void	zoomOutImpl (const std::optional< KoViewTransformStillPoint > &stillPoint)

Private Attributes
Private *const	m_d

Additional Inherited Members
Public Attributes inherited from KoCanvasControllerWidget
QPointer< KoCanvasBase >	canvas

bool	ignoreScrollSignals

KoCanvasSupervisor *	observerProvider

KoCanvasControllerWidget *	q

Viewport *	viewportWidget

Public Attributes inherited from KoCanvasController
KisKActionCollection *	actionCollection

QPoint	documentOffset

QSizeF	documentSize

qreal	preferredCenterFractionX

qreal	preferredCenterFractionY

QPointer< KoCanvasControllerProxyObject >	proxyObject

Detailed Description

Definition at line 23 of file kis_canvas_controller.h.

Constructor & Destructor Documentation

◆ KisCanvasController()

KisCanvasController::KisCanvasController	(	QPointer< KisView >	parent,
		KoCanvasSupervisor *	observerProvider,
		KisKActionCollection *	actionCollection )

Definition at line 74 of file kis_canvas_controller.cpp.

    : KoCanvasControllerWidget(actionCollection, observerProvider, parent),
      m_d(new Private(this))
{
    m_d->view = parent;
}

References m_d, and KisCanvasController::Private::view.

◆ ~KisCanvasController()

KisCanvasController::~KisCanvasController ( )

override

Definition at line 81 of file kis_canvas_controller.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

◆ activate()

void KisCanvasController::activate ( )

overridevirtual

Reimplemented from KoCanvasController.

Activate this canvascontroller

Reimplemented from KoCanvasControllerWidget.

Definition at line 129 of file kis_canvas_controller.cpp.

{
    KoCanvasControllerWidget::activate();
}

References KoCanvasControllerWidget::activate().

◆ beginCanvasRotation

void KisCanvasController::beginCanvasRotation ( )

slot

Definition at line 279 of file kis_canvas_controller.cpp.

{
    m_d->coordinatesConverter->beginRotation();
}

References KisCoordinatesConverter::beginRotation(), KisCanvasController::Private::coordinatesConverter, and m_d.

◆ canvasState()

KisCanvasState KisCanvasController::canvasState ( ) const

overridevirtual

Implements KoCanvasControllerWidget.

Definition at line 526 of file kis_canvas_controller.cpp.

{
    return KisCanvasState::fromConverter(*m_d->coordinatesConverter);
}

References KisCanvasController::Private::coordinatesConverter, KisCanvasState::fromConverter(), and m_d.

◆ currentCursorPosition()

QPointF KisCanvasController::currentCursorPosition ( ) const

overridevirtual

Returns: the current position of the cursor fetched from QCursor::pos() and converted into document coordinates

Implements KoCanvasController.

Definition at line 134 of file kis_canvas_controller.cpp.

{
    KoCanvasBase *canvas = m_d->view->canvasBase();
    QWidget *canvasWidget = canvas->canvasWidget();
    const QPointF cursorPosWidget = canvasWidget->mapFromGlobal(QCursor::pos());
 
    return m_d->coordinatesConverter->widgetToDocument(cursorPosWidget);
}

References KoCanvasControllerWidget::canvas, KisCanvasController::Private::coordinatesConverter, m_d, KisCanvasController::Private::view, and KisCoordinatesConverter::widgetToDocument().

◆ documentSizeChanged

void KisCanvasController::documentSizeChanged ( )

signal

◆ effectiveCanvasResolutionX()

qreal KisCanvasController::effectiveCanvasResolutionX ( ) const

Definition at line 117 of file kis_canvas_controller.cpp.

{
    KisImageSP image = m_d->view->image();
    return m_d->usePrintResolutionMode ? POINT_TO_INCH(m_d->physicalDpiX) : image->xRes() / m_d->devicePixelRatio;
}

References KisCanvasController::Private::devicePixelRatio, m_d, KisCanvasController::Private::physicalDpiX, POINT_TO_INCH(), KisCanvasController::Private::usePrintResolutionMode, KisCanvasController::Private::view, and KisImage::xRes().

◆ effectiveCanvasResolutionY()

qreal KisCanvasController::effectiveCanvasResolutionY ( ) const

Definition at line 123 of file kis_canvas_controller.cpp.

{
    KisImageSP image = m_d->view->image();
    return m_d->usePrintResolutionMode ? POINT_TO_INCH(m_d->physicalDpiY) : image->yRes() / m_d->devicePixelRatio;
}

References KisCanvasController::Private::devicePixelRatio, m_d, KisCanvasController::Private::physicalDpiY, POINT_TO_INCH(), KisCanvasController::Private::usePrintResolutionMode, KisCanvasController::Private::view, and KisImage::yRes().

◆ endCanvasRotation

void KisCanvasController::endCanvasRotation ( )

slot

Definition at line 284 of file kis_canvas_controller.cpp.

{
    m_d->coordinatesConverter->endRotation();
}

References KisCanvasController::Private::coordinatesConverter, KisCoordinatesConverter::endRotation(), and m_d.

◆ ensureVisibleDoc()

void KisCanvasController::ensureVisibleDoc	(	const QRectF &	docRect,
		bool	smooth )

overridevirtual

Scrolls the content of the canvas so that the given rect is visible.

The rect is to be specified in document coordinates (points). The scrollbar positions are changed so that the centerpoint of the rectangle is centered if possible.

Parameters

rect	the rectangle to make visible
smooth	if true the viewport translation will make be just enough to ensure visibility, no more.

Implements KoCanvasController.

Definition at line 181 of file kis_canvas_controller.cpp.

{
    const QRect currentVisible = viewport()->rect();
    const QRect viewRect = m_d->coordinatesConverter->documentToWidget(docRect).toAlignedRect();
 
    if (!viewRect.isValid() || currentVisible.contains(viewRect))
        return; // its visible. Nothing to do.
 
    // if we move, we move a little more so the amount of times we have to move is less.
    int jumpWidth = smooth ? 0 : currentVisible.width() / 5;
    int jumpHeight = smooth ? 0 : currentVisible.height() / 5;
    if (!smooth && viewRect.width() + jumpWidth > currentVisible.width())
        jumpWidth = 0;
    if (!smooth && viewRect.height() + jumpHeight > currentVisible.height())
        jumpHeight = 0;
 
    int horizontalMove = 0;
    if (currentVisible.width() <= viewRect.width())      // center view
        horizontalMove = viewRect.center().x() - currentVisible.center().x();
    else if (currentVisible.x() > viewRect.x())          // move left
        horizontalMove = viewRect.x() - currentVisible.x() - jumpWidth;
    else if (currentVisible.right() < viewRect.right())  // move right
        horizontalMove = viewRect.right() - qMax(0, currentVisible.right() - jumpWidth);
 
    int verticalMove = 0;
    if (currentVisible.height() <= viewRect.height())       // center view
        verticalMove = viewRect.center().y() - currentVisible.center().y();
    if (currentVisible.y() > viewRect.y())               // move up
        verticalMove = viewRect.y() - currentVisible.y() - jumpHeight;
    else if (currentVisible.bottom() < viewRect.bottom()) // move down
        verticalMove = viewRect.bottom() - qMax(0, currentVisible.bottom() - jumpHeight);
 
    pan(QPoint(horizontalMove, verticalMove));
}

References KisCanvasController::Private::coordinatesConverter, KisCoordinatesConverter::documentToWidget(), m_d, and KoCanvasControllerWidget::pan().

◆ eventFilter()

bool KisCanvasController::eventFilter	(	QObject *	watched,
		QEvent *	event )

override

Definition at line 163 of file kis_canvas_controller.cpp.

{
    KoCanvasBase *canvas = this->canvas();
    if (!canvas || !canvas->canvasWidget() || canvas->canvasWidget() != watched) return false;
 
    if (event->type() == QEvent::MouseMove) {
        QMouseEvent *mevent = static_cast<QMouseEvent*>(event);
        m_d->mousePositionCompressor->start(mevent->pos());
    } else if (event->type() == QEvent::TabletMove) {
        QTabletEvent *tevent = static_cast<QTabletEvent*>(event);
        m_d->mousePositionCompressor->start(tevent->pos());
    } else if (event->type() == QEvent::FocusIn) {
        m_d->view->syncLastActiveNodeToDocument();
    }
 
    return false;
}

References KoCanvasControllerWidget::canvas, m_d, KisCanvasController::Private::mousePositionCompressor, and KisCanvasController::Private::view.

◆ keyPressEvent()

void KisCanvasController::keyPressEvent ( QKeyEvent * event )

override

Dirty Hack Alert: Do not call the KoCanvasControllerWidget::keyPressEvent() to avoid activation of Pan and Default tool activation shortcuts

Definition at line 143 of file kis_canvas_controller.cpp.

{
    Q_UNUSED(event);
}

◆ levelOfDetailMode()

bool KisCanvasController::levelOfDetailMode ( ) const

Definition at line 429 of file kis_canvas_controller.cpp.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    return kritaCanvas->lodPreferredInCanvas();
}

References KoCanvasControllerWidget::canvas, and KisCanvas2::lodPreferredInCanvas().

◆ mirrorCanvas

void KisCanvasController::mirrorCanvas ( bool enable )

slot

Definition at line 237 of file kis_canvas_controller.cpp.

{
    mirrorCanvasImpl(std::nullopt, enable);
}

References mirrorCanvasImpl().

◆ mirrorCanvasAroundCanvas

void KisCanvasController::mirrorCanvasAroundCanvas ( bool enable )

slot

Definition at line 261 of file kis_canvas_controller.cpp.

{
    auto stillPoint =
        m_d->coordinatesConverter->makeDocStillPoint(
            m_d->coordinatesConverter->imageRectInDocumentPixels().center());
    mirrorCanvasImpl(stillPoint, enable);
}

References KisCanvasController::Private::coordinatesConverter, KisCoordinatesConverter::imageRectInDocumentPixels(), m_d, KisCoordinatesConverter::makeDocStillPoint(), and mirrorCanvasImpl().

◆ mirrorCanvasAroundCursor

void KisCanvasController::mirrorCanvasAroundCursor ( bool enable )

slot

Definition at line 242 of file kis_canvas_controller.cpp.

{
    QVariant customPos = sender()->property("customPosition");
    QPoint pos = customPos.isValid()
        ? customPos.value<QPoint>()
        : QCursor::pos();
    KoCanvasBase* canvas = m_d->view->canvasBase();
    QWidget *canvasWidget = canvas->canvasWidget();
    const QPointF cursorPosWidget = canvasWidget->mapFromGlobal(pos);
 
    std::optional<KoViewTransformStillPoint> stillPoint;
 
    if (canvasWidget->rect().contains(cursorPosWidget.toPoint())) {
        stillPoint = m_d->coordinatesConverter->makeWidgetStillPoint(cursorPosWidget);
    }
 
    mirrorCanvasImpl(stillPoint, enable);
}

References KoCanvasControllerWidget::canvas, KisCanvasController::Private::coordinatesConverter, m_d, KisCoordinatesConverter::makeWidgetStillPoint(), mirrorCanvasImpl(), and KisCanvasController::Private::view.

◆ mirrorCanvasImpl()

void KisCanvasController::mirrorCanvasImpl	(	const std::optional< KoViewTransformStillPoint > &	stillPoint,
		bool	enable )

private

Definition at line 227 of file kis_canvas_controller.cpp.

{
    const KisCanvasState oldCanvasState = canvasState();
    m_d->coordinatesConverter->mirror(stillPoint, enable, false);
    const KisCanvasState newCanvasState = canvasState();
    emitSignals(oldCanvasState, newCanvasState);
 
    m_d->showMirrorStateOnCanvas();
}

References canvasState(), KisCanvasController::Private::coordinatesConverter, KoCanvasControllerWidget::emitSignals(), m_d, KisCoordinatesConverter::mirror(), and KisCanvasController::Private::showMirrorStateOnCanvas().

◆ preferredCenter()

QPointF KisCanvasController::preferredCenter ( ) const

overridevirtual

Returns the currently set preferred center point in view coordinates (pixels)

Implements KoCanvasController.

Definition at line 536 of file kis_canvas_controller.cpp.

{
    const QPointF transformedImageBoundsTopleft = m_d->coordinatesConverter->imageRectInWidgetPixels().topLeft();
    return m_d->coordinatesConverter->widgetCenterPoint() - transformedImageBoundsTopleft;
}

References KisCanvasController::Private::coordinatesConverter, KisCoordinatesConverter::imageRectInWidgetPixels(), m_d, and KisCoordinatesConverter::widgetCenterPoint().

◆ resetCanvasRotation

void KisCanvasController::resetCanvasRotation ( )

slot

Definition at line 322 of file kis_canvas_controller.cpp.

{
    const KisCanvasState oldCanvasState = canvasState();
    m_d->coordinatesConverter->resetRotation(std::nullopt);
    const KisCanvasState newCanvasState = canvasState();
    emitSignals(oldCanvasState, newCanvasState);
 
    m_d->showRotationValueOnCanvas();
}

References canvasState(), KisCanvasController::Private::coordinatesConverter, KoCanvasControllerWidget::emitSignals(), m_d, KisCoordinatesConverter::resetRotation(), and KisCanvasController::Private::showRotationValueOnCanvas().

◆ resetScrollBars()

void KisCanvasController::resetScrollBars ( )

overridevirtual

Update the range of scroll bars

Implements KoCanvasController.

Definition at line 601 of file kis_canvas_controller.cpp.

{
    // The scrollbar value always points at the top-left corner of the
    // bit of image we paint.
 
    const QPoint minOffset = m_d->coordinatesConverter->minimumOffset();
    const QPoint maxOffset = m_d->coordinatesConverter->maximumOffset();
    const QPoint offset = m_d->coordinatesConverter->documentOffset();
 
    QScrollBar *hScroll = horizontalScrollBar();
    QScrollBar *vScroll = verticalScrollBar();
 
    QSignalBlocker b1(hScroll);
    QSignalBlocker b2(vScroll);
 
    hScroll->setRange(minOffset.x(), maxOffset.x());
    hScroll->setValue(offset.x());
    vScroll->setRange(minOffset.y(), maxOffset.y());
    vScroll->setValue(offset.y());
 
    const int drawH = viewport()->height() / 4;
    const int drawW = viewport()->width() / 4;
    const int fontHeight = QFontMetrics(font()).height();
 
    vScroll->setPageStep(drawH);
    vScroll->setSingleStep(fontHeight);
    hScroll->setPageStep(drawW);
    hScroll->setSingleStep(fontHeight);
}

References KisCanvasController::Private::coordinatesConverter, KisCoordinatesConverter::documentOffset(), m_d, KisCoordinatesConverter::maximumOffset(), and KisCoordinatesConverter::minimumOffset().

◆ restoreCanvasState()

void KisCanvasController::restoreCanvasState ( const KisPropertiesConfiguration & config )

Definition at line 450 of file kis_canvas_controller.cpp.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    mirrorCanvas(config.getBool("mirror", false));
    rotateCanvas(config.getFloat("rotation", 0.0f));
 
    const QPointF &center = preferredCenter();
    float panX = config.getFloat("panX", center.x());
    float panY = config.getFloat("panY", center.y());
    setPreferredCenter(QPointF(panX, panY));
 
    slotToggleWrapAroundMode(config.getBool("wrapAround", false));
    slotSetWrapAroundModeAxis((WrapAroundAxis)config.getInt("wrapAroundAxis", 0));
    kritaCanvas->setLodPreferredInCanvas(config.getBool("enableInstantPreview", false));
}

References KoCanvasControllerWidget::canvas, KisPropertiesConfiguration::getBool(), KisPropertiesConfiguration::getFloat(), KisPropertiesConfiguration::getInt(), mirrorCanvas(), preferredCenter(), rotateCanvas(), KisCanvas2::setLodPreferredInCanvas(), setPreferredCenter(), slotSetWrapAroundModeAxis(), and slotToggleWrapAroundMode().

◆ rotateCanvas [1/2]

void KisCanvasController::rotateCanvas ( qreal angle )

slot

Definition at line 302 of file kis_canvas_controller.cpp.

{
    rotateCanvas(angle, std::nullopt);
}

References rotateCanvas().

◆ rotateCanvas() [2/2]

void KisCanvasController::rotateCanvas	(	qreal	angle,
		const std::optional< KoViewTransformStillPoint > &	stillPoint,
		bool	isNativeGesture = false )

Definition at line 289 of file kis_canvas_controller.cpp.

{
    if(isNativeGesture) {
        m_d->coordinatesConverter->enableNatureGestureFlag();
    }
    const KisCanvasState oldCanvasState = canvasState();
    m_d->coordinatesConverter->rotate(stillPoint, angle);
    const KisCanvasState newCanvasState = canvasState();
    emitSignals(oldCanvasState, newCanvasState);
 
    m_d->showRotationValueOnCanvas();
}

References canvasState(), KisCanvasController::Private::coordinatesConverter, KoCanvasControllerWidget::emitSignals(), KisCoordinatesConverter::enableNatureGestureFlag(), m_d, KisCoordinatesConverter::rotate(), and KisCanvasController::Private::showRotationValueOnCanvas().

◆ rotateCanvasLeft15

void KisCanvasController::rotateCanvasLeft15 ( )

slot

Definition at line 312 of file kis_canvas_controller.cpp.

{
    rotateCanvas(-15.0);
}

References rotateCanvas().

◆ rotateCanvasRight15

void KisCanvasController::rotateCanvasRight15 ( )

slot

Definition at line 307 of file kis_canvas_controller.cpp.

{
    rotateCanvas(15.0);
}

References rotateCanvas().

◆ rotation

qreal KisCanvasController::rotation ( ) const

slot

Definition at line 317 of file kis_canvas_controller.cpp.

{
    return m_d->coordinatesConverter->rotationAngle();
}

References KisCanvasController::Private::coordinatesConverter, m_d, and KisCoordinatesConverter::rotationAngle().

◆ saveCanvasState()

void KisCanvasController::saveCanvasState ( KisPropertiesConfiguration & config ) const

Definition at line 437 of file kis_canvas_controller.cpp.

{
    const QPointF &center = preferredCenter();
    config.setProperty("panX", center.x());
    config.setProperty("panY", center.y());
 
    config.setProperty("rotation", rotation());
    config.setProperty("mirror", m_d->coordinatesConverter->xAxisMirrored());
    config.setProperty("wrapAround", wrapAroundMode());
    config.setProperty("wrapAroundAxis", wrapAroundModeAxis());
    config.setProperty("enableInstantPreview", levelOfDetailMode());
}

References KisCanvasController::Private::coordinatesConverter, levelOfDetailMode(), m_d, preferredCenter(), rotation(), KisPropertiesConfiguration::setProperty(), wrapAroundMode(), wrapAroundModeAxis(), and KisCoordinatesConverter::xAxisMirrored().

◆ setCanvas()

void KisCanvasController::setCanvas ( KoCanvasBase * canvas )

overridevirtual

Set the new canvas to be shown as a child Calling this will Q_EMIT canvasRemoved() if there was a canvas before, and will emit canvasSet() with the new canvas.

Parameters

canvas the new canvas. The KoCanvasBase::canvas() will be called to retrieve the actual widget which will then be added as child of this one.

Implements KoCanvasController.

Definition at line 86 of file kis_canvas_controller.cpp.

{
    if (canvas) {
        KisCanvas2 *kritaCanvas = qobject_cast<KisCanvas2*>(canvas);
        m_d->coordinatesConverter =
            const_cast<KisCoordinatesConverter*>(kritaCanvas->coordinatesConverter());
    } else {
        m_d->coordinatesConverter = 0;
    }
 
    KoCanvasControllerWidget::setCanvas(canvas);
}

References KoCanvasControllerWidget::canvas, KisCanvas2::coordinatesConverter, KisCanvasController::Private::coordinatesConverter, m_d, and KoCanvasControllerWidget::setCanvas().

◆ setPreferredCenter()

void KisCanvasController::setPreferredCenter ( const QPointF & viewPoint )

overridevirtual

Sets the preferred center point in view coordinates (pixels).

Parameters

viewPoint the new preferred center

Implements KoCanvasController.

Definition at line 542 of file kis_canvas_controller.cpp.

{
    const KisCanvasState oldState = canvasState();
 
    const QPointF expectedTransformedImageBoundsTopleft = m_d->coordinatesConverter->widgetCenterPoint() - viewPoint;
    updateCanvasOffsetInternal(-expectedTransformedImageBoundsTopleft);
 
    emitSignals(oldState, canvasState());
}

References canvasState(), KisCanvasController::Private::coordinatesConverter, KoCanvasControllerWidget::emitSignals(), m_d, updateCanvasOffsetInternal(), and KisCoordinatesConverter::widgetCenterPoint().

◆ setUsePrintResolutionMode

void KisCanvasController::setUsePrintResolutionMode ( bool value )

slot

Definition at line 636 of file kis_canvas_controller.cpp.

{
    const bool changed = value != m_d->usePrintResolutionMode;
 
    KisImageSP image = m_d->view->image();
 
    // changeCanvasMappingMode is called with the same canvasMappingMode when the window is
    // moved across screens. Preserve the old zoomMode if this is the case.
    const KoZoomMode::Mode newMode =
            !changed ? m_d->coordinatesConverter->zoomMode() : KoZoomMode::ZOOM_CONSTANT;
    const qreal newZoom = m_d->coordinatesConverter->zoom();
 
    m_d->usePrintResolutionMode = value;
 
    setZoom(newMode, newZoom, effectiveCanvasResolutionX(), effectiveCanvasResolutionY());
 
    if (changed) {
        Q_EMIT sigUsePrintResolutionModeChanged(value);
    }
}

References KisCanvasController::Private::coordinatesConverter, effectiveCanvasResolutionX(), effectiveCanvasResolutionY(), m_d, KoCanvasControllerWidget::setZoom(), sigUsePrintResolutionModeChanged(), KisCanvasController::Private::usePrintResolutionMode, value(), KisCanvasController::Private::view, KoZoomHandler::zoom(), KoZoomMode::ZOOM_CONSTANT, and KoZoomHandler::zoomMode().

◆ sigUsePrintResolutionModeChanged

void KisCanvasController::sigUsePrintResolutionModeChanged ( bool value )

signal

◆ slotSetWrapAroundModeAxis

void KisCanvasController::slotSetWrapAroundModeAxis ( WrapAroundAxis axis )

slot

Definition at line 353 of file kis_canvas_controller.cpp.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    kritaCanvas->setWrapAroundViewingModeAxis(value);
    kritaCanvas->image()->setWrapAroundModeAxis(value);
}

References KoCanvasControllerWidget::canvas, KisCanvas2::image(), KisImage::setWrapAroundModeAxis(), KisCanvas2::setWrapAroundViewingModeAxis(), and value().

◆ slotSetWrapAroundModeAxisH

void KisCanvasController::slotSetWrapAroundModeAxisH ( )

slot

Definition at line 367 of file kis_canvas_controller.cpp.

{
    slotSetWrapAroundModeAxis(WRAPAROUND_HORIZONTAL);
}

References slotSetWrapAroundModeAxis(), and WRAPAROUND_HORIZONTAL.

◆ slotSetWrapAroundModeAxisHV

void KisCanvasController::slotSetWrapAroundModeAxisHV ( )

slot

Definition at line 362 of file kis_canvas_controller.cpp.

{
    slotSetWrapAroundModeAxis(WRAPAROUND_BOTH);
}

References slotSetWrapAroundModeAxis(), and WRAPAROUND_BOTH.

◆ slotSetWrapAroundModeAxisV

void KisCanvasController::slotSetWrapAroundModeAxisV ( )

slot

Definition at line 372 of file kis_canvas_controller.cpp.

{
    slotSetWrapAroundModeAxis(WRAPAROUND_VERTICAL);
}

References slotSetWrapAroundModeAxis(), and WRAPAROUND_VERTICAL.

◆ slotToggleLevelOfDetailMode

void KisCanvasController::slotToggleLevelOfDetailMode ( bool value )

slot

Definition at line 393 of file kis_canvas_controller.cpp.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    kritaCanvas->setLodPreferredInCanvas(value);
 
    bool result = levelOfDetailMode();
 
    if (!value || result) {
        m_d->view->viewManager()->showFloatingMessage(
            i18n("Instant Preview Mode: %1", result ?
                 i18n("ON") : i18n("OFF")),
            QIcon(), 500, KisFloatingMessage::Low);
    } else {
        QString reason;
 
        if (!kritaCanvas->canvasIsOpenGL()) {
            reason = i18n("Instant Preview is only supported with OpenGL activated");
        }
        else if (kritaCanvas->openGLFilterMode() == KisOpenGL::BilinearFilterMode ||
                   kritaCanvas->openGLFilterMode() == KisOpenGL::NearestFilterMode) {
            QString filteringMode =
                kritaCanvas->openGLFilterMode() == KisOpenGL::BilinearFilterMode ?
                i18n("Bilinear") : i18n("Nearest Neighbour");
            reason = i18n("Instant Preview is supported\n in Trilinear or High Quality filtering modes.\nCurrent mode is %1", filteringMode);
        }
 
        m_d->view->viewManager()->showFloatingMessage(
            i18n("Failed activating Instant Preview mode!\n\n%1", reason),
            QIcon(), 5000, KisFloatingMessage::Low);
    }
 
 
}

References KisOpenGL::BilinearFilterMode, KoCanvasControllerWidget::canvas, KisCanvas2::canvasIsOpenGL(), levelOfDetailMode(), KisFloatingMessage::Low, m_d, KisOpenGL::NearestFilterMode, KisCanvas2::openGLFilterMode, KisCanvas2::setLodPreferredInCanvas(), value(), and KisCanvasController::Private::view.

◆ slotTogglePixelGrid

void KisCanvasController::slotTogglePixelGrid ( bool value )

slot

Definition at line 385 of file kis_canvas_controller.cpp.

{
    KisConfig cfg(false);
    cfg.enablePixelGrid(value);
 
    KisConfigNotifier::instance()->notifyPixelGridModeChanged();
}

References KisConfig::enablePixelGrid(), KisConfigNotifier::instance(), KisConfigNotifier::notifyPixelGridModeChanged(), and value().

◆ slotToggleWrapAroundMode

void KisCanvasController::slotToggleWrapAroundMode ( bool value )

slot

Definition at line 332 of file kis_canvas_controller.cpp.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    if (!canvas()->canvasIsOpenGL() && value) {
        m_d->view->viewManager()->showFloatingMessage(i18n("You are activating wrap-around mode, but have not enabled OpenGL.\n"
                                                          "To visualize wrap-around mode, enable OpenGL."), QIcon());
    }
    kritaCanvas->setWrapAroundViewingMode(value);
    kritaCanvas->image()->setWrapAroundModePermitted(value);
}

References KoCanvasControllerWidget::canvas, KisCanvas2::image(), m_d, KisImage::setWrapAroundModePermitted(), KisCanvas2::setWrapAroundViewingMode(), value(), and KisCanvasController::Private::view.

◆ syncOnImageResolutionChange()

void KisCanvasController::syncOnImageResolutionChange ( )

Definition at line 477 of file kis_canvas_controller.cpp.

{
    const KisCanvasState oldCanvasState = canvasState();
 
    KisImageSP image = m_d->view->image();
    m_d->coordinatesConverter->setImageResolution(image->xRes(), image->yRes());
 
    if (!m_d->usePrintResolutionMode) {
        m_d->coordinatesConverter->setZoom(m_d->coordinatesConverter->zoomMode(),
                                            m_d->coordinatesConverter->zoom(),
                                            effectiveCanvasResolutionX(),
                                            effectiveCanvasResolutionY(),
                                            m_d->coordinatesConverter->makeWidgetStillPoint(
                                                m_d->coordinatesConverter->imageCenterInWidgetPixel()));
    }
 
    const KisCanvasState newCanvasState = canvasState();
 
    emitSignals(oldCanvasState, newCanvasState);
}

References canvasState(), KisCanvasController::Private::coordinatesConverter, effectiveCanvasResolutionX(), effectiveCanvasResolutionY(), KoCanvasControllerWidget::emitSignals(), KisCoordinatesConverter::imageCenterInWidgetPixel(), m_d, KisCoordinatesConverter::makeWidgetStillPoint(), KisCoordinatesConverter::setImageResolution(), KisCoordinatesConverter::setZoom(), KisCanvasController::Private::usePrintResolutionMode, KisCanvasController::Private::view, KisImage::xRes(), KisImage::yRes(), KoZoomHandler::zoom(), and KoZoomHandler::zoomMode().

◆ syncOnImageSizeChange()

void KisCanvasController::syncOnImageSizeChange	(	const QPointF &	oldStillPoint,
		const QPointF &	newStillPoint )

Definition at line 498 of file kis_canvas_controller.cpp.

{
    const KisCanvasState oldCanvasState = canvasState();
 
    KisImageSP image = m_d->view->image();
    m_d->coordinatesConverter->setImageBounds(image->bounds(), oldStillPoint, newStillPoint);
 
    const KisCanvasState newCanvasState = canvasState();
 
    emitSignals(oldCanvasState, newCanvasState);
}

References KisImage::bounds(), canvasState(), KisCanvasController::Private::coordinatesConverter, KoCanvasControllerWidget::emitSignals(), m_d, KisCoordinatesConverter::setImageBounds(), and KisCanvasController::Private::view.

◆ syncOnReferencesChange()

void KisCanvasController::syncOnReferencesChange ( const QRectF & referencesRect )

Definition at line 468 of file kis_canvas_controller.cpp.

{
    const KisCanvasState oldCanvasState = canvasState();
    m_d->coordinatesConverter->setExtraReferencesBounds(referencesRect.toAlignedRect());
    const KisCanvasState newCanvasState = canvasState();
 
    emitSignals(oldCanvasState, newCanvasState);
}

References canvasState(), KisCanvasController::Private::coordinatesConverter, KoCanvasControllerWidget::emitSignals(), m_d, and KisCoordinatesConverter::setExtraReferencesBounds().

◆ updateCanvasOffsetInternal()

void KisCanvasController::updateCanvasOffsetInternal ( const QPointF & newOffset )

overrideprotectedvirtual

Implements KoCanvasControllerWidget.

Definition at line 510 of file kis_canvas_controller.cpp.

{
    // not need to snap to device pixels, it is done by the converter automatically
    m_d->coordinatesConverter->setDocumentOffset(newOffset);
}

References KisCanvasController::Private::coordinatesConverter, m_d, and KisCoordinatesConverter::setDocumentOffset().

◆ updateCanvasWidgetSizeInternal()

void KisCanvasController::updateCanvasWidgetSizeInternal ( const QSize & newSize )

overrideprotectedvirtual

Implements KoCanvasControllerWidget.

Definition at line 516 of file kis_canvas_controller.cpp.

{
    m_d->coordinatesConverter->setCanvasWidgetSizeKeepZoom(newSize);
}

References KisCanvasController::Private::coordinatesConverter, m_d, and KisCoordinatesConverter::setCanvasWidgetSizeKeepZoom().

◆ updateCanvasZoomInternal()

void KisCanvasController::updateCanvasZoomInternal	(	KoZoomMode::Mode	mode,
		qreal	zoom,
		qreal	resolutionX,
		qreal	resolutionY,
		const std::optional< KoViewTransformStillPoint > &	docStillPoint )

overrideprotectedvirtual

Implements KoCanvasControllerWidget.

Definition at line 521 of file kis_canvas_controller.cpp.

{
    m_d->coordinatesConverter->setZoom(mode, zoom, resolutionX, resolutionY, docStillPoint);
}

References KisCanvasController::Private::coordinatesConverter, m_d, and KisCoordinatesConverter::setZoom().

◆ updateScreenResolution()

void KisCanvasController::updateScreenResolution ( QWidget * parentWidget )

Definition at line 99 of file kis_canvas_controller.cpp.

{
    if (qFuzzyCompare(parentWidget->physicalDpiX(), m_d->physicalDpiX) &&
        qFuzzyCompare(parentWidget->physicalDpiY(), m_d->physicalDpiY) &&
        qFuzzyCompare(parentWidget->devicePixelRatioF(), m_d->devicePixelRatio)) {
 
        return;
    }
 
    m_d->physicalDpiX = parentWidget->physicalDpiX();
    m_d->physicalDpiY = parentWidget->physicalDpiY();
    m_d->devicePixelRatio = parentWidget->devicePixelRatioF();
 
    m_d->coordinatesConverter->setDevicePixelRatio(m_d->devicePixelRatio);
 
    setUsePrintResolutionMode(m_d->usePrintResolutionMode);
}

References KisCanvasController::Private::coordinatesConverter, KisCanvasController::Private::devicePixelRatio, m_d, KisCanvasController::Private::physicalDpiX, KisCanvasController::Private::physicalDpiY, qFuzzyCompare(), KisCoordinatesConverter::setDevicePixelRatio(), setUsePrintResolutionMode(), and KisCanvasController::Private::usePrintResolutionMode.

◆ usePrintResolutionMode()

bool KisCanvasController::usePrintResolutionMode ( )

Definition at line 631 of file kis_canvas_controller.cpp.

{
    return m_d->usePrintResolutionMode;
}

References m_d, and KisCanvasController::Private::usePrintResolutionMode.

◆ wheelEvent()

void KisCanvasController::wheelEvent ( QWheelEvent * event )

override

Dirty Hack Alert: Do not call the KoCanvasControllerWidget::wheelEvent() to disable the default behavior of KoCanvasControllerWidget and QAbstractScrollArea

Definition at line 153 of file kis_canvas_controller.cpp.

{
    Q_UNUSED(event);
}

◆ wrapAroundMode()

bool KisCanvasController::wrapAroundMode ( ) const

Definition at line 345 of file kis_canvas_controller.cpp.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    return kritaCanvas->wrapAroundViewingMode();
}

References KoCanvasControllerWidget::canvas, and KisCanvas2::wrapAroundViewingMode().

◆ wrapAroundModeAxis()

WrapAroundAxis KisCanvasController::wrapAroundModeAxis ( ) const

Definition at line 377 of file kis_canvas_controller.cpp.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    return kritaCanvas->wrapAroundViewingModeAxis();
}

References KoCanvasControllerWidget::canvas, and KisCanvas2::wrapAroundViewingModeAxis().

◆ zoomIn() [1/2]

void KisCanvasController::zoomIn ( )

overridevirtual

Implements KoCanvasController.

Definition at line 552 of file kis_canvas_controller.cpp.

{
    zoomInImpl(std::nullopt);
}

References zoomInImpl().

◆ zoomIn() [2/2]

void KisCanvasController::zoomIn ( const KoViewTransformStillPoint & stillPoint )

overridevirtual

zooms in keeping stillPoint not moved.

Implements KoCanvasController.

Definition at line 562 of file kis_canvas_controller.cpp.

{
    zoomInImpl(stillPoint);
}

References zoomInImpl().

◆ zoomInImpl()

void KisCanvasController::zoomInImpl ( const std::optional< KoViewTransformStillPoint > & stillPoint )

private

Definition at line 572 of file kis_canvas_controller.cpp.

{
    const qreal newZoom = KisCoordinatesConverter::findNextZoom(m_d->coordinatesConverter->zoom(), m_d->coordinatesConverter->standardZoomLevels());
    if (!qFuzzyCompare(newZoom, m_d->coordinatesConverter->zoom())) {
        if (stillPoint) {
            setZoom(KoZoomMode::ZOOM_CONSTANT, newZoom, *stillPoint);
        } else {
            setZoom(KoZoomMode::ZOOM_CONSTANT, newZoom);
        }
    }
}

References KisCanvasController::Private::coordinatesConverter, KisCoordinatesConverter::findNextZoom(), m_d, qFuzzyCompare(), KoCanvasControllerWidget::setZoom(), KisCoordinatesConverter::standardZoomLevels(), KoZoomHandler::zoom(), and KoZoomMode::ZOOM_CONSTANT.

◆ zoomOut() [1/2]

void KisCanvasController::zoomOut ( )

overridevirtual

Implements KoCanvasController.

Definition at line 557 of file kis_canvas_controller.cpp.

{
    zoomOutImpl(std::nullopt);
}

References zoomOutImpl().

◆ zoomOut() [2/2]

void KisCanvasController::zoomOut ( const KoViewTransformStillPoint & stillPoint )

overridevirtual

zooms out keeping stillPoint not moved.

Implements KoCanvasController.

Definition at line 567 of file kis_canvas_controller.cpp.

{
    zoomOutImpl(stillPoint);
}

References zoomOutImpl().

◆ zoomOutImpl()

void KisCanvasController::zoomOutImpl ( const std::optional< KoViewTransformStillPoint > & stillPoint )

private

Definition at line 584 of file kis_canvas_controller.cpp.

{
    const qreal newZoom = KisCoordinatesConverter::findPrevZoom(m_d->coordinatesConverter->zoom(), m_d->coordinatesConverter->standardZoomLevels());
    if (!qFuzzyCompare(newZoom, m_d->coordinatesConverter->zoom())) {
        if (stillPoint) {
            setZoom(KoZoomMode::ZOOM_CONSTANT, newZoom, *stillPoint);
        } else {
            setZoom(KoZoomMode::ZOOM_CONSTANT, newZoom);
        }
    }
}

References KisCanvasController::Private::coordinatesConverter, KisCoordinatesConverter::findPrevZoom(), m_d, qFuzzyCompare(), KoCanvasControllerWidget::setZoom(), KisCoordinatesConverter::standardZoomLevels(), KoZoomHandler::zoom(), and KoZoomMode::ZOOM_CONSTANT.

◆ zoomState()

KoZoomState KisCanvasController::zoomState ( ) const

overridevirtual

Implements KoCanvasController.

Definition at line 531 of file kis_canvas_controller.cpp.

{
    return canvasState().zoomState();
}

References canvasState(), and KisCanvasState::zoomState().

◆ zoomToInternal()

void KisCanvasController::zoomToInternal ( const QRect & viewRect )

overrideprotectedvirtual

Implements KoCanvasControllerWidget.

Definition at line 596 of file kis_canvas_controller.cpp.

{
    m_d->coordinatesConverter->zoomTo(viewRect);
}

References KisCanvasController::Private::coordinatesConverter, m_d, and KisCoordinatesConverter::zoomTo().

Member Data Documentation

◆ m_d

Private* const KisCanvasController::m_d

private

Definition at line 116 of file kis_canvas_controller.h.

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

libs/ui/canvas/kis_canvas_controller.h
libs/ui/canvas/kis_canvas_controller.cpp

Classes

Public Slots

Signals

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisCanvasController()

◆ ~KisCanvasController()

Member Function Documentation

◆ activate()

◆ beginCanvasRotation

◆ canvasState()

◆ currentCursorPosition()

◆ documentSizeChanged

◆ effectiveCanvasResolutionX()

◆ effectiveCanvasResolutionY()

◆ endCanvasRotation

◆ ensureVisibleDoc()

◆ eventFilter()

◆ keyPressEvent()

◆ levelOfDetailMode()

◆ mirrorCanvas

◆ mirrorCanvasAroundCanvas

◆ mirrorCanvasAroundCursor

◆ mirrorCanvasImpl()

◆ preferredCenter()

◆ resetCanvasRotation

◆ resetScrollBars()

◆ restoreCanvasState()

◆ rotateCanvas [1/2]

◆ rotateCanvas() [2/2]

◆ rotateCanvasLeft15

◆ rotateCanvasRight15

◆ rotation

◆ saveCanvasState()

◆ setCanvas()

◆ setPreferredCenter()

◆ setUsePrintResolutionMode

◆ sigUsePrintResolutionModeChanged

◆ slotSetWrapAroundModeAxis

◆ slotSetWrapAroundModeAxisH

◆ slotSetWrapAroundModeAxisHV

◆ slotSetWrapAroundModeAxisV

◆ slotToggleLevelOfDetailMode

◆ slotTogglePixelGrid

◆ slotToggleWrapAroundMode

◆ syncOnImageResolutionChange()

◆ syncOnImageSizeChange()

◆ syncOnReferencesChange()

◆ updateCanvasOffsetInternal()

◆ updateCanvasWidgetSizeInternal()

◆ updateCanvasZoomInternal()

◆ updateScreenResolution()

◆ usePrintResolutionMode()

◆ wheelEvent()

◆ wrapAroundMode()

◆ wrapAroundModeAxis()

◆ zoomIn() [1/2]

◆ zoomIn() [2/2]

◆ zoomInImpl()

◆ zoomOut() [1/2]

◆ zoomOut() [2/2]

◆ zoomOutImpl()

◆ zoomState()

◆ zoomToInternal()

Member Data Documentation

◆ m_d