src/declarative/util/qdeclarativetimeline_p_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVETIMELINE_H
  43 #define QDECLARATIVETIMELINE_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtCore/QObject>
  57 #include <QtCore/QAbstractAnimation>
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 class QEasingCurve;
  62 class QDeclarativeTimeLineValue;
  63 class QDeclarativeTimeLineCallback;
  64 struct QDeclarativeTimeLinePrivate;
  65 class QDeclarativeTimeLineObject;
  66 class Q_AUTOTEST_EXPORT QDeclarativeTimeLine : public QAbstractAnimation
  67 {
  68 Q_OBJECT
  69 public:
  70     QDeclarativeTimeLine(QObject *parent = 0);
  71     ~QDeclarativeTimeLine();
  72
  73     enum SyncMode { LocalSync, GlobalSync };
  74     SyncMode syncMode() const;
  75     void setSyncMode(SyncMode);
  76
  77     void pause(QDeclarativeTimeLineObject &, int);
  78     void callback(const QDeclarativeTimeLineCallback &);
  79     void set(QDeclarativeTimeLineValue &, qreal);
  80
  81     int accel(QDeclarativeTimeLineValue &, qreal velocity, qreal accel);
  82     int accel(QDeclarativeTimeLineValue &, qreal velocity, qreal accel, qreal maxDistance);
  83     int accelDistance(QDeclarativeTimeLineValue &, qreal velocity, qreal distance);
  84
  85     void move(QDeclarativeTimeLineValue &, qreal destination, int time = 500);
  86     void move(QDeclarativeTimeLineValue &, qreal destination, const QEasingCurve &, int time = 500);
  87     void moveBy(QDeclarativeTimeLineValue &, qreal change, int time = 500);
  88     void moveBy(QDeclarativeTimeLineValue &, qreal change, const QEasingCurve &, int time = 500);
  89
  90     void sync();
  91     void setSyncPoint(int);
  92     int syncPoint() const;
  93
  94     void sync(QDeclarativeTimeLineValue &);
  95     void sync(QDeclarativeTimeLineValue &, QDeclarativeTimeLineValue &);
  96
  97     void reset(QDeclarativeTimeLineValue &);
  98
  99     void complete();
 100     void clear();
 101     bool isActive() const;
 102
 103     int time() const;
 104
 105     virtual int duration() const;
 106 Q_SIGNALS:
 107     void updated();
 108     void completed();
 109
 110 protected:
 111     virtual void updateCurrentTime(int);
 112
 113 private:
 114     void remove(QDeclarativeTimeLineObject *);
 115     friend class QDeclarativeTimeLineObject;
 116     friend struct QDeclarativeTimeLinePrivate;
 117     QDeclarativeTimeLinePrivate *d;
 118 };
 119
 120 class Q_AUTOTEST_EXPORT QDeclarativeTimeLineObject
 121 {
 122 public:
 123     QDeclarativeTimeLineObject();
 124     virtual ~QDeclarativeTimeLineObject();
 125
 126 protected:
 127     friend class QDeclarativeTimeLine;
 128     friend struct QDeclarativeTimeLinePrivate;
 129     QDeclarativeTimeLine *_t;
 130 };
 131
 132 class Q_AUTOTEST_EXPORT QDeclarativeTimeLineValue : public QDeclarativeTimeLineObject
 133 {
 134 public:
 135     QDeclarativeTimeLineValue(qreal v = 0.) : _v(v) {}
 136
 137     virtual qreal value() const { return _v; }
 138     virtual void setValue(qreal v) { _v = v; }
 139
 140     QDeclarativeTimeLine *timeLine() const { return _t; }
 141
 142     operator qreal() const { return _v; }
 143     QDeclarativeTimeLineValue &operator=(qreal v) { setValue(v); return *this; }
 144 private:
 145     friend class QDeclarativeTimeLine;
 146     friend struct QDeclarativeTimeLinePrivate;
 147     qreal _v;
 148 };
 149
 150 class Q_AUTOTEST_EXPORT QDeclarativeTimeLineCallback
 151 {
 152 public:
 153     typedef void (*Callback)(void *);
 154
 155     QDeclarativeTimeLineCallback();
 156     QDeclarativeTimeLineCallback(QDeclarativeTimeLineObject *b, Callback, void * = 0);
 157     QDeclarativeTimeLineCallback(const QDeclarativeTimeLineCallback &o);
 158
 159     QDeclarativeTimeLineCallback &operator=(const QDeclarativeTimeLineCallback &o);
 160     QDeclarativeTimeLineObject *callbackObject() const;
 161
 162 private:
 163     friend struct QDeclarativeTimeLinePrivate;
 164     Callback d0;
 165     void *d1;
 166     QDeclarativeTimeLineObject *d2;
 167 };
 168
 169 template<class T>
 170 class QDeclarativeTimeLineValueProxy : public QDeclarativeTimeLineValue
 171 {
 172 public:
 173     QDeclarativeTimeLineValueProxy(T *cls, void (T::*func)(qreal), qreal v = 0.)
 174     : QDeclarativeTimeLineValue(v), _class(cls), _setFunctionReal(func), _setFunctionInt(0)
 175     {
 176         Q_ASSERT(_class);
 177     }
 178
 179     QDeclarativeTimeLineValueProxy(T *cls, void (T::*func)(int), qreal v = 0.)
 180     : QDeclarativeTimeLineValue(v), _class(cls), _setFunctionReal(0), _setFunctionInt(func)
 181     {
 182         Q_ASSERT(_class);
 183     }
 184
 185     virtual void setValue(qreal v)
 186     {
 187         QDeclarativeTimeLineValue::setValue(v);
 188         if (_setFunctionReal) (_class->*_setFunctionReal)(v);
 189         else if (_setFunctionInt) (_class->*_setFunctionInt)((int)v);
 190     }
 191
 192 private:
 193     T *_class;
 194     void (T::*_setFunctionReal)(qreal);
 195     void (T::*_setFunctionInt)(int);
 196 };
 197
 198 QT_END_NAMESPACE
 199
 200 #endif