KisDummiesFacadeBase Class Reference

#include <kis_dummies_facade_base.h>

Inheritance diagram for KisDummiesFacadeBase:

Classes
struct	Private

Signals
void	sigActivateNode (KisNodeSP node)
void	sigBeginInsertDummy (KisNodeDummy *parent, int index, const QString &metaObjectType)
void	sigBeginRemoveDummy (KisNodeDummy *dummy)
void	sigDummyChanged (KisNodeDummy *dummy)
void	sigEndInsertDummy (KisNodeDummy *dummy)
void	sigEndRemoveDummy ()

Public Member Functions
virtual int	dummiesCount () const =0
virtual KisNodeDummy *	dummyForNode (KisNodeSP node) const =0
virtual bool	hasDummyForNode (KisNodeSP node) const =0
	KisDummiesFacadeBase (QObject *parent=0)
KisNodeSP	lastActivatedNode () const
virtual KisNodeDummy *	rootDummy () const =0
void	setImage (KisImageWSP image)
virtual void	setImage (KisImageWSP image, KisNodeSP activeNode)
	~KisDummiesFacadeBase () override

Protected Member Functions
virtual void	addNodeImpl (KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis)=0
KisImageWSP	image () const
virtual void	removeNodeImpl (KisNodeSP node)=0

Private Slots
void	slotContinueAddNode (KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis)
void	slotContinueRemoveNode (KisNodeSP node)
void	slotLayersChanged ()
void	slotNodeActivationRequested (KisNodeSP node, KisNodeAdditionFlags flags)
void	slotNodeAdded (KisNodeSP node, KisNodeAdditionFlags flags)
void	slotNodeChanged (KisNodeSP node)
void	slotRemoveNode (KisNodeSP node)

Static Private Member Functions
static KisNodeSP	findFirstLayer (KisNodeSP root)

Private Attributes
Private *const	m_d

Detailed Description

Keeps track of the node stack and manages local (UI-wide) representation of the node stack. It uses KisNodeDummy objects to represent the stack. This is done to break synchronization tie between UI and Image threads, caused by the fact that KisNodeModel must be synchronously notified when a node is removed/deleted.

Definition at line 26 of file kis_dummies_facade_base.h.

Constructor & Destructor Documentation

KisDummiesFacadeBase()

KisDummiesFacadeBase::KisDummiesFacadeBase

(

QObject *

parent = 0

)

Definition at line 45 of file kis_dummies_facade_base.cpp.

    : QObject(parent),
      m_d(new Private())
{
    m_d->activateNodeConnection.connectOutputSlot(this, &KisDummiesFacadeBase::slotNodeActivationRequested);
    m_d->nodeChangedConnection.connectOutputSlot(this, &KisDummiesFacadeBase::slotNodeChanged);
    m_d->addNodeConnection.connectOutputSlot(this, &KisDummiesFacadeBase::slotContinueAddNode);
    m_d->removeNodeConnection.connectOutputSlot(this, &KisDummiesFacadeBase::slotContinueRemoveNode);
}

References KisDummiesFacadeBase::Private::activateNodeConnection, KisDummiesFacadeBase::Private::addNodeConnection, m_d, KisDummiesFacadeBase::Private::nodeChangedConnection, KisDummiesFacadeBase::Private::removeNodeConnection, slotContinueAddNode(), slotContinueRemoveNode(), slotNodeActivationRequested(), and slotNodeChanged().

~KisDummiesFacadeBase()

KisDummiesFacadeBase::~KisDummiesFacadeBase ( )

override

Definition at line 55 of file kis_dummies_facade_base.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

addNodeImpl()

virtual void KisDummiesFacadeBase::addNodeImpl ( KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis )

protectedpure virtual

Implemented in KisDummiesFacade, and KisShapeController.

dummiesCount()

virtual int KisDummiesFacadeBase::dummiesCount ( ) const

pure virtual

Implemented in KisDummiesFacade, and KisShapeController.

