Canvas Class Reference

#include <Canvas.h>

Inheritance diagram for Canvas:

Classes
struct	Private

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

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

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 22 of file Canvas.h.

Constructor & Destructor Documentation

Canvas()

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

explicit

Definition at line 20 of file Canvas.cpp.

    : QObject(parent)
    , d(new Private)
{
    d->canvas = static_cast<KisCanvas2*>(canvas);
}

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

~Canvas()

Canvas::~Canvas ( )

override

Definition at line 27 of file Canvas.cpp.

{
    delete d;
}

References d.

Member Function Documentation

displayColorConverter()

KisDisplayColorConverter * Canvas::displayColorConverter ( ) const

private

Definition at line 131 of file Canvas.cpp.

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

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

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 149 of file Canvas.cpp.

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

References 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 112 of file Canvas.cpp.

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

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

operator!=()

bool Canvas::operator!=

(

const Canvas &

other

)

const

Definition at line 38 of file Canvas.cpp.

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

References operator==().

operator==()

bool Canvas::operator==

(

const Canvas &

other

)

const

Definition at line 33 of file Canvas.cpp.

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

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

pan

void Canvas::pan ( const QPoint & offset )

slot

pan the current view in pixels.

Definition at line 81 of file Canvas.cpp.

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

References 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 68 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 Canvas::Private::canvas, KisCanvas2::coordinatesConverter, d, KisCoordinatesConverter::documentToImage(), KisCoordinatesConverter::flakeToDocument(), and KisCanvas2::imageView().

resetRotation

void Canvas::resetRotation ( )

slot

resetRotation reset the canvas rotation.

Definition at line 93 of file Canvas.cpp.

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

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

resetZoom

void Canvas::resetZoom ( )

slot

resetZoom set the zoomlevel to 100%

Definition at line 86 of file Canvas.cpp.

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

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

rotation

qreal Canvas::rotation ( ) const

slot

Returns

the rotation of the canvas in degrees.

Definition at line 99 of file Canvas.cpp.

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

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

setLevelOfDetailMode

void Canvas::setLevelOfDetailMode ( bool enable )

slot

setLevelOfDetailMode sets Instant Preview to

Parameters

enable

Definition at line 155 of file Canvas.cpp.

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

References 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 118 of file Canvas.cpp.

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

References 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 56 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 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 105 of file Canvas.cpp.

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

References 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 143 of file Canvas.cpp.

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

References 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 50 of file Canvas.cpp.

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

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

view

View * Canvas::view ( ) const

slot

Returns

the view that holds this canvas

Definition at line 124 of file Canvas.cpp.

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

References 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 137 of file Canvas.cpp.

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

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

zoomLevel

qreal Canvas::zoomLevel ( ) const

slot

Returns

the current zoomlevel. 1.0 is 100%.

Definition at line 44 of file Canvas.cpp.

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

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

Friends And Related Symbol Documentation

ManagedColor

friend class ManagedColor

friend

Definition at line 120 of file Canvas.h.

Member Data Documentation

d

Private* const Canvas::d

private

Definition at line 125 of file Canvas.h.

---

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

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