summaryrefslogtreecommitdiffstats
path: root/src/runtime/dragon/dragonmapper_p.h
blob: 130c60c959ed505867be6bafe4d32156339dec62 (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
/****************************************************************************
**
** Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
** 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 DRAGONMAPPER_P_H
#define DRAGONMAPPER_P_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 <private/dragonbackendnode_p.h>
#include <private/dragonvaluecontainer_p.h>

QT_BEGIN_NAMESPACE

namespace Qt3DRender {
namespace Dragon {

template<typename T, typename U>
class MapperWrapper;

/*!
 * Simple wrapper which works around the fact that the frontend/arbiter expects a
 * pointer to a constant object, while we want the data to be stored in an immutable
 * or cow handle (the jury is still out on which to choose).
 * T should be derived from Dragon::BackendNode
 */
template <class Backend, class BackendTarget=Backend>
class NodeFunctor : public Qt3DCore::QBackendNodeMapper
{
public:
    NodeFunctor()
        : m_localNodes(new ValueContainer<Backend>())
        , m_nodes(m_localNodes.get())
    {}

    NodeFunctor(ValueContainer<Backend> *nodes)
        : m_nodes(nodes)
    {}

    // TODO constructors, one takes nothing, creates nodes - other takes existing list
    Qt3DCore::QBackendNode *create(const Qt3DCore::QNodeCreatedChangeBasePtr &change) const final;

    Qt3DCore::QBackendNode *get(Qt3DCore::QNodeId id) const final
    {
        return m_wrappers.value(id);
    }

    void destroy(Qt3DCore::QNodeId id) const final
    {
        auto &nodes = *m_nodes;
        // TODO consider use modified to show there's a copy
        nodes.remove(id);
        delete m_wrappers.take(id);
    }

    void initializeFromPeer(Qt3DCore::QNodeId id, const Qt3DCore::QNodeCreatedChangeBasePtr &change) const
    {
        auto &nodes = *m_nodes;

        // Using a std::move here because we are assigning to the same node.
        nodes[id] = std::move(nodes[id]).modified([&change](Backend *node){
            node->initializeFromPeer(change);
        });
    }

    void sceneChangeEvent(Qt3DCore::QNodeId id, const Qt3DCore::QSceneChangePtr &e) const
    {
        auto &nodes = *m_nodes;

        // Using a std::move here because we are assigning to the same node.
        nodes[id] = std::move(nodes[id]).modified([&e](Backend *element){
            element->sceneChangeEvent(e);
        });

        // TODO consider adding a method to replace an item in the container directly:
        //    nodes.modify(id, [](Backend *element){
        //        element->sceneChangeEvent(e);
        //    });
    }

    // Task interface
    ValueContainer<Backend> result()
    {
        return *m_nodes;
    }

    bool isFinished() const
    {
        return true;
    }

    // TODO a bit annoying that we need this to be run at the end of the frame
    void reset()
    {
        m_nodes->reset();
    }

private:

    // NOTE mutable only because QBackendNodeMapper has a const interface (not sure why this is)
    // TODO consider changing QBackendNodeMapper for this reason, or add a pointer in-between as hacky
    // workaround
    mutable QHash<Qt3DCore::QNodeId, MapperWrapper<Backend, BackendTarget> *> m_wrappers;
    // TODO consider storing ValueContainer<BackendNode> (need to verify polymorphism)
    mutable QScopedPointer<ValueContainer<Backend>> m_localNodes;
    mutable ValueContainer<Backend> *m_nodes;
};

template <typename T, typename U>
class MapperWrapper : public Qt3DCore::QBackendNode
{
public:
    MapperWrapper(const NodeFunctor<T, U> *manager)
        : Qt3DCore::QBackendNode()
        , m_manager(manager)
    {
    }

protected:
    void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &e) override
    {
        m_manager->sceneChangeEvent(peerId(), e);
    }

private:
    void initializeFromPeer(const Qt3DCore::QNodeCreatedChangeBasePtr &change) override
    {
        m_manager->initializeFromPeer(peerId(), change);
    }

    const NodeFunctor<T, U> *m_manager = nullptr;
};

// Note: Implementation needs to be here because we need the definition of MapperWrapper
template<class Backend, class BackendTarget>
Qt3DCore::QBackendNode *NodeFunctor<Backend, BackendTarget>::create(const Qt3DCore::QNodeCreatedChangeBasePtr &change) const
{
    auto peerId = change->subjectId();
    auto *wrapper = new MapperWrapper<Backend, BackendTarget>(this);
    m_wrappers[peerId] = wrapper;
    BackendTarget node;
    node.setPeerId(peerId);
    // TODO consider getting rid of this long-lived pointer
    node.setManager(m_nodes);
    m_nodes->insert(peerId, node);
    return wrapper;
}

template<typename T, typename U=T>
using NodeFunctorPtr = QSharedPointer<NodeFunctor<T, U>>;

} // namespace Dragon
} // namespace Qt3DRender

QT_END_NAMESPACE

#endif // DRAGONMAPPER_P_H