KisImageSignalRouter Class Reference

#include <kis_image_signal_router.h>

Inheritance diagram for KisImageSignalRouter:

Public Slots
void	emitImageModifiedNotification ()

Signals
void	sigColorSpaceChanged (const KoColorSpace *cs)
void	sigImageModified ()
void	sigImageModifiedWithoutUndo ()
void	sigLayersChangedAsync ()
void	sigNodeAddedAsync (KisNodeSP node, KisNodeAdditionFlags flags)
void	sigNodeChanged (KisNodeSP node)
void	sigNotification (KisImageSignalType type)
void	sigNotifyBatchUpdateEnded ()
void	sigNotifyBatchUpdateStarted ()
void	sigProfileChanged (const KoColorProfile *profile)
void	sigRemoveNodeAsync (KisNodeSP node)
void	sigRequestLodPlanesSyncBlocked (bool value)
void	sigRequestNodeReselection (KisNodeSP activeNode, const KisNodeList &selectedNodes)
void	sigResolutionChanged (double xRes, double yRes)
void	sigSizeChanged (const QPointF &oldStillPoint, const QPointF &newStillPoint)

Public Member Functions
void	emitAboutToRemoveANode (KisNode *parent, int index)
void	emitNodeChanged (KisNodeSP node)
void	emitNodeHasBeenAdded (KisNode *parent, int index, KisNodeAdditionFlags flags)
void	emitNotification (KisImageSignalType type)
void	emitNotifications (KisImageSignalVector notifications)
void	emitNotifyBatchUpdateEnded ()
void	emitNotifyBatchUpdateStarted ()
void	emitRequestLodPlanesSyncBlocked (bool value)
	KisImageSignalRouter (KisImageWSP image)
	~KisImageSignalRouter () override

Private Slots
void	slotNotification (KisImageSignalType type)

Private Attributes
KisImageWSP	m_image

Detailed Description

Definition at line 18 of file kis_image_signal_router.h.

Constructor & Destructor Documentation

KisImageSignalRouter()

KisImageSignalRouter::KisImageSignalRouter

(

KisImageWSP

image

)

Color space and profile conversion functions run without strokes, therefore they are executed in GUI hread under the global lock held.

To ensure that the receiver of the signal will not deadlock by barrier-locking the image, we should make these signals queued.

Definition at line 26 of file kis_image_signal_router.cpp.

    : QObject(image.data()),
      m_image(image)
{
    connect(this, SIGNAL(sigNotification(KisImageSignalType)),
            SLOT(slotNotification(KisImageSignalType)));
 
    CONNECT_TO_IMAGE(sigImageModified());
    CONNECT_TO_IMAGE(sigImageModifiedWithoutUndo());
    CONNECT_TO_IMAGE(sigSizeChanged(const QPointF&, const QPointF&));
    CONNECT_TO_IMAGE(sigResolutionChanged(double, double));
    CONNECT_TO_IMAGE(sigRequestNodeReselection(KisNodeSP, const KisNodeList&));
 
    CONNECT_TO_IMAGE(sigNodeChanged(KisNodeSP));
    CONNECT_TO_IMAGE(sigNodeAddedAsync(KisNodeSP, KisNodeAdditionFlags));
    CONNECT_TO_IMAGE(sigRemoveNodeAsync(KisNodeSP));
    CONNECT_TO_IMAGE(sigLayersChangedAsync());
 
    CONNECT_TO_IMAGE_QUEUED(sigProfileChanged(const KoColorProfile*));
    CONNECT_TO_IMAGE_QUEUED(sigColorSpaceChanged(const KoColorSpace*));
}

References connect(), CONNECT_TO_IMAGE, CONNECT_TO_IMAGE_QUEUED, sigColorSpaceChanged(), sigImageModified(), sigImageModifiedWithoutUndo(), sigLayersChangedAsync(), sigNodeAddedAsync(), sigNodeChanged(), sigNotification(), sigProfileChanged(), sigRemoveNodeAsync(), sigRequestNodeReselection(), sigResolutionChanged(), sigSizeChanged(), and slotNotification().

~KisImageSignalRouter()

KisImageSignalRouter::~KisImageSignalRouter ( )

override

Definition at line 56 of file kis_image_signal_router.cpp.

{
}

Member Function Documentation

emitAboutToRemoveANode()

void KisImageSignalRouter::emitAboutToRemoveANode	(	KisNode *	parent,
		int	index )

Definition at line 108 of file kis_image_signal_router.cpp.

