#include <kis_shape_layer_canvas.h>

Inheritance diagram for KisShapeLayerCanvasBase:

Public Member Functions
void	addCommand (KUndo2Command *command) override

const QWidget *	canvasWidget () const override

QWidget *	canvasWidget () override

virtual void	forceRepaint ()=0

virtual void	forceRepaintWithHiddenAreas ()

void	gridSize (QPointF offset, QSizeF spacing) const override

bool	hasChangedWhileBeingInvisible ()

virtual bool	hasPendingUpdates () const =0

	KisShapeLayerCanvasBase (const KisShapeLayerCanvasBase &rhs, KisShapeLayer *parent)

	KisShapeLayerCanvasBase (KisShapeLayer *parent)

void	prepareForDestroying ()

virtual KisPaintDeviceSP	projection () const =0

virtual void	rerenderAfterBeingInvisible ()=0

virtual void	resetCache (const KoColorSpace *colorSpace)=0

KoSelectedShapesProxy *	selectedShapesProxy () const override
	selectedShapesProxy() is a special interface for keeping a persistent connections to selectionChanged() and selectionContentChanged() signals. While shapeManager() can change throughout the life time of the canvas, selectedShapesProxy() is guaranteed to stay the same.

void	setCursor (const QCursor &) override

virtual void	setImage (KisImageWSP image)

KoShapeManager *	shapeManager () const override

bool	snapToGrid () const override

KoToolProxy *	toolProxy () const override

KoUnit	unit () const override

const KoViewConverter *	viewConverter () const override

KoViewConverter *	viewConverter () override

Public Member Functions inherited from KoCanvasBase
KoCanvasController *	canvasController () const

virtual bool	canvasIsOpenGL () const

virtual void	clipToDocument (const KoShape *shape, QPointF &move) const

virtual void	disconnectCanvasObserver (QObject *object)

virtual QPoint	documentOrigin () const

	KoCanvasBase (KoShapeControllerBase shapeController, KoCanvasResourceProvider sharedResourceManager=0)

	Private ()

KoCanvasResourceProvider *	resourceManager () const

void	setCanvasController (KoCanvasController *controller)
	called by KoCanvasController to set the controller that handles this canvas.

KoShapeController *	shapeController () const

KoSnapGuide *	snapGuide () const

virtual void	updateCanvas (const QRectF &rc)=0

virtual QPointF	viewToDocument (const QPointF &viewPoint) const

	~KoCanvasBase () override

	~Private ()

Protected Attributes
bool	m_hasChangedWhileBeingInvisible {false}

bool	m_isDestroying {false}

QScopedPointer< KoSelectedShapesProxy >	m_selectedShapesProxy

QScopedPointer< KoShapeManager >	m_shapeManager

KisImageViewConverter	m_viewConverter

Additional Inherited Members
Public Attributes inherited from KoCanvasBase
KoCanvasController *	controller

bool	isResourceManagerShared

QPointer< KoCanvasResourceProvider >	resourceManager

QPointer< KoShapeController >	shapeController

KoSnapGuide *	snapGuide

Detailed Description

Definition at line 33 of file kis_shape_layer_canvas.h.

Constructor & Destructor Documentation

◆ KisShapeLayerCanvasBase() [1/2]

KisShapeLayerCanvasBase::KisShapeLayerCanvasBase ( KisShapeLayer * parent )

Definition at line 40 of file kis_shape_layer_canvas.cpp.

    : KoCanvasBase(0)
    , m_shapeManager(new KoShapeManager(this))
    , m_selectedShapesProxy(new KoSelectedShapesProxySimple(m_shapeManager.data()))
    , m_viewConverter()
{
    m_shapeManager->selection()->setActiveLayer(parent);
}

References m_shapeManager.

◆ KisShapeLayerCanvasBase() [2/2]

KisShapeLayerCanvasBase::KisShapeLayerCanvasBase	(	const KisShapeLayerCanvasBase &	rhs,
		KisShapeLayer *	parent )

Definition at line 49 of file kis_shape_layer_canvas.cpp.

    : KoCanvasBase(0)
    , m_shapeManager(new KoShapeManager(this))
    , m_selectedShapesProxy(new KoSelectedShapesProxySimple(m_shapeManager.data()))
    , m_viewConverter(rhs.m_viewConverter)
{
    m_viewConverter.setImage(nullptr);
    m_shapeManager->selection()->setActiveLayer(parent);
}

References m_shapeManager, m_viewConverter, and KisImageViewConverter::setImage().

Member Function Documentation

◆ addCommand()

void KisShapeLayerCanvasBase::addCommand ( KUndo2Command * command )

overridevirtual

Adds a command to the history. Call this for each command you create. This will also execute the command. This means, most of the application's code will look like MyCommand * cmd = new MyCommand( parameters ); canvas.addCommand( cmd );

