Inheritance diagram for UpdateCommand:

Public Member Functions
	UpdateCommand (KisImageWSP image, KisNodeList nodes, KisProcessingApplicator::ProcessingFlags flags, State initialState, QSharedPointer< bool > sharedAllFramesToken)

Public Member Functions inherited from KisCommandUtils::FlipFlopCommand
	FlipFlopCommand (bool finalizing=false, KUndo2Command *parent=0)

	FlipFlopCommand (State initialState, KUndo2Command *parent=0)

void	redo () override

void	undo () override

Public Member Functions inherited from KUndo2Command
QString	actionText () const

virtual bool	canAnnihilateWith (const KUndo2Command *other) const

const KUndo2Command *	child (int index) const

int	childCount () const

virtual QTime	endTime () const

KUndo2CommandExtraData *	extraData () const

bool	hasParent () const

virtual bool	isMerged () const

	KUndo2Command (const KUndo2MagicString &text, KUndo2Command *parent=0)

	KUndo2Command (KUndo2Command *parent=0)

virtual QVector< KUndo2Command * >	mergeCommandsVector () const

virtual void	redoMergedCommands ()

void	setEndTime ()

virtual void	setEndTime (const QTime &time)

void	setExtraData (KUndo2CommandExtraData *data)

void	setText (const KUndo2MagicString &text)

void	setTime ()

virtual void	setTime (const QTime &time)

virtual void	setTimedID (int timedID)

KUndo2MagicString	text () const

virtual QTime	time () const

virtual int	timedId () const

virtual bool	timedMergeWith (KUndo2Command *other)

virtual void	undoMergedCommands ()

virtual	~KUndo2Command ()

Public Member Functions inherited from KisAsynchronouslyMergeableCommandInterface
virtual	~KisAsynchronouslyMergeableCommandInterface ()

Private Member Functions
bool	canMergeWith (const KUndo2Command *command) const override

int	id () const override

bool	mergeWith (const KUndo2Command *command) override

void	partA () override

void	partB () override

void	updateClones (KisNodeSP node)

Private Attributes
KisProcessingApplicator::ProcessingFlags	m_flags

KisImageWSP	m_image

KisNodeList	m_nodes

QSharedPointer< bool >	m_sharedAllFramesToken

Additional Inherited Members
Public Types inherited from KisCommandUtils::FlipFlopCommand
enum	State { INITIALIZING , FINALIZING }

Protected Member Functions inherited from KisCommandUtils::FlipFlopCommand
State	getState () const

bool	isFirstRedo () const

Detailed Description

Definition at line 63 of file kis_processing_applicator.cpp.

Constructor & Destructor Documentation

◆ UpdateCommand()

UpdateCommand::UpdateCommand	(	KisImageWSP	image,
		KisNodeList	nodes,
		KisProcessingApplicator::ProcessingFlags	flags,
		State	initialState,
		QSharedPointer< bool >	sharedAllFramesToken )

inline

Definition at line 66 of file kis_processing_applicator.cpp.

        : FlipFlopCommand(initialState),
          m_image(image),
          m_nodes(nodes),
          m_flags(flags),
          m_sharedAllFramesToken(sharedAllFramesToken)
    {
    }

Member Function Documentation

◆ canMergeWith()

bool UpdateCommand::canMergeWith ( const KUndo2Command * command ) const

inlineoverrideprivatevirtual

Returns: true if command can be merged with (*this) command using KUndo2Command::mergeWith() call.

WARNING: if canMergeWith() returned true, then mergeWith() must also return true. Otherwise KisSavedMacroCommand will be able to enter inconsistent state and assert.

Implements KisAsynchronouslyMergeableCommandInterface.

Definition at line 161 of file kis_processing_applicator.cpp.

                                                                   {
        const UpdateCommand *other =
            dynamic_cast<const UpdateCommand*>(command);
 
        return other &&
            other->m_image == m_image &&
            other->m_nodes == m_nodes &&
            other->m_flags == m_flags &&
            bool(other->m_sharedAllFramesToken) == bool(m_sharedAllFramesToken) &&
            (!m_sharedAllFramesToken || *m_sharedAllFramesToken == *other->m_sharedAllFramesToken);
    }

References m_flags, m_image, m_nodes, and m_sharedAllFramesToken.

◆ id()

int UpdateCommand::id ( ) const

inlineoverrideprivatevirtual

