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_ANIMATIONCLIP_P_H
38#define QT3DANIMATION_ANIMATION_ANIMATIONCLIP_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/qanimationclipdata.h>
53#include <Qt3DAnimation/qanimationcliploader.h>
54#include <Qt3DAnimation/private/fcurve_p.h>
55#include <QtCore/qurl.h>
56#include <QtCore/qmutex.h>
57
58QT_BEGIN_NAMESPACE
59
60namespace Qt3DAnimation {
61namespace Animation {
62
63class Handler;
64
65class Q_AUTOTEST_EXPORT AnimationClip : public BackendNode
66{
67public:
68 AnimationClip();
69
70 void cleanup();
71 void setSource(const QUrl &source) { m_source = source; }
72 QUrl source() const { return m_source; }
73 void setStatus(QAnimationClipLoader::Status status);
74 QAnimationClipLoader::Status status() const { return m_status; }
75 void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &e) override;
76
77 void addDependingClipAnimator(const Qt3DCore::QNodeId &id);
78 void addDependingBlendedClipAnimator(const Qt3DCore::QNodeId &id);
79
80 QString name() const { return m_name; }
81 const QVector<Channel> &channels() const { return m_channels; }
82
83 // Called from jobs
84 void loadAnimation();
85 void setDuration(float duration);
86 float duration() const { return m_duration; }
87 int channelIndex(const QString &channelName, int jointIndex) const;
88 int channelCount() const { return m_channelComponentCount; }
89 int channelComponentBaseIndex(int channelGroupIndex) const;
90
91 // Allow unit tests to set the data type
92#if !defined(QT_BUILD_INTERNAL)
93private:
94#endif
95 enum ClipDataType {
96 Unknown,
97 File,
98 Data
99 };
100#if defined(QT_BUILD_INTERNAL)
101public:
102 void setDataType(ClipDataType dataType) { m_dataType = dataType; }
103#endif
104
105private:
106 void initializeFromPeer(const Qt3DCore::QNodeCreatedChangeBasePtr &change) final;
107 void loadAnimationFromUrl();
108 void loadAnimationFromData();
109 void clearData();
110 float findDuration();
111 int findChannelComponentCount();
112
113 QMutex m_mutex;
114
115 QUrl m_source;
116 QAnimationClipLoader::Status m_status;
117 QAnimationClipData m_clipData;
118 ClipDataType m_dataType;
119
120 QString m_name;
121 QVector<Channel> m_channels;
122 float m_duration;
123 int m_channelComponentCount;
124
125 Qt3DCore::QNodeIdVector m_dependingAnimators;
126 Qt3DCore::QNodeIdVector m_dependingBlendedAnimators;
127};
128
129#ifndef QT_NO_DEBUG_STREAM
130inline QDebug operator<<(QDebug dbg, const AnimationClip &animationClip)
131{
132 QDebugStateSaver saver(dbg);
133 dbg << "QNodeId =" << animationClip.peerId() << endl
134 << "Name =" << animationClip.name() << endl
135 << "Duration: " << animationClip.duration() << endl
136 << "Channels:" << endl;
137
138 const QVector<Channel> channels = animationClip.channels();
139 for (const auto &channel : channels) {
140 dbg << channel;
141 }
142
143 return dbg;
144}
145#endif
146
147} // namespace Animation
148} // namespace Qt3DAnimation
149
150
151QT_END_NAMESPACE
152
153#endif // QT3DANIMATION_ANIMATION_ANIMATIONCLIP_P_H
154