1/****************************************************************************
2**
3** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: http://www.qt-project.org/legal
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL3$
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 http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free
28** Software Foundation and appearing in the file LICENSE.GPL included in
29** the packaging of this file. Please review the following information to
30** ensure the GNU General Public License version 2.0 requirements will be
31** met: http://www.gnu.org/licenses/gpl-2.0.html.
32**
33** $QT_END_LICENSE$
34**
35****************************************************************************/
36
37#ifndef QT3DANIMATION_ANIMATION_CLIPANIMATOR_P_H
38#define QT3DANIMATION_ANIMATION_CLIPANIMATOR_P_H
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists for the convenience
45// of other Qt classes. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49//
50
51#include <Qt3DAnimation/private/backendnode_p.h>
52#include <Qt3DAnimation/private/animationutils_p.h>
53#include <Qt3DCore/qnodeid.h>
54
55QT_BEGIN_NAMESPACE
56
57namespace Qt3DAnimation {
58namespace Animation {
59
60struct Channel;
61class Handler;
62
63class Q_AUTOTEST_EXPORT ClipAnimator : public BackendNode
64{
65public:
66 ClipAnimator();
67
68 void cleanup();
69 void setClipId(Qt3DCore::QNodeId clipId);
70 Qt3DCore::QNodeId clipId() const { return m_clipId; }
71 void setMapperId(Qt3DCore::QNodeId mapperId);
72 Qt3DCore::QNodeId mapperId() const { return m_mapperId; }
73 void setClockId(Qt3DCore::QNodeId clockId);
74 Qt3DCore::QNodeId clockId() const { return m_clockId; }
75
76 void setRunning(bool running);
77 bool isRunning() const { return m_running; }
78 void setLoops(int loops) { m_loops = loops; }
79 int loops() const { return m_loops; }
80 void setNormalizedLocalTime(float normalizedLocalTime);
81 float normalizedLocalTime() const { return m_normalizedLocalTime; }
82
83 void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &e) override;
84 void setHandler(Handler *handler) { m_handler = handler; }
85
86 // Called by jobs
87 bool canRun() const { return !m_clipId.isNull() && !m_mapperId.isNull(); }
88 void setMappingData(const QVector<MappingData> &mappingData) { m_mappingData = mappingData; }
89 QVector<MappingData> mappingData() const { return m_mappingData; }
90
91 void setStartTime(qint64 globalTime) { m_lastGlobalTimeNS = globalTime; }
92
93 int currentLoop() const { return m_currentLoop; }
94 void setCurrentLoop(int currentLoop) { m_currentLoop = currentLoop; }
95
96 void sendPropertyChanges(const QVector<Qt3DCore::QSceneChangePtr> &changes);
97 void sendCallbacks(const QVector<AnimationCallbackAndValue> &callbacks);
98
99 void animationClipMarkedDirty() { setDirty(Handler::ClipAnimatorDirty); }
100
101 void setClipFormat(const ClipFormat &clipFormat) { m_clipFormat = clipFormat; }
102 ClipFormat clipFormat() const { return m_clipFormat; }
103
104 qint64 nsSincePreviousFrame(qint64 currentGlobalTimeNS);
105 void setLastGlobalTimeNS(qint64 lastGlobalTimeNS);
106
107 double lastLocalTime() const;
108 void setLastLocalTime(double lastLocalTime);
109
110 float lastNormalizedLocalTime() { return m_lastNormalizedLocalTime; }
111 void setLastNormalizedLocalTime(float normalizedLocalTime);
112 bool isSeeking() const
113 {
114 return isValidNormalizedTime(m_normalizedLocalTime)
115 && !qFuzzyCompare(m_lastNormalizedLocalTime, m_normalizedLocalTime);
116 }
117
118private:
119 void initializeFromPeer(const Qt3DCore::QNodeCreatedChangeBasePtr &change) final;
120
121 Qt3DCore::QNodeId m_clipId;
122 Qt3DCore::QNodeId m_mapperId;
123 Qt3DCore::QNodeId m_clockId;
124 bool m_running;
125 int m_loops;
126
127 // Working state
128 qint64 m_lastGlobalTimeNS;
129 double m_lastLocalTime;
130 QVector<MappingData> m_mappingData;
131
132 int m_currentLoop;
133 ClipFormat m_clipFormat;
134
135 float m_normalizedLocalTime;
136 float m_lastNormalizedLocalTime;
137};
138
139} // namespace Animation
140} // namespace Qt3DAnimation
141
142
143QT_END_NAMESPACE
144
145#endif // QT3DANIMATION_ANIMATION_CLIPANIMATOR_P_H
146