Note that the command history takes ownership of the command, it will delete it when the undo limit is reached, or when deleting the command history itself.

Parameters

command the command to add

Implements KoCanvasBase.

Definition at line 97 of file kis_shape_layer_canvas.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
}

References KIS_SAFE_ASSERT_RECOVER_NOOP.

◆ canvasWidget() [1/2]

const QWidget * KisShapeLayerCanvasBase::canvasWidget ( ) const

overridevirtual

Return the widget that will be added to the scrollArea.

Implements KoCanvasBase.

Definition at line 114 of file kis_shape_layer_canvas.cpp.

{
    return 0;
}

◆ canvasWidget() [2/2]

QWidget * KisShapeLayerCanvasBase::canvasWidget ( )

overridevirtual

Return the widget that will be added to the scrollArea.

Implements KoCanvasBase.

Definition at line 109 of file kis_shape_layer_canvas.cpp.

{
    return 0;
}

◆ forceRepaint()

virtual void KisShapeLayerCanvasBase::forceRepaint ( )

pure virtual

Implemented in KisShapeLayerCanvas, and ReferenceImagesCanvas.

◆ forceRepaintWithHiddenAreas()

virtual void KisShapeLayerCanvasBase::forceRepaintWithHiddenAreas ( )

inlinevirtual

Reimplemented in KisShapeLayerCanvas.

Definition at line 46 of file kis_shape_layer_canvas.h.

46{ forceRepaint(); }

KisShapeLayerCanvasBase::forceRepaint

virtual void forceRepaint()=0

References forceRepaint().

◆ gridSize()

void KisShapeLayerCanvasBase::gridSize	(	QPointF *	offset,
		QSizeF *	spacing ) const

overridevirtual

retrieve the grid size setting. The grid spacing will be provided in pt.

Parameters

horizontal	a pointer to a qreal that will be filled with the horizontal grid-spacing
vertical	a pointer to a qreal that will be filled with the vertical grid-spacing

Implements KoCanvasBase.

Definition at line 84 of file kis_shape_layer_canvas.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
    Q_UNUSED(offset);
    Q_UNUSED(spacing);
}

References KIS_SAFE_ASSERT_RECOVER_NOOP.

◆ hasChangedWhileBeingInvisible()

bool KisShapeLayerCanvasBase::hasChangedWhileBeingInvisible ( )

Definition at line 130 of file kis_shape_layer_canvas.cpp.

{
    return m_hasChangedWhileBeingInvisible;
}

References m_hasChangedWhileBeingInvisible.

◆ hasPendingUpdates()

virtual bool KisShapeLayerCanvasBase::hasPendingUpdates ( ) const

pure virtual

Implemented in KisShapeLayerCanvas, and ReferenceImagesCanvas.

◆ prepareForDestroying()

void KisShapeLayerCanvasBase::prepareForDestroying ( )

Definition at line 125 of file kis_shape_layer_canvas.cpp.

{
    m_isDestroying = true;
}

References m_isDestroying.

◆ projection()

virtual KisPaintDeviceSP KisShapeLayerCanvasBase::projection ( ) const

pure virtual

Implemented in KisShapeLayerCanvas, and ReferenceImagesCanvas.

◆ rerenderAfterBeingInvisible()

virtual void KisShapeLayerCanvasBase::rerenderAfterBeingInvisible ( )

pure virtual

Implemented in KisShapeLayerCanvas, and ReferenceImagesCanvas.

◆ resetCache()

virtual void KisShapeLayerCanvasBase::resetCache ( const KoColorSpace * colorSpace )

pure virtual

Implemented in ReferenceImagesCanvas, and KisShapeLayerCanvas.

◆ selectedShapesProxy()

KoSelectedShapesProxy * KisShapeLayerCanvasBase::selectedShapesProxy ( ) const

overridevirtual

selectedShapesProxy() is a special interface for keeping a persistent connections to selectionChanged() and selectionContentChanged() signals. While shapeManager() can change throughout the life time of the canvas, selectedShapesProxy() is guaranteed to stay the same.

Returns: persistent KoSelectedShapesProxy object

Implements KoCanvasBase.

Definition at line 69 of file kis_shape_layer_canvas.cpp.

{
    return m_selectedShapesProxy.data();
}

References m_selectedShapesProxy.

◆ setCursor()

void KisShapeLayerCanvasBase::setCursor ( const QCursor & cursor )

inlineoverridevirtual

set the specified cursor on this canvas

Parameters

cursor the new cursor

Returns: the old cursor

Implements KoCanvasBase.

Definition at line 64 of file kis_shape_layer_canvas.h.

64{}

◆ setImage()

void KisShapeLayerCanvasBase::setImage ( KisImageWSP image )

virtual

Reimplemented in KisShapeLayerCanvas.

