1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2016 The Qt Company Ltd. |
4 | ** Contact: https://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the QtGui module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:BSD$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and The Qt Company. For licensing terms |
14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://www.qt.io/contact-us. |
16 | ** |
17 | ** BSD License Usage |
18 | ** Alternatively, you may use this file under the terms of the BSD license |
19 | ** as follows: |
20 | ** |
21 | ** "Redistribution and use in source and binary forms, with or without |
22 | ** modification, are permitted provided that the following conditions are |
23 | ** met: |
24 | ** * Redistributions of source code must retain the above copyright |
25 | ** notice, this list of conditions and the following disclaimer. |
26 | ** * Redistributions in binary form must reproduce the above copyright |
27 | ** notice, this list of conditions and the following disclaimer in |
28 | ** the documentation and/or other materials provided with the |
29 | ** distribution. |
30 | ** * Neither the name of The Qt Company Ltd nor the names of its |
31 | ** contributors may be used to endorse or promote products derived |
32 | ** from this software without specific prior written permission. |
33 | ** |
34 | ** |
35 | ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
36 | ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
37 | ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
38 | ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
39 | ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
40 | ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
41 | ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
42 | ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
43 | ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
44 | ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
45 | ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." |
46 | ** |
47 | ** $QT_END_LICENSE$ |
48 | ** |
49 | ****************************************************************************/ |
50 | |
51 | #include "qanimationstate.h" |
52 | |
53 | #include <QAbstractAnimation> |
54 | |
55 | QT_BEGIN_NAMESPACE |
56 | |
57 | /*! |
58 | \class QAnimationState |
59 | |
60 | \brief The QAnimationState class provides state that handle an animation and emit |
61 | a signal when this animation is finished. |
62 | |
63 | \ingroup statemachine |
64 | |
65 | QAnimationState provides a state that handle an animation. It will start this animation |
66 | when the state is entered and stop it when it is leaved. When the animation has finished the |
67 | state emit animationFinished signal. |
68 | QAnimationState is part of \l{The State Machine Framework}. |
69 | |
70 | \code |
71 | QStateMachine machine; |
72 | QAnimationState *s = new QAnimationState(machine->rootState()); |
73 | QPropertyAnimation *animation = new QPropertyAnimation(obj, "pos"); |
74 | s->setAnimation(animation); |
75 | QState *s2 = new QState(machine->rootState()); |
76 | s->addTransition(s, &QAnimationState::animationFinished, s2); |
77 | machine.start(); |
78 | \endcode |
79 | |
80 | \sa QState, {The Animation Framework} |
81 | */ |
82 | |
83 | /*! |
84 | Constructs a new state with the given \a parent state. |
85 | */ |
86 | QAnimationState::QAnimationState(QState *parent) |
87 | : QState(parent), m_animation(nullptr) |
88 | { |
89 | } |
90 | |
91 | /*! |
92 | Destroys the animation state. |
93 | */ |
94 | QAnimationState::~QAnimationState() |
95 | { |
96 | } |
97 | |
98 | /*! |
99 | Set an \a animation for this QAnimationState. If an animation was previously handle by this |
100 | state then it won't emit animationFinished for the old animation. The QAnimationState doesn't |
101 | take the ownership of the animation. |
102 | */ |
103 | void QAnimationState::setAnimation(QAbstractAnimation *animation) |
104 | { |
105 | if (animation == m_animation) |
106 | return; |
107 | |
108 | //Disconnect from the previous animation if exist |
109 | if (m_animation) |
110 | disconnect(sender: m_animation, signal: &QAbstractAnimation::finished, receiver: this, slot: &QAnimationState::animationFinished); |
111 | |
112 | m_animation = animation; |
113 | |
114 | if (m_animation) { |
115 | //connect the new animation |
116 | connect(sender: m_animation, signal: &QAbstractAnimation::finished, receiver: this, slot: &QAnimationState::animationFinished); |
117 | } |
118 | } |
119 | |
120 | /*! |
121 | Returns the animation handle by this animation state, or \nullptr if there is no animation. |
122 | */ |
123 | QAbstractAnimation* QAnimationState::animation() const |
124 | { |
125 | return m_animation; |
126 | } |
127 | |
128 | /*! |
129 | \reimp |
130 | */ |
131 | void QAnimationState::onEntry(QEvent *) |
132 | { |
133 | if (m_animation) |
134 | m_animation->start(); |
135 | } |
136 | |
137 | /*! |
138 | \reimp |
139 | */ |
140 | void QAnimationState::onExit(QEvent *) |
141 | { |
142 | if (m_animation) |
143 | m_animation->stop(); |
144 | } |
145 | |
146 | /*! |
147 | \reimp |
148 | */ |
149 | bool QAnimationState::event(QEvent *e) |
150 | { |
151 | return QState::event(e); |
152 | } |
153 | |
154 | QT_END_NAMESPACE |
155 | |