summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Studio/Render/Q3DSGraphObjectTranslator.h
blob: efffa03915714a21534fce24069fb9844d1b661c (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
209
210
211
212
213
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** 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 Q3DS_GRAPH_OBJECT_TRANSLATOR_H
#define Q3DS_GRAPH_OBJECT_TRANSLATOR_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 "q3dsruntime2api_p.h"
#include "Qt3DSDMMetaData.h"

/* This class replace SGraphObjectTranslator */

namespace Q3DStudio {

class Q3DSTranslation;

class Q3DSGraphObjectTranslator
{
public:
    Q3DSGraphObjectTranslator(qt3dsdm::Qt3DSDMInstanceHandle inInstance, Q3DSGraphObject &inObj);

    virtual ~Q3DSGraphObjectTranslator();

    virtual void pushTranslation(Q3DSTranslation &inTranslatorContext);
    virtual void setActive(bool inActive) = 0;
    virtual void clearChildren() = 0;
    virtual void appendChild(Q3DSGraphObject &inChild) = 0;
    virtual void resetEffect() {}
    virtual Q3DSGraphObject &graphObject() { return *m_graphObject; }
    virtual Q3DSGraphObject &nonAliasedGraphObject() { return *m_graphObject; }
    virtual qt3dsdm::Qt3DSDMInstanceHandle instanceHandle() { return m_instanceHandle; }
    virtual qt3dsdm::Qt3DSDMInstanceHandle sceneGraphInstanceHandle()
    {
        return m_instanceHandle;
    }
    virtual qt3dsdm::Qt3DSDMInstanceHandle possiblyAliasedInstanceHandle()
    {
        if (m_aliasInstanceHandle.Valid())
            return m_aliasInstanceHandle;
        return instanceHandle();
    }
    virtual void copyProperties(Q3DSGraphObject *target, bool ignoreReferenced);
    void enableAutoUpdates(bool enable)
    {
        m_autoUpdate = enable;
    }
    bool isAutoUpdateEnabled() const
    {
        return m_autoUpdate;
    }
    quint32 dirtyIndex() const
    {
        return m_dirtyIndex;
    }
    void setDirtyIndex(quint32 index)
    {
        m_dirtyIndex = index;
    }
    void setAliasInstanceHandle(qt3dsdm::Qt3DSDMInstanceHandle a)
    {
        m_aliasInstanceHandle = a;
    }
    qt3dsdm::Qt3DSDMInstanceHandle aliasInstanceHandle() const
    {
        return m_aliasInstanceHandle;
    }
    virtual bool updateProperty(Q3DSTranslation &inContext,
                                qt3dsdm::Qt3DSDMInstanceHandle instance,
                                qt3dsdm::Qt3DSDMPropertyHandle property,
                                qt3dsdm::SValue &value,
                                const QString &name);
    bool dirty() const
    {
        return m_dirty;
    }
    void setDirty(bool dirty)
    {
        m_dirty = dirty;
    }

    static Q3DSGraphObjectTranslator *translatorForObject(Q3DSGraphObject *object);

    template <typename T>
    T *graphObject() const
    {
        return static_cast<T *>(m_graphObject);
    }

    void pushTranslationIfDirty(Q3DSTranslation &inTranslatorContext)
    {
        if (m_dirty)
            pushTranslation(inTranslatorContext);
    }

    bool isMaterial(const Q3DSGraphObject &inChild) const
    {
        if (inChild.type() == Q3DSGraphObject::ReferencedMaterial
                || inChild.type() == Q3DSGraphObject::DefaultMaterial
                || inChild.type() == Q3DSGraphObject::CustomMaterial) {
            return true;
        }
        return false;
    }

    virtual bool shaderRequiresRecompilation(Q3DSTranslation &inContext,
                                             const qt3dsdm::SValue &value,
                                             const QString &name,
                                             qt3dsdm::AdditionalMetaDataType::Value type)
    {
        Q_UNUSED(inContext);
        Q_UNUSED(value);
        Q_UNUSED(name);
        Q_UNUSED(type);
        return false;
    }

    void setGraphObject(Q3DSGraphObject *object)
    {
        if (object != m_graphObject) {
            if (m_graphObject)
                s_translatorMap.remove(object);
            m_graphObject = object;
            s_translatorMap.insert(object, this);
        }
    }

    Q3DSGraphObjectTranslator *parent() const;
    virtual void releaseGraphObjectsRecursive(Q3DSTranslation &inContext);

private:

    // This will never be null.  The reason it is a pointer is because
    // alias translators need to switch which graph object they point to
    Q3DSGraphObject *m_graphObject;
    qt3dsdm::Qt3DSDMInstanceHandle m_instanceHandle;
    qt3dsdm::Qt3DSDMInstanceHandle m_aliasInstanceHandle;

    bool m_dirty = true;
    bool m_autoUpdate = true;
    bool m_ignoreReferenced = false;
    quint32 m_dirtyIndex;
    static QMap<Q3DSGraphObject *, Q3DSGraphObjectTranslator *> s_translatorMap;
};

class Q3DSAliasedTranslator : public Q3DSGraphObjectTranslator
{
public:
    Q3DSAliasedTranslator(Q3DSGraphObjectTranslator *aliasTranslator,
                          qt3dsdm::Qt3DSDMInstanceHandle inInstance, Q3DSGraphObject &inObj)
        : Q3DSGraphObjectTranslator(inInstance, inObj), m_aliasTranslator(aliasTranslator)
    {
        setAliasInstanceHandle(m_aliasTranslator->instanceHandle());
    }

    Q3DSGraphObjectTranslator *aliasTranslator() const
    {
        return m_aliasTranslator;
    }

    void setActive(bool) override
    {
    }
    void clearChildren() override
    {
    }
    void appendChild(Q3DSGraphObject &) override
    {
    }

    void pushTranslation(Q3DSTranslation &inTranslatorContext) override;

private:
    Q3DSGraphObjectTranslator *m_aliasTranslator = nullptr;
};

}

#endif