Definition at line 59 of file kis_shape_layer_canvas.cpp.

{
    m_viewConverter.setImage(image);
}

References m_viewConverter, and KisImageViewConverter::setImage().

◆ shapeManager()

KoShapeManager * KisShapeLayerCanvasBase::shapeManager ( ) const

overridevirtual

Return the current shapeManager. WARNING: the shape manager can switch in time, e.g. when a layer is changed. Please don't keep any persistent connections to it. Instead please use selectedShapesProxy(), which is guaranteed to be the same throughout the life of the canvas.

Returns: the current shapeManager

Implements KoCanvasBase.

Definition at line 64 of file kis_shape_layer_canvas.cpp.

{
    return m_shapeManager.data();
}

References m_shapeManager.

◆ snapToGrid()

bool KisShapeLayerCanvasBase::snapToGrid ( ) const

overridevirtual

return if snap to grid is enabled.

Returns: if snap to grid is enabled.

Implements KoCanvasBase.

Definition at line 91 of file kis_shape_layer_canvas.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
    return false;
}

References KIS_SAFE_ASSERT_RECOVER_NOOP.

◆ toolProxy()

KoToolProxy * KisShapeLayerCanvasBase::toolProxy ( ) const

overridevirtual

Return the proxy to the active tool (determining which tool is really, really active is hard when tablets are involved, so leave that to others.

Implements KoCanvasBase.

Definition at line 103 of file kis_shape_layer_canvas.cpp.

{
//     KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
    return 0;
}

◆ unit()

KoUnit KisShapeLayerCanvasBase::unit ( ) const

overridevirtual

Return the unit of the current document for initialization of the widgets created by the flake framework.

See also: KoDocument::unit()

Implements KoCanvasBase.

Definition at line 119 of file kis_shape_layer_canvas.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
    return KoUnit(KoUnit::Point);
}

References KIS_SAFE_ASSERT_RECOVER_NOOP, and KoUnit::Point.

◆ viewConverter() [1/2]

const KoViewConverter * KisShapeLayerCanvasBase::viewConverter ( ) const

overridevirtual

Return the viewConverter for this view.

Returns: the viewConverter for this view.

Implements KoCanvasBase.

Definition at line 74 of file kis_shape_layer_canvas.cpp.

{
    return &m_viewConverter;
}

References m_viewConverter.

◆ viewConverter() [2/2]

KoViewConverter * KisShapeLayerCanvasBase::viewConverter ( )

overridevirtual

Implements KoCanvasBase.

Definition at line 79 of file kis_shape_layer_canvas.cpp.

{
    return &m_viewConverter;
}

References m_viewConverter.

Member Data Documentation

◆ m_hasChangedWhileBeingInvisible

bool KisShapeLayerCanvasBase::m_hasChangedWhileBeingInvisible {false}

protected

Definition at line 69 of file kis_shape_layer_canvas.h.

69{false};

◆ m_isDestroying

bool KisShapeLayerCanvasBase::m_isDestroying {false}

protected

Definition at line 70 of file kis_shape_layer_canvas.h.

70{false};

◆ m_selectedShapesProxy

QScopedPointer<KoSelectedShapesProxy> KisShapeLayerCanvasBase::m_selectedShapesProxy

protected

Definition at line 68 of file kis_shape_layer_canvas.h.

◆ m_shapeManager

QScopedPointer<KoShapeManager> KisShapeLayerCanvasBase::m_shapeManager

protected

Definition at line 67 of file kis_shape_layer_canvas.h.

◆ m_viewConverter

KisImageViewConverter KisShapeLayerCanvasBase::m_viewConverter

protected

Definition at line 72 of file kis_shape_layer_canvas.h.

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

libs/ui/flake/kis_shape_layer_canvas.h
libs/ui/flake/kis_shape_layer_canvas.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisShapeLayerCanvasBase() [1/2]

◆ KisShapeLayerCanvasBase() [2/2]

Member Function Documentation

◆ addCommand()

◆ canvasWidget() [1/2]

◆ canvasWidget() [2/2]

◆ forceRepaint()

◆ forceRepaintWithHiddenAreas()

◆ gridSize()

◆ hasChangedWhileBeingInvisible()

◆ hasPendingUpdates()

◆ prepareForDestroying()

◆ projection()

◆ rerenderAfterBeingInvisible()

◆ resetCache()

◆ selectedShapesProxy()

◆ setCursor()

◆ setImage()

◆ shapeManager()

◆ snapToGrid()

◆ toolProxy()

◆ unit()

◆ viewConverter() [1/2]

◆ viewConverter() [2/2]

Member Data Documentation

◆ m_hasChangedWhileBeingInvisible

◆ m_isDestroying

◆ m_selectedShapesProxy

◆ m_shapeManager

◆ m_viewConverter