KisReferenceImagesDecoration Class Reference

The KisReferenceImagesDecoration class draws the reference images on the canvas. The document stores the list of reference images. More...

#include <KisReferenceImagesDecoration.h>

Inheritance diagram for KisReferenceImagesDecoration:

Classes
struct	Private

Public Member Functions
void	addReferenceImage (KisReferenceImage *referenceImage)
bool	documentHasReferenceImages () const
	KisReferenceImagesDecoration (QPointer< KisView > parent, KisDocument *document, bool viewReady=true)
	~KisReferenceImagesDecoration () override
Public Member Functions inherited from KisCanvasDecoration
const QString &	id () const
	KisCanvasDecoration (const QString &id, QPointer< KisView >parent)
virtual void	notifyWindowMinimized (bool minimized)
void	paint (QPainter &gc, const QRectF &updateRect, const KisCoordinatesConverter *converter, KisCanvas2 *canvas)
int	priority () const
virtual void	setCanvasWidget (KisCanvasWidgetBase *canvas)
void	setView (QPointer< KisView > imageView)
bool	visible () const
	~KisCanvasDecoration () override
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Protected Member Functions
void	drawDecoration (QPainter &gc, const QRectF &updateRect, const KisCoordinatesConverter *converter, KisCanvas2 *canvas) override
Protected Member Functions inherited from KisCanvasDecoration
int	decorationThickness () const
void	setPriority (int value)
QPointer< KisView >	view () const
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Private Slots
void	slotLayersChanged ()
void	slotNodeAdded (KisNodeSP)
void	slotNodeAdded (KisNodeSP, KisNodeAdditionFlags)
void	slotNodeRemoved (KisNodeSP)
void	slotReferenceImagesChanged (const QRectF &dirtyRect)

Private Member Functions
void	setReferenceImageLayer (KisSharedPtr< KisReferenceImagesLayer > layer, bool updateCanvas)

Private Attributes
const QScopedPointer< Private >	d

Additional Inherited Members
Public Slots inherited from KisCanvasDecoration
virtual void	setVisible (bool v)
void	toggleVisibility ()
Static Public Member Functions inherited from KisCanvasDecoration
static bool	comparePriority (KisCanvasDecorationSP decoration1, KisCanvasDecorationSP decoration2)

Detailed Description

The KisReferenceImagesDecoration class draws the reference images on the canvas. The document stores the list of reference images.

Definition at line 28 of file KisReferenceImagesDecoration.h.

Constructor & Destructor Documentation

KisReferenceImagesDecoration()

KisReferenceImagesDecoration::KisReferenceImagesDecoration	(	QPointer< KisView >	parent,
		KisDocument *	document,
		bool	viewReady = true )

Definition at line 98 of file KisReferenceImagesDecoration.cpp.

    : KisCanvasDecoration("referenceImagesDecoration", parent)
    , d(new Private(this))
{
    connect(document->image().data(), SIGNAL(sigNodeAddedAsync(KisNodeSP, KisNodeAdditionFlags)), this, SLOT(slotNodeAdded(KisNodeSP, KisNodeAdditionFlags)));
    connect(document->image().data(), SIGNAL(sigRemoveNodeAsync(KisNodeSP)), this, SLOT(slotNodeRemoved(KisNodeSP)));
    connect(document->image().data(), SIGNAL(sigLayersChangedAsync()), this, SLOT(slotLayersChanged()));
    connect(document, &KisDocument::sigReferenceImagesLayerChanged, this, qOverload<KisNodeSP>(&KisReferenceImagesDecoration::slotNodeAdded));
 
    auto referenceImageLayer = document->referenceImagesLayer();
    if (referenceImageLayer) {
        setReferenceImageLayer(referenceImageLayer, /* updateCanvas = */ viewReady);
    }
}

References setReferenceImageLayer(), KisDocument::sigReferenceImagesLayerChanged(), slotLayersChanged(), slotNodeAdded(), and slotNodeRemoved().

~KisReferenceImagesDecoration()

KisReferenceImagesDecoration::~KisReferenceImagesDecoration ( )

override

Definition at line 113 of file KisReferenceImagesDecoration.cpp.

{}

Member Function Documentation

addReferenceImage()

void KisReferenceImagesDecoration::addReferenceImage

(

KisReferenceImage *

referenceImage

)

Definition at line 116 of file KisReferenceImagesDecoration.cpp.

{
    KUndo2Command *cmd = KisReferenceImagesLayer::addReferenceImages(view()->document(), {referenceImage});
    view()->canvasBase()->addCommand(cmd);
}

References KisReferenceImagesLayer::addReferenceImages(), and KisCanvasDecoration::view().

documentHasReferenceImages()

bool KisReferenceImagesDecoration::documentHasReferenceImages

(

)

const

Definition at line 122 of file KisReferenceImagesDecoration.cpp.

{
    return view()->document()->referenceImagesLayer() != nullptr;
}

References KisCanvasDecoration::view().

drawDecoration()

void KisReferenceImagesDecoration::drawDecoration ( QPainter & gc, const QRectF & updateRect, const KisCoordinatesConverter * converter, KisCanvas2 * canvas )

overrideprotectedvirtual

Implements KisCanvasDecoration.

Definition at line 127 of file KisReferenceImagesDecoration.cpp.

