git.sesse.net Git - kdenlive/blob - src/abstractclipitem.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Marco Gittler (g.marco@freenet.de)              *
   3  *   Copyright (C) 2008 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
   4  *                                                                         *
   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.                                   *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  ***************************************************************************/
  20
  21 #ifndef ABSTRACTCLIPITEM
  22 #define ABSTRACTCLIPITEM
  23
  24 #include <QGraphicsRectItem>
  25 #include <QGraphicsWidget>
  26
  27 #if QT_VERSION >= 0x040600
  28 #include <QPropertyAnimation>
  29 #endif
  30
  31 #include "definitions.h"
  32 #include "gentime.h"
  33
  34 class CustomTrackScene;
  35 class QGraphicsSceneMouseEvent;
  36
  37 class AbstractClipItem : public QObject, public QGraphicsRectItem
  38 {
  39     Q_OBJECT
  40     Q_PROPERTY(QRectF rect READ rect WRITE setRect)
  41     Q_PROPERTY(qreal opacity READ opacity WRITE setOpacity)
  42
  43 public:
  44     AbstractClipItem(const ItemInfo &info, const QRectF& rect, double fps);
  45     virtual ~ AbstractClipItem();
  46     void updateSelectedKeyFrame();
  47
  48     /** @brief Move the selected keyframe (does not influence the effect, only the display in timeline).
  49     * @param pos new Position
  50     * @param value new Value */
  51     void updateKeyFramePos(const GenTime &pos, const double value);
  52     int checkForSingleKeyframe();
  53     int addKeyFrame(const GenTime &pos, const double value);
  54     bool hasKeyFrames() const;
  55     int editedKeyFramePos() const;
  56     int selectedKeyFramePos() const;
  57     double selectedKeyFrameValue() const;
  58     double editedKeyFrameValue() const;
  59     double keyFrameFactor() const;
  60     /** @brief Returns the number of keyframes the selected effect has. */
  61     int keyFrameNumber() const;
  62     ItemInfo info() const;
  63     CustomTrackScene* projectScene();
  64     void updateRectGeometry();
  65     void updateItem();
  66     void setItemLocked(bool locked);
  67     bool isItemLocked() const;
  68     void closeAnimation();
  69
  70     virtual OPERATIONTYPE operationMode(const QPointF &pos) = 0;
  71     virtual GenTime startPos() const ;
  72     virtual void setTrack(int track);
  73     virtual GenTime endPos() const ;
  74     virtual int defaultZValue() const ;
  75     virtual int track() const ;
  76     virtual GenTime cropStart() const ;
  77     virtual GenTime cropDuration() const ;
  78     /** @brief Return the current item's height */
  79     static int itemHeight();
  80     /** @brief Return the current item's vertical offset
  81      *         For example transitions are drawn at 1/3 of track height */
  82     static int itemOffset();
  83
  84     /** @brief Resizes the clip from the start.
  85     * @param posx Absolute position of new in point
  86     * @param hasSizeLimit (optional) Whether the clip has a maximum size */
  87     virtual void resizeStart(int posx, bool hasSizeLimit = true, bool emitChange = true);
  88
  89     /** @brief Resizes the clip from the end.
  90     * @param posx Absolute position of new out point */
  91     virtual void resizeEnd(int posx, bool emitChange = true);
  92     virtual double fps() const;
  93     virtual void updateFps(double fps);
  94     virtual GenTime maxDuration() const;
  95     virtual void setCropStart(const GenTime &pos);
  96
  97     /** @brief Set this clip as the main selected clip (or not). */
  98     void setMainSelectedClip(bool selected);
  99     /** @brief Is this clip selected as the main clip. */
 100     bool isMainSelectedClip();
 101
 102 protected:
 103     ItemInfo m_info;
 104     /** The position of the current keyframe when it has moved */
 105     int m_editedKeyframe;
 106     /** The position of the current keyframe before it was moved */
 107     int m_selectedKeyframe;
 108     /*    GenTime m_cropStart;
 109         GenTime m_cropDuration;
 110         GenTime m_startPos;*/
 111     GenTime m_maxDuration;
 112     QMap <int, int> m_keyframes;
 113     /** @brief Strech factor so that keyframes display on the full clip height. */
 114     double m_keyframeFactor;
 115     /** @brief Offset factor so that keyframes minimum value are displaed at the bottom of the clip. */
 116     double m_keyframeOffset;
 117     /** @brief Default reset value for keyframe. */
 118     double m_keyframeDefault;
 119     /** The (keyframe) parameter that is visible and editable in timeline (on the clip) */
 120     int m_visibleParam;
 121     double m_fps;
 122     /** @brief True if this is the last clip the user selected */
 123     bool m_isMainSelectedClip;
 124     /** @brief Draw the keyframes of a clip
 125       * @param painter The painter device for the clip
 126       * @param limitedKeyFrames The keyframes can be of type "keyframe" or "simplekeyframe". In the
 127       *        "simplekeyframe" type, the effect always starts on clip start and ends on clip end. With the
 128       *        "keyframe" type, the effect starts on the first keyframe and ends on the last keyframe
 129       */
 130     void drawKeyFrames(QPainter *painter, const QTransform &transformation, bool limitedKeyFrames);
 131     int mouseOverKeyFrames(QPointF pos, double maxOffset);
 132     void mousePressEvent(QGraphicsSceneMouseEvent * event);
 133
 134 };
 135
 136 #endif