#include <kis_keyframe_commands.h>

Inheritance diagram for KisScalarKeyframeUpdateCommand:

Public Types
template<typename T >
using	UndoStore = QPair<T, T>

Public Member Functions
	KisScalarKeyframeUpdateCommand (KisScalarKeyframe keyframe, KisScalarKeyframe::InterpolationMode interpMode, KUndo2Command parentCmd)

	KisScalarKeyframeUpdateCommand (KisScalarKeyframe keyframe, KisScalarKeyframe::TangentsMode tangentMode, KUndo2Command parentCmd)

	KisScalarKeyframeUpdateCommand (KisScalarKeyframe keyframe, QPointF tangentLeft, QPointF tangentRight, KUndo2Command parentCmd)

	KisScalarKeyframeUpdateCommand (KisScalarKeyframe keyframe, qreal value, KisScalarKeyframe::InterpolationMode interpolationMode, KisScalarKeyframe::TangentsMode tangentMode, QPointF tangentLeft, QPointF tangentRight, KUndo2Command parentCmd)

	KisScalarKeyframeUpdateCommand (KisScalarKeyframe keyframe, qreal value, KUndo2Command parentCmd)

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 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
UndoStore< KisScalarKeyframe::InterpolationMode >	cachedInterpolationMode

UndoStore< QPointF >	cachedTangentLeft

UndoStore< QPointF >	cachedTangentRight

UndoStore< KisScalarKeyframe::TangentsMode >	cachedTangentsMode

UndoStore< qreal >	cachedValue

KisScalarKeyframe *	keyframe

Detailed Description

Definition at line 50 of file kis_keyframe_commands.h.

Member Typedef Documentation

◆ UndoStore

template<typename T >

using KisScalarKeyframeUpdateCommand::UndoStore = QPair<T, T>

Definition at line 94 of file kis_keyframe_commands.h.

Constructor & Destructor Documentation

◆ KisScalarKeyframeUpdateCommand() [1/5]

KisScalarKeyframeUpdateCommand::KisScalarKeyframeUpdateCommand	(	KisScalarKeyframe *	keyframe,
		qreal	value,
		KisScalarKeyframe::InterpolationMode	interpolationMode,
		KisScalarKeyframe::TangentsMode	tangentMode,
		QPointF	tangentLeft,
		QPointF	tangentRight,
		KUndo2Command *	parentCmd )

Definition at line 54 of file kis_keyframe_commands.cpp.

    : KUndo2Command(parentCmd),
      keyframe(keyframe),
      cachedValue(keyframe->value(), value),
      cachedInterpolationMode(keyframe->interpolationMode(), interpolationMode),
      cachedTangentsMode(keyframe->tangentsMode(), tangentMode),
      cachedTangentLeft(keyframe->leftTangent(), tangentLeft),
      cachedTangentRight(keyframe->rightTangent(), tangentRight)
{}

◆ KisScalarKeyframeUpdateCommand() [2/5]

KisScalarKeyframeUpdateCommand::KisScalarKeyframeUpdateCommand	(	KisScalarKeyframe *	keyframe,
		qreal	value,
		KUndo2Command *	parentCmd )

inline

Definition at line 61 of file kis_keyframe_commands.h.

        : KisScalarKeyframeUpdateCommand(keyframe, value, keyframe->m_interpolationMode,
                                         keyframe->m_tangentsMode, keyframe->m_leftTangent,
                                         keyframe->m_rightTangent, parentCmd) {};

◆ KisScalarKeyframeUpdateCommand() [3/5]

KisScalarKeyframeUpdateCommand::KisScalarKeyframeUpdateCommand	(	KisScalarKeyframe *	keyframe,
		KisScalarKeyframe::InterpolationMode	interpMode,
		KUndo2Command *	parentCmd )

inline

Definition at line 68 of file kis_keyframe_commands.h.

        : KisScalarKeyframeUpdateCommand(keyframe, keyframe->m_value, interpMode,
                                         keyframe->m_tangentsMode, keyframe->m_leftTangent,
                                         keyframe->m_rightTangent, parentCmd) {};

◆ KisScalarKeyframeUpdateCommand() [4/5]

KisScalarKeyframeUpdateCommand::KisScalarKeyframeUpdateCommand	(	KisScalarKeyframe *	keyframe,
		KisScalarKeyframe::TangentsMode	tangentMode,
		KUndo2Command *	parentCmd )

inline

Definition at line 75 of file kis_keyframe_commands.h.

        : KisScalarKeyframeUpdateCommand(keyframe, keyframe->m_value, keyframe->m_interpolationMode,
                                         tangentMode, keyframe->m_leftTangent,
                                         keyframe->m_rightTangent, parentCmd) {};

◆ KisScalarKeyframeUpdateCommand() [5/5]

KisScalarKeyframeUpdateCommand::KisScalarKeyframeUpdateCommand	(	KisScalarKeyframe *	keyframe,
		QPointF	tangentLeft,
		QPointF	tangentRight,
		KUndo2Command *	parentCmd )

