1/****************************************************************************
2**
3** Copyright (C) 2014 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 QT3DRENDER_QSCENELOADER_H
41#define QT3DRENDER_QSCENELOADER_H
42
43#include <Qt3DCore/qcomponent.h>
44#include <Qt3DCore/qscenechange.h>
45#include <Qt3DRender/qt3drender_global.h>
46#include <QtCore/QUrl>
47
48QT_BEGIN_NAMESPACE
49
50namespace Qt3DRender {
51
52class QSceneLoaderPrivate;
53
54class Q_3DRENDERSHARED_EXPORT QSceneLoader : public Qt3DCore::QComponent
55{
56 Q_OBJECT
57 Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
58 Q_PROPERTY(Status status READ status NOTIFY statusChanged)
59public:
60 explicit QSceneLoader(Qt3DCore::QNode *parent = nullptr);
61 ~QSceneLoader();
62
63 // TODO Unused remove in Qt6
64 void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) override;
65 enum Status {
66 None = 0,
67 Loading,
68 Ready,
69 Error
70 };
71 Q_ENUM(Status) // LCOV_EXCL_LINE
72
73 enum ComponentType {
74 UnknownComponent = 0,
75 GeometryRendererComponent,
76 TransformComponent,
77 MaterialComponent,
78 LightComponent,
79 CameraLensComponent
80 };
81 Q_ENUM(ComponentType)
82
83 QUrl source() const;
84 Status status() const;
85
86 Q_REVISION(9) Q_INVOKABLE Qt3DCore::QEntity *entity(const QString &entityName) const;
87 Q_REVISION(9) Q_INVOKABLE QStringList entityNames() const;
88 Q_REVISION(9) Q_INVOKABLE Qt3DCore::QComponent *component(const QString &entityName,
89 ComponentType componentType) const;
90
91public Q_SLOTS:
92 void setSource(const QUrl &arg);
93 QT_DEPRECATED void setStatus(Status status);
94
95Q_SIGNALS:
96 void sourceChanged(const QUrl &source);
97 void statusChanged(Status status);
98
99protected:
100 explicit QSceneLoader(QSceneLoaderPrivate &dd, Qt3DCore::QNode *parent = nullptr);
101
102private:
103 Q_DECLARE_PRIVATE(QSceneLoader)
104 Qt3DCore::QNodeCreatedChangeBasePtr createNodeCreationChange() const override;
105};
106
107} // namespace Qt3DRender
108
109QT_END_NAMESPACE
110
111#endif // QT3DRENDER_QSCENELOADER_H
112

source code of qt3d/src/render/io/qsceneloader.h