Returns the ID of this command.

A command ID is used in command compression. It must be an integer unique to this command's class, or -1 if the command doesn't support compression.

If the command supports compression this function must be overridden in the derived class to return the correct ID. The base implementation returns -1.

KUndo2QStack::push() will only try to merge two commands if they have the same ID, and the ID is not -1.

See also: mergeWith(), KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 153 of file kis_processing_applicator.cpp.

                            {
        return KisCommandUtils::UpdateCommandId;
    }

References KisCommandUtils::UpdateCommandId.

◆ mergeWith()

bool UpdateCommand::mergeWith ( const KUndo2Command * command )

inlineoverrideprivatevirtual

Attempts to merge this command with command. Returns true on success; otherwise returns false.

If this function returns true, calling this command's redo() must have the same effect as redoing both this command and command. Similarly, calling this command's undo() must have the same effect as undoing command and this command.

KUndo2QStack will only try to merge two commands if they have the same id, and the id is not -1.

The default implementation returns false.

See also: id() KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 157 of file kis_processing_applicator.cpp.

                                                          {
        return canMergeWith(command);
    }

◆ partA()

void UpdateCommand::partA ( )

inlineoverrideprivatevirtual

We disable all non-centralized updates here. Everything should be done by this command's explicit updates.

If you still need third-party updates work, please add a flag to the applicator.

Reimplemented from KisCommandUtils::FlipFlopCommand.

Definition at line 78 of file kis_processing_applicator.cpp.

                          {
        m_image->disableDirtyRequests();
    }

References KisImage::disableDirtyRequests(), and m_image.

◆ partB()

void UpdateCommand::partB ( )

inlineoverrideprivatevirtual

Reimplemented from KisCommandUtils::FlipFlopCommand.

Definition at line 89 of file kis_processing_applicator.cpp.

                          {
        m_image->enableDirtyRequests();
 
        if (*m_sharedAllFramesToken) {
            KisLayerUtils::recursiveApplyNodes(m_image->root(), [](KisNodeSP node){
                KisPaintLayer* paintLayer = qobject_cast<KisPaintLayer*>(node.data());
                if (paintLayer && paintLayer->onionSkinEnabled()) {
                    paintLayer->flushOnionSkinCache();
                }
            });
        }
 
        Q_FOREACH(KisNodeSP node, m_nodes) {
            m_image->root()->graphListener()->invalidateFrames(KisTimeSpan::infinite(0), node->exactBounds());
 
            if (!m_flags.testFlag(KisProcessingApplicator::NO_IMAGE_UPDATES)) {
                if(m_flags.testFlag(KisProcessingApplicator::RECURSIVE)) {
                    m_image->refreshGraphAsync(node);
                }
 
                node->setDirty(m_image->bounds());
 
                updateClones(node);
            }
        }
    }

References KisImage::enableDirtyRequests(), m_image, m_sharedAllFramesToken, KisLayerUtils::recursiveApplyNodes(), and KisNodeFacade::root.

◆ updateClones()

void UpdateCommand::updateClones ( KisNodeSP node )

inlineprivate

TODO: completely remove these clone updates code in Krita 6

These updates should actually be issued by KisBaseRectsWalker::registerCloneNotification(), so we disable then for now. If no reports about broken clones arrive until Krita 6, just remove this (deprecated?) code.

Definition at line 116 of file kis_processing_applicator.cpp.

                                      {
        if (qEnvironmentVariableIsSet("KRITA_ENABLE_CLONE_UPDATES_IN_APPLICATOR")) {
            // simple tail-recursive iteration
            KisNodeSP prevNode = node->lastChild();
            while(prevNode) {
                updateClones(prevNode);
                prevNode = prevNode->prevSibling();
            }
 
            Q_FOREACH(KisNodeSP node, m_nodes) {
                KisLayer *layer = qobject_cast<KisLayer*>(node.data());
                if(layer && layer->hasClones()) {
                    Q_FOREACH (KisCloneLayerSP clone, layer->registeredClones()) {
                        if(!clone) continue;
 
                        QPoint offset(clone->x(), clone->y());
                        QRegion dirtyRegion(m_image->bounds());
                        dirtyRegion -= m_image->bounds().translated(offset);
 
                        clone->setDirty(KisRegion::fromQRegion(dirtyRegion));
                    }
                }
            }
        }
    }