KisKeyframeChannel Class Reference

KisKeyframeChannel stores and manages KisKeyframes. Maps units of time to virtual keyframe values. This class is a key piece of Krita's animation backend. Abstract base class of KisRasterKeyframeChannel, KisScalarKeyframeChannel, etc. More...

#include <kis_keyframe_channel.h>

Inheritance diagram for KisKeyframeChannel:

Classes
struct	Private

Signals
void	sigAddedKeyframe (const KisKeyframeChannel *channel, int time)
	This signal is emitted just AFTER a keyframe was added to the channel.
void	sigAnyKeyframeChange ()
void	sigKeyframeAboutToBeRemoved (const KisKeyframeChannel *channel, int time)
	This signal is emitted just BEFORE a keyframe is removed from the channel.
void	sigKeyframeChanged (const KisKeyframeChannel *channel, int time)
	This signal is emitted just AFTER a non-raster keyframe was changed its value.
void	sigKeyframeHasBeenRemoved (const KisKeyframeChannel *channel, int time)
	This signal is emitted just AFTER a keyframe is removed from the channel.

Public Member Functions
KisKeyframeSP	activeKeyframeAt (int time) const
template<class KeyframeType >
QSharedPointer< KeyframeType >	activeKeyframeAt (int time) const
int	activeKeyframeTime () const
int	activeKeyframeTime (int time) const
	Get the time of the active keyframe. Useful for snapping any time to that of the most recent keyframe.
void	addKeyframe (int time, KUndo2Command *parentUndoCmd=nullptr)
	Add a new keyframe to the channel at the specified time.
virtual KisTimeSpan	affectedFrames (int time) const
	Get the set of frames affected by any changes to the value or content of the active keyframe at the given time.
virtual QRect	affectedRect (int time) const =0
QSet< int >	allKeyframeTimes () const
	Get a set of all integer times that map to a keyframe.
int	channelHash () const
	Calculates a pseudo-unique hash based on the relevant internal state of the channel.
void	copyKeyframe (int sourceTime, int targetTime, KUndo2Command *parentUndoCmd=nullptr)
int	firstKeyframeTime () const
QString	id () const
virtual KisTimeSpan	identicalFrames (int time) const
	Get a span of times for which the channel gives identical results compared to frame at a given time. NOTE: This set may be different than the set of affected frames due to interpolation.
virtual void	insertKeyframe (int time, KisKeyframeSP keyframe, KUndo2Command *parentUndoCmd=nullptr)
	Insert an existing keyframe into the channel at the specified time.
KisKeyframeSP	keyframeAt (int time) const
	Get a keyframe at specified time. Used primarily when the value of a given keyframe is needed.
template<class KeyframeType >
QSharedPointer< KeyframeType >	keyframeAt (int time) const
int	keyframeCount () const
	KisKeyframeChannel (const KisKeyframeChannel &rhs)
	KisKeyframeChannel (const KoID &id, KisDefaultBoundsBaseSP bounds)
int	lastKeyframeTime () const
virtual void	loadXML (const QDomElement &channelNode)
int	lookupKeyframeTime (KisKeyframeSP toLookup)
	Search for the time for a given keyframe. (Reverse map lookup, so use sparingly.)
void	moveKeyframe (int sourceTime, int targetTime, KUndo2Command *parentUndoCmd=nullptr)
QString	name () const
int	nextKeyframeTime (const int time) const
KisNodeWSP	node () const
int	previousKeyframeTime (const int time) const
virtual void	removeKeyframe (int time, KUndo2Command *parentUndoCmd=nullptr)
	Remove a keyframe from the channel at the specified time.
void	setDefaultBounds (KisDefaultBoundsBaseSP bounds)
void	setNode (KisNodeWSP node)
void	swapKeyframes (int timeA, int timeB, KUndo2Command *parentUndoCmd=nullptr)
virtual QDomElement	toXML (QDomDocument doc, const QString &layerFilename)
	~KisKeyframeChannel () override

Static Public Member Functions
static KoID	channelIdToKoId (const QString &id)
static void	copyKeyframe (const KisKeyframeChannel *sourceChannel, int sourceTime, KisKeyframeChannel *targetChannel, int targetTime, KUndo2Command *parentUndoCmd=nullptr)
	Copy a keyframe across channel(s) at the specified times.
static void	moveKeyframe (KisKeyframeChannel *sourceChannel, int sourceTime, KisKeyframeChannel *targetChannel, int targetTime, KUndo2Command *parentUndoCmd=nullptr)
	Move a keyframe across channel(s) at the specified times.
static void	swapKeyframes (KisKeyframeChannel *channelA, int timeA, KisKeyframeChannel *channelB, int timeB, KUndo2Command *parentUndoCmd=nullptr)
	Swap two keyframes across channel(s) at the specified times.

