#include <kis_update_command.h>

Inheritance diagram for KisUpdateCommand:

Public Member Functions
	KisUpdateCommand (KisNodeSP node, QRect dirtyRect, KisUpdatesFacade *updatesFacade, bool needsFullRefresh=false)

	KisUpdateCommand (KisNodeSP node, QSharedPointer< QRect > dirtyRect, KisUpdatesFacade *updatesFacade, bool needsFullRefresh=false)

void	redo () override

void	undo () override

	~KisUpdateCommand () 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 int	id () const

virtual bool	isMerged () const

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

	KUndo2Command (KUndo2Command *parent=0)

virtual QVector< KUndo2Command * >	mergeCommandsVector () const

virtual bool	mergeWith (const KUndo2Command *other)

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 ()

Private Member Functions
void	update ()

Private Attributes
QRect	m_dirtyRect

bool	m_needsFullRefresh

KisNodeSP	m_node

QSharedPointer< QRect >	m_sharedDirtyRect

KisUpdatesFacade *	m_updatesFacade

Detailed Description

Definition at line 18 of file kis_update_command.h.

Constructor & Destructor Documentation

◆ KisUpdateCommand() [1/2]

KisUpdateCommand::KisUpdateCommand	(	KisNodeSP	node,
		QRect	dirtyRect,
		KisUpdatesFacade *	updatesFacade,
		bool	needsFullRefresh = false )

Definition at line 13 of file kis_update_command.cpp.

    : KUndo2Command(kundo2_noi18n("UPDATE_COMMAND")),
      m_node(node),
      m_dirtyRect(dirtyRect),
      m_sharedDirtyRect(nullptr),
      m_updatesFacade(updatesFacade),
      m_needsFullRefresh(needsFullRefresh)
{
}

◆ KisUpdateCommand() [2/2]

KisUpdateCommand::KisUpdateCommand	(	KisNodeSP	node,
		QSharedPointer< QRect >	dirtyRect,
		KisUpdatesFacade *	updatesFacade,
		bool	needsFullRefresh = false )

Definition at line 25 of file kis_update_command.cpp.

    : KUndo2Command(kundo2_noi18n("UPDATE_COMMAND")),
      m_node(node),
      m_sharedDirtyRect(dirtyRect),
      m_updatesFacade(updatesFacade),
      m_needsFullRefresh(needsFullRefresh)
{
}

◆ ~KisUpdateCommand()

KisUpdateCommand::~KisUpdateCommand ( )

override

Definition at line 36 of file kis_update_command.cpp.

37{

38}

Member Function Documentation

◆ redo()

void KisUpdateCommand::redo ( )

overridevirtual

Applies a change to the document. This function must be implemented in the derived class. Calling KUndo2QStack::push(), KUndo2QStack::undo() or KUndo2QStack::redo() from this function leads to undefined behavior.

The default implementation calls redo() on all child commands.

See also: undo()

Reimplemented from KUndo2Command.

Definition at line 46 of file kis_update_command.cpp.

{
    KUndo2Command::redo();
    update();
}

References KUndo2Command::redo(), and update().

◆ undo()

void KisUpdateCommand::undo ( )

overridevirtual

Reverts a change to the document. After undo() is called, the state of the document should be the same as before redo() was called. This function must be implemented in the derived class. Calling KUndo2QStack::push(), KUndo2QStack::undo() or KUndo2QStack::redo() from this function leads to undefined behavior.

The default implementation calls undo() on all child commands in reverse order.

See also: redo()

Reimplemented from KUndo2Command.

Definition at line 40 of file kis_update_command.cpp.

{
    KUndo2Command::undo();
    update();
}

References KUndo2Command::undo(), and update().

◆ update()

void KisUpdateCommand::update ( )

private

Definition at line 52 of file kis_update_command.cpp.

{
    if(m_needsFullRefresh) {
        m_updatesFacade->refreshGraphAsync(m_node, m_dirtyRect);
    }
    else {
        if (m_sharedDirtyRect) {
            m_node->setDirty(*m_sharedDirtyRect);
        } else {
            m_node->setDirty(m_dirtyRect);
        }
    }
}

References m_dirtyRect, m_needsFullRefresh, m_node, m_sharedDirtyRect, m_updatesFacade, KisUpdatesFacade::refreshGraphAsync(), and KisNode::setDirty().

Member Data Documentation

◆ m_dirtyRect

QRect KisUpdateCommand::m_dirtyRect

private

Definition at line 37 of file kis_update_command.h.

◆ m_needsFullRefresh

bool KisUpdateCommand::m_needsFullRefresh

private

Definition at line 40 of file kis_update_command.h.

◆ m_node

KisNodeSP KisUpdateCommand::m_node

private

Definition at line 36 of file kis_update_command.h.

◆ m_sharedDirtyRect

QSharedPointer<QRect> KisUpdateCommand::m_sharedDirtyRect

private

Definition at line 38 of file kis_update_command.h.

◆ m_updatesFacade

KisUpdatesFacade* KisUpdateCommand::m_updatesFacade

private

Definition at line 39 of file kis_update_command.h.

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

libs/image/commands_new/kis_update_command.h
libs/image/commands_new/kis_update_command.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisUpdateCommand() [1/2]

◆ KisUpdateCommand() [2/2]

◆ ~KisUpdateCommand()

Member Function Documentation

◆ redo()

◆ undo()

◆ update()

Member Data Documentation

◆ m_dirtyRect

◆ m_needsFullRefresh

◆ m_node

◆ m_sharedDirtyRect

◆ m_updatesFacade