#include <kis_switch_current_time_command.h>

Inheritance diagram for KisSwitchCurrentTimeToKeyframeCommand:

Public Member Functions
int	id () const override

	KisSwitchCurrentTimeToKeyframeCommand (KisImageAnimationInterface animation, int oldTime, KisNodeSP node, KoID channelId, KisKeyframeSP targetKeyframe, KUndo2Command parent=0)

bool	mergeWith (const KUndo2Command *command) override

void	redo () override

void	undo () override

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

Private Attributes
KisImageAnimationInterface *	m_animation

KoID	m_channelId

KisNodeSP	m_node

int	m_oldTime

KisKeyframeSP	m_targetKeyframe

Detailed Description

Definition at line 37 of file kis_switch_current_time_command.h.

Constructor & Destructor Documentation

◆ KisSwitchCurrentTimeToKeyframeCommand()

KisSwitchCurrentTimeToKeyframeCommand::KisSwitchCurrentTimeToKeyframeCommand	(	KisImageAnimationInterface *	animation,
		int	oldTime,
		KisNodeSP	node,
		KoID	channelId,
		KisKeyframeSP	targetKeyframe,
		KUndo2Command *	parent = 0 )

Definition at line 58 of file kis_switch_current_time_command.cpp.

    : KUndo2Command(kundo2_i18n("Switch current time to keyframe"), parent),
      m_animation(animation),
      m_oldTime(oldTime),
      m_node(node),
      m_channelId(channelId),
      m_targetKeyframe(targetKeyframe)
{
}

◆ ~KisSwitchCurrentTimeToKeyframeCommand()

KisSwitchCurrentTimeToKeyframeCommand::~KisSwitchCurrentTimeToKeyframeCommand ( )

override

Definition at line 68 of file kis_switch_current_time_command.cpp.

69{

70}

Member Function Documentation

◆ id()

int KisSwitchCurrentTimeToKeyframeCommand::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 72 of file kis_switch_current_time_command.cpp.

{
    return KisCommandUtils::ChangeCurrentTimeToKeyId;
}

References KisCommandUtils::ChangeCurrentTimeToKeyId.

◆ mergeWith()

bool KisSwitchCurrentTimeToKeyframeCommand::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 77 of file kis_switch_current_time_command.cpp.

{
    // Note: Maybe we could merge this with a regular time switch command with a bit more logic.
    const KisSwitchCurrentTimeToKeyframeCommand *other =
        dynamic_cast<const KisSwitchCurrentTimeToKeyframeCommand*>(command);
 
    if (!other || other->id() != id()) {
        return false;
    }
 
    m_targetKeyframe = other->m_targetKeyframe;
    return true;
}

References id(), and m_targetKeyframe.

◆ redo()

void KisSwitchCurrentTimeToKeyframeCommand::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 91 of file kis_switch_current_time_command.cpp.

{
    KisKeyframeChannel *channel = m_node->getKeyframeChannel(m_channelId.id());
    if (channel) {
        int newTime = channel->lookupKeyframeTime(m_targetKeyframe);
        m_animation->requestTimeSwitchNonGUI(newTime);
    }
}

References KisBaseNode::getKeyframeChannel(), KoID::id(), KisKeyframeChannel::lookupKeyframeTime(), m_animation, m_channelId, m_node, m_targetKeyframe, and KisImageAnimationInterface::requestTimeSwitchNonGUI().

◆ undo()

void KisSwitchCurrentTimeToKeyframeCommand::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 100 of file kis_switch_current_time_command.cpp.

{
    m_animation->requestTimeSwitchNonGUI(m_oldTime);
}

References m_animation, m_oldTime, and KisImageAnimationInterface::requestTimeSwitchNonGUI().

Member Data Documentation

◆ m_animation

KisImageAnimationInterface* KisSwitchCurrentTimeToKeyframeCommand::m_animation

private

Definition at line 50 of file kis_switch_current_time_command.h.

◆ m_channelId

KoID KisSwitchCurrentTimeToKeyframeCommand::m_channelId

private

Definition at line 53 of file kis_switch_current_time_command.h.

◆ m_node

KisNodeSP KisSwitchCurrentTimeToKeyframeCommand::m_node

private

Definition at line 52 of file kis_switch_current_time_command.h.

◆ m_oldTime

int KisSwitchCurrentTimeToKeyframeCommand::m_oldTime

private

Definition at line 51 of file kis_switch_current_time_command.h.

◆ m_targetKeyframe

KisKeyframeSP KisSwitchCurrentTimeToKeyframeCommand::m_targetKeyframe

private

Definition at line 54 of file kis_switch_current_time_command.h.

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

libs/image/commands_new/kis_switch_current_time_command.h
libs/image/commands_new/kis_switch_current_time_command.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisSwitchCurrentTimeToKeyframeCommand()

◆ ~KisSwitchCurrentTimeToKeyframeCommand()

Member Function Documentation

◆ id()

◆ mergeWith()

◆ redo()

◆ undo()

Member Data Documentation

◆ m_animation

◆ m_channelId

◆ m_node

◆ m_oldTime

◆ m_targetKeyframe