1// Copyright (C) 2019 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
3
4#ifndef QSSGVIEW3D_H
5#define QSSGVIEW3D_H
6
7//
8// W A R N I N G
9// -------------
10//
11// This file is not part of the Qt API. It exists purely as an
12// implementation detail. This header file may change from version to
13// version without notice, or even be removed.
14//
15// We mean it.
16//
17
18#include <QtQuick/QQuickItem>
19#include <QtCore/qurl.h>
20
21#include <QtQuick3D/qtquick3dglobal.h>
22#include <QtQuick3D/private/qquick3dpickresult_p.h>
23#if QT_CONFIG(quick_shadereffect)
24#include <QtQuick/private/qquickshadereffectsource_p.h>
25#endif
26
27#include <QtQuick3DRuntimeRender/private/qssgrenderpickresult_p.h>
28
29#include "qquick3dsceneenvironment_p.h"
30#include "qquick3drenderstats_p.h"
31#include "qquick3dlightmapbaker_p.h"
32
33QT_BEGIN_NAMESPACE
34
35class QSSGView3DPrivate;
36class QQuick3DCamera;
37class QQuick3DSceneEnvironment;
38class QQuick3DNode;
39class QQuick3DSceneRootNode;
40class QQuick3DSceneRenderer;
41class QQuick3DRenderStats;
42class QQuick3DSceneManager;
43
44class SGFramebufferObjectNode;
45class QQuick3DSGRenderNode;
46class QQuick3DSGDirectRenderer;
47
48class Q_QUICK3D_EXPORT QQuick3DViewport : public QQuickItem
49{
50 Q_OBJECT
51 Q_PROPERTY(QQmlListProperty<QObject> data READ data DESIGNABLE false FINAL)
52 Q_PROPERTY(QQuick3DCamera *camera READ camera WRITE setCamera NOTIFY cameraChanged FINAL)
53 Q_PROPERTY(QQuick3DSceneEnvironment *environment READ environment WRITE setEnvironment NOTIFY environmentChanged FINAL)
54 Q_PROPERTY(QQuick3DNode *scene READ scene NOTIFY sceneChanged)
55 Q_PROPERTY(QQuick3DNode *importScene READ importScene WRITE setImportScene NOTIFY importSceneChanged FINAL)
56 Q_PROPERTY(RenderMode renderMode READ renderMode WRITE setRenderMode NOTIFY renderModeChanged FINAL)
57#if QT_CONFIG(quick_shadereffect)
58 Q_PROPERTY(QQuickShaderEffectSource::Format renderFormat READ renderFormat WRITE setRenderFormat NOTIFY renderFormatChanged FINAL REVISION(6, 4))
59#endif
60 Q_PROPERTY(QQuick3DRenderStats *renderStats READ renderStats CONSTANT)
61 Q_PROPERTY(QQmlListProperty<QQuick3DObject> extensions READ extensions FINAL REVISION(6, 6))
62 Q_PROPERTY(int explicitTextureWidth READ explicitTextureWidth WRITE setExplicitTextureWidth NOTIFY explicitTextureWidthChanged FINAL REVISION(6, 7))
63 Q_PROPERTY(int explicitTextureHeight READ explicitTextureHeight WRITE setExplicitTextureHeight NOTIFY explicitTextureHeightChanged FINAL REVISION(6, 7))
64 Q_PROPERTY(QSize effectiveTextureSize READ effectiveTextureSize NOTIFY effectiveTextureSizeChanged FINAL REVISION(6, 7))
65 Q_CLASSINFO("DefaultProperty", "data")
66
67 QML_NAMED_ELEMENT(View3D)
68
69public:
70 enum RenderMode {
71 Offscreen,
72 Underlay,
73 Overlay,
74 Inline
75 };
76 Q_ENUM(RenderMode)
77
78 explicit QQuick3DViewport(QQuickItem *parent = nullptr);
79 ~QQuick3DViewport() override;
80
81 QQmlListProperty<QObject> data();
82
83 QQuick3DCamera *camera() const;
84 QQuick3DSceneEnvironment *environment() const;
85 QQuick3DNode *scene() const;
86 QQuick3DNode *importScene() const;
87 RenderMode renderMode() const;
88#if QT_CONFIG(quick_shadereffect)
89 Q_REVISION(6, 4) QQuickShaderEffectSource::Format renderFormat() const;
90#endif
91 QQuick3DRenderStats *renderStats() const;
92
93 QQuick3DSceneRenderer *createRenderer() const;
94
95 bool isTextureProvider() const override;
96 QSGTextureProvider *textureProvider() const override;
97 void releaseResources() override;
98
99 Q_INVOKABLE QVector3D mapFrom3DScene(const QVector3D &scenePos) const;
100 Q_INVOKABLE QVector3D mapTo3DScene(const QVector3D &viewPos) const;
101
102 Q_INVOKABLE QQuick3DPickResult pick(float x, float y) const;
103 Q_REVISION(6, 8) Q_INVOKABLE QQuick3DPickResult pick(float x, float y, QQuick3DModel *model) const;
104 Q_REVISION(6, 8) Q_INVOKABLE QList<QQuick3DPickResult> pickSubset(float x, float y, const QJSValue &models) const;
105 Q_REVISION(6, 2) Q_INVOKABLE QList<QQuick3DPickResult> pickAll(float x, float y) const;
106 Q_REVISION(6, 2) Q_INVOKABLE QQuick3DPickResult rayPick(const QVector3D &origin, const QVector3D &direction) const;
107 Q_REVISION(6, 2) Q_INVOKABLE QList<QQuick3DPickResult> rayPickAll(const QVector3D &origin, const QVector3D &direction) const;
108
109 void processPointerEventFromRay(const QVector3D &origin, const QVector3D &direction, QPointerEvent *event) const;
110 bool singlePointPick(QSinglePointEvent *event, const QVector3D &origin, const QVector3D &direction);
111
112 Q_REVISION(6, 8) Q_INVOKABLE void setTouchpoint(QQuickItem *target, const QPointF &position, int pointId, bool active);
113
114 QQuick3DLightmapBaker *maybeLightmapBaker();
115 QQuick3DLightmapBaker *lightmapBaker();
116
117 Q_INVOKABLE void bakeLightmap();
118 Q_REVISION(6, 10) Q_INVOKABLE void denoiseLightmap();
119
120 QQmlListProperty<QQuick3DObject> extensions();
121
122 Q_REVISION(6, 7) int explicitTextureWidth() const;
123 Q_REVISION(6, 7) int explicitTextureHeight() const;
124 Q_REVISION(6, 7) QSize effectiveTextureSize() const;
125
126 // Private helpers
127 [[nodiscard]] bool extensionListDirty() const { return m_extensionListDirty; }
128 [[nodiscard]] const QList<QQuick3DObject *> &extensionList() const { return m_extensions; }
129 void clearExtensionListDirty() { m_extensionListDirty = false; }
130
131 Q_REVISION(6, 7) Q_INVOKABLE void rebuildExtensionList();
132
133 enum class PrivateInstanceType : quint8 { XrViewInstance = 1 };
134 explicit QQuick3DViewport(PrivateInstanceType type, QQuickItem *parent = nullptr);
135 [[nodiscard]] bool isXrViewInstance() const { return m_isXrViewInstance; }
136
137 static void updateCameraForLayer(const QQuick3DViewport &view3D, QSSGRenderLayer &layerNode);
138
139protected:
140 void geometryChange(const QRectF &newGeometry, const QRectF &oldGeometry) override;
141 QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *) override;
142 void itemChange(QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &value) override;
143
144 bool event(QEvent *) override;
145 void componentComplete() override;
146
147public Q_SLOTS:
148 void setCamera(QQuick3DCamera *camera);
149 void setEnvironment(QQuick3DSceneEnvironment * environment);
150 void setImportScene(QQuick3DNode *inScene);
151 void setRenderMode(QQuick3DViewport::RenderMode renderMode);
152#if QT_CONFIG(quick_shadereffect)
153 Q_REVISION(6, 4) void setRenderFormat(QQuickShaderEffectSource::Format format);
154#endif
155 Q_REVISION(6, 7) void setExplicitTextureWidth(int width);
156 Q_REVISION(6, 7) void setExplicitTextureHeight(int height);
157 void cleanupDirectRenderer();
158
159 // Setting this true enables picking for all the models, regardless of
160 // the models pickable property.
161 void setGlobalPickingEnabled(bool isEnabled);
162
163private Q_SLOTS:
164 void invalidateSceneGraph();
165 void updateInputProcessing();
166 void onReleaseCachedResources();
167
168Q_SIGNALS:
169 void cameraChanged();
170 void environmentChanged();
171 void sceneChanged();
172 void importSceneChanged();
173 void renderModeChanged();
174 Q_REVISION(6, 4) void renderFormatChanged();
175 Q_REVISION(6, 7) void explicitTextureWidthChanged();
176 Q_REVISION(6, 7) void explicitTextureHeightChanged();
177 Q_REVISION(6, 7) void effectiveTextureSizeChanged();
178
179private:
180 void setMultiViewCameras(QQuick3DCamera **firstCamera, int count);
181 template <size_t N>
182 void setMultiViewCameras(QQuick3DCamera *(&cameras)[N])
183 {
184 static_assert(N > 1, "Use setCamera for single view");
185 setMultiViewCameras(cameras, N);
186 }
187
188 friend class QQuick3DExtensionListHelper;
189 friend class QQuick3DXrManager;
190 friend class QQuick3DXrManagerPrivate;
191 friend class QQuick3DRenderLayerHelpers;
192
193 Q_DISABLE_COPY(QQuick3DViewport)
194 struct SubsceneInfo {
195 QQuick3DObject* obj = nullptr;
196 QVarLengthArray<QPointF, 16> eventPointScenePositions;
197 };
198 QQuick3DSceneRenderer *getRenderer() const;
199 void updateDynamicTextures();
200 QSGNode *setupOffscreenRenderer(QSGNode *node);
201 QSGNode *setupInlineRenderer(QSGNode *node);
202 void setupDirectRenderer(RenderMode mode);
203 bool checkIsVisible() const;
204 bool internalPick(QPointerEvent *event, const QVector3D &origin = QVector3D(), const QVector3D &direction = QVector3D()) const;
205 QPair<QQuickItem *, QPointF> getItemAndPosition(const QSSGRenderPickResult &pickResult);
206 QVarLengthArray<QSSGRenderPickResult, 20> getPickResults(QQuick3DSceneRenderer *renderer, const QVector3D &origin, const QVector3D &direction) const;
207 QVarLengthArray<QSSGRenderPickResult, 20> getPickResults(QQuick3DSceneRenderer *renderer, const QEventPoint &eventPoint) const;
208 bool forwardEventToSubscenes(QPointerEvent *event,
209 bool useRayPicking,
210 QQuick3DSceneRenderer *renderer,
211 const QFlatMap<QQuickItem *, SubsceneInfo> &visitedSubscenes) const;
212
213 void processPickedObject(const QSSGRenderPickResult &pickResult,
214 int pointIndex,
215 QPointerEvent *event,
216 QFlatMap<QQuickItem *, SubsceneInfo> &vistedSubscenes) const;
217 QQuickItem *getSubSceneRootItem(QQuick3DMaterial *material) const;
218 QQuick3DPickResult getNearestPickResult(const QVarLengthArray<QSSGRenderPickResult, 20> &pickResults) const;
219 QQuick3DPickResult processPickResult(const QSSGRenderPickResult &pickResult) const;
220 QQuick3DObject *findFrontendNode(const QSSGRenderGraphObject *backendObject) const;
221 QQuick3DSceneManager *findChildSceneManager(QQuick3DObject *inObject, QQuick3DSceneManager *manager = nullptr);
222 void updateSceneManagerForImportScene();
223 QQuick3DCamera *m_camera = nullptr;
224 QVarLengthArray<QQuick3DCamera *, 2> m_multiViewCameras;
225 QQuick3DSceneEnvironment *m_environment = nullptr;
226 mutable QPointer<QQuick3DSceneEnvironment> m_builtInEnvironment;
227 QQuick3DSceneRootNode *m_sceneRoot = nullptr;
228 QQuick3DNode *m_importScene = nullptr;
229 mutable SGFramebufferObjectNode *m_node = nullptr;
230 mutable QQuick3DSGRenderNode *m_renderNode = nullptr;
231 mutable QQuick3DSGDirectRenderer *m_directRenderer = nullptr;
232 bool m_renderModeDirty = false;
233 RenderMode m_renderMode = Offscreen;
234#if QT_CONFIG(quick_shadereffect)
235 QQuickShaderEffectSource::Format m_renderFormat = QQuickShaderEffectSource::RGBA8;
236#endif
237 int m_explicitTextureWidth = 0;
238 int m_explicitTextureHeight = 0;
239 QSize m_effectiveTextureSize;
240 float m_widthMultiplier = 1.0f;
241 float m_heightMultiplier = 1.0f;
242 QQuick3DRenderStats *m_renderStats = nullptr;
243 bool m_enableInputProcessing = false;
244 QQuick3DLightmapBaker *m_lightmapBaker = nullptr;
245 QList<QQuick3DObject *> m_extensions;
246 bool m_extensionListDirty = false;
247 bool m_isXrViewInstance = false;
248
249 struct TouchState {
250 QQuickItem *target = nullptr;
251 QPointF position;
252 bool isPressed = false;
253 };
254 QPointingDevice *m_syntheticTouchDevice = nullptr;
255 QVarLengthArray<TouchState, 2> m_touchState{2};
256
257 QPointer<QQuickItem> m_prevMouseItem = nullptr;
258 QPointF m_prevMousePos;
259
260 Q_QUICK3D_PROFILE_ID
261};
262
263QT_END_NAMESPACE
264
265#endif // QSSGVIEW3D_H
266

source code of qtquick3d/src/quick3d/qquick3dviewport_p.h