summaryrefslogtreecommitdiffstats
path: root/src/runtime/q3dscustommaterial_p.h
blob: 8c3cfbb9247d2df58a54ebd3fe991a2507e91e4e (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
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef Q3DSCUSTOMMATERIAL_P_H
#define Q3DSCUSTOMMATERIAL_P_H

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

#include <QtCore/QString>
#include <QtCore/QMap>
#include <Qt3DRender/QMaterial>

#include "q3dsabstractxmlparser_p.h"
#include "q3dsmaterial_p.h"

QT_BEGIN_NAMESPACE

namespace Qt3DRender {
class QShaderProgram;
}

class Q3DSV_PRIVATE_EXPORT Q3DSCustomMaterial
{
public:
    Q3DSCustomMaterial();

    QString name() const;
    QString description() const;

    bool isNull() const;

    const QMap<QString, Q3DSMaterial::PropertyElement> &properties() const;

    QString shaderType() const;
    QString shadersVersion() const;
    const QVector<Q3DSMaterial::Shader> &shaders() const;
    const QVector<Q3DSMaterial::Pass> &passes() const;
    const QHash<QString, Q3DSMaterial::Buffer> &buffers() const;

    bool isAlwaysDirty() const;

    int layerCount() const; // nothing to do with normal layers

    bool shaderIsDielectric() const;
    bool shaderIsSpecular() const;
    bool shaderIsGlossy() const;
    bool shaderIsCutoutEnabled() const;
    bool shaderHasRefraction() const;
    bool shaderHasTransparency() const;
    bool shaderIsDisplaced() const;
    bool shaderIsVolumetric() const;
    bool shaderIsTransmissive() const;

    QString emissiveMaskMapName() const;

    bool materialHasTransparency() const;
    bool materialHasRefraction() const;

private:
    // MaterialElement
    QString m_name;
    QString m_description;
    bool m_alwaysDirty;

    // MetaData
    QString m_author;
    QString m_created;
    QString m_modified;
    QMap<QString,Q3DSMaterial::PropertyElement> m_properties;

    //Shaders
    QString m_shaderType;
    QString m_shadersVersion;
    QVector<Q3DSMaterial::Shader> m_shaders;

    // Passes
    QVector<Q3DSMaterial::Pass> m_passes;
    QHash<QString, Q3DSMaterial::Buffer> m_buffers;
    int m_layerCount;
    // these two are set based on Blending and Buffer stuff, not related to the shader key
    bool m_hasTransparency;
    bool m_hasRefraction;
    // metadata for the shader generator
    enum ShaderKeyFlag {
        Diffuse = 1 << 0,
        Specular = 1 << 1,
        Glossy = 1 << 2,
        Cutout = 1 << 3,
        Refraction = 1 << 4,
        Transparent = 1 << 5,
        Displace = 1 << 6,
        Volumetric = 1 << 7,
        Transmissive = 1 << 8,
    };
    quint32 m_shaderKey;

    friend class Q3DSCustomMaterialParser;
};

Q_DECLARE_TYPEINFO(Q3DSCustomMaterial, Q_MOVABLE_TYPE);

class Q3DSV_PRIVATE_EXPORT Q3DSCustomMaterialParser : public Q3DSAbstractXmlParser
{
public:
    Q3DSCustomMaterial parse(const QString &filename, bool *ok = nullptr);

private:
    void parseMaterial();
    void parseMetaData();
    void parseShaders();
    void parseProperty();
    void parseShader();
    void parsePasses();
    void parsePass();
    void parseBuffer();

    bool isPropertyNameUnique(const QString &name);

    Q3DSCustomMaterial m_material;
};

QT_END_NAMESPACE

#endif // Q3DSCUSTOMMATERIAL_P_H