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
|
/****************************************************************************
**
** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 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.LGPL3 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-3.0.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 (at your option) the GNU General
** Public license version 3 or 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.GPL2 and 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QT3DCORE_QCHANGEARBITER_P_H
#define QT3DCORE_QCHANGEARBITER_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 <Qt3DCore/qnodeid.h>
#include <Qt3DCore/qscenechange.h>
#include <QtCore/QFlags>
#include <QtCore/QMutex>
#include <QtCore/QObject>
#include <QtCore/QPair>
#include <QtCore/QReadWriteLock>
#include <QtCore/QThreadStorage>
#include <QtCore/QVariant>
#include <QtCore/QVector>
#include <Qt3DCore/private/qlockableobserverinterface_p.h>
#include <Qt3DCore/private/qt3dcore_global_p.h>
#include <Qt3DCore/private/qscenechange_p.h>
QT_BEGIN_NAMESPACE
namespace Qt3DCore {
class QNode;
class QObservableInterface;
class QAbstractAspectJobManager;
class QSceneObserverInterface;
class QAbstractPostman;
class QScene;
class Q_3DCORE_PRIVATE_EXPORT QAbstractArbiter : public QLockableObserverInterface
{
public:
virtual QAbstractPostman *postman() const = 0;
virtual void addDirtyFrontEndNode(QNode *node) = 0;
virtual void removeDirtyFrontEndNode(QNode *node) = 0;
virtual void addDirtyFrontEndNode(QNode *node, QNode *subNode, const char *property, ChangeFlag change) = 0;
};
class Q_3DCORE_PRIVATE_EXPORT QChangeArbiter final
: public QObject
, public QAbstractArbiter
{
Q_OBJECT
public:
explicit QChangeArbiter(QObject *parent = nullptr);
~QChangeArbiter();
void initialize(Qt3DCore::QAbstractAspectJobManager *jobManager);
void syncChanges();
void registerObserver(QObserverInterface *observer,
QNodeId nodeId,
ChangeFlags changeFlags = AllChanges);
void unregisterObserver(QObserverInterface *observer,
QNodeId nodeId);
void sceneChangeEvent(const QSceneChangePtr &e) override; // QLockableObserverInterface impl
void sceneChangeEventWithLock(const QSceneChangePtr &e) override; // QLockableObserverInterface impl
void sceneChangeEventWithLock(const QSceneChangeList &e) override; // QLockableObserverInterface impl
void addDirtyFrontEndNode(QNode *node) override;
void addDirtyFrontEndNode(QNode *node, QNode *subNode, const char *property, ChangeFlag change) override;
void removeDirtyFrontEndNode(QNode *node) override;
QVector<QNode *> takeDirtyFrontEndNodes();
QVector<NodeRelationshipChange> takeDirtyFrontEndSubNodes();
void setPostman(Qt3DCore::QAbstractPostman *postman);
void setScene(Qt3DCore::QScene *scene);
QAbstractPostman *postman() const final;
QScene *scene() const;
static void createUnmanagedThreadLocalChangeQueue(void *changeArbiter);
static void destroyUnmanagedThreadLocalChangeQueue(void *changeArbiter);
static void createThreadLocalChangeQueue(void *changeArbiter);
static void destroyThreadLocalChangeQueue(void *changeArbiter);
Q_SIGNALS:
void receivedChange();
protected:
typedef std::vector<QSceneChangePtr> QChangeQueue;
typedef QPair<ChangeFlags, QObserverInterface *> QObserverPair;
typedef QVector<QObserverPair> QObserverList;
void distributeQueueChanges(QChangeQueue *queue);
QThreadStorage<QChangeQueue *> *tlsChangeQueue();
void appendChangeQueue(QChangeQueue *queue);
void removeChangeQueue(QChangeQueue *queue);
void appendLockingChangeQueue(QChangeQueue *queue);
void removeLockingChangeQueue(QChangeQueue *queue);
private:
mutable QRecursiveMutex m_mutex;
QAbstractAspectJobManager *m_jobManager;
// The lists of observers indexed by observable (QNodeId).
// m_nodeObservations is for observables in the main thread's object tree
QHash<QNodeId, QObserverList> m_nodeObservations;
// Each thread has a TLS ChangeQueue so we never need to lock whilst
// receiving a QSceneChange.
QThreadStorage<QChangeQueue *> m_tlsChangeQueue;
// We store a list of the ChangeQueue's from each thread. This will only
// be accessed from the aspect thread during the syncChanges() phase.
QList<QChangeQueue *> m_changeQueues;
QList<QChangeQueue *> m_lockingChangeQueues;
QAbstractPostman *m_postman;
QScene *m_scene;
QVector<QNode *> m_dirtyFrontEndNodes;
QVector<NodeRelationshipChange> m_dirtySubNodeChanges;
};
} // namespace Qt3DCore
QT_END_NAMESPACE
#endif // QT3DCORE_QCHANGEARBITER_P_H
|