dummyForNode()

virtual KisNodeDummy * KisDummiesFacadeBase::dummyForNode ( KisNodeSP node ) const

pure virtual

Implemented in KisShapeController, and KisDummiesFacade.

findFirstLayer()

KisNodeSP KisDummiesFacadeBase::findFirstLayer ( KisNodeSP root )

staticprivate

Definition at line 123 of file kis_dummies_facade_base.cpp.

{
    KisNodeSP child = root->firstChild();
    while(child && !child->inherits("KisLayer")) {
        child = child->nextSibling();
    }
    return child;
}

References KisNode::firstChild(), and KisNode::nextSibling().

hasDummyForNode()

virtual bool KisDummiesFacadeBase::hasDummyForNode ( KisNodeSP node ) const

pure virtual

Implemented in KisDummiesFacade, and KisShapeController.

image()

KisImageWSP KisDummiesFacadeBase::image ( ) const

protected

Definition at line 118 of file kis_dummies_facade_base.cpp.

{
    return m_d->image;
}

References KisDummiesFacadeBase::Private::image, and m_d.

lastActivatedNode()

KisNodeSP KisDummiesFacadeBase::lastActivatedNode

(

)

const

Sometimes (e.g. on setImage() call) sigActivateNode() signal may be emitted while the dummies facade is not yet connected to the node managed. In this case, the activation signal would be lost. Hence we should provide the last emitted value, so that node manager could cold-initialize the current node value on connection.

Definition at line 113 of file kis_dummies_facade_base.cpp.

{
    return m_d->lastActivatedNode;
}

References KisDummiesFacadeBase::Private::lastActivatedNode, and m_d.

removeNodeImpl()

virtual void KisDummiesFacadeBase::removeNodeImpl ( KisNodeSP node )

protectedpure virtual

Implemented in KisDummiesFacade, and KisShapeController.

rootDummy()

virtual KisNodeDummy * KisDummiesFacadeBase::rootDummy ( ) const

pure virtual

Return the root dummy of the graph. Since the call to setImage() causes an asynchronous update of the dummies graph, it may cause rootDummy() to be null at some moments, which is a valid state.

Implemented in KisDummiesFacade, and KisShapeController.

setImage() [1/2]

void KisDummiesFacadeBase::setImage

(

KisImageWSP

image

)

Definition at line 60 of file kis_dummies_facade_base.cpp.

{
    setImage(image, nullptr);
}

References image(), and setImage().

setImage() [2/2]

void KisDummiesFacadeBase::setImage ( KisImageWSP image, KisNodeSP activeNode )

virtual

Reimplemented in KisShapeController, and KisShapeController.

Definition at line 65 of file kis_dummies_facade_base.cpp.

{
    if (m_d->image) {
        Q_EMIT sigActivateNode(0);
        m_d->lastActivatedNode = 0;
        m_d->image->disconnect(this);
        m_d->image->disconnect(&m_d->nodeChangedConnection);
        m_d->image->disconnect(&m_d->activateNodeConnection);
 
        KisNodeList nodesToRemove;
 
        {
            QMutexLocker l(&m_d->pendingNodeSetLock);
            std::swap(nodesToRemove, m_d->pendingNodeSet);
            m_d->pendingNodeSet.clear();
        }
 
        for (auto it = std::make_reverse_iterator(nodesToRemove.end());
             it != std::make_reverse_iterator(nodesToRemove.begin());
             ++it) {
 
            m_d->removeNodeConnection.start(*it);
        }
    }
 
    m_d->image = image;
 
    if (image) {
        slotNodeAdded(image->root(), KisNodeAdditionFlag::None);
 
        connect(image, SIGNAL(sigNodeAddedAsync(KisNodeSP, KisNodeAdditionFlags)),
                SLOT(slotNodeAdded(KisNodeSP, KisNodeAdditionFlags)), Qt::DirectConnection);
        connect(image, SIGNAL(sigRemoveNodeAsync(KisNodeSP)),
                SLOT(slotRemoveNode(KisNodeSP)), Qt::DirectConnection);
        connect(image, SIGNAL(sigLayersChangedAsync()),
                SLOT(slotLayersChanged()), Qt::DirectConnection);
 
        m_d->nodeChangedConnection.connectInputSignal(image, &KisImage::sigNodeChanged);
        m_d->activateNodeConnection.connectInputSignal(image, &KisImage::sigNodeAddedAsync);
 
        if (!activeNode) {
            activeNode = findFirstLayer(image->root());
        }
 
        m_d->activateNodeConnection.start(activeNode, KisNodeAdditionFlag::None);
    }
}

