The command for setting the node opacity. More...

#include <kis_node_opacity_command.h>

Inheritance diagram for KisNodeOpacityCommand:

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

bool	canMergeWith (const KUndo2Command *command) const override

int	id () const override

	KisNodeOpacityCommand (KisNodeSP node, quint8 newOpacity)

bool	mergeWith (const KUndo2Command *command) override

void	redo () override

void	undo () override

Public Member Functions inherited from KisNodeCommand
	KisNodeCommand (const KUndo2MagicString &name, KisNodeSP node)

	~KisNodeCommand () override

Public Member Functions inherited from KUndo2Command
QString	actionText () 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 Attributes
QScopedPointer< KUndo2Command >	m_autokey

quint8	m_newOpacity

boost::optional< quint8 >	m_oldOpacity

Additional Inherited Members
Protected Attributes inherited from KisNodeCommand
KisNodeSP	m_node

Detailed Description

The command for setting the node opacity.

Definition at line 15 of file kis_node_opacity_command.h.

Constructor & Destructor Documentation

◆ KisNodeOpacityCommand()

KisNodeOpacityCommand::KisNodeOpacityCommand	(	KisNodeSP	node,
		quint8	newOpacity )

Constructor

Parameters

node	The node the command will be working on.
oldOpacity	the old node opacity
newOpacity	the new node opacity

Definition at line 21 of file kis_node_opacity_command.cpp.

                                                                              :
        KisNodeCommand(kundo2_i18n("Opacity Change"), node)
{
    m_newOpacity = newOpacity;
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(node->image());
 
    const int time = node->image()->animationInterface()->currentTime();
 
    KisKeyframeChannel* channel = m_node->getKeyframeChannel(KisKeyframeChannel::Opacity.id());
    if (channel && !channel->keyframeAt(time)) {
        KisScalarKeyframeChannel* scalarChannel = dynamic_cast<KisScalarKeyframeChannel*>(channel);
        KIS_ASSERT(scalarChannel);
        m_autokey.reset(new SkipFirstRedoWrapper());
        scalarChannel->addScalarKeyframe(time, newOpacity, m_autokey.data());
    }
}

References KisScalarKeyframeChannel::addScalarKeyframe(), KisImage::animationInterface(), KisImageAnimationInterface::currentTime(), KisBaseNode::getKeyframeChannel(), KisBaseNode::image, KisKeyframeChannel::keyframeAt(), KIS_ASSERT, KIS_SAFE_ASSERT_RECOVER_RETURN, m_autokey, m_newOpacity, KisNodeCommand::m_node, KisKeyframeChannel::Opacity, and KUndo2Command::time().

Member Function Documentation

◆ canAnnihilateWith()

bool KisNodeOpacityCommand::canAnnihilateWith ( const KUndo2Command * other ) const

overridevirtual

Attempts to merge this command with command and checks if the two commands compensate each other. If the function returns true, both commands are removed from the stack.

If this function returns true, calling this command's redo() followed by other redo() must have no effect.

The function itself shouldn't do any changes to the command, because after returning true, the command will be deleted as a "noop"

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 107 of file kis_node_opacity_command.cpp.

{
    const KisNodeOpacityCommand *other =
        dynamic_cast<const KisNodeOpacityCommand*>(command);
 
    if (!other || other->m_node != m_node) {
        return false;
    }
 
    if (m_autokey || other->m_autokey) {
        return false;
    }
 
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(m_oldOpacity, false);
    return *m_oldOpacity == other->m_newOpacity;
}

References KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_autokey, m_newOpacity, KisNodeCommand::m_node, and m_oldOpacity.

◆ canMergeWith()

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

overridevirtual

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 93 of file kis_node_opacity_command.cpp.