{
    KisNodeSP removedNode = parent->at(index);
 
    // overlay selection masks reset frames themselves
    if (!removedNode->inherits("KisSelectionMask")) {
        KisImageSP image = m_image.toStrongRef();
        if (image) {
            image->invalidateAllFrames();
        }
    }
 
    Q_EMIT sigRemoveNodeAsync(removedNode);
}

References KisImage::invalidateAllFrames(), m_image, sigRemoveNodeAsync(), and KisWeakSharedPtr< T >::toStrongRef().

emitImageModifiedNotification

void KisImageSignalRouter::emitImageModifiedNotification ( )

slot

Definition at line 60 of file kis_image_signal_router.cpp.

{
    Q_EMIT sigImageModified();
}

References sigImageModified().

emitNodeChanged()

void KisImageSignalRouter::emitNodeChanged

(

KisNodeSP

node

)

Definition at line 88 of file kis_image_signal_router.cpp.

{
    Q_EMIT sigNodeChanged(node);
}

References sigNodeChanged().

emitNodeHasBeenAdded()

void KisImageSignalRouter::emitNodeHasBeenAdded	(	KisNode *	parent,
		int	index,
		KisNodeAdditionFlags	flags )

Definition at line 93 of file kis_image_signal_router.cpp.

{
    KisNodeSP newNode = parent->at(index);
 
    // overlay selection masks reset frames themselves
    if (!newNode->inherits("KisSelectionMask")) {
        KisImageSP image = m_image.toStrongRef();
        if (image) {
            image->invalidateAllFrames();
        }
    }
 
    Q_EMIT sigNodeAddedAsync(newNode, flags);
}

References KisImage::invalidateAllFrames(), m_image, sigNodeAddedAsync(), and KisWeakSharedPtr< T >::toStrongRef().

emitNotification()

void KisImageSignalRouter::emitNotification

(

KisImageSignalType

type

)

All the notifications except LayersChangedSignal should go in a queued way. And LayersChangedSignal should be delivered to the recipients in a non-reordered way

Definition at line 72 of file kis_image_signal_router.cpp.

{
    if (type.id == LayersChangedSignal ||
        type.id == NodeReselectionRequestSignal) {
        slotNotification(type);
    } else {
        Q_EMIT sigNotification(type);
    }
}

References KisImageSignalType::id, LayersChangedSignal, NodeReselectionRequestSignal, sigNotification(), and slotNotification().

emitNotifications()

void KisImageSignalRouter::emitNotifications

(

KisImageSignalVector

notifications

)

Definition at line 65 of file kis_image_signal_router.cpp.

{
    Q_FOREACH (const KisImageSignalType &type, notifications) {
        emitNotification(type);
    }
}

References emitNotification().

emitNotifyBatchUpdateEnded()

void KisImageSignalRouter::emitNotifyBatchUpdateEnded

(

)

Definition at line 133 of file kis_image_signal_router.cpp.

{
    Q_EMIT sigNotifyBatchUpdateEnded();
}

References sigNotifyBatchUpdateEnded().

emitNotifyBatchUpdateStarted()

void KisImageSignalRouter::emitNotifyBatchUpdateStarted

(

)

Definition at line 128 of file kis_image_signal_router.cpp.

{
    Q_EMIT sigNotifyBatchUpdateStarted();
}

References sigNotifyBatchUpdateStarted().

emitRequestLodPlanesSyncBlocked()

void KisImageSignalRouter::emitRequestLodPlanesSyncBlocked

(

bool

value

)

Definition at line 123 of file kis_image_signal_router.cpp.

{
    Q_EMIT sigRequestLodPlanesSyncBlocked(value);
}

References sigRequestLodPlanesSyncBlocked(), and value().

sigColorSpaceChanged

void KisImageSignalRouter::sigColorSpaceChanged ( const KoColorSpace * cs )

signal

sigImageModified

void KisImageSignalRouter::sigImageModified ( )

signal

sigImageModifiedWithoutUndo

void KisImageSignalRouter::sigImageModifiedWithoutUndo ( )

signal

sigLayersChangedAsync

void KisImageSignalRouter::sigLayersChangedAsync ( )

signal

sigNodeAddedAsync

void KisImageSignalRouter::sigNodeAddedAsync ( KisNodeSP node, KisNodeAdditionFlags flags )

signal

sigNodeChanged

void KisImageSignalRouter::sigNodeChanged ( KisNodeSP node )

signal

sigNotification

void KisImageSignalRouter::sigNotification ( KisImageSignalType type )

signal

sigNotifyBatchUpdateEnded

void KisImageSignalRouter::sigNotifyBatchUpdateEnded ( )

signal

See also

sigNotifyBatchUpdateStarted()

sigNotifyBatchUpdateStarted