Static Public Attributes
static const KoID	Opacity = KoID("opacity", ki18n("Opacity"))
static const KoID	PositionX = KoID("transform_pos_x", ki18n("Position (X)"))
static const KoID	PositionY = KoID("transform_pos_y", ki18n("Position (Y)"))
static const KoID	Raster = KoID("content", ki18n("Content"))
static const KoID	RotationX = KoID("transform_rotation_x", ki18n("Rotation (X)"))
static const KoID	RotationY = KoID("transform_rotation_y", ki18n("Rotation (Y)"))
static const KoID	RotationZ = KoID("transform_rotation_z", ki18n("Rotation (Z)"))
static const KoID	ScaleX = KoID("transform_scale_x", ki18n("Scale (X)"))
static const KoID	ScaleY = KoID("transform_scale_y", ki18n("Scale (Y)"))
static const KoID	ShearX = KoID("transform_shear_x", ki18n("Shear (X)"))
static const KoID	ShearY = KoID("transform_shear_y", ki18n("Shear (Y)"))
static const KoID	TransformArguments

Protected Types
typedef QMap< int, KisKeyframeSP >	TimeKeyframeMap

Protected Member Functions
const TimeKeyframeMap &	constKeys () const
int	currentTime () const
TimeKeyframeMap &	keys ()
virtual void	removeKeyframeImpl (int time, KUndo2Command *parentUndoCmd)
Q_DECL_DEPRECATED void	workaroundBrokenFrameTimeBug (int *time)
	Between Krita 4.1 and 4.4 Krita had a bug which resulted in creating frames with negative time stamp. The bug has been fixed, but there might be some files still in the wild.

Private Member Functions
virtual KisKeyframeSP	createKeyframe ()=0
	Virtual keyframe creation function. Derived classes implement this function based on the needs of their specific KisKeyframe subclasses.
virtual QPair< int, KisKeyframeSP >	loadKeyframe (const QDomElement &keyframeNode)=0
virtual void	saveKeyframe (KisKeyframeSP keyframe, QDomElement keyframeElement, const QString &layerFilename)=0

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

KisKeyframeChannel stores and manages KisKeyframes. Maps units of time to virtual keyframe values. This class is a key piece of Krita's animation backend. Abstract base class of KisRasterKeyframeChannel, KisScalarKeyframeChannel, etc.

Definition at line 32 of file kis_keyframe_channel.h.

Member Typedef Documentation

TimeKeyframeMap

typedef QMap<int, KisKeyframeSP> KisKeyframeChannel::TimeKeyframeMap

protected

Definition at line 173 of file kis_keyframe_channel.h.

Constructor & Destructor Documentation

KisKeyframeChannel() [1/2]

KisKeyframeChannel::KisKeyframeChannel	(	const KoID &	id,
		KisDefaultBoundsBaseSP	bounds )

Definition at line 94 of file kis_keyframe_channel.cpp.

    : m_d(new Private(id, bounds))
{
    // Added keyframes should fire channel updated signal..
    connect(this, &KisKeyframeChannel::sigAddedKeyframe, [this](const KisKeyframeChannel *, int) {
        Q_EMIT sigAnyKeyframeChange();
    });
 
    connect(this, &KisKeyframeChannel::sigKeyframeHasBeenRemoved, [this](const KisKeyframeChannel *, int) {
        Q_EMIT sigAnyKeyframeChange();
    });
 
    connect(this, &KisKeyframeChannel::sigKeyframeChanged, [this](const KisKeyframeChannel *, int) {
        Q_EMIT sigAnyKeyframeChange();
    });
}

References connect(), sigAddedKeyframe(), sigAnyKeyframeChange(), sigKeyframeChanged(), and sigKeyframeHasBeenRemoved().

KisKeyframeChannel() [2/2]

KisKeyframeChannel::KisKeyframeChannel

(

const KisKeyframeChannel &

rhs

)

Definition at line 111 of file kis_keyframe_channel.cpp.

    : KisKeyframeChannel(rhs.m_d->id, new KisDefaultBounds(nullptr))
{
    m_d.reset(new Private(*rhs.m_d));
}

References m_d.

~KisKeyframeChannel()

KisKeyframeChannel::~KisKeyframeChannel ( )

override

Definition at line 117 of file kis_keyframe_channel.cpp.

{
}

Member Function Documentation

activeKeyframeAt() [1/2]

KisKeyframeSP KisKeyframeChannel::activeKeyframeAt ( int time ) const

inline

Definition at line 82 of file kis_keyframe_channel.h.

{ return keyframeAt(activeKeyframeTime(time)); }

activeKeyframeAt() [2/2]

template<class KeyframeType >

