path: root/src/declarative/util/qmlfollow.cpp

/****************************************************************************
**
** 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$
**
****************************************************************************/

#include <limits.h>
#include <math.h>
#include <QtCore/qdebug.h>
#include "private/qobject_p.h"
#include "qmlfollow.h"
#include "private/qmlanimation_p.h"

QT_BEGIN_NAMESPACE

QML_DEFINE_TYPE(QmlFollow,Follow)

class QmlFollowPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlFollow)
public:
    QmlFollowPrivate()
        : sourceValue(0), maxVelocity(0), lastTime(0)
        , mass(1.0), spring(0.), damping(0.), velocity(0), epsilon(0.01), modulus(0.0), enabled(true), mode(Track), clock(this) {}

    QmlMetaProperty property;
    qreal currentValue;
    qreal sourceValue;
    qreal maxVelocity;
    qreal velocityms;
    int lastTime;
    qreal mass;
    qreal spring;
    qreal damping;
    qreal velocity;
    qreal epsilon;
    qreal modulus;
    bool enabled;

    enum Mode {
        Track,
        Velocity,
        Spring
    };
    Mode mode;

    void tick(int);
    void updateMode();
    void start();
    void stop();

    QTickAnimationProxy<QmlFollowPrivate, &QmlFollowPrivate::tick> clock;
};

void QmlFollowPrivate::tick(int time)
{
    Q_Q(QmlFollow);

    int elapsed = time - lastTime;
    if (!elapsed)
        return;
    qreal srcVal = sourceValue;
    if (modulus != 0.0) {
        currentValue = fmod(currentValue, modulus);
        srcVal = fmod(srcVal, modulus);
    }
    if (mode == Spring) {
        if (elapsed < 16) // capped at 62fps.
            return;
        // Real men solve the spring DEs using RK4.
        // We'll do something much simpler which gives a result that looks fine.
        int count = (elapsed+8) / 16;
        for (int i = 0; i < count; ++i) {
            qreal diff = srcVal - currentValue;
            if (modulus != 0.0 && qAbs(diff) > modulus / 2) {
                if (diff < 0)
                    diff += modulus;
                else
                    diff -= modulus;
            }
            velocity = velocity + spring * diff - damping * velocity;
            // The following line supports mass.  Not sure its worth the extra divisions.
            // velocity = velocity + spring / mass * diff - damping / mass * velocity;
            if (maxVelocity > 0.) {
                // limit velocity
                if (velocity > maxVelocity)
                    velocity = maxVelocity;
                else if (velocity < -maxVelocity)
                    velocity = -maxVelocity;
            }
            currentValue += velocity * 16.0 / 1000.0;
            if (modulus != 0.0) {
                currentValue = fmod(currentValue, modulus);
                if (currentValue < 0.0)
                    currentValue += modulus;
            }
        }
        if (qAbs(velocity) < epsilon && qAbs(srcVal - currentValue) < epsilon) {
            velocity = 0.0;
            currentValue = srcVal;
            clock.stop();
        }
        lastTime = time - (elapsed - count * 16);
    } else {
        qreal moveBy = elapsed * velocityms;
        qreal diff = srcVal - currentValue;
        if (modulus != 0.0 && qAbs(diff) > modulus / 2) {
            if (diff < 0)
                diff += modulus;
            else
                diff -= modulus;
        }
        if (diff > 0) {
            currentValue += moveBy;
            if (modulus != 0.0)
                currentValue = fmod(currentValue, modulus);
            if (currentValue > sourceValue) {
                currentValue = sourceValue;
                clock.stop();
            }
        } else {
            currentValue -= moveBy;
            if (modulus != 0.0 && currentValue < 0.0)
                currentValue = fmod(currentValue, modulus) + modulus;
            if (currentValue < sourceValue) {
                currentValue = sourceValue;
                clock.stop();
            }
        }
        lastTime = time;
    }
    property.write(currentValue);
    emit q->valueChanged(currentValue);
    if (clock.state() != QAbstractAnimation::Running)
        emit q->syncChanged();
}

void QmlFollowPrivate::updateMode()
{
    if (spring == 0. && maxVelocity == 0.)
        mode = Track;
    else if (spring > 0.)
        mode = Spring;
    else
        mode = Velocity;
}

void QmlFollowPrivate::start()
{
    if (!enabled)
        return;

    Q_Q(QmlFollow);
    if (mode == QmlFollowPrivate::Track) {
        currentValue = sourceValue;
        property.write(currentValue);
    } else if (sourceValue != currentValue && clock.state() != QAbstractAnimation::Running) {
        lastTime = 0;
        currentValue = property.read().toDouble();
        clock.start(); // infinity??
        emit q->syncChanged();
    }
}

void QmlFollowPrivate::stop()
{
    clock.stop();
}

