1 /***************************************************************************
2 * Copyright (C) 2008 by Marco Gittler (g.marco@freenet.de) *
3 * Copyright (C) 2008 by Jean-Baptiste Mardelle (jb@kdenlive.org) *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
19 ***************************************************************************/
21 #ifndef ABSTRACTCLIPITEM
22 #define ABSTRACTCLIPITEM
24 #include <QGraphicsRectItem>
25 #include <QGraphicsWidget>
27 #if QT_VERSION >= 0x040600
28 #include <QPropertyAnimation>
31 #include "definitions.h"
34 class CustomTrackScene;
35 class QGraphicsSceneMouseEvent;
37 class AbstractClipItem : public QObject, public QGraphicsRectItem
40 Q_PROPERTY(QRectF rect READ rect WRITE setRect)
43 AbstractClipItem(const ItemInfo &info, const QRectF& rect, double fps);
44 virtual ~ AbstractClipItem();
45 void updateSelectedKeyFrame();
47 /** @brief Move the selected keyframe (does not influence the effect, only the display in timeline).
48 * @param pos new Position
49 * @param value new Value */
50 void updateKeyFramePos(const GenTime &pos, const double value);
51 int addKeyFrame(const GenTime &pos, const double value);
52 bool hasKeyFrames() const;
53 int editedKeyFramePos() const;
54 int selectedKeyFramePos() const;
55 double selectedKeyFrameValue() const;
56 double editedKeyFrameValue() const;
57 double keyFrameFactor() const;
58 /** @brief Returns the number of keyframes the selected effect has. */
59 int keyFrameNumber() const;
60 ItemInfo info() const;
61 CustomTrackScene* projectScene();
62 void updateRectGeometry();
64 void setItemLocked(bool locked);
65 bool isItemLocked() const;
66 void closeAnimation();
68 virtual OPERATIONTYPE operationMode(QPointF pos) = 0;
69 virtual GenTime startPos() const ;
70 virtual void setTrack(int track);
71 virtual GenTime endPos() const ;
72 virtual int defaultZValue() const ;
73 virtual int track() const ;
74 virtual GenTime cropStart() const ;
75 virtual GenTime cropDuration() const ;
76 /** @brief Return the current item's height */
77 static int itemHeight();
78 /** @brief Return the current item's vertical offset
79 * For example transitions are drawn at 1/3 of track height */
80 static int itemOffset();
82 /** @brief Resizes the clip from the start.
83 * @param posx Absolute position of new in point
84 * @param hasSizeLimit (optional) Whether the clip has a maximum size */
85 virtual void resizeStart(int posx, bool hasSizeLimit = true, bool emitChange = true);
87 /** @brief Resizes the clip from the end.
88 * @param posx Absolute position of new out point */
89 virtual void resizeEnd(int posx, bool emitChange = true);
90 virtual double fps() const;
91 virtual void updateFps(double fps);
92 virtual GenTime maxDuration() const;
93 virtual void setCropStart(GenTime pos);
95 /** @brief Set this clip as the main selected clip (or not). */
96 void setMainSelectedClip(bool selected);
97 /** @brief Is this clip selected as the main clip. */
98 bool isMainSelectedClip();
102 /** The position of the current keyframe when it has moved */
103 int m_editedKeyframe;
104 /** The position of the current keyframe before it was moved */
105 int m_selectedKeyframe;
106 /* GenTime m_cropStart;
107 GenTime m_cropDuration;
108 GenTime m_startPos;*/
109 GenTime m_maxDuration;
110 QMap <int, int> m_keyframes;
111 /** @brief Strech factor so that keyframes display on the full clip height. */
112 double m_keyframeFactor;
113 /** @brief Offset factor so that keyframes minimum value are displaed at the bottom of the clip. */
114 double m_keyframeOffset;
115 /** @brief Default reset value for keyframe. */
116 double m_keyframeDefault;
117 /** The (keyframe) parameter that is visible and editable in timeline (on the clip) */
120 /** @brief True if this is the last clip the user selected */
121 bool m_isMainSelectedClip;
122 /** @brief Draw the keyframes of a clip
123 * @param painter The painter device for the clip
124 * @param limitedKeyFrames The keyframes can be of type "keyframe" or "simplekeyframe". In the
125 * "simplekeyframe" type, the effect always starts on clip start and ends on clip end. With the
126 * "keyframe" type, the effect starts on the first keyframe and ends on the last keyframe
128 void drawKeyFrames(QPainter *painter, bool limitedKeyFrames);
129 int mouseOverKeyFrames(QPointF pos, double maxOffset);
130 virtual void mousePressEvent(QGraphicsSceneMouseEvent * event);