QSharedPointer< KeyframeType > KisKeyframeChannel::activeKeyframeAt ( int time ) const

inline

Definition at line 91 of file kis_keyframe_channel.h.

                                                                  {
        return activeKeyframeAt(time).dynamicCast<KeyframeType>();
    }

activeKeyframeTime() [1/2]

int KisKeyframeChannel::activeKeyframeTime ( ) const

inline

Definition at line 103 of file kis_keyframe_channel.h.

{ return activeKeyframeTime(currentTime()); }

References activeKeyframeTime().

activeKeyframeTime() [2/2]

int KisKeyframeChannel::activeKeyframeTime

(

int

time

)

const

Get the time of the active keyframe. Useful for snapping any time to that of the most recent keyframe.

Parameters

time	Input time. When not specified, currentTime() will be used.

Definition at line 233 of file kis_keyframe_channel.cpp.

{
    QMap<int, KisKeyframeSP>::const_iterator iter = const_cast<const QMap<int, KisKeyframeSP>*>(&m_d->keys)->upperBound(time);
 
    // If the next keyframe is the first keyframe, that means there's no active frame.
    if (iter == m_d->keys.constBegin()) {
        return -1;
    }
 
    iter--;
 
    if (iter == m_d->keys.constEnd()) {
        return -1;
    }
 
    return iter.key();
}

References m_d.

addKeyframe()

void KisKeyframeChannel::addKeyframe	(	int	time,
		KUndo2Command *	parentUndoCmd = nullptr )

Add a new keyframe to the channel at the specified time.

Definition at line 121 of file kis_keyframe_channel.cpp.

{
    KisKeyframeSP keyframe = createKeyframe();
    insertKeyframe(time, keyframe, parentUndoCmd);
}

References createKeyframe(), and insertKeyframe().

affectedFrames()

KisTimeSpan KisKeyframeChannel::affectedFrames ( int time ) const

virtual

Get the set of frames affected by any changes to the value or content of the active keyframe at the given time.

Reimplemented in KisScalarKeyframeChannel.

Definition at line 372 of file kis_keyframe_channel.cpp.

{
    if (m_d->keys.isEmpty()) return KisTimeSpan::infinite(0);
 
    const int activeKeyTime = activeKeyframeTime(time);
    const int nextKeyTime = nextKeyframeTime(time);
 
    // Check for keyframe behind..
    if (!keyframeAt(activeKeyTime)) {
        return KisTimeSpan::fromTimeToTime(0, nextKeyTime - 1);
    }
 
    // Check for keyframe ahead..
    if (!keyframeAt(nextKeyTime)) {
        return KisTimeSpan::infinite(activeKeyTime);
    }
 
    return KisTimeSpan::fromTimeToTime(activeKeyTime, nextKeyTime - 1);
}

References activeKeyframeTime(), KisTimeSpan::fromTimeToTime(), KisTimeSpan::infinite(), keyframeAt(), m_d, and nextKeyframeTime().

affectedRect()

virtual QRect KisKeyframeChannel::affectedRect ( int time ) const

pure virtual

The rect that is affected by a frame at the given time

Implemented in KisRasterKeyframeChannel, and KisScalarKeyframeChannel.

allKeyframeTimes()

QSet< int > KisKeyframeChannel::allKeyframeTimes

(

)

const

Get a set of all integer times that map to a keyframe.

Definition at line 303 of file kis_keyframe_channel.cpp.

{
    QSet<int> frames;
 
    TimeKeyframeMap::const_iterator it = m_d->keys.constBegin();
    TimeKeyframeMap::const_iterator end = m_d->keys.constEnd();
 
    while (it != end) {
        frames.insert(it.key());
        ++it;
    }
 
    return frames;
}

References m_d.

channelHash()

int KisKeyframeChannel::channelHash

(

)

const

Calculates a pseudo-unique hash based on the relevant internal state of the channel.

Definition at line 357 of file kis_keyframe_channel.cpp.

{
    TimeKeyframeMap::const_iterator it = m_d->keys.constBegin();
    TimeKeyframeMap::const_iterator end = m_d->keys.constEnd();
 
    int hash = 0;
 
    while (it != end) {
        hash += it.key();
        ++it;
    }
 
    return hash;
}

References m_d.

channelIdToKoId()

KoID KisKeyframeChannel::channelIdToKoId ( const QString & id )

static

Definition at line 38 of file kis_keyframe_channel.cpp.