/*!
    \qmlclass Follow QmlFollow
    \brief The Follow element allows a property to track a value.

    In example below, Rect2 will follow Rect1 moving with a velocity of up to 200:
    \code
    Rect {
        id: Rect1
        width: 20; height: 20
        color: "#00ff00"
        y: 200  //initial value
        y: SequentialAnimation {
            running: true
            repeat: true
            NumberAnimation {
                to: 200
                easing: "easeOutBounce(amplitude:100)"
                duration: 2000
            }
            PauseAnimation { duration: 1000 }
        }
    }
    Rect {
        id: Rect2
        x: Rect1.width
        width: 20; height: 20
        color: "#ff0000"
        y: Follow { source: Rect1.y; velocity: 200 }
    }
    \endcode
*/

QmlFollow::QmlFollow(QObject *parent)
: QmlPropertyValueSource(*(new QmlFollowPrivate),parent)
{
}

QmlFollow::~QmlFollow()
{
}

void QmlFollow::setTarget(const QmlMetaProperty &property)
{
    Q_D(QmlFollow);
    d->property = property;
    d->currentValue = property.read().toDouble();
}

qreal QmlFollow::sourceValue() const
{
    Q_D(const QmlFollow);
    return d->sourceValue;
}

/*!
    \qmlproperty qreal Follow::source
    This property holds the source value which will be tracked.

    Bind to a property in order to track its changes.
*/

void QmlFollow::setSourceValue(qreal value)
{
    Q_D(QmlFollow);
    if (d->sourceValue != value) {
        d->sourceValue = value;
        d->start();
    }
}

/*!
    \qmlproperty qreal Follow::velocity
    This property holds the maximum velocity allowed when tracking the source.
*/

qreal QmlFollow::velocity() const
{
    Q_D(const QmlFollow);
    return d->maxVelocity;
}

void QmlFollow::setVelocity(qreal velocity)
{
    Q_D(QmlFollow);
    d->maxVelocity = velocity;
    d->velocityms = velocity / 1000.0;
    d->updateMode();
}

/*!
    \qmlproperty qreal Follow::spring
    This property holds the spring constant

    The spring constant describes how strongly the target is pulled towards the
    source.  Setting spring to 0 turns off spring tracking.  Useful values 0 - 5.0

    When a spring constant is set and the velocity property is greater than 0,
    velocity limits the maximum speed.
*/
qreal QmlFollow::spring() const
{
    Q_D(const QmlFollow);
    return d->spring;
}

void QmlFollow::setSpring(qreal spring)
{
    Q_D(QmlFollow);
    d->spring = spring;
    d->updateMode();
}

/*!
    \qmlproperty qreal Follow::damping
    This property holds the spring damping constant

    The damping constant describes how quickly a sprung follower comes to rest.
    Useful range is 0 - 1.0
*/
qreal QmlFollow::damping() const
{
    Q_D(const QmlFollow);
    return d->damping;
}

void QmlFollow::setDamping(qreal damping)
{
    Q_D(QmlFollow);
    if (damping > 1.)
        damping = 1.;

    d->damping = damping;
}


/*!
    \qmlproperty qreal Follow::epsilon
    This property holds the spring epsilon

    The epsilon is the rate and amount of change in the value which is close enough
    to 0 to be considered equal to zero. This will depend on the usage of the value.
    For pixel positions, 0.25 would suffice. For scale, 0.005 will suffice.

    The default is 0.01. Small performance improvements can result in tuning this
    value.
*/
qreal QmlFollow::epsilon() const
{
    Q_D(const QmlFollow);
    return d->epsilon;
}

void QmlFollow::setEpsilon(qreal epsilon)
{
    Q_D(QmlFollow);
    d->epsilon = epsilon;
}

/*!
    \qmlproperty qreal Follow::modulus
    This property holds the modulus value.

    Setting a \a modulus forces the target value to "wrap around" at the modulus.
    For example, setting the modulus to 360 will cause a value of 370 to wrap around to 10.
*/
qreal QmlFollow::modulus() const
{
    Q_D(const QmlFollow);
    return d->modulus;
}

void QmlFollow::setModulus(qreal modulus)
{
    Q_D(QmlFollow);
    d->modulus = modulus;
}

/*!
    \qmlproperty qreal Follow::followValue
    The current value.
*/

/*!
    \qmlproperty bool Follow::enabled
    This property holds whether the target will track the source.
*/
bool QmlFollow::enabled() const
{
    Q_D(const QmlFollow);
    return d->enabled;
}

void QmlFollow::setEnabled(bool enabled)
{
    Q_D(QmlFollow);
    d->enabled = enabled;
    if (enabled)
        d->start();
    else
        d->stop();
}

/*!
    \qmlproperty bool Follow::inSync
    This property is true when target is equal to the source; otherwise
    false.  If inSync is true the target is not being animated.

    If \l enabled is false then inSync will also be false.
*/
bool QmlFollow::inSync() const
{
    Q_D(const QmlFollow);
    return d->enabled && d->clock.state() != QAbstractAnimation::Running;
}

qreal QmlFollow::value() const
{
    Q_D(const QmlFollow);
    return d->currentValue;
}

QT_END_NAMESPACE