/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef GFXTIMELINE_H
#define GFXTIMELINE_H

#include <QObject>
#include <qfxglobal.h>
#include <QAbstractAnimation>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Declarative)

class GfxEasing;
class GfxValue;
class GfxEvent;
struct QmlTimeLinePrivate;
class QmlTimeLineObject;
class Q_DECLARATIVE_EXPORT QmlTimeLine : public QAbstractAnimation
{
Q_OBJECT
public:
    QmlTimeLine(QObject *parent = 0);
    ~QmlTimeLine();

    enum SyncMode { LocalSync, GlobalSync };
    SyncMode syncMode() const;
    void setSyncMode(SyncMode);

    void pause(QmlTimeLineObject &, int);
    void execute(const GfxEvent &);
    void set(GfxValue &, qreal);

    int accel(GfxValue &, qreal velocity, qreal accel);
    int accel(GfxValue &, qreal velocity, qreal accel, qreal maxDistance);
    int accelDistance(GfxValue &, qreal velocity, qreal distance);

    void move(GfxValue &, qreal destination, int time = 500);
    void move(GfxValue &, qreal destination, const GfxEasing &, int time = 500);
    void moveBy(GfxValue &, qreal change, int time = 500);
    void moveBy(GfxValue &, qreal change, const GfxEasing &, int time = 500);

    void sync();
    void setSyncPoint(int);
    int syncPoint() const;

    void sync(GfxValue &);
    void sync(GfxValue &, GfxValue &);

    void reset(GfxValue &);

    void complete();
    void clear();
    bool isActive() const;

    int time() const;

    virtual int duration() const;
Q_SIGNALS:
    void updated();
    void completed();

protected:
    virtual void updateCurrentTime(int);

private:
    void remove(QmlTimeLineObject *);
    friend class QmlTimeLineObject;
    friend struct QmlTimeLinePrivate;
    QmlTimeLinePrivate *d;
};

class Q_DECLARATIVE_EXPORT QmlTimeLineObject
{
public:
    QmlTimeLineObject();
    virtual ~QmlTimeLineObject();

protected:
    friend class QmlTimeLine;
    friend struct QmlTimeLinePrivate;
    QmlTimeLine *_t;
};

class Q_DECLARATIVE_EXPORT GfxValue : public QmlTimeLineObject
{
public:
    GfxValue(qreal v = 0.) : _v(v) {}

    qreal value() const { return _v; }
    virtual void setValue(qreal v) { _v = v; }

    QmlTimeLine *timeLine() const { return _t; }

    operator qreal() const { return _v; }
    GfxValue &operator=(qreal v) { setValue(v); return *this; }
private:
    friend class QmlTimeLine;
    friend struct QmlTimeLinePrivate;
    qreal _v;
};

class Q_DECLARATIVE_EXPORT GfxEvent
{
public:
    GfxEvent();
    GfxEvent(const GfxEvent &o);

    template<class T, void (T::*method)()>
    GfxEvent(QmlTimeLineObject *b, T *c)
    {
	d0 = &callFunc<T, method>;
	d1 = (void *)c;
	d2 = b;
    }

    template<class T, void (T::*method)()>
    static GfxEvent gfxEvent(QmlTimeLineObject *b, T *c)
    {
        GfxEvent rv;
	rv.d0 = &callFunc<T, method>;
	rv.d1 = (void *)c;
	rv.d2 = b;
	return rv;
    }

    GfxEvent &operator=(const GfxEvent &o);
    void execute() const;
    QmlTimeLineObject *eventObject() const;

private:
    typedef void (*CallFunc)(void *c);

    template <class T, void (T::*method)()>
    static void callFunc(void *c)
    {
        T *cls = (T *)c;
	(cls->*method)();
    }
    CallFunc d0;
    void *d1;
    QmlTimeLineObject *d2;
};

QT_END_NAMESPACE

QT_END_HEADER

#endif