#include <kis_node_juggler_compressed.h>

Inheritance diagram for KisNodeJugglerCompressed:

Classes
struct	Private

Public Slots
void	end ()

Signals
void	requestUpdateAsyncFromCommand ()

Public Member Functions
void	addNode (const KisNodeList &nodes, KisNodeSP dstParent, KisNodeSP dstAbove)

bool	canMergeAction (const KUndo2MagicString &actionName)

void	copyNode (const KisNodeList &nodes, KisNodeSP dstParent, KisNodeSP dstAbove)

void	duplicateNode (const KisNodeList &nodes)

bool	isEnded () const

	KisNodeJugglerCompressed (const KUndo2MagicString &actionName, KisImageSP image, KisNodeManager *nodeManager, int timeout)

void	lowerNode (const KisNodeList &nodes)

void	moveNode (const KisNodeList &nodes, KisNodeSP dstParent, KisNodeSP dstAbove)

void	moveNode (KisNodeSP node, KisNodeSP parent, KisNodeSP above)

void	raiseNode (const KisNodeList &nodes)

void	removeNode (const KisNodeList &nodes)

void	setAutoDelete (bool value)

	~KisNodeJugglerCompressed () override

Private Slots
void	slotEndStrokeRequested ()

void	slotImageAboutToBeDeleted ()

void	slotUndoDuringStrokeRequested ()

void	slotUpdateTimeout ()

void	startTimers ()

Private Member Functions
void	cleanup ()

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

Definition at line 19 of file kis_node_juggler_compressed.h.

Constructor & Destructor Documentation

◆ KisNodeJugglerCompressed()

KisNodeJugglerCompressed::KisNodeJugglerCompressed	(	const KUndo2MagicString &	actionName,
		KisImageSP	image,
		KisNodeManager *	nodeManager,
		int	timeout )

Definition at line 708 of file kis_node_juggler_compressed.cpp.

    : m_d(new Private(this, actionName, image, nodeManager, timeout))
{
 
    KisImageSignalVector emitSignals;
 
    m_d->applicator.reset(
        new KisProcessingApplicator(m_d->image, 0,
                                    KisProcessingApplicator::NONE,
                                    emitSignals,
                                    actionName));
    connect(this, SIGNAL(requestUpdateAsyncFromCommand()), SLOT(startTimers()));
    connect(&m_d->compressor, SIGNAL(timeout()), SLOT(slotUpdateTimeout()));
 
    connect(m_d->image, SIGNAL(sigStrokeCancellationRequested()), SLOT(slotEndStrokeRequested()));
    connect(m_d->image, SIGNAL(sigUndoDuringStrokeRequested()), SLOT(slotUndoDuringStrokeRequested()));
    connect(m_d->image, SIGNAL(sigStrokeEndRequestedActiveNodeFiltered()), SLOT(slotEndStrokeRequested()));
    connect(m_d->image, SIGNAL(sigAboutToBeDeleted()), SLOT(slotImageAboutToBeDeleted()));
 
    m_d->applicator->applyCommand(
        new UpdateMovedNodesCommand(m_d->updateData, false));
    m_d->isStarted = true;
}

References connect(), m_d, KisProcessingApplicator::NONE, requestUpdateAsyncFromCommand(), slotEndStrokeRequested(), slotImageAboutToBeDeleted(), slotUndoDuringStrokeRequested(), slotUpdateTimeout(), and startTimers().

◆ ~KisNodeJugglerCompressed()

KisNodeJugglerCompressed::~KisNodeJugglerCompressed ( )

override

Definition at line 732 of file kis_node_juggler_compressed.cpp.

{
    KIS_ASSERT_RECOVER(!m_d->applicator) {
        m_d->applicator->end();
        m_d->applicator.reset();
    }
}

References KIS_ASSERT_RECOVER, and m_d.

Member Function Documentation

◆ addNode()

void KisNodeJugglerCompressed::addNode	(	const KisNodeList &	nodes,
		KisNodeSP	dstParent,
		KisNodeSP	dstAbove )

Definition at line 821 of file kis_node_juggler_compressed.cpp.

