Animators - Render thread animation system

This introduces 6 new QML types for animating state in the
scene graph when the UI thread is blocked. The QObject property
being animated is updated after the animation completes.

It works also with the "windows" and "basic" render loops, but
offer litte benefit then compared to in the "threaded" case.

Change-Id: Ic19e47c898c0b8bd53e457db922b3c9c457c8147
Reviewed-by: Lars Knoll <lars.knoll@digia.com>

1 files changed, 565 insertions, 0 deletions

diff --git a/src/quick/util/qquickanimator.cpp b/src/quick/util/qquickanimator.cpp
new file mode 100644
index 0000000000..c6f9f20aae
--- /dev/null
+++ b/src/quick/util/qquickanimator.cpp
@@ -0,0 +1,565 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtQuick module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, 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.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qquickanimator_p_p.h"
+#include "qquickanimatorjob_p.h"
+
+#include <private/qquickitem_p.h>
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \qmltype Animator
+    \instantiates QQuickAnimator
+    \inqmlmodule QtQuick 2
+    \since QtQuick 2.2
+    \ingroup qtquick-transitions-animations
+    \brief Is the base of all QML animators.
+
+    Animator types are a special type of animation which operate
+    directly on Qt Quick's scene graph, rather than the QML objects and their
+    properties like regular Animation types do. This has the benefit that
+    Animator based animations can animate on the \l
+    {Threaded Render Loop}{scene graph's rendering thread} even when the
+    UI thread is blocked.
+
+    The value of the QML property will be updated after the animation has
+    finished. The property is not updated while the animation is running.
+
+    The Animator types can be used just like any other Animation type.
+
+    \snippet qml/animators.qml mixed
+
+    If all sub-animations of ParallelAnimation and SequentialAnimation
+    are Animator types, the ParallelAnimation and SequentialAnimation will
+    also be treated as an Animator and be run on the scene graph's rendering
+    thread when possible.
+
+    The Animator type cannot be used directly in a QML file. It exists
+    to provide a set of common properties and methods, available across all the
+    other animator types that inherit from it. Attempting to use the Animator
+    type directly will result in an error.
+ */
+
+QQuickAnimator::QQuickAnimator(QQuickAnimatorPrivate &dd, QObject *parent)
+    : QQuickAbstractAnimation(dd, parent)
+{
+}
+
+QQuickAnimator::QQuickAnimator(QObject *parent)
+    : QQuickAbstractAnimation(*new QQuickAnimatorPrivate, parent)
+{
+}
+
+/*!
+   \qmlproperty QtQuick2::Item QtQuick2::Animator::target
+
+   This property holds the target item of the animator.
+
+   \note Animator targets must be Item based types.
+ */
+
+void QQuickAnimator::setTargetItem(QQuickItem *target)
+{
+    Q_D(QQuickAnimator);
+    if (target == d->target)
+        return;
+    d->target = target;
+    Q_EMIT targetItemChanged(d->target);
+}
+
+QQuickItem *QQuickAnimator::targetItem() const
+{
+    Q_D(const QQuickAnimator);
+    return d->target;
+}
+
+/*!
+    \qmlproperty int QtQuick2::Animator::duration
+    This property holds the duration of the animation in milliseconds.
+
+    The default value is 250.
+*/
+void QQuickAnimator::setDuration(int duration)
+{
+    Q_D(QQuickAnimator);
+    if (duration == d->duration)
+        return;
+    d->duration = duration;
+    Q_EMIT durationChanged(duration);
+}
+
+int QQuickAnimator::duration() const
+{
+    Q_D(const QQuickAnimator);
+    return d->duration;
+}
+
+/*!
+    \qmlpropertygroup QtQuick2::Animator::easing
+    \qmlproperty enumeration QtQuick2::Animator::easing.type
+    \qmlproperty real QtQuick2::Animator::easing.amplitude
+    \qmlproperty real QtQuick2::Animator::easing.overshoot
+    \qmlproperty real QtQuick2::Animator::easing.period
+    \qmlproperty list<real> QtQuick2::Animator::easing.bezierCurve
+    \include qquickanimation.cpp propertyanimation.easing
+*/
+
+void QQuickAnimator::setEasing(const QEasingCurve &easing)
+{
+    Q_D(QQuickAnimator);
+    if (easing == d->easing)
+        return;
+    d->easing = easing;
+    Q_EMIT easingChanged(d->easing);
+}
+
+QEasingCurve QQuickAnimator::easing() const
+{
+    Q_D(const QQuickAnimator);
+    return d->easing;
+}
+
+/*!
+    \qmlproperty real QtQuick2::Animator::to
+    This property holds the end value for the animation.
+
+    If the Animator is defined within a \l Transition or \l Behavior,
+    this value defaults to the value defined in the end state of the
+    \l Transition, or the value of the property change that triggered the
+    \l Behavior.
+ */
+
+void QQuickAnimator::setTo(qreal to)
+{
+    Q_D(QQuickAnimator);
+    if (to == d->to)
+        return;
+    d->isToDefined = true;
+    d->to = to;
+    Q_EMIT toChanged(d->to);
+}
+
+qreal QQuickAnimator::to() const
+{
+    Q_D(const QQuickAnimator);
+    return d->to;
+}
+
+/*!
+    \qmlproperty real QtQuick2::Animator::from
+    This property holds the starting value for the animation.
+
+    If the Animator is defined within a \l Transition or \l Behavior,
+    this value defaults to the value defined in the starting state of the
+    \l Transition, or the current value of the property at the moment the
+    \l Behavior is triggered.
+
+    \sa {Animation and Transitions in Qt Quick}
+*/
+
+void QQuickAnimator::setFrom(qreal from)
+{
+    Q_D(QQuickAnimator);
+    if (from == d->from)
+        return;
+    d->isFromDefined = true;
+    d->from = from;
+    Q_EMIT fromChanged(d->from);
+}
+
+qreal QQuickAnimator::from() const
+{
+    Q_D(const QQuickAnimator);
+    return d->from;
+}
+
+void QQuickAnimatorPrivate::apply(QQuickAnimatorJob *job,
+                                     const QString &propertyName,
+                                     QQuickStateActions &actions,
+                                     QQmlProperties &modified)
+{
+
+    if (actions.size()) {
+        for (int i=0; i<actions.size(); ++i) {
+            QQuickAction &action = actions[i];
+            if (action.property.name() != propertyName)
+                continue;
+            modified << action.property;
+
+            job->setTarget(qobject_cast<QQuickItem *>(action.property.object()));
+
+            if (isFromDefined)
+                job->setFrom(from);
+            else if (action.fromValue.isValid())
+                job->setFrom(action.fromValue.toReal());
+            else
+                job->setFrom(action.property.read().toReal());
+
+            if (isToDefined)
+                job->setTo(to);
+            else if (action.toValue.isValid())
+                job->setTo(action.toValue.toReal());
+            else
+                job->setTo(action.property.read().toReal());
+
+            // This magic line is in sync with what PropertyAnimation does
+            // and prevents the animation to end up in the "completeList"
+            // which forces action.toValue to be written directly to
+            // the item when a transition is cancelled.
+            action.fromValue = action.toValue;
+       }
+    } else {
+        job->setTarget(target);
+        job->setFrom(from);
+        job->setTo(to);
+    }
+
+    if (!job->target() && defaultProperty.object())
+        job->setTarget(qobject_cast<QQuickItem *>(defaultProperty.object()));
+
+    job->setDuration(duration);
+    job->setLoopCount(loopCount);
+    job->setEasingCurve(easing);
+}
+
+QAbstractAnimationJob *QQuickAnimator::transition(QQuickStateActions &actions,
+                                                  QQmlProperties &modified,
+                                                  TransitionDirection,
+                                                  QObject *)
+{
+    Q_D(QQuickAnimator);
+
+    if (d->defaultProperty.isValid() && propertyName() != d->defaultProperty.name()) {
+        qDebug() << Q_FUNC_INFO << "property name conflict...";
+        return 0;
+    }
+
+    QQuickAnimatorJob *job = createJob();
+    if (!job)
+        return 0;
+
+    d->apply(job, propertyName(), actions, modified);
+
+    if (!job->target()) {
+        delete job;
+        return 0;
+    }
+
+    return job;
+}
+
+/*!
+    \qmltype XAnimator
+    \instantiates QQuickXAnimator
+    \inqmlmodule QtQuick 2
+    \since QtQuick 2.2
+    \ingroup qtquick-transitions-animations
+    \brief The XAnimator type animates the x position of an Item.
+
+    \l{Animator} types are different from normal Animation types. When
+    using an Animator, the animation can be run in the render thread
+    and the property value will jump to the end when the animation is
+    complete.
+
+    The value of Item::x is updated after the animation has finished.
+
+    The following snippet shows how to use a XAnimator together
+    with a Rectangle item.
+
+    \snippet qml/animators.qml x target
+
+    It is also possible to use the \c on keyword to tie the
+    XAnimator directly to an Item instance.
+
+    \snippet qml/animators.qml x on
+
+
+ */
+
+QQuickXAnimator::QQuickXAnimator(QObject *parent) : QQuickAnimator(parent) {}
+
+QQuickAnimatorJob *QQuickXAnimator::createJob() const { return new QQuickXAnimatorJob(); }
+
+/*!
+    \qmltype YAnimator
+    \instantiates QQuickYAnimator
+    \inqmlmodule QtQuick 2
+    \since QtQuick 2.2
+    \ingroup qtquick-transitions-animations
+    \brief The YAnimator type animates the y position of an Item.
+
+    \l{Animator} types are different from normal Animation types. When
+    using an Animator, the animation can be run in the render thread
+    and the property value will jump to the end when the animation is
+    complete.
+
+    The value of Item::y is updated after the animation has finished.
+
+    The following snippet shows how to use a YAnimator together
+    with a Rectangle item.
+
+    \snippet qml/animators.qml y target
+
+    It is also possible to use the \c on keyword to tie the
+    YAnimator directly to an Item instance.
+
+    \snippet qml/animators.qml y on
+
+
+ */
+
+QQuickYAnimator::QQuickYAnimator(QObject *parent) : QQuickAnimator(parent) {}
+
+QQuickAnimatorJob *QQuickYAnimator::createJob() const { return new QQuickYAnimatorJob(); }
+
+/*!
+    \qmltype ScaleAnimator
+    \instantiates QQuickScaleAnimator
+    \inqmlmodule QtQuick 2
+    \since QtQuick 2.2
+    \ingroup qtquick-transitions-animations
+    \brief The ScaleAnimator type animates the scale factor of an Item.
+
+    \l{Animator} types are different from normal Animation types. When
+    using an Animator, the animation can be run in the render thread
+    and the property value will jump to the end when the animation is
+    complete.
+
+    The value of Item::scale is updated after the animation has finished.
+
+    The following snippet shows how to use a ScaleAnimator together
+    with a Rectangle item.
+
+    \snippet qml/animators.qml scale target
+
+    It is also possible to use the \c on keyword to tie the
+    ScaleAnimator directly to an Item instance.
+
+    \snippet qml/animators.qml scale on
+
+    \sa Item::transformOrigin, RotationAnimator
+ */
+
+QQuickScaleAnimator::QQuickScaleAnimator(QObject *parent) : QQuickAnimator(parent) {}
+
+QQuickAnimatorJob *QQuickScaleAnimator::createJob() const { return new QQuickScaleAnimatorJob(); }
+
+/*!
+    \qmltype OpacityAnimator
+    \instantiates QQuickOpacityAnimator
+    \inqmlmodule QtQuick 2
+    \since QtQuick 2.2
+    \ingroup qtquick-transitions-animations
+    \brief The OpacityAnimator type animates the opacity of an Item.
+
+    \l{Animator} types are different from normal Animation types. When
+    using an Animator, the animation can be run in the render thread
+    and the property value will jump to the end when the animation is
+    complete.
+
+    The value of Item::opacity is updated after the animation has finished.
+
+    The following snippet shows how to use a OpacityAnimator together
+    with a Rectangle item.
+
+    \snippet qml/animators.qml opacity target
+
+    It is also possible to use the \c on keyword to tie the
+    OpacityAnimator directly to an Item instance.
+
+    \snippet qml/animators.qml opacity on
+
+ */
+
+QQuickOpacityAnimator::QQuickOpacityAnimator(QObject *parent) : QQuickAnimator(parent) {}
+
+QQuickAnimatorJob *QQuickOpacityAnimator::createJob() const { return new QQuickOpacityAnimatorJob(); }
+
+/*!
+    \qmltype RotationAnimator
+    \instantiates QQuickRotationAnimator
+    \inqmlmodule QtQuick 2
+    \since QtQuick 2.2
+    \ingroup qtquick-transitions-animations
+    \brief The RotationAnimator type animates the rotation of an Item.
+
+    \l{Animator} types are different from normal Animation types. When
+    using an Animator, the animation can be run in the render thread
+    and the property value will jump to the end when the animation is
+    complete.
+
+    The value of Item::rotation is updated after the animation has finished.
+
+    The following snippet shows how to use a RotationAnimator together
+    with a Rectangle item.
+
+    \snippet qml/animators.qml rotation target
+
+    It is also possible to use the \c on keyword to tie the
+    RotationAnimator directly to the \c rotation property of an Item
+    instance.
+
+    \snippet qml/animators.qml rotation on
+
+    \sa Item::transformOrigin, ScaleAnimator
+ */
+
+QQuickRotationAnimator::QQuickRotationAnimator(QObject *parent)
+    : QQuickAnimator(*new QQuickRotationAnimatorPrivate, parent)
+{
+}
+
+QQuickAnimatorJob *QQuickRotationAnimator::createJob() const {
+    Q_D(const QQuickRotationAnimator);
+    QQuickRotationAnimatorJob *job = new QQuickRotationAnimatorJob();
+    job->setDirection(d->direction);
+    return job;
+}
+
+/*!
+    \qmlproperty enumeration QtQuick2::RotationAnimator::direction
+    This property holds the direction of the rotation.
+
+    Possible values are:
+
+    \list
+    \li RotationAnimator.Numerical (default) - Rotate by linearly interpolating between the two numbers.
+           A rotation from 10 to 350 will rotate 340 degrees clockwise.
+    \li RotationAnimator.Clockwise - Rotate clockwise between the two values
+    \li RotationAnimator.Counterclockwise - Rotate counterclockwise between the two values
+    \li RotationAnimator.Shortest - Rotate in the direction that produces the shortest animation path.
+           A rotation from 10 to 350 will rotate 20 degrees counterclockwise.
+    \endlist
+*/
+void QQuickRotationAnimator::setDirection(RotationDirection dir)
+{
+    Q_D(QQuickRotationAnimator);
+    if (d->direction == dir)
+        return;
+    d->direction = dir;
+    Q_EMIT directionChanged(d->direction);
+}
+
+QQuickRotationAnimator::RotationDirection QQuickRotationAnimator::direction() const
+{
+    Q_D(const QQuickRotationAnimator);
+    return d->direction;
+}
+
+/*!
+    \qmltype UniformAnimator
+    \instantiates QQuickUniformAnimator
+    \inqmlmodule QtQuick 2
+    \since QtQuick 2.2
+    \ingroup qtquick-transitions-animations
+    \brief The UniformAnimator type animates a uniform of a ShaderEffect.
+
+    \l{Animator} types are different from normal Animation types. When
+    using an Animator, the animation can be run in the render thread
+    and the property value will jump to the end when the animation is
+    complete.
+
+    The value of the QML property defining the uniform is updated after
+    the animation has finished.
+
+    The following snippet shows how to use a UniformAnimator together
+    with a ShaderEffect item.
+
+    \snippet qml/animators.qml shader target
+
+    It is also possible to use the \c on keyword to tie the
+    UniformAnimator directly to a uniform of a ShaderEffect
+    instance.
+
+    \snippet qml/animators.qml shader on
+
+    \sa ShaderEffect, ShaderEffectSource
+ */
+
+QQuickUniformAnimator::QQuickUniformAnimator(QObject *parent)
+    : QQuickAnimator(*new QQuickUniformAnimatorPrivate, parent)
+{
+}
+
+/*!
+   \qmlproperty string QtQuick2::UniformAnimator::uniform
+   This property holds the name of the uniform to animate.
+
+   The value of the uniform must correspond to both a property
+   on the target ShaderEffect and must be a uniform of type
+   \c float in the fragment or vertex shader.
+ */
+void QQuickUniformAnimator::setUniform(const QString &uniform)
+{
+    Q_D(QQuickUniformAnimator);
+    if (d->uniform == uniform)
+        return;
+    d->uniform = uniform;
+    Q_EMIT uniformChanged(d->uniform);
+}
+
+QString QQuickUniformAnimator::uniform() const
+{
+    Q_D(const QQuickUniformAnimator);
+    return d->uniform;
+}
+
+QString QQuickUniformAnimator::propertyName() const
+{
+    Q_D(const QQuickUniformAnimator);
+    if (!d->uniform.isEmpty())
+        return d->uniform;
+    return d->defaultProperty.name();
+}
+
+QQuickAnimatorJob *QQuickUniformAnimator::createJob() const
+{
+    QString u = propertyName();
+    if (u.isEmpty())
+        return 0;
+
+    QQuickUniformAnimatorJob *job = new QQuickUniformAnimatorJob();
+    job->setUniform(u.toLatin1());
+    return job;
+}
+
+QT_END_NAMESPACE