Canvas Class Reference

#include <Canvas.h>

Inheritance diagram for Canvas:

Public Types
enum	ZoomMode { ZOOM_CONSTANT = 0 , ZOOM_PAGE = 1 , ZOOM_WIDTH = 2 , ZOOM_HEIGHT = 16 }

Public Slots
bool	levelOfDetailMode () const
bool	mirror () const
void	pan (const QPoint &offset)
	pan the current view in pixels.
QPointF	preferredCenter () const
void	resetRotation ()
	resetRotation reset the canvas rotation.
void	resetZoom ()
	resetZoom set the zoomlevel to 100%
qreal	rotation () const
void	setLevelOfDetailMode (bool enable)
	setLevelOfDetailMode sets Instant Preview to
void	setMirror (bool value)
	setMirror turn the canvas mirroring on or off depending on
void	setPreferredCenter (const QPointF &imagePos)
	setPan Centers the image pixel at imagePos in the current view
void	setRotation (qreal angle)
	setRotation set the rotation of the canvas to the given
void	setWrapAroundMode (bool enable)
	setWrapAroundMode set wraparound mode to
void	setZoomLevel (qreal value)
	setZoomLevel set the zoomlevel to the given value. 1.0 is 100%.
View *	view () const
bool	wrapAroundMode () const
qreal	zoomLevel () const

Signals
void	cursorPositionChanged (const QPoint &position)
void	documentCursorPositionChanged (const QPointF &position)
void	documentOffsetChanged (const QPointF &oldOffset, const QPointF &newOffset)
void	documentRectInWidgetPixelsChanged (const QRectF &documentRectInWidgetPixels)
void	effectiveZoomChanged (qreal effectiveZoom)
void	mirrorChanged (bool mirrorX, bool mirrorY)
void	offsetChanged ()
void	removed ()
void	rotationChanged (qreal angle)
void	sizeChanged (const QSize &size)
void	stateChanged ()
void	zoomStateChanged (const ZoomMode zoomMode, qreal zoom, qreal minZoom, qreal maxZoom)

Public Member Functions
	Canvas (KoCanvasBase *canvas, QObject *parent=0)
bool	operator!= (const Canvas &other) const
bool	operator== (const Canvas &other) const
	~Canvas () override

Private Slots
void	emitZoomStateChanged (const KoZoomState &zoomState)

Private Member Functions
KisDisplayColorConverter *	displayColorConverter () const

Private Attributes
Private *const	d

Friends
class	ManagedColor

Detailed Description

Canvas wraps the canvas inside a view on an image/document. It is responsible for the view parameters of the document: zoom, rotation, mirror, wraparound and instant preview.

Definition at line 23 of file Canvas.h.

Member Enumeration Documentation

ZoomMode

enum Canvas::ZoomMode

Enumerator
ZOOM_CONSTANT
ZOOM_PAGE
ZOOM_WIDTH
ZOOM_HEIGHT

Definition at line 28 of file Canvas.h.

    {
        ZOOM_CONSTANT = 0,  // zoom x %
        ZOOM_PAGE     = 1,  // zoom to page
        ZOOM_WIDTH    = 2,  // zoom to width
        ZOOM_HEIGHT   = 16, // zoom to height
    };

Constructor & Destructor Documentation

Canvas()

Canvas::Canvas ( KoCanvasBase * canvas, QObject * parent = 0 )

explicit

