1/****************************************************************************
2**
3** Copyright (C) 2017 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 QT3DCORE_QSKELETONLOADER_H
41#define QT3DCORE_QSKELETONLOADER_H
42
43#include <Qt3DCore/qabstractskeleton.h>
44#include <Qt3DCore/qt3dcore_global.h>
45#include <QtCore/qurl.h>
46
47QT_BEGIN_NAMESPACE
48
49namespace Qt3DCore {
50
51class QJoint;
52class QSkeletonLoaderPrivate;
53
54class Q_3DCORESHARED_EXPORT QSkeletonLoader : public QAbstractSkeleton
55{
56 Q_OBJECT
57 Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
58 Q_PROPERTY(Status status READ status NOTIFY statusChanged)
59 Q_PROPERTY(bool createJointsEnabled READ isCreateJointsEnabled WRITE setCreateJointsEnabled NOTIFY createJointsEnabledChanged)
60 Q_PROPERTY(Qt3DCore::QJoint* rootJoint READ rootJoint NOTIFY rootJointChanged)
61
62public:
63 explicit QSkeletonLoader(Qt3DCore::QNode *parent = nullptr);
64 explicit QSkeletonLoader(const QUrl &source,
65 Qt3DCore::QNode *parent = nullptr);
66 ~QSkeletonLoader();
67
68 enum Status {
69 NotReady = 0,
70 Ready,
71 Error
72 };
73 Q_ENUM(Status) // LCOV_EXCL_LINE
74
75 QUrl source() const;
76 Status status() const;
77 bool isCreateJointsEnabled() const;
78 Qt3DCore::QJoint* rootJoint() const;
79
80public Q_SLOTS:
81 void setSource(const QUrl &source);
82 void setCreateJointsEnabled(bool enabled);
83
84Q_SIGNALS:
85 void sourceChanged(const QUrl &source);
86 void statusChanged(Status status);
87 void createJointsEnabledChanged(bool createJointsEnabled);
88 void rootJointChanged(Qt3DCore::QJoint* rootJoint);
89
90protected:
91 explicit QSkeletonLoader(QSkeletonLoaderPrivate &dd, Qt3DCore::QNode *parent = nullptr);
92 void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) override;
93
94private:
95 Q_DECLARE_PRIVATE(QSkeletonLoader)
96 QNodeCreatedChangeBasePtr createNodeCreationChange() const override;
97 void setRootJoint(QJoint *rootJoint); // Needed for lifetime management of created joints
98};
99
100} // namespace Qt3DCore
101
102QT_END_NAMESPACE
103
104#endif // QT3DCORE_QSKELETONLOADER_H
105