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_QASPECTMANAGER_P_H
41#define QT3DCORE_QASPECTMANAGER_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/qnodecreatedchange.h>
55#include <Qt3DCore/qaspectengine.h>
56#include <QtCore/QObject>
57#include <QtCore/QScopedPointer>
58#include <QtCore/QSemaphore>
59#include <QtCore/QVariant>
60#include <QtCore/QVector>
61
62#include <Qt3DCore/private/qt3dcore_global_p.h>
63
64QT_BEGIN_NAMESPACE
65
66class QSurface;
67
68namespace Qt3DCore {
69
70class QNode;
71class QEntity;
72class QScheduler;
73class QChangeArbiter;
74class QAbstractAspect;
75class QAbstractAspectJobManager;
76class QAspectEngine;
77class QServiceLocator;
78class NodePostConstructorInit;
79struct NodeTreeChange;
80#if QT_CONFIG(animation)
81class RequestFrameAnimation;
82#endif
83
84class Q_3DCORE_PRIVATE_EXPORT QAspectManager : public QObject
85{
86 Q_OBJECT
87public:
88 explicit QAspectManager(QAspectEngine *parent = nullptr);
89 ~QAspectManager();
90
91 void setRunMode(QAspectEngine::RunMode mode);
92 void enterSimulationLoop();
93 void exitSimulationLoop();
94
95 bool isShuttingDown() const;
96
97public Q_SLOTS:
98 void initialize();
99 void shutdown();
100 void processFrame();
101
102 void setRootEntity(Qt3DCore::QEntity *root, const QVector<QNode *> &nodes);
103 void addNodes(const QVector<QNode *> &nodes);
104 void removeNodes(const QVector<QNode *> &nodes);
105 void registerAspect(Qt3DCore::QAbstractAspect *aspect);
106 void unregisterAspect(Qt3DCore::QAbstractAspect *aspect);
107
108public:
109 const QVector<QAbstractAspect *> &aspects() const;
110 QAbstractAspectJobManager *jobManager() const;
111 QChangeArbiter *changeArbiter() const;
112 QServiceLocator *serviceLocator() const;
113 void setPostConstructorInit(NodePostConstructorInit *postConstructorInit);
114
115 QNode *lookupNode(QNodeId id) const;
116 QVector<QNode *> lookupNodes(const QVector<QNodeId> &ids) const;
117
118 int jobsInLastFrame() const { return m_jobsInLastFrame; }
119 void dumpJobsOnNextFrame();
120
121private:
122#if !QT_CONFIG(animation)
123 bool event(QEvent *event) override;
124#endif
125 void requestNextFrame();
126
127 QAspectEngine *m_engine;
128 QVector<QAbstractAspect *> m_aspects;
129 QEntity *m_root;
130 QVariantMap m_data;
131 QScheduler *m_scheduler;
132 QAbstractAspectJobManager *m_jobManager;
133 QChangeArbiter *m_changeArbiter;
134 QScopedPointer<QServiceLocator> m_serviceLocator;
135 bool m_simulationLoopRunning;
136 QAspectEngine::RunMode m_driveMode;
137 QVector<NodeTreeChange> m_nodeTreeChanges;
138 NodePostConstructorInit* m_postConstructorInit;
139
140#if QT_CONFIG(animation)
141 RequestFrameAnimation *m_simulationAnimation;
142#endif
143 int m_jobsInLastFrame;
144 bool m_dumpJobs;
145};
146
147} // namespace Qt3DCore
148
149QT_END_NAMESPACE
150
151#endif // QT3DCORE_QASPECTMANAGER_P_H
152

source code of qt3d/src/core/aspects/qaspectmanager_p.h