Definition at line 21 of file Canvas.cpp.

    : QObject(parent)
    , d(new Private)
{
    d->canvas = static_cast<KisCanvas2*>(canvas);
 
    if (d->canvas) {
        d->canvasControllerProxy = d->canvas->imageView()->canvasController()->proxyObject;
 
        connect(d->canvasControllerProxy, SIGNAL(canvasRemoved(KoCanvasController*)), this, SIGNAL(removed()));
        connect(d->canvasControllerProxy, SIGNAL(canvasOffsetChanged()), this, SIGNAL(offsetChanged()));
        connect(d->canvasControllerProxy, SIGNAL(canvasMousePositionChanged(QPoint)), this, SIGNAL(cursorPositionChanged(QPoint)));
        connect(d->canvasControllerProxy, SIGNAL(documentMousePositionChanged(QPointF)), this, SIGNAL(documentCursorPositionChanged(QPointF)));
        connect(d->canvasControllerProxy, SIGNAL(sizeChanged(QSize)), this, SIGNAL(sizeChanged(QSize)));
        connect(d->canvasControllerProxy, SIGNAL(moveDocumentOffset(QPointF, QPointF)), this, SIGNAL(documentOffsetChanged(QPointF, QPointF)));
        connect(d->canvasControllerProxy, SIGNAL(effectiveZoomChanged(qreal)), this, SIGNAL(effectiveZoomChanged(qreal)));
        connect(d->canvasControllerProxy, SIGNAL(zoomStateChanged(KoZoomState)), this, SLOT(emitZoomStateChanged(KoZoomState)));
        connect(d->canvasControllerProxy, SIGNAL(documentRectInWidgetPixelsChanged(QRectF)), this, SIGNAL(documentRectInWidgetPixelsChanged(QRectF)));
        connect(d->canvasControllerProxy, SIGNAL(documentRotationChanged(qreal)), this, SIGNAL(rotationChanged(qreal)));
        connect(d->canvasControllerProxy, SIGNAL(documentMirrorStatusChanged(bool, bool)), this, SIGNAL(mirrorChanged(bool, bool)));
        connect(d->canvasControllerProxy, SIGNAL(canvasStateChanged()), this, SIGNAL(stateChanged()));
    }
}

References krita::Canvas::Private::canvas, krita::Canvas::Private::canvasControllerProxy, cursorPositionChanged(), d, documentCursorPositionChanged(), documentOffsetChanged(), documentRectInWidgetPixelsChanged(), effectiveZoomChanged(), emitZoomStateChanged(), KisCanvas2::imageView(), mirrorChanged(), offsetChanged(), removed(), rotationChanged(), sizeChanged(), stateChanged(), and zoomStateChanged().

~Canvas()

Canvas::~Canvas ( )

override

Definition at line 45 of file Canvas.cpp.

{
    delete d;
}

References d.

Member Function Documentation

cursorPositionChanged

void Canvas::cursorPositionChanged ( const QPoint & position )

signal

Emitted when the cursor is moved over the canvas widget.

Parameters

position

the position in view coordinates (pixels).

displayColorConverter()

KisDisplayColorConverter * Canvas::displayColorConverter ( ) const

private

Definition at line 149 of file Canvas.cpp.

