summaryrefslogtreecommitdiffstats
path: root/src/animation/frontend/qanimationgroup.cpp
blob: 36574566219ed1fdfc61695c7bfefcbf92698bfc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** 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 The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later 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 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qanimationgroup.h"
#include "Qt3DAnimation/private/qanimationgroup_p.h"

QT_BEGIN_NAMESPACE

namespace Qt3DAnimation {

/*!
    \class Qt3DAnimation::QAnimationGroup
    \brief A class grouping animations together
    \inmodule Qt3DAnimation
    \since 5.9
    \inherits QObject

    Qt3DAnimation::QAnimationGroup class is used to group multiple animations so that
    they can act as one animation. The position set to the group is also set to
    all animations in a group. The duration is the maximum of the individual animations.
    The animations can be any supported animation type and do not have to have the same name.
*/
/*!
    \qmltype AnimationGroup
    \brief A type grouping animations together
    \inqmlmodule Qt3D.Animation
    \since 5.9
    \inherits QObject

    AnimationGroup type is used to group multiple animations so that
    they can act as one animation. The position set to the group is also set to
    all animations in a group. The duration is the maximum of the individual animations.
    The animations can be any supported animation type and do not have to have the same name.
*/

/*!
    \property Qt3DAnimation::QAnimationGroup::name
    Holds the name of the animation group.
*/
/*!
    \property Qt3DAnimation::QAnimationGroup::position
    Holds the animation position.
*/
/*!
    \property Qt3DAnimation::QAnimationGroup::duration
    Holds the maximum duration of the animations in the group.
    \readonly
*/

/*!
    \qmlproperty string AnimationGroup::name
    Holds the name of the animation group.
*/
/*!
    \qmlproperty real AnimationGroup::position
    Holds the animation position.
*/
/*!
    \qmlproperty real AnimationGroup::duration
    Holds the maximum duration of the animations in the group.
    \readonly
*/
/*!
    \qmlproperty list<AbstractAnimation> AnimationGroup::animations
    Holds the list of animations in the animation group.
*/

QAnimationGroupPrivate::QAnimationGroupPrivate()
    : QObjectPrivate()
    , m_position(0.0f)
    , m_duration(0.0f)
{

}

void QAnimationGroupPrivate::updatePosition(float position)
{
    m_position = position;
    for (QAbstractAnimation *aa : qAsConst(m_animations))
        aa->setPosition(position);
}

/*!
    Constructs an QAnimationGroup with \a parent.
*/
QAnimationGroup::QAnimationGroup(QObject *parent)
    : QObject(*new QAnimationGroupPrivate, parent)
{

}

QString QAnimationGroup::name() const
{
    Q_D(const QAnimationGroup);
    return d->m_name;
}

/*!
    Returns the list of animations in the group.
 */
QVector<Qt3DAnimation::QAbstractAnimation *> QAnimationGroup::animationList()
{
    Q_D(QAnimationGroup);
    return d->m_animations;
}

float QAnimationGroup::position() const
{
    Q_D(const QAnimationGroup);
    return d->m_position;
}

float QAnimationGroup::duration() const
{
    Q_D(const QAnimationGroup);
    return d->m_duration;
}

void QAnimationGroup::setName(const QString &name)
{
    Q_D(QAnimationGroup);
    if (d->m_name != name) {
        d->m_name = name;
        emit nameChanged(name);
    }
}

/*!
    Sets the \a animations to the group. Old animations are removed.
 */
void QAnimationGroup::setAnimations(const QVector<Qt3DAnimation::QAbstractAnimation *> &animations)
{
    Q_D(QAnimationGroup);
    d->m_animations = animations;
    d->m_duration = 0.0f;
    for (const Qt3DAnimation::QAbstractAnimation *a : animations)
        d->m_duration = qMax(d->m_duration, a->duration());
}

/*!
    Adds new \a animation to the group.
 */
void QAnimationGroup::addAnimation(Qt3DAnimation::QAbstractAnimation *animation)
{
    Q_D(QAnimationGroup);
    if (!d->m_animations.contains(animation)) {
        d->m_animations.push_back(animation);
        d->m_duration = qMax(d->m_duration, animation->duration());
    }
}

/*!
    Removes \a animation from the group.
 */
void QAnimationGroup::removeAnimation(Qt3DAnimation::QAbstractAnimation *animation)
{
    Q_D(QAnimationGroup);
    if (!d->m_animations.contains(animation)) {
        d->m_animations.removeAll(animation);
        if (qFuzzyCompare(d->m_duration, animation->duration())) {
            d->m_duration = 0.0f;
            for (const Qt3DAnimation::QAbstractAnimation *a : d->m_animations)
                d->m_duration = qMax(d->m_duration, a->duration());
        }
    }
}

void QAnimationGroup::setPosition(float position)
{
    Q_D(QAnimationGroup);
    if (!qFuzzyCompare(d->m_position, position)) {
        d->updatePosition(position);
        emit positionChanged(position);
    }
}

} // Qt3DAnimation

QT_END_NAMESPACE