{
    KoID channelId;
 
    if (id == KisKeyframeChannel::Raster.id()) {
        channelId = KisKeyframeChannel::Raster;
    } else if (id == KisKeyframeChannel::Opacity.id()) {
        channelId = KisKeyframeChannel::Opacity;
    } else if (id == KisKeyframeChannel::PositionX.id()) {
        channelId = KisKeyframeChannel::PositionX;
    } else if (id == KisKeyframeChannel::PositionY.id()) {
        channelId = KisKeyframeChannel::PositionY;
    } else if (id == KisKeyframeChannel::ScaleX.id()) {
        channelId = KisKeyframeChannel::ScaleX;
    } else if (id == KisKeyframeChannel::ScaleY.id()) {
        channelId = KisKeyframeChannel::ScaleY;
    } else if (id == KisKeyframeChannel::ShearX.id()) {
        channelId = KisKeyframeChannel::ShearX;
    } else if (id == KisKeyframeChannel::ShearY.id()) {
        channelId = KisKeyframeChannel::ShearY;
    } else if (id == KisKeyframeChannel::RotationX.id()) {
        channelId = KisKeyframeChannel::RotationX;
    } else if (id == KisKeyframeChannel::RotationY.id()) {
        channelId = KisKeyframeChannel::RotationY;
    } else if (id == KisKeyframeChannel::RotationZ.id()) {
        channelId = KisKeyframeChannel::RotationZ;
 
    } else {
        channelId = KoID();
    }
 
    return channelId;
}

References Opacity, PositionX, PositionY, Raster, RotationX, RotationY, RotationZ, ScaleX, ScaleY, ShearX, and ShearY.

constKeys()

const KisKeyframeChannel::TimeKeyframeMap & KisKeyframeChannel::constKeys ( ) const

protected

Definition at line 439 of file kis_keyframe_channel.cpp.

{
    return m_d->keys;
}

References m_d.

copyKeyframe() [1/2]

void KisKeyframeChannel::copyKeyframe ( const KisKeyframeChannel * sourceChannel, int sourceTime, KisKeyframeChannel * targetChannel, int targetTime, KUndo2Command * parentUndoCmd = nullptr )

static

Copy a keyframe across channel(s) at the specified times.

Definition at line 186 of file kis_keyframe_channel.cpp.

{
    KIS_ASSERT(sourceChannel && targetChannel);
 
    KisKeyframeSP sourceKeyframe = sourceChannel->keyframeAt(sourceTime);
    if (!sourceKeyframe) return;
 
    KisKeyframeSP copiedKeyframe = sourceKeyframe->duplicate(targetChannel);
    KIS_SAFE_ASSERT_RECOVER_RETURN(copiedKeyframe);
 
    targetChannel->insertKeyframe(targetTime, copiedKeyframe, parentUndoCmd);
}

References insertKeyframe(), keyframeAt(), KIS_ASSERT, and KIS_SAFE_ASSERT_RECOVER_RETURN.

copyKeyframe() [2/2]

void KisKeyframeChannel::copyKeyframe ( int sourceTime, int targetTime, KUndo2Command * parentUndoCmd = nullptr )

inline

Definition at line 75 of file kis_keyframe_channel.h.

{ copyKeyframe(this, sourceTime, this, targetTime, parentUndoCmd); }

References copyKeyframe().

createKeyframe()

virtual KisKeyframeSP KisKeyframeChannel::createKeyframe ( )

privatepure virtual

Virtual keyframe creation function. Derived classes implement this function based on the needs of their specific KisKeyframe subclasses.

Implemented in KisRasterKeyframeChannel, and KisScalarKeyframeChannel.

currentTime()

int KisKeyframeChannel::currentTime ( ) const

protected

Definition at line 444 of file kis_keyframe_channel.cpp.

{
    return m_d->bounds->currentTime();
}

References m_d.

firstKeyframeTime()

int KisKeyframeChannel::firstKeyframeTime

(

)

const

Definition at line 258 of file kis_keyframe_channel.cpp.

{
    if (m_d->keys.isEmpty()) {
        return -1;
    } else {
        return m_d->keys.firstKey();
    }
}

References m_d.

id()

QString KisKeyframeChannel::id

(

)

const

Definition at line 318 of file kis_keyframe_channel.cpp.

{
    return m_d->id.id();
}

References m_d.

identicalFrames()

KisTimeSpan KisKeyframeChannel::identicalFrames ( int time ) const

virtual

Get a span of times for which the channel gives identical results compared to frame at a given time. NOTE: This set may be different than the set of affected frames due to interpolation.

Reimplemented in KisScalarKeyframeChannel.

Definition at line 392 of file kis_keyframe_channel.cpp.

{
    return affectedFrames(time);
}

References affectedFrames().

insertKeyframe()

void KisKeyframeChannel::insertKeyframe ( int time, KisKeyframeSP keyframe, KUndo2Command * parentUndoCmd = nullptr )

virtual

Insert an existing keyframe into the channel at the specified time.

