summaryrefslogtreecommitdiffstats
path: root/src/plugins/sceneparsers/gltf/gltfparser_p.h
blob: 5ce69ebc55115309aa728eb371bb4ec82f6116fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/****************************************************************************
**
** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
** Copyright (C) 2015 The Qt Company Ltd and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef GLTFPARSER_H
#define GLTFPARSER_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of other Qt classes.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtCore/QJsonDocument>
#include <QtCore/QMultiHash>

#include <Qt3DRender/qattribute.h>
#include <Qt3DRender/qbuffer.h>

#include <Qt3DRender/private/abstractsceneparser_p.h>

QT_BEGIN_NAMESPACE

class QFile;

namespace Qt3DCore {
class QCamera;
class QCameraLens;
class QEntity;
}

namespace Qt3DRender {

class QMaterial;
class QShaderProgram;
class QEffect;
class QAbstractTextureProvider;
class QRenderState;
class QTechnique;
class QParameter;
class QGeometryRenderer;

Q_DECLARE_LOGGING_CATEGORY(GLTFParserLog)

class GLTFParser : public AbstractSceneParser
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID "org.qt-project.Qt3DRenderer.GLTFParser")

public:
    GLTFParser();
    ~GLTFParser();

    void setBasePath(const QString& path);
    bool setJSON( const QJsonDocument &json );

    // SceneParserInterface interface
    void setSource(const QUrl &source) Q_DECL_FINAL;
    bool isExtensionSupported(const QUrl &source) const Q_DECL_FINAL;
    Qt3DCore::QEntity *node(const QString &id) Q_DECL_FINAL;
    Qt3DCore::QEntity *scene(const QString &id = QString()) Q_DECL_FINAL;

private:
    class BufferData
    {
    public:
        BufferData();

        BufferData(QJsonObject json);

        quint64 length;
        QString path;
        QByteArray *data;
        // type if ever useful
    };

    class ParameterData
    {
    public:
        ParameterData();
        ParameterData(QJsonObject json);

        QString semantic;
        int type;
    };

    class AccessorData
    {
    public:
        AccessorData();
        AccessorData(const QJsonObject& json);

        QString bufferViewName;
        QAttribute::DataType type;
        uint dataSize;
        int count;
        int offset;
        int stride;
    };

    static bool isGLTFPath(const QString &path);
    static void renameFromJson(const QJsonObject& json, QObject * const object );
    static QString standardUniformNamefromSemantic(const QString &semantic);
    static QString standardAttributeNameFromSemantic(const QString &semantic);
    static QParameter *parameterFromTechnique(QTechnique *technique, const QString &parameterName);

    Qt3DCore::QEntity *defaultScene();
    QMaterial *material(const QString &id);
    Qt3DCore::QCameraLens *camera(const QString &id) const;

    void parse();
    void cleanup();

    void processJSONBuffer(const QString &id, const QJsonObject &json);
    void processJSONBufferView(const QString &id, const QJsonObject &json);
    void processJSONShader(const QString &id, const QJsonObject &jsonObject);
    void processJSONProgram(const QString &id, const QJsonObject &jsonObject);
    void processJSONTechnique(const QString &id, const QJsonObject &jsonObject);
    void processJSONAccessor(const QString &id, const QJsonObject &json);
    void processJSONMesh(const QString &id, const QJsonObject &json);
    void processJSONImage(const QString &id, const QJsonObject &jsonObject);
    void processJSONTexture(const QString &id, const QJsonObject &jsonObject);

    void loadBufferData();
    void unloadBufferData();

    QFile* resolveLocalData(QString path) const;

    QVariant parameterValueFromJSON(int type, const QJsonValue &value) const;
    static Qt3DCore::QAbstractAttribute::DataType accessorTypeFromJSON(int componentType);
    static uint accessorDataSizeFromJson(const QString &type);

    static QRenderState *buildStateEnable(int state);
    static QRenderState *buildState(const QString& functionName, const QJsonValue &value, int &type);

    QJsonDocument m_json;
    QString m_basePath;
    bool m_parseDone;
    QString m_defaultScene;

    // multi-hash because our QMeshData corresponds to a single primitive
    // in glTf.
    QMultiHash<QString, QGeometryRenderer*> m_meshDict;

    // GLTF assigns materials at the mesh level, but we do them as siblings,
    // so record the association here for when we instantiate meshes
    QMap<QGeometryRenderer*, QString> m_meshMaterialDict;

    QMap<QString, AccessorData> m_accessorDict;

    QMap<QString, QMaterial*> m_materialCache;

    QMap<QString, BufferData> m_bufferDatas;
    QMap<QString, QBuffer*> m_buffers;

    QMap<QString, QString> m_shaderPaths;
    QMap<QString, QShaderProgram*> m_programs;

    QMap<QString, QTechnique *> m_techniques;
    QMap<QParameter*, ParameterData> m_parameterDataDict;

    QMap<QString, QAbstractTextureProvider*> m_textures;
    QMap<QString, QString> m_imagePaths;
};

} // namespace Qt3DRender

QT_END_NAMESPACE

#endif // GLTFPARSER_H