X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Ftransition.h;h=4f9378181eb6ed91dc74045b7b7221187c85324b;hb=c24658bd34221d735f0641c924b890e1a6be7101;hp=69ac44e2756d13904d9051a33af1a1e64aa63010;hpb=b9eb65d858870989b94d23bee961eb129f0a9996;p=kdenlive diff --git a/src/transition.h b/src/transition.h index 69ac44e2..4f937818 100644 --- a/src/transition.h +++ b/src/transition.h @@ -15,6 +15,12 @@ * * ***************************************************************************/ +/** + * @class Transition + * @author Jean-Baptiste Mardelle + * @brief Describes a transition with a name, parameters, keyframes, etc. + */ + #ifndef TRANSITION_H #define TRANSITION_H @@ -28,11 +34,6 @@ #include "definitions.h" #include "abstractclipitem.h" - -/**Describes a Transition, with a name, parameters keyframes, etc. - *@author Jean-Baptiste Mardelle - */ - class ClipItem; class Transition : public AbstractClipItem @@ -40,39 +41,42 @@ class Transition : public AbstractClipItem Q_OBJECT public: - Transition(const ItemInfo info, int transitiontrack, double fps, QDomElement params = QDomElement(), bool automaticTransition = false); + Transition(const ItemInfo &info, int transitiontrack, double fps, const QDomElement ¶ms = QDomElement(), bool automaticTransition = false); virtual ~Transition(); virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget); virtual int type() const; - /** Returns an XML representation of this transition. */ + + /** @brief Returns an XML representation of this transition. */ QDomElement toXML(); - /** Return the track number of transition in the playlist*/ + /** @brief Returns the track number of the transition in the playlist. */ int transitionEndTrack() const; - bool hasClip(const ClipItem * clip) const; - bool belongsToClip(const ClipItem * clip) const; - bool invertedTransition() const; - QString transitionName() const; QString transitionTag() const; - OPERATIONTYPE operationMode(QPointF pos); + QStringList transitionInfo() const; + OperationType operationMode(const QPointF &pos); + static int itemHeight(); + static int itemOffset(); //const QMap < QString, QString > transitionParameters() const; - void setTransitionParameters(const QDomElement params); - void setTransitionDirection(bool inv); + void setTransitionParameters(const QDomElement ¶ms); void setTransitionTrack(int track); - //Transition *reparent(ClipItem * clip); - bool isValid() const; - /** Transition should be linked to another track */ + + /** @brief Links the transition to another track. + * + * This happens only if the current track is not forced. */ void updateTransitionEndTrack(int newtrack); void setForcedTrack(bool force, int track); bool forcedTrack() const; - const ClipItem *referencedClip() const; Transition *clone(); bool isAutomatic() const; void setAutomatic(bool automatic); bool hasGeometry(); int defaultZValue() const; + /** @brief When a transition is resized, check if keyframes are out of the transition and fix if necessary. + * @param oldEnd the previous transition end, so that when we expand the transition, if there is a keyframe at end we move it + */ + bool updateKeyframes(int oldEnd); protected: virtual QVariant itemChange(GraphicsItemChange change, const QVariant &value); @@ -81,26 +85,19 @@ private: QString m_name; bool m_forceTransitionTrack; - /** true if the transition was added automatically and should be moved with its clip */ + /** @brief True if the transition is attached to its clip. */ bool m_automaticTransition; - /** contains the transition parameters */ + + /** @brief Contains the transition parameters. */ QDomElement m_parameters; - /** The clip to which the transition is attached */ - ClipItem *m_referenceClip; - /** The 2nd clip to which the transition is attached */ - ClipItem *m_secondClip; int m_transitionTrack; - /** Return the display name for a transition type */ - QString getTransitionName(const TRANSITIONTYPE & type); + /** @brief Returns the display name for a transition type. */ + QString getTransitionName(const TransitionType & type); - /** Return the transition type for a given name */ - TRANSITIONTYPE getTransitionForName(const QString & type); - -#if QT_VERSION >= 0x040600 - QPropertyAnimation *m_startAnimation; -#endif + /** @brief Returns the transition type for a given name. */ + TransitionType getTransitionForName(const QString & type); }; #endif