src/qtquick1/util/qdeclarativetimeline_p_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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 QDeclarative1TimeLineValue;
  63 class QDeclarative1TimeLineCallback;
  64 struct QDeclarative1TimeLinePrivate;
  65 class QDeclarative1TimeLineObject;
  66 class Q_AUTOTEST_EXPORT QDeclarative1TimeLine : public QAbstractAnimation
  67 {
  68 Q_OBJECT
  69 public:
  70     QDeclarative1TimeLine(QObject *parent = 0);
  71     ~QDeclarative1TimeLine();
  72
  73     enum SyncMode { LocalSync, GlobalSync };
  74     SyncMode syncMode() const;
  75     void setSyncMode(SyncMode);
  76
  77     void pause(QDeclarative1TimeLineObject &, int);
  78     void callback(const QDeclarative1TimeLineCallback &);
  79     void set(QDeclarative1TimeLineValue &, qreal);
  80
  81     int accel(QDeclarative1TimeLineValue &, qreal velocity, qreal accel);
  82     int accel(QDeclarative1TimeLineValue &, qreal velocity, qreal accel, qreal maxDistance);
  83     int accelDistance(QDeclarative1TimeLineValue &, qreal velocity, qreal distance);
  84
  85     void move(QDeclarative1TimeLineValue &, qreal destination, int time = 500);
  86     void move(QDeclarative1TimeLineValue &, qreal destination, const QEasingCurve &, int time = 500);
  87     void moveBy(QDeclarative1TimeLineValue &, qreal change, int time = 500);
  88     void moveBy(QDeclarative1TimeLineValue &, qreal change, const QEasingCurve &, int time = 500);
  89
  90     void sync();
  91     void setSyncPoint(int);
  92     int syncPoint() const;
  93
  94     void sync(QDeclarative1TimeLineValue &);
  95     void sync(QDeclarative1TimeLineValue &, QDeclarative1TimeLineValue &);
  96
  97     void reset(QDeclarative1TimeLineValue &);
  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(QDeclarative1TimeLineObject *);
 115     friend class QDeclarative1TimeLineObject;
 116     friend struct QDeclarative1TimeLinePrivate;
 117     QDeclarative1TimeLinePrivate *d;
 118 };
 119
 120 class Q_AUTOTEST_EXPORT QDeclarative1TimeLineObject
 121 {
 122 public:
 123     QDeclarative1TimeLineObject();
 124     virtual ~QDeclarative1TimeLineObject();
 125
 126 protected:
 127     friend class QDeclarative1TimeLine;
 128     friend struct QDeclarative1TimeLinePrivate;
 129     QDeclarative1TimeLine *_t;
 130 };
 131
 132 class Q_AUTOTEST_EXPORT QDeclarative1TimeLineValue : public QDeclarative1TimeLineObject
 133 {
 134 public:
 135     QDeclarative1TimeLineValue(qreal v = 0.) : _v(v) {}
 136
 137     virtual qreal value() const { return _v; }
 138     virtual void setValue(qreal v) { _v = v; }
 139
 140     QDeclarative1TimeLine *timeLine() const { return _t; }
 141
 142     operator qreal() const { return _v; }
 143     QDeclarative1TimeLineValue &operator=(qreal v) { setValue(v); return *this; }
 144 private:
 145     friend class QDeclarative1TimeLine;
 146     friend struct QDeclarative1TimeLinePrivate;
 147     qreal _v;
 148 };
 149
 150 class Q_AUTOTEST_EXPORT QDeclarative1TimeLineCallback
 151 {
 152 public:
 153     typedef void (*Callback)(void *);
 154
 155     QDeclarative1TimeLineCallback();
 156     QDeclarative1TimeLineCallback(QDeclarative1TimeLineObject *b, Callback, void * = 0);
 157     QDeclarative1TimeLineCallback(const QDeclarative1TimeLineCallback &o);
 158
 159     QDeclarative1TimeLineCallback &operator=(const QDeclarative1TimeLineCallback &o);
 160     QDeclarative1TimeLineObject *callbackObject() const;
 161
 162 private:
 163     friend struct QDeclarative1TimeLinePrivate;
 164     Callback d0;
 165     void *d1;
 166     QDeclarative1TimeLineObject *d2;
 167 };
 168
 169 template<class T>
 170 class QDeclarative1TimeLineValueProxy : public QDeclarative1TimeLineValue
 171 {
 172 public:
 173     QDeclarative1TimeLineValueProxy(T *cls, void (T::*func)(qreal), qreal v = 0.)
 174     : QDeclarative1TimeLineValue(v), _class(cls), _setFunctionReal(func), _setFunctionInt(0)
 175     {
 176         Q_ASSERT(_class);
 177     }
 178
 179     QDeclarative1TimeLineValueProxy(T *cls, void (T::*func)(int), qreal v = 0.)
 180     : QDeclarative1TimeLineValue(v), _class(cls), _setFunctionReal(0), _setFunctionInt(func)
 181     {
 182         Q_ASSERT(_class);
 183     }
 184
 185     virtual void setValue(qreal v)
 186     {
 187         QDeclarative1TimeLineValue::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