void KisImageSignalRouter::sigNotifyBatchUpdateStarted ( )

signal

Emitted whenever the image is going to issue a lot of canvas update signals and it is a good idea to group then and rerender the canvas in one go. The canvas should initiate new rerenders while the batch is in progress.

NOTE: even though the batched updates will not initiate a rerender, it does not guarantee that there will be processed during the batch. The updates may come from other sources, e.g. from mouse moves.

NOTE: this feature is used to avoid flickering when switching back from lodN plane back to lod0. All the texture tiles should be loaded with new information before mipmaps can be regenerated.

sigProfileChanged

void KisImageSignalRouter::sigProfileChanged ( const KoColorProfile * profile )

signal

sigRemoveNodeAsync

void KisImageSignalRouter::sigRemoveNodeAsync ( KisNodeSP node )

signal

sigRequestLodPlanesSyncBlocked

void KisImageSignalRouter::sigRequestLodPlanesSyncBlocked ( bool value )

signal

Emitted whenever the image wants to update Lod0 plane of the canvas. Blocking syncing effectively means that the canvas will not try to read from these planes until the all the data is loaded. Otherwise the user will see weird flickering because of partially loaded lod0 tiles.

NOTE: while the sync is blocked, the canvas is considered to use LodN planes that are expected to contain valid data.

sigRequestNodeReselection

void KisImageSignalRouter::sigRequestNodeReselection ( KisNodeSP activeNode, const KisNodeList & selectedNodes )

signal

sigResolutionChanged

void KisImageSignalRouter::sigResolutionChanged ( double xRes, double yRes )

signal

sigSizeChanged

void KisImageSignalRouter::sigSizeChanged ( const QPointF & oldStillPoint, const QPointF & newStillPoint )

signal

slotNotification

void KisImageSignalRouter::slotNotification ( KisImageSignalType type )

privateslot

Definition at line 138 of file kis_image_signal_router.cpp.

{
    KisImageSP image = m_image.toStrongRef();
    if (!image) {
        return;
    }
 
    switch(type.id) {
    case LayersChangedSignal:
        image->invalidateAllFrames();
        Q_EMIT sigLayersChangedAsync();
        break;
    case ModifiedWithoutUndoSignal:
        Q_EMIT sigImageModifiedWithoutUndo();
        break;
    case SizeChangedSignal:
        image->invalidateAllFrames();
        Q_EMIT sigSizeChanged(type.sizeChangedSignal.oldStillPoint,
                            type.sizeChangedSignal.newStillPoint);
        break;
    case ProfileChangedSignal:
        image->invalidateAllFrames();
        Q_EMIT sigProfileChanged(image->profile());
        break;
    case ColorSpaceChangedSignal:
        image->invalidateAllFrames();
        Q_EMIT sigColorSpaceChanged(image->colorSpace());
        break;
    case ResolutionChangedSignal:
        image->invalidateAllFrames();
        Q_EMIT sigResolutionChanged(image->xRes(), image->yRes());
        break;
    case NodeReselectionRequestSignal:
        if (type.nodeReselectionSignal.newActiveNode ||
            !type.nodeReselectionSignal.newSelectedNodes.isEmpty()) {
 
            Q_EMIT sigRequestNodeReselection(type.nodeReselectionSignal.newActiveNode,
                                           type.nodeReselectionSignal.newSelectedNodes);
        }
        break;
    }
}

References KisImage::colorSpace(), ColorSpaceChangedSignal, KisImageSignalType::id, KisImage::invalidateAllFrames(), LayersChangedSignal, m_image, ModifiedWithoutUndoSignal, ComplexNodeReselectionSignal::newActiveNode, ComplexNodeReselectionSignal::newSelectedNodes, ComplexSizeChangedSignal::newStillPoint, NodeReselectionRequestSignal, KisImageSignalType::nodeReselectionSignal, ComplexSizeChangedSignal::oldStillPoint, KisImage::profile(), ProfileChangedSignal, ResolutionChangedSignal, sigColorSpaceChanged(), sigImageModifiedWithoutUndo(), sigLayersChangedAsync(), sigProfileChanged(), sigRequestNodeReselection(), sigResolutionChanged(), sigSizeChanged(), SizeChangedSignal, KisImageSignalType::sizeChangedSignal, KisWeakSharedPtr< T >::toStrongRef(), KisImage::xRes(), and KisImage::yRes().

Member Data Documentation

m_image

KisImageWSP KisImageSignalRouter::m_image

private

Definition at line 95 of file kis_image_signal_router.h.

---

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

• libs/image/kis_image_signal_router.h
• libs/image/kis_image_signal_router.cpp