{
    KisNodeSP activeNode = m_d->nodeManager ? m_d->nodeManager->activeNode() : 0;
 
    m_d->applicator->applyCommand(
        new DuplicateLayers(m_d->updateData,
                            m_d->image,
                            nodes,
                            dstParent, dstAbove,
                            activeNode,
                            DuplicateLayers::ADD),
                KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
}

References DuplicateLayers::ADD, KisStrokeJobData::EXCLUSIVE, m_d, and KisStrokeJobData::SEQUENTIAL.

◆ canMergeAction()

bool KisNodeJugglerCompressed::canMergeAction ( const KUndo2MagicString & actionName )

Definition at line 740 of file kis_node_juggler_compressed.cpp.

{
    return actionName == m_d->actionName;
}

References m_d.

◆ cleanup()

void KisNodeJugglerCompressed::cleanup ( )

private

Definition at line 888 of file kis_node_juggler_compressed.cpp.

{
    m_d->applicator.reset();
    m_d->compressor.stop();
    m_d->image.clear();
    m_d->updateData.clear();
    m_d->isStarted = false;
 
    if (m_d->autoDelete) {
        m_d->selfDestructionCompressor.stop();
        this->deleteLater();
    }
}

References m_d.

◆ copyNode()

void KisNodeJugglerCompressed::copyNode	(	const KisNodeList &	nodes,
		KisNodeSP	dstParent,
		KisNodeSP	dstAbove )

Definition at line 793 of file kis_node_juggler_compressed.cpp.

{
    KisNodeSP activeNode = m_d->nodeManager ? m_d->nodeManager->activeNode() : 0;
 
    m_d->applicator->applyCommand(
        new DuplicateLayers(m_d->updateData,
                            m_d->image,
                            nodes,
                            dstParent, dstAbove,
                            activeNode,
                            DuplicateLayers::COPY),
                KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
}

References DuplicateLayers::COPY, KisStrokeJobData::EXCLUSIVE, m_d, and KisStrokeJobData::SEQUENTIAL.

◆ duplicateNode()

void KisNodeJugglerCompressed::duplicateNode ( const KisNodeList & nodes )

Definition at line 779 of file kis_node_juggler_compressed.cpp.

{
    KisNodeSP activeNode = m_d->nodeManager ? m_d->nodeManager->activeNode() : 0;
 
    m_d->applicator->applyCommand(
        new DuplicateLayers(m_d->updateData,
                            m_d->image,
                            nodes,
                            KisNodeSP(), KisNodeSP(),
                            activeNode,
                            DuplicateLayers::COPY),
                KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
}

References DuplicateLayers::COPY, KisStrokeJobData::EXCLUSIVE, m_d, and KisStrokeJobData::SEQUENTIAL.

◆ end

void KisNodeJugglerCompressed::end ( )

slot

Definition at line 877 of file kis_node_juggler_compressed.cpp.

{
    if (!m_d->isStarted) return;
 
    m_d->applicator->applyCommand(
        new UpdateMovedNodesCommand(m_d->updateData, true));
 
    m_d->applicator->end();
    cleanup();
}

References cleanup(), and m_d.

◆ isEnded()

bool KisNodeJugglerCompressed::isEnded ( ) const

Definition at line 944 of file kis_node_juggler_compressed.cpp.

{
    return !m_d->isStarted;
}

References m_d.

◆ lowerNode()

void KisNodeJugglerCompressed::lowerNode ( const KisNodeList & nodes )

Definition at line 745 of file kis_node_juggler_compressed.cpp.

{
    KisNodeSP activeNode = m_d->nodeManager ? m_d->nodeManager->activeNode() : 0;
 
    m_d->applicator->applyCommand(
        new LowerRaiseLayer(m_d->updateData,
                            m_d->image,
                            nodes, activeNode, true),
                KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
 
}

References KisStrokeJobData::EXCLUSIVE, m_d, and KisStrokeJobData::SEQUENTIAL.

◆ moveNode() [1/2]

void KisNodeJugglerCompressed::moveNode	(	const KisNodeList &	nodes,
		KisNodeSP	dstParent,
		KisNodeSP	dstAbove )

Definition at line 807 of file kis_node_juggler_compressed.cpp.

{
    KisNodeSP activeNode = m_d->nodeManager ? m_d->nodeManager->activeNode() : 0;
 
    m_d->applicator->applyCommand(
        new DuplicateLayers(m_d->updateData,
                            m_d->image,
                            nodes,
                            dstParent, dstAbove,
                            activeNode,
                            DuplicateLayers::MOVE),
                KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
}

References KisStrokeJobData::EXCLUSIVE, m_d, DuplicateLayers::MOVE, and KisStrokeJobData::SEQUENTIAL.

◆ moveNode() [2/2]

void KisNodeJugglerCompressed::moveNode	(	KisNodeSP	node,
		KisNodeSP	parent,
		KisNodeSP	above )

Definition at line 835 of file kis_node_juggler_compressed.cpp.

{
    m_d->applicator->applyCommand(new KisImageLayerMoveCommand(m_d->image, node, parent, above, false),
                                  KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
 
    MoveNodeStructSP moveStruct = toQShared(new MoveNodeStruct(m_d->image, node, parent, above));
 
    m_d->updateData->addInitialUpdate(moveStruct);
}

References KisStrokeJobData::EXCLUSIVE, m_d, KisStrokeJobData::SEQUENTIAL, and toQShared().

◆ raiseNode()

void KisNodeJugglerCompressed::raiseNode ( const KisNodeList & nodes )

Definition at line 757 of file kis_node_juggler_compressed.cpp.

{
    KisNodeSP activeNode = m_d->nodeManager ? m_d->nodeManager->activeNode() : 0;
 
    m_d->applicator->applyCommand(
        new LowerRaiseLayer(m_d->updateData,
                            m_d->image,
                            nodes, activeNode, false),
                KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
}

References KisStrokeJobData::EXCLUSIVE, m_d, and KisStrokeJobData::SEQUENTIAL.

◆ removeNode()

void KisNodeJugglerCompressed::removeNode ( const KisNodeList & nodes )

Definition at line 768 of file kis_node_juggler_compressed.cpp.

{
    KisNodeSP activeNode = m_d->nodeManager ? m_d->nodeManager->activeNode() : 0;
 
    m_d->applicator->applyCommand(
        new RemoveLayers(m_d->updateData,
                         m_d->image,
                         nodes, activeNode),
                KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
}

References KisStrokeJobData::EXCLUSIVE, m_d, and KisStrokeJobData::SEQUENTIAL.

◆ requestUpdateAsyncFromCommand

void KisNodeJugglerCompressed::requestUpdateAsyncFromCommand ( )

signal

◆ setAutoDelete()

void KisNodeJugglerCompressed::setAutoDelete ( bool value )

Definition at line 902 of file kis_node_juggler_compressed.cpp.

{
    m_d->autoDelete = value;
    connect(&m_d->selfDestructionCompressor, SIGNAL(timeout()), SLOT(end()));
}

References connect(), end(), m_d, and value().

◆ slotEndStrokeRequested

void KisNodeJugglerCompressed::slotEndStrokeRequested ( )

privateslot

Definition at line 908 of file kis_node_juggler_compressed.cpp.

{
    if (!m_d->isStarted) return;
    end();
}

References end(), and m_d.

◆ slotImageAboutToBeDeleted

void KisNodeJugglerCompressed::slotImageAboutToBeDeleted ( )

privateslot

We should start a proper end() routine with updates to avoid an assert about missing updates

Definition at line 933 of file kis_node_juggler_compressed.cpp.

{
    if (!m_d->isStarted) return;
 
    end();
}

References end(), and m_d.

◆ slotUndoDuringStrokeRequested

void KisNodeJugglerCompressed::slotUndoDuringStrokeRequested ( )

privateslot

When the user presses Cltr+Z during the process of layer removal we should end the process and pass execution process back to the undo stack to make it undone. If we just cancel the action, then no redo action will be created (see bug 491186).

So we just wait till the end of the action and return back to the undo stack.

Definition at line 914 of file kis_node_juggler_compressed.cpp.

{
    if (!m_d->isStarted) return;
 
    KisImageSP image = m_d->image;
    end();
    image->waitForDone();
}

References end(), m_d, and KisImage::waitForDone().

◆ slotUpdateTimeout

void KisNodeJugglerCompressed::slotUpdateTimeout ( )

privateslot

Since the update should be synchronized with the flow of layer-add commands, we issue it from a fake undo command that doesn't generate any history

Definition at line 854 of file kis_node_juggler_compressed.cpp.

{
    // The juggler could have been already finished explicitly
    // by slotEndStrokeRequested(). In such a case the final updates
    // will be issued by the last command of the stroke.
 
    if (!m_d->updateData || !m_d->isStarted) return;
 
    BatchMoveUpdateDataSP updateData = m_d->updateData;
 
    m_d->applicator->applyCommand(
        new KisCommandUtils::LambdaCommand(
            [updateData] () {
                updateData->processUnhandledUpdates();
                return nullptr;
            }));
}

References m_d.

◆ startTimers

void KisNodeJugglerCompressed::startTimers ( )

privateslot

Definition at line 845 of file kis_node_juggler_compressed.cpp.

{
    m_d->compressor.start();
 
    if (m_d->autoDelete) {
        m_d->selfDestructionCompressor.start();
    }
}

References m_d.

Member Data Documentation

◆ m_d

const QScopedPointer<Private> KisNodeJugglerCompressed::m_d

private

Definition at line 60 of file kis_node_juggler_compressed.h.

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

libs/ui/kis_node_juggler_compressed.h
libs/ui/kis_node_juggler_compressed.cpp

Classes

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisNodeJugglerCompressed()

◆ ~KisNodeJugglerCompressed()

Member Function Documentation

◆ addNode()

◆ canMergeAction()

◆ cleanup()

◆ copyNode()

◆ duplicateNode()

◆ end

◆ isEnded()

◆ lowerNode()

◆ moveNode() [1/2]

◆ moveNode() [2/2]

◆ raiseNode()

◆ removeNode()

◆ requestUpdateAsyncFromCommand

◆ setAutoDelete()

◆ slotEndStrokeRequested

◆ slotImageAboutToBeDeleted

◆ slotUndoDuringStrokeRequested

◆ slotUpdateTimeout

◆ startTimers

Member Data Documentation

◆ m_d