The command for layer moves inside the layer stack. More...

#include <kis_image_layer_move_command.h>

Inheritance diagram for KisImageLayerMoveCommand:

Public Member Functions
	KisImageLayerMoveCommand (KisImageWSP image, KisNodeSP node, KisNodeSP newParent, KisNodeSP newAbove, bool doUpdates=true)

	KisImageLayerMoveCommand (KisImageWSP image, KisNodeSP node, KisNodeSP newParent, quint32 index)

void	redo () override

void	undo () override

Public Member Functions inherited from KisImageCommand
	KisImageCommand (const KUndo2MagicString &name, KisImageWSP image, KUndo2Command *parent=0)

	~KisImageCommand () 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 Attributes
bool	m_doUpdates

quint32	m_index

KisNodeSP	m_layer

KisNodeSP	m_newAbove

KisNodeSP	m_newParent

KisNodeSP	m_prevAbove

KisNodeSP	m_prevParent

bool	m_useIndex

Additional Inherited Members
Protected Attributes inherited from KisImageCommand
KisImageWSP	m_image

Detailed Description

The command for layer moves inside the layer stack.

Definition at line 18 of file kis_image_layer_move_command.h.

Constructor & Destructor Documentation

◆ KisImageLayerMoveCommand() [1/2]

KisImageLayerMoveCommand::KisImageLayerMoveCommand	(	KisImageWSP	image,
		KisNodeSP	node,
		KisNodeSP	newParent,
		KisNodeSP	newAbove,
		bool	doUpdates = true )

Command for layer moves inside the layer stack

Parameters

image	the image
node	the moved node
newParent	the next parent of the layer
newAbove	the layer that will be below the layer after the move
doUpdates	whether to do updates

Definition at line 22 of file kis_image_layer_move_command.cpp.

        : KisImageCommand(kundo2_i18n("Move Layer"), image)
{
    m_layer = layer;
    m_newParent = newParent;
    m_newAbove = newAbove;
    m_prevParent = layer->parent();
    m_prevAbove = layer->prevSibling();
    m_index = -1;
    m_useIndex = false;
    m_doUpdates = doUpdates;
}

References m_doUpdates, m_index, m_layer, m_newAbove, m_newParent, m_prevAbove, m_prevParent, m_useIndex, KisNode::parent, and KisNode::prevSibling().

◆ KisImageLayerMoveCommand() [2/2]

KisImageLayerMoveCommand::KisImageLayerMoveCommand	(	KisImageWSP	image,
		KisNodeSP	node,
		KisNodeSP	newParent,
		quint32	index )

Definition at line 35 of file kis_image_layer_move_command.cpp.

        : KisImageCommand(kundo2_i18n("Move Layer"), image)
{
    m_layer = node;
    m_newParent = newParent;
    m_newAbove = 0;
    m_prevParent = node->parent();
    m_prevAbove = node->prevSibling();
    m_index = index;
    m_useIndex = true;
    m_doUpdates = true;
}

References m_doUpdates, m_index, m_layer, m_newAbove, m_newParent, m_prevAbove, m_prevParent, m_useIndex, KisNode::parent, and KisNode::prevSibling().

Member Function Documentation

◆ redo()

void KisImageLayerMoveCommand::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 48 of file kis_image_layer_move_command.cpp.

{
    KisImageSP image = m_image.toStrongRef();
    if (!image) {
        return;
    }
    if (m_useIndex) {
        image->moveNode(m_layer, m_newParent, m_index);
    } else {
        image->moveNode(m_layer, m_newParent, m_newAbove);
    }
 
    if (m_doUpdates) {
        image->refreshGraphAsync(m_prevParent, KisProjectionUpdateFlag::NoFilthy);
        if (m_newParent != m_prevParent) {
            m_layer->setDirty(image->bounds());
        }
    }
}

References KisImage::bounds(), m_doUpdates, KisImageCommand::m_image, m_index, m_layer, m_newAbove, m_newParent, m_prevParent, m_useIndex, KisNodeFacade::moveNode(), NoFilthy, KisImage::refreshGraphAsync(), KisNode::setDirty(), and KisWeakSharedPtr< T >::toStrongRef().

◆ undo()

void KisImageLayerMoveCommand::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 68 of file kis_image_layer_move_command.cpp.

{
    KisImageSP image = m_image.toStrongRef();
    if (!image) {
        return;
    }
    image->moveNode(m_layer, m_prevParent, m_prevAbove);
 
    if (m_doUpdates) {
        image->refreshGraphAsync(m_newParent, KisProjectionUpdateFlag::NoFilthy);
        if (m_newParent != m_prevParent) {
            m_layer->setDirty(image->bounds());
        }
    }
}