1/****************************************************************************
2**
3** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QT3DCORE_QCHANGEARBITER_P_H
41#define QT3DCORE_QCHANGEARBITER_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of other Qt classes. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <Qt3DCore/qnodeid.h>
55#include <Qt3DCore/qscenechange.h>
56#include <QtCore/QFlags>
57#include <QtCore/QMutex>
58#include <QtCore/QObject>
59#include <QtCore/QPair>
60#include <QtCore/QReadWriteLock>
61#include <QtCore/QThreadStorage>
62#include <QtCore/QVariant>
63#include <QtCore/QVector>
64
65#include <Qt3DCore/private/qlockableobserverinterface_p.h>
66#include <Qt3DCore/private/qt3dcore_global_p.h>
67
68QT_BEGIN_NAMESPACE
69
70namespace Qt3DCore {
71
72class QNode;
73class QObservableInterface;
74class QAbstractAspectJobManager;
75class QSceneObserverInterface;
76class QAbstractPostman;
77class QScene;
78
79
80class Q_3DCORE_PRIVATE_EXPORT QAbstractArbiter : public QLockableObserverInterface
81{
82public:
83 virtual QAbstractPostman *postman() const = 0;
84};
85
86class Q_3DCORE_PRIVATE_EXPORT QChangeArbiter final
87 : public QObject
88 , public QAbstractArbiter
89{
90 Q_OBJECT
91public:
92 explicit QChangeArbiter(QObject *parent = 0);
93 ~QChangeArbiter();
94
95 void initialize(Qt3DCore::QAbstractAspectJobManager *jobManager);
96
97 void syncChanges();
98
99 void registerObserver(QObserverInterface *observer,
100 QNodeId nodeId,
101 ChangeFlags changeFlags = AllChanges);
102 void unregisterObserver(QObserverInterface *observer,
103 QNodeId nodeId);
104
105 void registerSceneObserver(QSceneObserverInterface *observer);
106 void unregisterSceneObserver(QSceneObserverInterface *observer);
107
108 void sceneChangeEvent(const QSceneChangePtr &e) override; // QLockableObserverInterface impl
109 void sceneChangeEventWithLock(const QSceneChangePtr &e) override; // QLockableObserverInterface impl
110 void sceneChangeEventWithLock(const QSceneChangeList &e) override; // QLockableObserverInterface impl
111
112 Q_INVOKABLE void setPostman(Qt3DCore::QAbstractPostman *postman);
113 Q_INVOKABLE void setScene(Qt3DCore::QScene *scene);
114
115 QAbstractPostman *postman() const final;
116 QScene *scene() const;
117
118 static void createUnmanagedThreadLocalChangeQueue(void *changeArbiter);
119 static void destroyUnmanagedThreadLocalChangeQueue(void *changeArbiter);
120 static void createThreadLocalChangeQueue(void *changeArbiter);
121 static void destroyThreadLocalChangeQueue(void *changeArbiter);
122
123Q_SIGNALS:
124 void receivedChange();
125
126protected:
127 typedef std::vector<QSceneChangePtr> QChangeQueue;
128 typedef QPair<ChangeFlags, QObserverInterface *> QObserverPair;
129 typedef QVector<QObserverPair> QObserverList;
130
131 void distributeQueueChanges(QChangeQueue *queue);
132
133 QThreadStorage<QChangeQueue *> *tlsChangeQueue();
134 void appendChangeQueue(QChangeQueue *queue);
135 void removeChangeQueue(QChangeQueue *queue);
136 void appendLockingChangeQueue(QChangeQueue *queue);
137 void removeLockingChangeQueue(QChangeQueue *queue);
138
139private:
140 mutable QRecursiveMutex m_mutex;
141 QAbstractAspectJobManager *m_jobManager;
142
143 // The lists of observers indexed by observable (QNodeId).
144 // m_nodeObservations is for observables in the main thread's object tree
145 QHash<QNodeId, QObserverList> m_nodeObservations;
146 QList<QSceneObserverInterface *> m_sceneObservers;
147
148 // Each thread has a TLS ChangeQueue so we never need to lock whilst
149 // receiving a QSceneChange.
150 QThreadStorage<QChangeQueue *> m_tlsChangeQueue;
151
152 // We store a list of the ChangeQueue's from each thread. This will only
153 // be accessed from the aspect thread during the syncChanges() phase.
154 QList<QChangeQueue *> m_changeQueues;
155 QList<QChangeQueue *> m_lockingChangeQueues;
156 QAbstractPostman *m_postman;
157 QScene *m_scene;
158};
159
160} // namespace Qt3DCore
161
162QT_END_NAMESPACE
163
164#endif // QT3DCORE_QCHANGEARBITER_P_H
165