/* * SPDX-FileCopyrightText: 2015 Jouni Pentikäinen * SPDX-FileCopyrightText: 2020 Emmet O 'Neill * SPDX-FileCopyrightText: 2020 Eoin O 'Neill * * SPDX-License-Identifier: GPL-2.0-or-later */ #ifndef KIS_KEYFRAME_CHANNEL_H #define KIS_KEYFRAME_CHANNEL_H #include #include #include #include "kis_types.h" #include "KoID.h" #include "kis_keyframe.h" #include "kis_default_bounds.h" #include "kis_default_bounds_node_wrapper.h" #include "kritaimage_export.h" class KisTimeSpan; /** @brief 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. */ class KRITAIMAGE_EXPORT KisKeyframeChannel : public QObject { Q_OBJECT public: static const KoID Raster; static const KoID Opacity; static const KoID TransformArguments; static const KoID PositionX; static const KoID PositionY; static const KoID ScaleX; static const KoID ScaleY; static const KoID ShearX; static const KoID ShearY; static const KoID RotationX; static const KoID RotationY; static const KoID RotationZ; KisKeyframeChannel(const KoID &id, KisDefaultBoundsBaseSP bounds); KisKeyframeChannel(const KisKeyframeChannel &rhs); ~KisKeyframeChannel() override; /** @brief Add a new keyframe to the channel at the specified time. */ void addKeyframe(int time, KUndo2Command *parentUndoCmd = nullptr); /** @brief Insert an existing keyframe into the channel at the specified time. */ virtual void insertKeyframe(int time, KisKeyframeSP keyframe, KUndo2Command *parentUndoCmd = nullptr); /** @brief Remove a keyframe from the channel at the specified time. */ virtual void removeKeyframe(int time, KUndo2Command *parentUndoCmd = nullptr); // Inter-channel operations.. /** @brief Move a keyframe across channel(s) at the specified times. */ static void moveKeyframe(KisKeyframeChannel *sourceChannel, int sourceTime, KisKeyframeChannel *targetChannel, int targetTime, KUndo2Command* parentUndoCmd = nullptr); /** @brief Copy a keyframe across channel(s) at the specified times. */ static void copyKeyframe(const KisKeyframeChannel *sourceChannel, int sourceTime, KisKeyframeChannel *targetChannel, int targetTime, KUndo2Command* parentUndoCmd = nullptr); /** @brief Swap two keyframes across channel(s) at the specified times. */ static void swapKeyframes(KisKeyframeChannel *channelA, int timeA, KisKeyframeChannel *channelB, int timeB, KUndo2Command* parentUndoCmd = nullptr); // Intra-channel convenience methods.. void moveKeyframe(int sourceTime, int targetTime, KUndo2Command* parentUndoCmd = nullptr) { moveKeyframe(this, sourceTime, this, targetTime, parentUndoCmd); } void copyKeyframe(int sourceTime, int targetTime, KUndo2Command* parentUndoCmd = nullptr) { copyKeyframe(this, sourceTime, this, targetTime, parentUndoCmd); } void swapKeyframes(int timeA, int timeB, KUndo2Command* parentUndoCmd = nullptr) { swapKeyframes(this, timeA, this, timeB, parentUndoCmd); } // Keyframe methods.. /** @brief Get a keyframe at specified time. * Used primarily when the value of a given keyframe is needed. */ KisKeyframeSP keyframeAt(int time) const; KisKeyframeSP activeKeyframeAt(int time) const { return keyframeAt(activeKeyframeTime(time)); } // Quick casting convenience templates.. template QSharedPointer keyframeAt(int time) const { return keyframeAt(time).dynamicCast(); } template QSharedPointer activeKeyframeAt(int time) const { return activeKeyframeAt(time).dynamicCast(); } int keyframeCount() const; // Time methods.. /** @brief Get the time of the active keyframe. * Useful for snapping any time to that of the most recent keyframe. * @param time Input time. When not specified, currentTime() will be used. */ int activeKeyframeTime(int time) const; int activeKeyframeTime() const { return activeKeyframeTime(currentTime()); } /** * @brief Search for the time for a given keyframe. (Reverse map lookup, so use sparingly.) * @param toLookup - the keyframe to look up the time for. * @return Returns the time of the keyframe. */ int lookupKeyframeTime(KisKeyframeSP toLookup); int firstKeyframeTime() const; int previousKeyframeTime(const int time) const; int nextKeyframeTime(const int time) const; int lastKeyframeTime() const; /** @brief Get a set of all integer times that map to a keyframe. */ QSet allKeyframeTimes() const; QString id() const; QString name() const; void setNode(KisNodeWSP node); KisNodeWSP node() const; void setDefaultBounds(KisDefaultBoundsBaseSP bounds); /** @brief Calculates a pseudo-unique hash based on * the relevant internal state of the channel. */ int channelHash() const; /** @brief Get the set of frames affected by any changes to the value * or content of the active keyframe at the given time. */ virtual KisTimeSpan affectedFrames(int time) const; /** @brief 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 KisTimeSpan identicalFrames(int time) const; /** * The rect that is affected by a frame at the given time */ virtual QRect affectedRect(int time) const = 0; virtual QDomElement toXML(QDomDocument doc, const QString &layerFilename); virtual void loadXML(const QDomElement &channelNode); static KoID channelIdToKoId(const QString &id); Q_SIGNALS: /** @brief This signal is emitted just AFTER a keyframe was added to the channel. */ void sigAddedKeyframe(const KisKeyframeChannel *channel, int time); /** @brief This signal is emitted just BEFORE a keyframe is removed from the channel. */ void sigKeyframeAboutToBeRemoved(const KisKeyframeChannel *channel, int time); /** @brief This signal is emitted just AFTER a keyframe is removed from the channel. */ void sigKeyframeHasBeenRemoved(const KisKeyframeChannel *channel, int time); /** @brief This signal is emitted just AFTER a non-raster keyframe was changed its value */ void sigKeyframeChanged(const KisKeyframeChannel *channel, int time); /** This signal is an aggregate of the following signals: * - sigAddedKeyframe * - sigKeyframeHasBeenRemoved * - sigKeyframeChanged */ void sigAnyKeyframeChange(); protected: typedef QMap TimeKeyframeMap; TimeKeyframeMap &keys(); const TimeKeyframeMap &constKeys() const; int currentTime() const; /** * Actual implementation of the frame removal that does everything except of * the signal emission (that should be emitted **before** the removal) */ virtual void removeKeyframeImpl(int time, KUndo2Command *parentUndoCmd); /** * @brief 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 :) */ Q_DECL_DEPRECATED void workaroundBrokenFrameTimeBug(int *time); private: struct Private; QScopedPointer m_d; /** @brief Virtual keyframe creation function. * Derived classes implement this function based on the needs * of their specific KisKeyframe subclasses. */ virtual KisKeyframeSP createKeyframe() = 0; virtual QPair loadKeyframe(const QDomElement &keyframeNode) = 0; virtual void saveKeyframe(KisKeyframeSP keyframe, QDomElement keyframeElement, const QString &layerFilename) = 0; }; #endif // KIS_KEYFRAME_CHANNEL_H