Inheritance diagram for EmitImageSignalsCommand:

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

	EmitImageSignalsCommand (KisImageWSP image, KisImageSignalVector emitSignals, bool finalUpdate)

int	id () const override

bool	mergeWith (const KUndo2Command *command) override

void	partB () override

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
void	doUpdate (KisImageSignalVector emitSignals)

Private Attributes
KisImageSignalVector	m_emitSignals

KisImageWSP	m_image

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

virtual void	partA ()

Detailed Description

Definition at line 180 of file kis_processing_applicator.cpp.

Constructor & Destructor Documentation

◆ EmitImageSignalsCommand()

EmitImageSignalsCommand::EmitImageSignalsCommand	(	KisImageWSP	image,
		KisImageSignalVector	emitSignals,
		bool	finalUpdate )

inline

Definition at line 183 of file kis_processing_applicator.cpp.

        : FlipFlopCommand(finalUpdate),
          m_image(image),
          m_emitSignals(emitSignals)
    {
    }

Member Function Documentation

◆ canMergeWith()

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

inlineoverridevirtual

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 216 of file kis_processing_applicator.cpp.

                                                                   {
        const EmitImageSignalsCommand *other =
            dynamic_cast<const EmitImageSignalsCommand*>(command);
 
        return other &&
            other->m_image == m_image;
 
            // TODO: implement proper comparison for emitted signals
            // other->m_emitSignals == m_emitSignals;
    }

References m_image.

◆ doUpdate()

void EmitImageSignalsCommand::doUpdate ( KisImageSignalVector emitSignals )

inlineprivate

Definition at line 228 of file kis_processing_applicator.cpp.

                                                    {
        Q_FOREACH (KisImageSignalType type, emitSignals) {
            m_image->signalRouter()->emitNotification(type);
        }
    }

References KisImageSignalRouter::emitNotification(), m_image, and KisImage::signalRouter().

◆ id()

int EmitImageSignalsCommand::id ( ) const

inlineoverridevirtual

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 208 of file kis_processing_applicator.cpp.

                            {
        return KisCommandUtils::EmitImageSignalsCommandId;
    }

References KisCommandUtils::EmitImageSignalsCommandId.

◆ mergeWith()

bool EmitImageSignalsCommand::mergeWith ( const KUndo2Command * command )

inlineoverridevirtual

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 212 of file kis_processing_applicator.cpp.

                                                          {
        return canMergeWith(command);
    }

References canMergeWith().

◆ partB()

void EmitImageSignalsCommand::partB ( )

inlineoverridevirtual

Reimplemented from KisCommandUtils::FlipFlopCommand.

Definition at line 192 of file kis_processing_applicator.cpp.

                          {
        if (getState() == State::FINALIZING) {
            doUpdate(m_emitSignals);
        } else {
            KisImageSignalVector reverseSignals;
 
            KisImageSignalVector::iterator i = m_emitSignals.end();
            while (i != m_emitSignals.begin()) {
                --i;
                reverseSignals.append(i->inverted());
            }
 
            doUpdate(reverseSignals);
        }
    }

References doUpdate(), KisCommandUtils::FlipFlopCommand::FINALIZING, KisCommandUtils::FlipFlopCommand::getState(), and m_emitSignals.

Member Data Documentation

◆ m_emitSignals

KisImageSignalVector EmitImageSignalsCommand::m_emitSignals

private

Definition at line 236 of file kis_processing_applicator.cpp.

◆ m_image

KisImageWSP EmitImageSignalsCommand::m_image

private

Definition at line 235 of file kis_processing_applicator.cpp.

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

libs/image/kis_processing_applicator.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EmitImageSignalsCommand()

Member Function Documentation

◆ canMergeWith()

◆ doUpdate()

◆ id()

◆ mergeWith()

◆ partB()

Member Data Documentation

◆ m_emitSignals

◆ m_image