Reimplemented in KisRasterKeyframeChannel, and KisScalarKeyframeChannel.

Definition at line 127 of file kis_keyframe_channel.cpp.

{
    KIS_ASSERT(time >= 0);
    KIS_ASSERT(keyframe);
 
    if (m_d->keys.contains(time)) {
        // Properly remove overwritten frames.
        removeKeyframe(time, parentUndoCmd);
    }
 
    if (parentUndoCmd) {
        KUndo2Command* cmd =
            new KisCommandUtils::SkipFirstRedoWrapper(
                new KisInsertKeyframeCommand(this, time, keyframe), parentUndoCmd);
        Q_UNUSED(cmd);
    }
 
    m_d->keys.insert(time, keyframe);
    Q_EMIT sigAddedKeyframe(this, time);
}

References KIS_ASSERT, m_d, removeKeyframe(), and sigAddedKeyframe().

keyframeAt() [1/2]

KisKeyframeSP KisKeyframeChannel::keyframeAt

(

int

time

)

const

Get a keyframe at specified time. Used primarily when the value of a given keyframe is needed.

Definition at line 218 of file kis_keyframe_channel.cpp.

{
    QMap<int, KisKeyframeSP>::const_iterator iter = m_d->keys.constFind(time);
    if (iter != m_d->keys.constEnd()) {
        return iter.value();
    } else {
        return KisKeyframeSP();
    }
}

References m_d.

keyframeAt() [2/2]

template<class KeyframeType >

QSharedPointer< KeyframeType > KisKeyframeChannel::keyframeAt ( int time ) const

inline

Definition at line 86 of file kis_keyframe_channel.h.

                                                            {
        return keyframeAt(time).dynamicCast<KeyframeType>();
    }

keyframeCount()

int KisKeyframeChannel::keyframeCount

(

)

const

Definition at line 228 of file kis_keyframe_channel.cpp.

{
    return m_d->keys.count();
}

References m_d.

keys()

KisKeyframeChannel::TimeKeyframeMap & KisKeyframeChannel::keys ( )

protected

Definition at line 434 of file kis_keyframe_channel.cpp.

{
    return m_d->keys;
}

References m_d.

lastKeyframeTime()

int KisKeyframeChannel::lastKeyframeTime

(

)

const

Definition at line 294 of file kis_keyframe_channel.cpp.

{
    if (m_d->keys.isEmpty()) {
        return -1;
    }
 
    return m_d->keys.lastKey();
}

References m_d.

loadKeyframe()

virtual QPair< int, KisKeyframeSP > KisKeyframeChannel::loadKeyframe ( const QDomElement & keyframeNode )

privatepure virtual

Implemented in KisRasterKeyframeChannel, and KisScalarKeyframeChannel.

loadXML()

void KisKeyframeChannel::loadXML ( const QDomElement & channelNode )

virtual

Reimplemented in KisRasterKeyframeChannel.

Definition at line 418 of file kis_keyframe_channel.cpp.

{
    for (QDomElement keyframeNode = channelNode.firstChildElement(); !keyframeNode.isNull(); keyframeNode = keyframeNode.nextSiblingElement()) {
        if (keyframeNode.nodeName().toUpper() != "KEYFRAME") continue;
 
        QPair<int, KisKeyframeSP> timeKeyPair = loadKeyframe(keyframeNode);
        KIS_SAFE_ASSERT_RECOVER(timeKeyPair.second) { continue; }
 
        if (keyframeNode.hasAttribute("color-label")) {
            timeKeyPair.second->setColorLabel(keyframeNode.attribute("color-label").toUInt());
        }
 
        insertKeyframe(timeKeyPair.first, timeKeyPair.second);
    }
}

References insertKeyframe(), KIS_SAFE_ASSERT_RECOVER, and loadKeyframe().

lookupKeyframeTime()

int KisKeyframeChannel::lookupKeyframeTime

(

KisKeyframeSP

toLookup

)

Search for the time for a given keyframe. (Reverse map lookup, so use sparingly.)

Parameters

toLookup

- the keyframe to look up the time for.

Returns

Returns the time of the keyframe.

Definition at line 251 of file kis_keyframe_channel.cpp.

{
    int time = m_d->keys.key(toLookup, -1);
    KIS_ASSERT(time >= 0);
    return time;
}

References KIS_ASSERT, and m_d.

moveKeyframe() [1/2]

void KisKeyframeChannel::moveKeyframe ( int sourceTime, int targetTime, KUndo2Command * parentUndoCmd = nullptr )

inline

Definition at line 74 of file kis_keyframe_channel.h.

{ moveKeyframe(this, sourceTime, this, targetTime, parentUndoCmd); }

References moveKeyframe().

moveKeyframe() [2/2]

