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_QSCENE_P_H
41#define QT3DCORE_QSCENE_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 <QtCore/QScopedPointer>
55
56#include <Qt3DCore/qnode.h>
57#include <QtCore/qscopedpointer.h>
58#include <Qt3DCore/private/qobservableinterface_p.h>
59#include <Qt3DCore/private/qt3dcore_global_p.h>
60
61QT_BEGIN_NAMESPACE
62
63namespace Qt3DCore {
64
65class QScenePrivate;
66class QAspectEngine;
67class NodePostConstructorInit;
68class QAbstractArbiter;
69
70typedef QList<QObservableInterface *> QObservableList;
71
72class Q_3DCORE_PRIVATE_EXPORT QScene
73{
74public:
75 QScene(QAspectEngine *engine = nullptr);
76 ~QScene();
77
78 QAspectEngine *engine() const;
79
80 void addObservable(QObservableInterface *observable, QNodeId id);
81 void addObservable(QNode *observable);
82 void removeObservable(QObservableInterface *observable, QNodeId id);
83 void removeObservable(QNode *observable);
84 QObservableList lookupObservables(QNodeId id) const;
85
86 QNode *lookupNode(QNodeId id) const;
87 QVector<QNode *> lookupNodes(const QVector<QNodeId> &ids) const;
88 QNodeId nodeIdFromObservable(QObservableInterface *observable) const;
89
90 QNode *rootNode() const;
91
92 void setArbiter(QAbstractArbiter *arbiter);
93 QAbstractArbiter *arbiter() const;
94
95 // Component -> Entities
96 QVector<QNodeId> entitiesForComponent(QNodeId id) const;
97 void addEntityForComponent(QNodeId componentUuid, QNodeId entityUuid);
98 void removeEntityForComponent(QNodeId componentUuid, QNodeId entityUuid);
99 bool hasEntityForComponent(QNodeId componentUuid, QNodeId entityUuid);
100
101 // Node -> Property Update Data
102 struct NodePropertyTrackData
103 {
104 QNode::PropertyTrackingMode defaultTrackMode = QNode::TrackFinalValues;
105 QHash<QString, QNode::PropertyTrackingMode> trackedPropertiesOverrides;
106 };
107 NodePropertyTrackData lookupNodePropertyTrackData(QNodeId id) const;
108 void setPropertyTrackDataForNode(QNodeId id, const NodePropertyTrackData &data);
109 void removePropertyTrackDataForNode(QNodeId id);
110
111 NodePostConstructorInit* postConstructorInit() const;
112
113private:
114 Q_DECLARE_PRIVATE(QScene)
115 QScopedPointer<QScenePrivate> d_ptr;
116
117 void setRootNode(QNode *root);
118 friend class QAspectEnginePrivate;
119};
120
121} // Qt3D
122
123QT_END_NAMESPACE
124
125Q_DECLARE_METATYPE(Qt3DCore::QScene*) // LCOV_EXCL_LINE
126
127#endif // QT3DCORE_QSCENE_P_H
128

source code of qt3d/src/core/qscene_p.h