1/****************************************************************************
2**
3** Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
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** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QT3DANIMATION_QABSTRACTCLIPANIMATOR_H
41#define QT3DANIMATION_QABSTRACTCLIPANIMATOR_H
42
43#include <Qt3DAnimation/qt3danimation_global.h>
44#include <Qt3DCore/qcomponent.h>
45
46QT_BEGIN_NAMESPACE
47
48namespace Qt3DAnimation {
49
50class QAnimationClip;
51class QChannelMapper;
52class QClock;
53class QAbstractClipAnimatorPrivate;
54
55class Q_3DANIMATIONSHARED_EXPORT QAbstractClipAnimator : public Qt3DCore::QComponent
56{
57 Q_OBJECT
58 Q_PROPERTY(bool running READ isRunning WRITE setRunning NOTIFY runningChanged)
59 Q_PROPERTY(int loops READ loopCount WRITE setLoopCount NOTIFY loopCountChanged)
60 Q_PROPERTY(Qt3DAnimation::QChannelMapper *channelMapper READ channelMapper WRITE setChannelMapper NOTIFY channelMapperChanged)
61 Q_PROPERTY(Qt3DAnimation::QClock *clock READ clock WRITE setClock NOTIFY clockChanged)
62 Q_PROPERTY(float normalizedTime READ normalizedTime WRITE setNormalizedTime NOTIFY normalizedTimeChanged)
63
64public:
65 enum Loops { Infinite = -1 };
66 Q_ENUM(Loops)
67
68 ~QAbstractClipAnimator();
69
70 bool isRunning() const;
71 Qt3DAnimation::QChannelMapper *channelMapper() const;
72 int loopCount() const;
73 Qt3DAnimation::QClock *clock() const;
74 float normalizedTime() const;
75
76public Q_SLOTS:
77 void setRunning(bool running);
78 void setChannelMapper(Qt3DAnimation::QChannelMapper *channelMapper);
79 void setLoopCount(int loops);
80 void setClock(Qt3DAnimation::QClock *clock);
81 void setNormalizedTime(float timeFraction);
82
83 void start();
84 void stop();
85
86Q_SIGNALS:
87 void runningChanged(bool running);
88 void channelMapperChanged(Qt3DAnimation::QChannelMapper *channelMapper);
89 void loopCountChanged(int loops);
90 void clockChanged(Qt3DAnimation::QClock *clock);
91 void normalizedTimeChanged(float index);
92
93protected:
94 explicit QAbstractClipAnimator(Qt3DCore::QNode *parent = nullptr);
95 QAbstractClipAnimator(QAbstractClipAnimatorPrivate &dd, Qt3DCore::QNode *parent = nullptr);
96
97 void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) override;
98
99private:
100 Q_DECLARE_PRIVATE(QAbstractClipAnimator)
101};
102
103} // namespace Qt3DAnimation
104
105QT_END_NAMESPACE
106
107#endif // QT3DANIMATION_QABSTRACTCLIPANIMATOR_H
108