/**************************************************************************** ** ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the QtDeclarative 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 "private/qdeclarativestate_p.h" #include "private/qdeclarativestategroup_p.h" #include "private/qdeclarativestate_p_p.h" #include "private/qdeclarativestateoperations_p.h" #include "private/qdeclarativeanimation_p.h" #include "private/qdeclarativeanimation_p_p.h" #include "private/qdeclarativetransitionmanager_p_p.h" #include QT_BEGIN_NAMESPACE /*! \qmlclass Transition QDeclarativeTransition \ingroup qml-animation-transition \since 4.7 \brief The Transition element defines animated transitions that occur on state changes. A Transition defines the animations to be applied when a \l State change occurs. For example, the following \l Rectangle has two states: the default state, and an added "moved" state. In the "moved state, the rectangle's position changes to (50, 50). The added Transition specifies that when the rectangle changes between the default and the "moved" state, any changes to the \c x and \c y properties should be animated, using an \c Easing.InOutQuad. \snippet doc/src/snippets/declarative/transition.qml 0 Notice the example does not require \l{PropertyAnimation::}{to} and \l{PropertyAnimation::}{from} values for the NumberAnimation. As a convenience, these properties are automatically set to the values of \c x and \c y before and after the state change; the \c from values are provided by the current values of \c x and \c y, and the \c to values are provided by the PropertyChanges object. If you wish, you can provide \l{PropertyAnimation::}{to} and \l{PropertyAnimation::}{from} values anyway to override the default values. By default, a Transition's animations are applied for any state change in the parent item. The Transition \l {Transition::}{from} and \l {Transition::}{to} values can be set to restrict the animations to only be applied when changing from one particular state to another. To define multiple transitions, specify \l Item::transitions as a list: \snippet doc/src/snippets/declarative/transitions-list.qml list of transitions If multiple Transitions are specified, only a single (best-matching) Transition will be applied for any particular state change. In the example above, when changing to \c state1, the first transition will be used, rather than the more generic second transition. If a state change has a Transition that matches the same property as a \l Behavior, the Transition animation overrides the \l Behavior for that state change. \sa {QML Animation and Transitions}, {declarative/animation/states}{states example}, {qmlstates}{States}, {QtDeclarative} */ //ParallelAnimationWrapper allows us to do a "callback" when the animation finishes, rather than connecting //and disconnecting signals and slots frequently class ParallelAnimationWrapper : public QParallelAnimationGroup { Q_OBJECT public: ParallelAnimationWrapper(QObject *parent = 0) : QParallelAnimationGroup(parent) {} QDeclarativeTransitionPrivate *trans; protected: virtual void updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState); }; class QDeclarativeTransitionPrivate : public QObjectPrivate { Q_DECLARE_PUBLIC(QDeclarativeTransition) public: QDeclarativeTransitionPrivate() : fromState(QLatin1String("*")), toState(QLatin1String("*")), reversed(false), reversible(false), endState(0) { group.trans = this; } QString fromState; QString toState; bool reversed; bool reversible; ParallelAnimationWrapper group; QDeclarativeTransitionManager *endState; void complete() { endState->complete(); } static void append_animation(QDeclarativeListProperty *list, QDeclarativeAbstractAnimation *a); static int animation_count(QDeclarativeListProperty *list); static QDeclarativeAbstractAnimation* animation_at(QDeclarativeListProperty *list, int pos); static void clear_animations(QDeclarativeListProperty *list); QList animations; }; void QDeclarativeTransitionPrivate::append_animation(QDeclarativeListProperty *list, QDeclarativeAbstractAnimation *a) { QDeclarativeTransition *q = static_cast(list->object); q->d_func()->animations.append(a); q->d_func()->group.addAnimation(a->qtAnimation()); a->setDisableUserControl(); } int QDeclarativeTransitionPrivate::animation_count(QDeclarativeListProperty *list) { QDeclarativeTransition *q = static_cast(list->object); return q->d_func()->animations.count(); } QDeclarativeAbstractAnimation* QDeclarativeTransitionPrivate::animation_at(QDeclarativeListProperty *list, int pos) { QDeclarativeTransition *q = static_cast(list->object); return q->d_func()->animations.at(pos); } void QDeclarativeTransitionPrivate::clear_animations(QDeclarativeListProperty *list) { QDeclarativeTransition *q = static_cast(list->object); while (q->d_func()->animations.count()) { QDeclarativeAbstractAnimation *firstAnim = q->d_func()->animations.at(0); q->d_func()->group.removeAnimation(firstAnim->qtAnimation()); q->d_func()->animations.removeAll(firstAnim); } } void ParallelAnimationWrapper::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState) { QParallelAnimationGroup::updateState(newState, oldState); if (newState == Stopped && (duration() == -1 || (direction() == QAbstractAnimation::Forward && currentLoopTime() == duration()) || (direction() == QAbstractAnimation::Backward && currentLoopTime() == 0))) { trans->complete(); } } QDeclarativeTransition::QDeclarativeTransition(QObject *parent) : QObject(*(new QDeclarativeTransitionPrivate), parent) { } QDeclarativeTransition::~QDeclarativeTransition() { } void QDeclarativeTransition::stop() { Q_D(QDeclarativeTransition); d->group.stop(); } void QDeclarativeTransition::setReversed(bool r) { Q_D(QDeclarativeTransition); d->reversed = r; } void QDeclarativeTransition::prepare(QDeclarativeStateOperation::ActionList &actions, QList &after, QDeclarativeTransitionManager *endState) { Q_D(QDeclarativeTransition); qmlExecuteDeferred(this); if (d->reversed) { for (int ii = d->animations.count() - 1; ii >= 0; --ii) { d->animations.at(ii)->transition(actions, after, QDeclarativeAbstractAnimation::Backward); } } else { for (int ii = 0; ii < d->animations.count(); ++ii) { d->animations.at(ii)->transition(actions, after, QDeclarativeAbstractAnimation::Forward); } } d->endState = endState; d->group.setDirection(d->reversed ? QAbstractAnimation::Backward : QAbstractAnimation::Forward); d->group.start(); } /*! \qmlproperty string Transition::from \qmlproperty string Transition::to These properties indicate the state changes that trigger the transition. The default values for these properties is "*" (that is, any state). For example, the following transition has not set the \c to and \c from properties, so the animation is always applied when changing between the two states (i.e. when the mouse is pressed and released). \snippet doc/src/snippets/declarative/transition-from-to.qml 0 If the transition was changed to this: \snippet doc/src/snippets/declarative/transition-from-to-modified.qml modified transition The animation would only be applied when changing from the default state to the "brighter" state (i.e. when the mouse is pressed, but not on release). \sa reversible */ QString QDeclarativeTransition::fromState() const { Q_D(const QDeclarativeTransition); return d->fromState; } void QDeclarativeTransition::setFromState(const QString &f) { Q_D(QDeclarativeTransition); if (f == d->fromState) return; d->fromState = f; emit fromChanged(); } /*! \qmlproperty bool Transition::reversible This property holds whether the transition should be automatically reversed when the conditions that triggered this transition are reversed. The default value is false. By default, transitions run in parallel and are applied to all state changes if the \l from and \l to states have not been set. In this situation, the transition is automatically applied when a state change is reversed, and it is not necessary to set this property to reverse the transition. However, if a SequentialAnimation is used, or if the \l from or \l to properties have been set, this property will need to be set to reverse a transition when a state change is reverted. For example, the following transition applies a sequential animation when the mouse is pressed, and reverses the sequence of the animation when the mouse is released: \snippet doc/src/snippets/declarative/transition-reversible.qml 0 If the transition did not set the \c to and \c reversible values, then on the mouse release, the transition would play the PropertyAnimation before the ColorAnimation instead of reversing the sequence. */ bool QDeclarativeTransition::reversible() const { Q_D(const QDeclarativeTransition); return d->reversible; } void QDeclarativeTransition::setReversible(bool r) { Q_D(QDeclarativeTransition); if (r == d->reversible) return; d->reversible = r; emit reversibleChanged(); } QString QDeclarativeTransition::toState() const { Q_D(const QDeclarativeTransition); return d->toState; } void QDeclarativeTransition::setToState(const QString &t) { Q_D(QDeclarativeTransition); if (t == d->toState) return; d->toState = t; emit toChanged(); } /*! \qmlproperty list Transition::animations \default This property holds a list of the animations to be run for this transition. \snippet examples/declarative/toys/dynamicscene/dynamicscene.qml top-level transitions The top-level animations are run in parallel. To run them sequentially, define them within a SequentialAnimation: \snippet doc/src/snippets/declarative/transition-reversible.qml sequential animations */ QDeclarativeListProperty QDeclarativeTransition::animations() { Q_D(QDeclarativeTransition); return QDeclarativeListProperty(this, &d->animations, QDeclarativeTransitionPrivate::append_animation, QDeclarativeTransitionPrivate::animation_count, QDeclarativeTransitionPrivate::animation_at, QDeclarativeTransitionPrivate::clear_animations); } QT_END_NAMESPACE #include