{
    if (!d->canvas) return 0;
    return d->canvas->displayColorConverter();
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::displayColorConverter.

documentCursorPositionChanged

void Canvas::documentCursorPositionChanged ( const QPointF & position )

signal

Emitted when the cursor is moved over the canvas widget.

Parameters

position

the position in document coordinates.

Use cursorPositionChanged to get the position in view coordinates.

documentOffsetChanged

void Canvas::documentOffsetChanged ( const QPointF & oldOffset, const QPointF & newOffset )

signal

Emitted whenever the canvas is panned.

Parameters

point

the new top-left point from which the document should be drawn.

documentRectInWidgetPixelsChanged

void Canvas::documentRectInWidgetPixelsChanged ( const QRectF & documentRectInWidgetPixels )

signal

Emitted whenever the document's position or size within the viewport widget changes.

Parameters

documentRectInWidgetPixels

rect with position of documentOffset and size of document size * effective zoom.

effectiveZoomChanged

void Canvas::effectiveZoomChanged ( qreal effectiveZoom )

signal

Emitted whenever the effective zoom level changes.

Parameters

effectiveZoom

In pixel size display mode, zoom * 1 / display scaling. In print size display mode, zoom * display DPI / image PPI.

emitZoomStateChanged

void Canvas::emitZoomStateChanged ( const KoZoomState & zoomState )

privateslot

Definition at line 179 of file Canvas.cpp.

{
    emit zoomStateChanged((ZoomMode)zoomState.mode, zoomState.zoom, zoomState.minZoom, zoomState.maxZoom);
}

References KoZoomState::maxZoom, KoZoomState::minZoom, KoZoomState::mode, KoZoomState::zoom, and zoomStateChanged().

levelOfDetailMode

bool Canvas::levelOfDetailMode ( ) const

slot

Returns

true if the canvas is in Instant Preview mode, false if not. Only when OpenGL is enabled, is Instant Preview mode available.

Definition at line 167 of file Canvas.cpp.

{
    if (!d->canvas) return false;
    return d->canvas->imageView()->canvasController()->levelOfDetailMode();
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

mirror

bool Canvas::mirror ( ) const

slot

Returns

return true if the canvas is mirrored, false otherwise.

Definition at line 130 of file Canvas.cpp.

{
    if (!d->canvas) return false;
    return d->canvas->imageView()->canvasIsMirrored();
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

mirrorChanged

void Canvas::mirrorChanged ( bool mirrorX, bool mirrorY )

signal

Emitted when mirrored status changes.

Parameters

mirrorX	whether the canvas's view is mirrored horizontally (reversed)
mirrorY	whether the canvas's view is mirrored vertically (inverted)

offsetChanged

void Canvas::offsetChanged ( )

signal

Emitted when the canvas is panned. See documentOffsetChanged

operator!=()

bool Canvas::operator!=

(

const Canvas &

other

)

const

Definition at line 56 of file Canvas.cpp.

{
    return !(operator==(other));
}

References operator==().

operator==()

bool Canvas::operator==

(

const Canvas &

other

)

const

Definition at line 51 of file Canvas.cpp.

{
    return (d->canvas == other.d->canvas);
}

References krita::Canvas::Private::canvas, and d.

pan

void Canvas::pan ( const QPoint & offset )

slot

pan the current view in pixels.

Definition at line 99 of file Canvas.cpp.

{
    d->canvas->imageView()->canvasController()->pan(offset);
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

preferredCenter

QPointF Canvas::preferredCenter ( ) const

slot

Returns

the position of the image pixel that is placed in the center of the current view

Definition at line 86 of file Canvas.cpp.

{
    if (!d->canvas) return QPointF();
 
    QPointF flakePos = d->canvas->imageView()->canvasController()->preferredCenter();
 
    const KisCoordinatesConverter *coordConv = d->canvas->coordinatesConverter();
    QPointF docPos = coordConv->flakeToDocument(flakePos);
    QPointF imagePos = coordConv->documentToImage(docPos);
 
    return imagePos; 
}

References krita::Canvas::Private::canvas, KisCanvas2::coordinatesConverter, d, KisCoordinatesConverter::documentToImage(), KisCoordinatesConverter::flakeToDocument(), and KisCanvas2::imageView().

removed

void Canvas::removed ( )

signal

Emitted when the canvas is about to be removed.

resetRotation

void Canvas::resetRotation ( )

slot

resetRotation reset the canvas rotation.

Definition at line 111 of file Canvas.cpp.

{
    if (!d->canvas) return;
    d->canvas->imageView()->canvasController()->resetCanvasRotation();
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

resetZoom

void Canvas::resetZoom ( )

slot

resetZoom set the zoomlevel to 100%

Definition at line 104 of file Canvas.cpp.

{
    if (!d->canvas) return;
    d->canvas->imageView()->zoomManager()->zoomTo100();
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

rotation

qreal Canvas::rotation ( ) const

slot

Returns

the rotation of the canvas in degrees.

Definition at line 117 of file Canvas.cpp.

{
    if (!d->canvas) return 0;
    return d->canvas->imageView()->canvasController()->rotation();
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

rotationChanged

void Canvas::rotationChanged ( qreal angle )

signal

Emitted when rotation changes.

Parameters

angle

the angle in degrees

setLevelOfDetailMode

void Canvas::setLevelOfDetailMode ( bool enable )

slot

setLevelOfDetailMode sets Instant Preview to

Parameters

enable

Definition at line 173 of file Canvas.cpp.

{
    if (!d->canvas) return;
    return d->canvas->imageView()->canvasController()->slotToggleLevelOfDetailMode(enable);
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

setMirror

void Canvas::setMirror ( bool value )

slot

setMirror turn the canvas mirroring on or off depending on

Parameters

value

Definition at line 136 of file Canvas.cpp.

{
    if (!d->canvas) return;
    d->canvas->imageView()->canvasController()->mirrorCanvas(value);
}

References krita::Canvas::Private::canvas, d, KisCanvas2::imageView(), and value().

setPreferredCenter

void Canvas::setPreferredCenter ( const QPointF & imagePos )

slot

setPan Centers the image pixel at imagePos in the current view

Definition at line 74 of file Canvas.cpp.

{
    if (!d->canvas) return;
 
    const KisCoordinatesConverter *coordConv = d->canvas->coordinatesConverter();
 
    QPointF documentPos = coordConv->imageToDocument(imagePos);
    QPointF flakePos = coordConv->documentToFlake(documentPos);
 
    d->canvas->imageView()->canvasController()->setPreferredCenter(flakePos);
}

References krita::Canvas::Private::canvas, KisCanvas2::coordinatesConverter, d, KisCoordinatesConverter::documentToFlake(), KisCoordinatesConverter::imageToDocument(), and KisCanvas2::imageView().

setRotation

void Canvas::setRotation ( qreal angle )

slot

setRotation set the rotation of the canvas to the given

Parameters

angle

in degrees.

Definition at line 123 of file Canvas.cpp.

{
    if (!d->canvas) return;
    d->canvas->imageView()->canvasController()->rotateCanvas(angle - rotation());
}

References krita::Canvas::Private::canvas, d, KisCanvas2::imageView(), and rotation().

setWrapAroundMode

void Canvas::setWrapAroundMode ( bool enable )

slot

setWrapAroundMode set wraparound mode to

Parameters

enable

Definition at line 161 of file Canvas.cpp.

{
    if (!d->canvas) return;
    d->canvas->imageView()->canvasController()->slotToggleWrapAroundMode(enable);
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

setZoomLevel

void Canvas::setZoomLevel ( qreal value )

slot

setZoomLevel set the zoomlevel to the given value. 1.0 is 100%.

Definition at line 68 of file Canvas.cpp.

{
    if (!d->canvas) return;
    d->canvas->imageView()->canvasController()->setZoom(KoZoomMode::ZOOM_CONSTANT, value);
}

References krita::Canvas::Private::canvas, d, KisCanvas2::imageView(), value(), and KoZoomMode::ZOOM_CONSTANT.

sizeChanged

void Canvas::sizeChanged ( const QSize & size )

signal

Emitted when the viewport size changes.

Parameters

size	the size in widget pixels.

stateChanged

void Canvas::stateChanged ( )

signal

Emitted when this canvas's zoom, rotation, mirror, offset, or viewport change.

view

View * Canvas::view ( ) const

slot

Returns

the view that holds this canvas

Definition at line 142 of file Canvas.cpp.

{
    if (!d->canvas) return 0;
    View *view = new View(d->canvas->imageView());
    return view;
}

References krita::Canvas::Private::canvas, d, KisCanvas2::imageView(), and view().

wrapAroundMode

bool Canvas::wrapAroundMode ( ) const

slot

Returns

true if the canvas is in wraparound mode, false if not. Only when OpenGL is enabled, is wraparound mode available.

Definition at line 155 of file Canvas.cpp.

{
    if (!d->canvas) return false;
    return d->canvas->imageView()->canvasController()->wrapAroundMode();
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

zoomLevel

qreal Canvas::zoomLevel ( ) const

slot

Returns

the current zoomlevel. 1.0 is 100%.

Definition at line 62 of file Canvas.cpp.

{
    if (!d->canvas) return 1.0;
    return d->canvas->imageView()->viewConverter()->zoom();
}

References krita::Canvas::Private::canvas, d, and KisCanvas2::imageView().

zoomStateChanged

void Canvas::zoomStateChanged ( const ZoomMode zoomMode, qreal zoom, qreal minZoom, qreal maxZoom )

signal

Emitted whenever the zoom state changes.

Parameters

zoomMode	ZoomMode
zoom	zoom level, 1.0 is 100%
minZoom	the minimum allowed zoom level
maxZoom	the maximum allowed zoom level

Friends And Related Symbol Documentation

ManagedColor

friend class ManagedColor

friend

Definition at line 216 of file Canvas.h.

Member Data Documentation

d

Private* const Canvas::d

private

Definition at line 221 of file Canvas.h.

---

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

• libs/libkis/Canvas.h
• libs/libkis/Canvas.cpp