References KisDummiesFacadeBase::Private::activateNodeConnection, connect(), findFirstLayer(), KisDummiesFacadeBase::Private::image, image(), KisDummiesFacadeBase::Private::lastActivatedNode, m_d, KisDummiesFacadeBase::Private::nodeChangedConnection, None, KisDummiesFacadeBase::Private::pendingNodeSet, KisDummiesFacadeBase::Private::pendingNodeSetLock, KisDummiesFacadeBase::Private::removeNodeConnection, KisNodeFacade::root, sigActivateNode(), KisImage::sigNodeAddedAsync(), KisImage::sigNodeChanged(), slotLayersChanged(), slotNodeAdded(), and slotRemoveNode().

sigActivateNode

void KisDummiesFacadeBase::sigActivateNode ( KisNodeSP node )

signal

This signal is emitted when the shape controller wants to request the change of an active layer. E.g. when a new layer is added or when the root layer of the image is changed. It should be forwarded through a signal to allow queueing and synchronization of threads.

sigBeginInsertDummy

void KisDummiesFacadeBase::sigBeginInsertDummy ( KisNodeDummy * parent, int index, const QString & metaObjectType )

signal

The signals for controlling the node model

sigBeginRemoveDummy

void KisDummiesFacadeBase::sigBeginRemoveDummy ( KisNodeDummy * dummy )

signal

sigDummyChanged

void KisDummiesFacadeBase::sigDummyChanged ( KisNodeDummy * dummy )

signal

sigEndInsertDummy

void KisDummiesFacadeBase::sigEndInsertDummy ( KisNodeDummy * dummy )

signal

sigEndRemoveDummy

void KisDummiesFacadeBase::sigEndRemoveDummy ( )

signal

slotContinueAddNode

void KisDummiesFacadeBase::slotContinueAddNode ( KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis )

privateslot

Definition at line 205 of file kis_dummies_facade_base.cpp.

{
    KisNodeDummy *parentDummy = parent ? dummyForNode(parent) : 0;
    KisNodeDummy *aboveThisDummy = aboveThis ? dummyForNode(aboveThis) : 0;
    // Add one because this node does not exist yet
    int index = parentDummy && aboveThisDummy ?
        parentDummy->indexOf(aboveThisDummy) + 1 : 0;
    Q_EMIT sigBeginInsertDummy(parentDummy, index, node->metaObject()->className());
 
    addNodeImpl(node, parent, aboveThis);
 
    Q_EMIT sigEndInsertDummy(dummyForNode(node));
}

References addNodeImpl(), dummyForNode(), KisNodeDummy::indexOf(), sigBeginInsertDummy(), and sigEndInsertDummy().

slotContinueRemoveNode

void KisDummiesFacadeBase::slotContinueRemoveNode ( KisNodeSP node )

privateslot

Definition at line 219 of file kis_dummies_facade_base.cpp.

{
    KisNodeDummy *dummy = dummyForNode(node);
    Q_EMIT sigBeginRemoveDummy(dummy);
 
    removeNodeImpl(node);
 
    Q_EMIT sigEndRemoveDummy();
}

References dummyForNode(), removeNodeImpl(), sigBeginRemoveDummy(), and sigEndRemoveDummy().