void KisKeyframeChannel::moveKeyframe ( KisKeyframeChannel * sourceChannel, int sourceTime, KisKeyframeChannel * targetChannel, int targetTime, KUndo2Command * parentUndoCmd = nullptr )

static

Move a keyframe across channel(s) at the specified times.

Definition at line 167 of file kis_keyframe_channel.cpp.

{
    KIS_ASSERT(sourceChannel && targetChannel);
 
    KisKeyframeSP sourceKeyframe = sourceChannel->keyframeAt(sourceTime);
    if (!sourceKeyframe) return;
 
    sourceChannel->removeKeyframe(sourceTime, parentUndoCmd);
 
    KisKeyframeSP targetKeyframe = sourceKeyframe;
    if (sourceChannel != targetChannel) {
        // When "moving" Keyframes between channels, a new copy is made for that channel.
        targetKeyframe = sourceKeyframe->duplicate(targetChannel);
        KIS_SAFE_ASSERT_RECOVER_RETURN(targetKeyframe);
    }
 
    targetChannel->insertKeyframe(targetTime, targetKeyframe, parentUndoCmd);
}

References insertKeyframe(), keyframeAt(), KIS_ASSERT, KIS_SAFE_ASSERT_RECOVER_RETURN, and removeKeyframe().

name()

QString KisKeyframeChannel::name

(

)

const

Definition at line 323 of file kis_keyframe_channel.cpp.

{
    return m_d->id.name();
}

References m_d.

nextKeyframeTime()

int KisKeyframeChannel::nextKeyframeTime

(

const int

time

)

const

Definition at line 283 of file kis_keyframe_channel.cpp.

{
    QMap<int, KisKeyframeSP>::const_iterator iter = const_cast<const QMap<int, KisKeyframeSP>*>(&m_d->keys)->upperBound(time);
 
    if (iter == m_d->keys.constEnd()) {
        return -1;
    }
 
    return iter.key();
}

References m_d.

node()

KisNodeWSP KisKeyframeChannel::node

(

)

const

Definition at line 348 of file kis_keyframe_channel.cpp.

{
    return m_d->parentNode;
}

References m_d.

previousKeyframeTime()

int KisKeyframeChannel::previousKeyframeTime

(

const int

time

)

const

Definition at line 267 of file kis_keyframe_channel.cpp.

{
    if (!keyframeAt(time)) {
        return activeKeyframeTime(time);
    }
 
    QMap<int, KisKeyframeSP>::const_iterator iter = m_d->keys.constFind(time);
 
    if (iter == m_d->keys.constBegin() || iter == m_d->keys.constEnd()) {
        return -1;
    }
 
    iter--;
    return iter.key();
}

References activeKeyframeTime(), keyframeAt(), and m_d.

removeKeyframe()

void KisKeyframeChannel::removeKeyframe ( int time, KUndo2Command * parentUndoCmd = nullptr )

virtual

Remove a keyframe from the channel at the specified time.

Reimplemented in KisRasterKeyframeChannel, and KisScalarKeyframeChannel.

Definition at line 161 of file kis_keyframe_channel.cpp.

{
    Q_EMIT sigKeyframeAboutToBeRemoved(this, time);
    removeKeyframeImpl(time, parentUndoCmd);
}

References removeKeyframeImpl(), and sigKeyframeAboutToBeRemoved().

removeKeyframeImpl()

void KisKeyframeChannel::removeKeyframeImpl ( int time, KUndo2Command * parentUndoCmd )

protectedvirtual

Actual implementation of the frame removal that does everything except of the signal emission (that should be emitted before the removal)

Definition at line 148 of file kis_keyframe_channel.cpp.

{
    if (parentUndoCmd) {
        KUndo2Command* cmd =
            new KisCommandUtils::SkipFirstRedoWrapper(
                new KisRemoveKeyframeCommand(this, time), parentUndoCmd);
        Q_UNUSED(cmd);
    }
 
    m_d->keys.remove(time);
    Q_EMIT sigKeyframeHasBeenRemoved(this, time);
}

References m_d, and sigKeyframeHasBeenRemoved().

saveKeyframe()

virtual void KisKeyframeChannel::saveKeyframe ( KisKeyframeSP keyframe, QDomElement keyframeElement, const QString & layerFilename )

privatepure virtual

Implemented in KisRasterKeyframeChannel, and KisScalarKeyframeChannel.

setDefaultBounds()

void KisKeyframeChannel::setDefaultBounds

(

KisDefaultBoundsBaseSP

bounds

)

Definition at line 353 of file kis_keyframe_channel.cpp.

                                                                       {
    m_d->bounds = bounds;
}

References bounds, and m_d.

setNode()

void KisKeyframeChannel::setNode

(

KisNodeWSP

node

)