{
    // TODO: can we use partial updates here?
 
    KisSharedPtr<KisReferenceImagesLayer> layer = d->layer.toStrongRef();
    const QColorSpace canvasSpace = KoColorSpaceRegistry::instance()->QColorSpaceForProfile(canvas->displayColorConverter()->multiSurfaceDisplayConfig().canvasProfile);
 
    if (!layer.isNull()) {
        QSizeF viewSize = view()->size();
 
        QTransform transform = converter->imageToWidgetTransform();
        if (d->previousViewSize != viewSize || !KisAlgebra2D::fuzzyMatrixCompare(transform, d->previousTransform, 1e-4)
            || d->buffer.image.colorSpace() != canvasSpace) {
            d->previousViewSize = viewSize;
            d->previousTransform = transform;
 
            d->buffer.image = QImage(QSize(1, 1), QImage::Format_ARGB32);
            d->buffer.image.setColorSpace(canvasSpace);
 
            d->updateBufferByWidgetCoordinates(QRectF(QPointF(0,0), viewSize));
        }
 
        if (!d->buffer.image.isNull()) {
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
            gc.drawImage(d->buffer.position, d->buffer.image);
#else
            gc.drawImage(d->buffer.position, canvas->displayRendererInterface()->convertImageToDisplayColorSpace(d->buffer.image));
#endif
        }
    }
}

References KisMultiSurfaceDisplayConfig::canvasProfile, KoColorDisplayRendererInterface::convertImageToDisplayColorSpace(), d, KisCanvas2::displayColorConverter, KisCanvas2::displayRendererInterface(), KisAlgebra2D::fuzzyMatrixCompare(), KisCoordinatesConverter::imageToWidgetTransform(), KoColorSpaceRegistry::instance(), KisSharedPtr< T >::isNull(), KisDisplayColorConverter::multiSurfaceDisplayConfig(), KoColorSpaceRegistry::QColorSpaceForProfile(), and KisCanvasDecoration::view().

setReferenceImageLayer()

void KisReferenceImagesDecoration::setReferenceImageLayer ( KisSharedPtr< KisReferenceImagesLayer > layer, bool updateCanvas )

private

Definition at line 204 of file KisReferenceImagesDecoration.cpp.

{
    if (d->layer != layer.data()) {
        KisSharedPtr<KisReferenceImagesLayer> oldLayer = d->layer.toStrongRef();
        if (oldLayer) {
            oldLayer->disconnect(this);
        }
 
        d->layer = layer;
 
        if (layer) {
            connect(layer.data(), SIGNAL(sigUpdateCanvas(QRectF)),
                    this, SLOT(slotReferenceImagesChanged(QRectF)));
 
            const QRectF dirtyRect = layer->boundingImageRect();
 
            // If the view is not ready yet (because this is being constructed
            // from view.d's ctor and thus view.d is not available now),
            // do not update canvas because it will lead to a crash.
            if (updateCanvas && !dirtyRect.isEmpty()) { // in case the reference layer is just being loaded from the .kra file
                slotReferenceImagesChanged(dirtyRect);
            }
        }
    }
}

References d, KisSharedPtr< T >::data(), and slotReferenceImagesChanged().

slotLayersChanged

void KisReferenceImagesDecoration::slotLayersChanged ( )

privateslot

Definition at line 186 of file KisReferenceImagesDecoration.cpp.

{
    KisImageSP image = view()->image();
 
    KisReferenceImagesLayer *referenceImagesLayer =
        KisLayerUtils::findNodeByType<KisReferenceImagesLayer>(image->root());
 
    setReferenceImageLayer(referenceImagesLayer, true);
}

References KisNodeFacade::root, setReferenceImageLayer(), and KisCanvasDecoration::view().

slotNodeAdded [1/2]

void KisReferenceImagesDecoration::slotNodeAdded ( KisNodeSP node )

privateslot

Definition at line 159 of file KisReferenceImagesDecoration.cpp.

{
    slotNodeAdded(node, KisNodeAdditionFlag::None);
}

References None, and slotNodeAdded().

slotNodeAdded [2/2]

void KisReferenceImagesDecoration::slotNodeAdded ( KisNodeSP node, KisNodeAdditionFlags flags )

privateslot

Definition at line 164 of file KisReferenceImagesDecoration.cpp.

{
    Q_UNUSED(flags)
 
    KisReferenceImagesLayer *referenceImagesLayer =
        dynamic_cast<KisReferenceImagesLayer*>(node.data());
 
    if (referenceImagesLayer) {
        setReferenceImageLayer(referenceImagesLayer, /* updateCanvas = */ true);
    }
}

References KisSharedPtr< T >::data(), and setReferenceImageLayer().

slotNodeRemoved

void KisReferenceImagesDecoration::slotNodeRemoved ( KisNodeSP node )

privateslot

Definition at line 176 of file KisReferenceImagesDecoration.cpp.

{
    KisReferenceImagesLayer *referenceImagesLayer =
        dynamic_cast<KisReferenceImagesLayer*>(node.data());
 
    if (referenceImagesLayer && referenceImagesLayer == d->layer) {
        setReferenceImageLayer(0, true);
    }
}

References d, KisSharedPtr< T >::data(), and setReferenceImageLayer().

slotReferenceImagesChanged

void KisReferenceImagesDecoration::slotReferenceImagesChanged ( const QRectF & dirtyRect )

privateslot

Definition at line 196 of file KisReferenceImagesDecoration.cpp.

{
    d->updateBufferByImageCoordinates(dirtyRect);
 
    QRectF documentRect = view()->viewConverter()->imageToDocument(dirtyRect);
    view()->canvasBase()->updateCanvasDecorations(documentRect);
}

References d, and KisCanvasDecoration::view().

Member Data Documentation

d

const QScopedPointer<Private> KisReferenceImagesDecoration::d

private

Definition at line 51 of file KisReferenceImagesDecoration.h.

---

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

• libs/ui/KisReferenceImagesDecoration.h
• libs/ui/KisReferenceImagesDecoration.cpp