{
    const KisNodeOpacityCommand *other =
        dynamic_cast<const KisNodeOpacityCommand*>(command);
    if (!other) return false;
 
 
    bool otherCreatedKeyframe = bool(other->m_autokey);
    bool weCreatedKeyframe = bool(m_autokey);
    bool canMergeKeyframe = ((otherCreatedKeyframe ^ weCreatedKeyframe) == true) || (!otherCreatedKeyframe && !weCreatedKeyframe);
 
    return other->m_node == m_node && canMergeKeyframe;
}

References m_autokey, and KisNodeCommand::m_node.

◆ id()

int KisNodeOpacityCommand::id ( ) const

overridevirtual

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 70 of file kis_node_opacity_command.cpp.

{
    return KisCommandUtils::ChangeNodeOpacityId;
}

References KisCommandUtils::ChangeNodeOpacityId.

◆ mergeWith()

bool KisNodeOpacityCommand::mergeWith ( const KUndo2Command * command )

overridevirtual

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 75 of file kis_node_opacity_command.cpp.

{
    const KisNodeOpacityCommand *other =
        dynamic_cast<const KisNodeOpacityCommand*>(command);
 
    if (other && other->m_node == m_node) {
        // verify both commands have been executed and they are consecutive
        KIS_SAFE_ASSERT_RECOVER_NOOP(m_oldOpacity);
        KIS_SAFE_ASSERT_RECOVER_NOOP(other->m_oldOpacity);
        KIS_SAFE_ASSERT_RECOVER_NOOP(other->m_oldOpacity && m_newOpacity == *other->m_oldOpacity);
 
        m_newOpacity = other->m_newOpacity;
        return true;
    }
 
    return false;
}

References KIS_SAFE_ASSERT_RECOVER_NOOP, m_newOpacity, KisNodeCommand::m_node, and m_oldOpacity.

◆ redo()

void KisNodeOpacityCommand::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 39 of file kis_node_opacity_command.cpp.

{
    if (!m_oldOpacity) {
        m_oldOpacity = m_node->opacity();
    }
 
    if (m_autokey) {
        m_autokey->redo();
    }
 
    m_node->setOpacity(m_newOpacity);
    m_node->setDirty();
 
    // BUG:499389 workaround.
    // Unlike drawing, non-animated opacity changes need to be recached across all raster frames.
    // It's probably better to change KisNode::setDirty, KisImage::requestProjectionUpdate, and/or KisProjectionUpdateFlags.
    m_node->invalidateFrames(KisTimeSpan::infinite(0), QRect());
}

References KisTimeSpan::infinite(), KisNode::invalidateFrames(), m_autokey, m_newOpacity, KisNodeCommand::m_node, m_oldOpacity, KisBaseNode::opacity(), KisNode::setDirty(), and KisBaseNode::setOpacity().

◆ undo()

void KisNodeOpacityCommand::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 58 of file kis_node_opacity_command.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_oldOpacity);
 
    m_node->setOpacity(*m_oldOpacity);
    m_node->setDirty();
 
    if (m_autokey) {
        m_autokey->undo();
    }
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_autokey, KisNodeCommand::m_node, m_oldOpacity, KisNode::setDirty(), and KisBaseNode::setOpacity().

Member Data Documentation

◆ m_autokey

QScopedPointer<KUndo2Command> KisNodeOpacityCommand::m_autokey

private

Definition at line 37 of file kis_node_opacity_command.h.

◆ m_newOpacity

quint8 KisNodeOpacityCommand::m_newOpacity

private

Definition at line 38 of file kis_node_opacity_command.h.

◆ m_oldOpacity

boost::optional<quint8> KisNodeOpacityCommand::m_oldOpacity

private

Definition at line 36 of file kis_node_opacity_command.h.

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

libs/image/commands/kis_node_opacity_command.h
libs/image/commands/kis_node_opacity_command.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisNodeOpacityCommand()

Member Function Documentation

◆ canAnnihilateWith()

◆ canMergeWith()

◆ id()

◆ mergeWith()

◆ redo()

◆ undo()

Member Data Documentation

◆ m_autokey

◆ m_newOpacity

◆ m_oldOpacity