inline

Definition at line 82 of file kis_keyframe_commands.h.

        : KisScalarKeyframeUpdateCommand(keyframe, keyframe->m_value, keyframe->m_interpolationMode,
                                         keyframe->m_tangentsMode, tangentLeft,
                                         tangentRight, parentCmd) {};

Member Function Documentation

◆ redo()

void KisScalarKeyframeUpdateCommand::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 64 of file kis_keyframe_commands.cpp.

{
    KIS_ASSERT(keyframe);
 
    QSharedPointer<ScalarKeyframeLimits> limits = keyframe->m_channelLimits.toStrongRef();
    if (limits) {
        keyframe->m_value = limits->clamp(cachedValue.second);
    } else {
        keyframe->m_value = cachedValue.second;
    }
 
    keyframe->m_interpolationMode = cachedInterpolationMode.second;
    keyframe->m_tangentsMode = cachedTangentsMode.second;
    keyframe->m_leftTangent = cachedTangentLeft.second;
    keyframe->m_rightTangent = cachedTangentRight.second;
 
    keyframe->sigChanged(keyframe);
}

References cachedInterpolationMode, cachedTangentLeft, cachedTangentRight, cachedTangentsMode, cachedValue, keyframe, KIS_ASSERT, KisScalarKeyframe::m_channelLimits, KisScalarKeyframe::m_interpolationMode, KisScalarKeyframe::m_leftTangent, KisScalarKeyframe::m_rightTangent, KisScalarKeyframe::m_tangentsMode, KisScalarKeyframe::m_value, and KisScalarKeyframe::sigChanged().

◆ undo()

void KisScalarKeyframeUpdateCommand::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 83 of file kis_keyframe_commands.cpp.

{
    KIS_ASSERT(keyframe);
 
    QSharedPointer<ScalarKeyframeLimits> limits = keyframe->m_channelLimits.toStrongRef();
    if (limits) {
        keyframe->m_value = limits->clamp(cachedValue.first);
    } else {
        keyframe->m_value = cachedValue.first;
    }
 
    keyframe->m_interpolationMode = cachedInterpolationMode.first;
    keyframe->m_tangentsMode = cachedTangentsMode.first;
    keyframe->m_leftTangent = cachedTangentLeft.first;
    keyframe->m_rightTangent = cachedTangentRight.first;
 
    keyframe->sigChanged(keyframe);
}

References cachedInterpolationMode, cachedTangentLeft, cachedTangentRight, cachedTangentsMode, cachedValue, keyframe, KIS_ASSERT, KisScalarKeyframe::m_channelLimits, KisScalarKeyframe::m_interpolationMode, KisScalarKeyframe::m_leftTangent, KisScalarKeyframe::m_rightTangent, KisScalarKeyframe::m_tangentsMode, KisScalarKeyframe::m_value, and KisScalarKeyframe::sigChanged().

Member Data Documentation

◆ cachedInterpolationMode

UndoStore<KisScalarKeyframe::InterpolationMode> KisScalarKeyframeUpdateCommand::cachedInterpolationMode

private

Definition at line 99 of file kis_keyframe_commands.h.

◆ cachedTangentLeft

UndoStore<QPointF> KisScalarKeyframeUpdateCommand::cachedTangentLeft

private

Definition at line 101 of file kis_keyframe_commands.h.

◆ cachedTangentRight

UndoStore<QPointF> KisScalarKeyframeUpdateCommand::cachedTangentRight

private

Definition at line 102 of file kis_keyframe_commands.h.

◆ cachedTangentsMode

UndoStore<KisScalarKeyframe::TangentsMode> KisScalarKeyframeUpdateCommand::cachedTangentsMode

private

Definition at line 100 of file kis_keyframe_commands.h.

◆ cachedValue

UndoStore<qreal> KisScalarKeyframeUpdateCommand::cachedValue

private

Definition at line 98 of file kis_keyframe_commands.h.

◆ keyframe

KisScalarKeyframe* KisScalarKeyframeUpdateCommand::keyframe

private

Definition at line 97 of file kis_keyframe_commands.h.

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

libs/image/kis_keyframe_commands.h
libs/image/kis_keyframe_commands.cpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ UndoStore

Constructor & Destructor Documentation

◆ KisScalarKeyframeUpdateCommand() [1/5]

◆ KisScalarKeyframeUpdateCommand() [2/5]

◆ KisScalarKeyframeUpdateCommand() [3/5]

◆ KisScalarKeyframeUpdateCommand() [4/5]

◆ KisScalarKeyframeUpdateCommand() [5/5]

Member Function Documentation

◆ redo()

◆ undo()

Member Data Documentation

◆ cachedInterpolationMode

◆ cachedTangentLeft

◆ cachedTangentRight

◆ cachedTangentsMode

◆ cachedValue

◆ keyframe