Definition at line 328 of file kis_keyframe_channel.cpp.

{
    if (m_d->parentNode.isValid()) { // Disconnect old..
        disconnect(this, &KisKeyframeChannel::sigAddedKeyframe, m_d->parentNode, &KisNode::handleKeyframeChannelFrameAdded);
        disconnect(this, &KisKeyframeChannel::sigKeyframeAboutToBeRemoved, m_d->parentNode, &KisNode::handleKeyframeChannelFrameAboutToBeRemoved);
        disconnect(this, &KisKeyframeChannel::sigKeyframeHasBeenRemoved, m_d->parentNode, &KisNode::handleKeyframeChannelFrameHasBeenRemoved);
        disconnect(this, &KisKeyframeChannel::sigKeyframeChanged, m_d->parentNode, &KisNode::handleKeyframeChannelFrameChange);
    }
 
    m_d->parentNode = node;
    m_d->bounds = KisDefaultBoundsNodeWrapperSP( new KisDefaultBoundsNodeWrapper( node ));
 
    if (m_d->parentNode) { // Connect new..
        connect(this, &KisKeyframeChannel::sigAddedKeyframe, m_d->parentNode, &KisNode::handleKeyframeChannelFrameAdded, Qt::DirectConnection);
        connect(this, &KisKeyframeChannel::sigKeyframeAboutToBeRemoved, m_d->parentNode, &KisNode::handleKeyframeChannelFrameAboutToBeRemoved, Qt::DirectConnection);
        connect(this, &KisKeyframeChannel::sigKeyframeHasBeenRemoved, m_d->parentNode, &KisNode::handleKeyframeChannelFrameHasBeenRemoved, Qt::DirectConnection);
        connect(this, &KisKeyframeChannel::sigKeyframeChanged, m_d->parentNode, &KisNode::handleKeyframeChannelFrameChange, Qt::DirectConnection);
    }
}

References connect(), KisNode::handleKeyframeChannelFrameAboutToBeRemoved(), KisNode::handleKeyframeChannelFrameAdded(), KisNode::handleKeyframeChannelFrameChange(), KisNode::handleKeyframeChannelFrameHasBeenRemoved(), m_d, node(), sigAddedKeyframe(), sigKeyframeAboutToBeRemoved(), sigKeyframeChanged(), and sigKeyframeHasBeenRemoved().

sigAddedKeyframe

void KisKeyframeChannel::sigAddedKeyframe ( const KisKeyframeChannel * channel, int time )

signal

This signal is emitted just AFTER a keyframe was added to the channel.

sigAnyKeyframeChange

void KisKeyframeChannel::sigAnyKeyframeChange ( )

signal

This signal is an aggregate of the following signals:

• sigAddedKeyframe
• sigKeyframeHasBeenRemoved
• sigKeyframeChanged

sigKeyframeAboutToBeRemoved

void KisKeyframeChannel::sigKeyframeAboutToBeRemoved ( const KisKeyframeChannel * channel, int time )

signal

This signal is emitted just BEFORE a keyframe is removed from the channel.

sigKeyframeChanged

void KisKeyframeChannel::sigKeyframeChanged ( const KisKeyframeChannel * channel, int time )

signal

This signal is emitted just AFTER a non-raster keyframe was changed its value.

sigKeyframeHasBeenRemoved

void KisKeyframeChannel::sigKeyframeHasBeenRemoved ( const KisKeyframeChannel * channel, int time )

signal

This signal is emitted just AFTER a keyframe is removed from the channel.

swapKeyframes() [1/2]

void KisKeyframeChannel::swapKeyframes ( int timeA, int timeB, KUndo2Command * parentUndoCmd = nullptr )

inline

Definition at line 76 of file kis_keyframe_channel.h.

{ swapKeyframes(this, timeA, this, timeB, parentUndoCmd); }

References swapKeyframes().

swapKeyframes() [2/2]

void KisKeyframeChannel::swapKeyframes ( KisKeyframeChannel * channelA, int timeA, KisKeyframeChannel * channelB, int timeB, KUndo2Command * parentUndoCmd = nullptr )

static

Swap two keyframes across channel(s) at the specified times.

Definition at line 199 of file kis_keyframe_channel.cpp.

{
    KIS_ASSERT(channelA && channelB);
 
    // Store B.
    KisKeyframeSP keyframeB = channelB->keyframeAt(timeB);
    if (!keyframeB) return;
 
    // Move A -> B
    moveKeyframe(channelA, timeA, channelB, timeB, parentUndoCmd);
 
    // Insert B -> A
    if (channelA != channelB) {
        keyframeB = keyframeB->duplicate(channelA);
        KIS_SAFE_ASSERT_RECOVER_RETURN(keyframeB);
    }
    channelA->insertKeyframe(timeA, keyframeB, parentUndoCmd);
}

