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