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_QSCENE_IMPORTER_P_H
41#define QT3DRENDER_QSCENE_IMPORTER_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QObject>
55#include <QStringList>
56#include <QLoggingCategory>
57#include <QUrl>
58#include <private/qt3drender_global_p.h>
59
60QT_BEGIN_NAMESPACE
61
62namespace Qt3DCore {
63class QEntity;
64}
65
66namespace Qt3DRender {
67
68Q_DECLARE_LOGGING_CATEGORY(SceneParsers)
69
70class Q_3DRENDERSHARED_PRIVATE_EXPORT QSceneImporter : public QObject
71{
72 Q_OBJECT
73 Q_PROPERTY(ParserStatus status READ status NOTIFY statusChanged)
74 Q_PROPERTY(QStringList errors READ errors NOTIFY errorsChanged)
75
76public:
77 enum ParserStatus {
78 Empty,
79 Loading,
80 Loaded,
81 Error
82 };
83 Q_ENUM(ParserStatus) // LCOV_EXCL_LINE
84
85 QSceneImporter();
86 virtual ~QSceneImporter();
87
88 virtual void setSource(const QUrl &source) = 0;
89 virtual void setData(const QByteArray& data, const QString &basePath) = 0;
90 virtual bool areFileTypesSupported(const QStringList &extensions) const = 0;
91 virtual Qt3DCore::QEntity *scene(const QString &id = QString()) = 0;
92 virtual Qt3DCore::QEntity *node(const QString &id) = 0;
93
94 ParserStatus status() const;
95 QStringList errors() const;
96
97Q_SIGNALS:
98 void statusChanged(ParserStatus status);
99 void errorsChanged(const QStringList &errors);
100
101protected:
102 void setStatus(ParserStatus status);
103 void logError(const QString &error);
104 void logInfo(const QString &info);
105
106private:
107 ParserStatus m_status;
108 QStringList m_errors;
109};
110
111} // namespace Qt3DRender
112
113QT_END_NAMESPACE
114
115#endif // QT3DRENDER_QSCENE_IMPORTER_P_H
116