slotLayersChanged

void KisDummiesFacadeBase::slotLayersChanged ( )

privateslot

Definition at line 147 of file kis_dummies_facade_base.cpp.

{
    setImage(m_d->image);
}

References KisDummiesFacadeBase::Private::image, m_d, and setImage().

slotNodeActivationRequested

void KisDummiesFacadeBase::slotNodeActivationRequested ( KisNodeSP node, KisNodeAdditionFlags flags )

privateslot

Definition at line 152 of file kis_dummies_facade_base.cpp.

{
    if (flags.testFlag(KisNodeAdditionFlag::DontActivateNode)) return;
 
    if (!node || !node->graphListener()) return;
 
    if (!node->inherits("KisSelectionMask") &&
        !node->inherits("KisReferenceImagesLayer") &&
        !node->inherits("KisDecorationsWrapperLayer")) {
 
        Q_EMIT sigActivateNode(node);
        m_d->lastActivatedNode = node;
    }
}

References DontActivateNode, KisNode::graphListener, KisDummiesFacadeBase::Private::lastActivatedNode, m_d, and sigActivateNode().

slotNodeAdded

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

privateslot

Definition at line 167 of file kis_dummies_facade_base.cpp.

{
    Q_UNUSED(flags)
 
    {
        QMutexLocker l(&m_d->pendingNodeSetLock);
        m_d->pendingNodeSet.append(node);
    }
 
    m_d->addNodeConnection.start(node, node->parent(), node->prevSibling());
 
    KisNodeSP childNode = node->firstChild();
    while (childNode) {
        slotNodeAdded(childNode, flags);
        childNode = childNode->nextSibling();
    }
}

References KisDummiesFacadeBase::Private::addNodeConnection, KisNode::firstChild(), m_d, KisNode::nextSibling(), KisNode::parent, KisDummiesFacadeBase::Private::pendingNodeSet, KisDummiesFacadeBase::Private::pendingNodeSetLock, KisNode::prevSibling(), and slotNodeAdded().

slotNodeChanged

void KisDummiesFacadeBase::slotNodeChanged ( KisNodeSP node )

privateslot

In some "buggy" code the node-changed signal may be emitted before the node will become a part of the node graph. It is a bug, we a really minor one. It should not cause any data losses to the user.

Definition at line 132 of file kis_dummies_facade_base.cpp.

{
    KisNodeDummy *dummy = dummyForNode(node);
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(dummy);
 
    Q_EMIT sigDummyChanged(dummy);
}

References dummyForNode(), KIS_SAFE_ASSERT_RECOVER_RETURN, and sigDummyChanged().

slotRemoveNode

void KisDummiesFacadeBase::slotRemoveNode ( KisNodeSP node )

privateslot

Definition at line 185 of file kis_dummies_facade_base.cpp.

{
    {
        QMutexLocker l(&m_d->pendingNodeSetLock);
        KIS_SAFE_ASSERT_RECOVER_RETURN(m_d->pendingNodeSet.contains(node));
    }
 
    KisNodeSP childNode = node->lastChild();
    while (childNode) {
        slotRemoveNode(childNode);
        childNode = childNode->prevSibling();
    }
 
    {
        QMutexLocker l(&m_d->pendingNodeSetLock);
        m_d->pendingNodeSet.removeOne(node);
    }
    m_d->removeNodeConnection.start(node);
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, KisNode::lastChild(), m_d, KisDummiesFacadeBase::Private::pendingNodeSet, KisDummiesFacadeBase::Private::pendingNodeSetLock, KisNode::prevSibling(), KisDummiesFacadeBase::Private::removeNodeConnection, and slotRemoveNode().

Member Data Documentation

m_d

Private* const KisDummiesFacadeBase::m_d

private

Definition at line 101 of file kis_dummies_facade_base.h.

---

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

• libs/ui/flake/kis_dummies_facade_base.h
• libs/ui/flake/kis_dummies_facade_base.cpp