References insertKeyframe(), keyframeAt(), KIS_ASSERT, KIS_SAFE_ASSERT_RECOVER_RETURN, and moveKeyframe().

toXML()

QDomElement KisKeyframeChannel::toXML ( QDomDocument doc, const QString & layerFilename )

virtual

Reimplemented in KisRasterKeyframeChannel.

Definition at line 397 of file kis_keyframe_channel.cpp.

{
    QDomElement channelElement = doc.createElement("channel");
 
    channelElement.setAttribute("name", id());
 
    Q_FOREACH (int time, m_d->keys.keys()) {
        QDomElement keyframeElement = doc.createElement("keyframe");
        KisKeyframeSP keyframe = keyframeAt(time);
 
        keyframeElement.setAttribute("time", time);
        keyframeElement.setAttribute("color-label", keyframe->colorLabel());
 
        saveKeyframe(keyframe, keyframeElement, layerFilename);
 
        channelElement.appendChild(keyframeElement);
    }
 
    return channelElement;
}

References keyframeAt(), m_d, and saveKeyframe().

workaroundBrokenFrameTimeBug()

void KisKeyframeChannel::workaroundBrokenFrameTimeBug ( int * time )

protected

Between Krita 4.1 and 4.4 Krita had a bug which resulted in creating frames with negative time stamp. The bug has been fixed, but there might be some files still in the wild.

TODO: remove this workaround in Krita 5.0, when no such file are left :)

Definition at line 449 of file kis_keyframe_channel.cpp.

{
    if (*time < 0) {
        qWarning() << "WARNING: Loading a file with negative animation frames!";
        qWarning() << "         The file has been saved with a buggy version of Krita.";
        qWarning() << "         All the frames with negative ids will be dropped!";
        qWarning() << "         " << ppVar(this->id()) << ppVar(*time);
 
        m_d->haveBrokenFrameTimeBug = true;
        *time = 0;
    }
 
    if (m_d->haveBrokenFrameTimeBug) {
        while (keyframeAt(*time)) {
            (*time)++;
        }
    }
}

References keyframeAt(), m_d, and ppVar.

Member Data Documentation

m_d

QScopedPointer<Private> KisKeyframeChannel::m_d

private

Definition at line 195 of file kis_keyframe_channel.h.

Opacity

const KoID KisKeyframeChannel::Opacity = KoID("opacity", ki18n("Opacity"))

static

Definition at line 38 of file kis_keyframe_channel.h.

PositionX

const KoID KisKeyframeChannel::PositionX = KoID("transform_pos_x", ki18n("Position (X)"))

static

Definition at line 40 of file kis_keyframe_channel.h.

PositionY

const KoID KisKeyframeChannel::PositionY = KoID("transform_pos_y", ki18n("Position (Y)"))

static

Definition at line 41 of file kis_keyframe_channel.h.

Raster

const KoID KisKeyframeChannel::Raster = KoID("content", ki18n("Content"))

static

Definition at line 37 of file kis_keyframe_channel.h.

RotationX

const KoID KisKeyframeChannel::RotationX = KoID("transform_rotation_x", ki18n("Rotation (X)"))

static

Definition at line 46 of file kis_keyframe_channel.h.

RotationY

const KoID KisKeyframeChannel::RotationY = KoID("transform_rotation_y", ki18n("Rotation (Y)"))

static

Definition at line 47 of file kis_keyframe_channel.h.

RotationZ

const KoID KisKeyframeChannel::RotationZ = KoID("transform_rotation_z", ki18n("Rotation (Z)"))

static

Definition at line 48 of file kis_keyframe_channel.h.

ScaleX

const KoID KisKeyframeChannel::ScaleX = KoID("transform_scale_x", ki18n("Scale (X)"))

static

Definition at line 42 of file kis_keyframe_channel.h.

ScaleY

const KoID KisKeyframeChannel::ScaleY = KoID("transform_scale_y", ki18n("Scale (Y)"))

static

Definition at line 43 of file kis_keyframe_channel.h.

ShearX

const KoID KisKeyframeChannel::ShearX = KoID("transform_shear_x", ki18n("Shear (X)"))

static

Definition at line 44 of file kis_keyframe_channel.h.

ShearY

const KoID KisKeyframeChannel::ShearY = KoID("transform_shear_y", ki18n("Shear (Y)"))

static

Definition at line 45 of file kis_keyframe_channel.h.

TransformArguments

const KoID KisKeyframeChannel::TransformArguments

static

Definition at line 39 of file kis_keyframe_channel.h.

---

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

• libs/image/kis_keyframe_channel.h
• libs/image/kis_keyframe_channel.cpp