1// Copyright (C) 2024 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
3
4#ifndef QQUICK3DXRVIEW_P_H
5#define QQUICK3DXRVIEW_P_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
19#include <QtCore/QObject>
20#include <QtQml/QQmlEngine>
21#include <QtQml/qqml.h>
22
23#include <QtQuick3D/private/qquick3dviewport_p.h>
24#include <QtQuick3D/private/qquick3dnode_p.h>
25#include <QtQuick3D/private/qquick3dsceneenvironment_p.h>
26#include <QtQuick3D/private/qquick3dpickresult_p.h>
27
28#include <QtQuick3DXr/private/qquick3dxrmanager_p.h>
29#include <QtQuick3DXr/private/qquick3dxrorigin_p.h>
30#include <QtQuick3DXr/private/qquick3dxrruntimeinfo_p.h>
31
32QT_BEGIN_NAMESPACE
33
34class QQuick3DXrItem;
35
36class Q_QUICK3DXR_EXPORT QQuick3DXrView : public QQuick3DNode
37{
38 Q_OBJECT
39
40 Q_PROPERTY(QQuick3DXrOrigin *xrOrigin READ xrOrigin WRITE setXROrigin NOTIFY xrOriginChanged)
41 Q_PROPERTY(QQuick3DSceneEnvironment *environment READ environment WRITE setEnvironment NOTIFY environmentChanged)
42 Q_PROPERTY(bool passthroughSupported READ passthroughSupported CONSTANT)
43 Q_PROPERTY(bool passthroughEnabled READ passthroughEnabled WRITE setPassthroughEnabled NOTIFY passthroughEnabledChanged FINAL)
44 Q_PROPERTY(QQuick3DXrRuntimeInfo *runtimeInfo READ runtimeInfo CONSTANT)
45 Q_PROPERTY(bool quitOnSessionEnd READ isQuitOnSessionEndEnabled WRITE setQuitOnSessionEnd NOTIFY quitOnSessionEndChanged FINAL)
46 Q_PROPERTY(QQuick3DRenderStats *renderStats READ renderStats CONSTANT)
47 Q_PROPERTY(FoveationLevel fixedFoveation READ fixedFoveation WRITE setFixedFoveation NOTIFY fixedFoveationChanged FINAL)
48 Q_PROPERTY(ReferenceSpace referenceSpace READ referenceSpace WRITE setReferenceSpace NOTIFY referenceSpaceChanged FINAL)
49 Q_PROPERTY(bool depthSubmissionEnabled READ depthSubmissionEnabled WRITE setDepthSubmissionEnabled NOTIFY depthSubmissionEnabledChanged FINAL)
50 Q_PROPERTY(bool multiViewRenderingSupported READ isMultiViewRenderingSupported CONSTANT)
51 Q_PROPERTY(bool multiViewRenderingEnabled READ multiViewRenderingEnabled WRITE setMultiViewRenderingEnabled NOTIFY multiViewRenderingEnabledChanged FINAL)
52 QML_NAMED_ELEMENT(XrView)
53 QML_ADDED_IN_VERSION(6, 8)
54
55public:
56 enum FoveationLevel {
57 NoFoveation = 0,
58 LowFoveation = 1,
59 MediumFoveation = 2,
60 HighFoveation = 3
61 };
62 Q_ENUM(FoveationLevel)
63
64 enum class ReferenceSpace {
65 ReferenceSpaceUnknown,
66 ReferenceSpaceLocal,
67 ReferenceSpaceStage,
68 ReferenceSpaceLocalFloor
69 };
70 Q_ENUM(ReferenceSpace)
71
72 explicit QQuick3DXrView();
73 ~QQuick3DXrView();
74
75 QQuick3DXrOrigin *xrOrigin() const;
76 QQuick3DSceneEnvironment *environment() const;
77
78 bool passthroughSupported() const;
79 bool passthroughEnabled() const;
80
81 FoveationLevel fixedFoveation() const;
82 void setFixedFoveation(FoveationLevel level);
83
84 QQuick3DXrRuntimeInfo *runtimeInfo() const;
85
86 bool isQuitOnSessionEndEnabled() const;
87
88 QQuick3DRenderStats *renderStats() const;
89
90 Q_INVOKABLE QQuick3DPickResult rayPick(const QVector3D &origin, const QVector3D &direction) const;
91 Q_INVOKABLE QList<QQuick3DPickResult> rayPickAll(const QVector3D &origin, const QVector3D &direction) const;
92
93 Q_INVOKABLE void setTouchpoint(QQuickItem *target, const QPointF &position, int pointId, bool active);
94 Q_INVOKABLE QVector3D processTouch(const QVector3D &pos, int pointId);
95 Q_INVOKABLE QVariantMap touchpointState(int pointId) const;
96
97 ReferenceSpace referenceSpace() const;
98 void setReferenceSpace(ReferenceSpace newReferenceSpace);
99
100 bool depthSubmissionEnabled() const;
101
102 void registerXrItem(QQuick3DXrItem *newXrItem);
103 void unregisterXrItem(QQuick3DXrItem *xrItem);
104
105 bool isMultiViewRenderingSupported() const;
106 bool multiViewRenderingEnabled() const;
107
108 QQuick3DXrManager *xrManager() { return &m_xrManager; }
109
110public Q_SLOTS:
111 void setEnvironment(QQuick3DSceneEnvironment * environment);
112 void setPassthroughEnabled(bool enable);
113 void setQuitOnSessionEnd(bool enable);
114 void setDepthSubmissionEnabled(bool enable);
115 void setMultiViewRenderingEnabled(bool enable);
116 void setXROrigin(QQuick3DXrOrigin *newXrOrigin);
117
118private Q_SLOTS:
119 void updateViewportGeometry();
120 void handleSessionEnded();
121 void handleClearColorChanged();
122 void handleAAChanged();
123 bool init();
124
125Q_SIGNALS:
126 void initializeFailed(const QString &errorString);
127 void sessionEnded();
128 void xrOriginChanged();
129 void environmentChanged(QQuick3DSceneEnvironment * environment);
130 void passthroughEnabledChanged();
131 void quitOnSessionEndChanged();
132 void fixedFoveationChanged();
133 void frameReady(); // tooling
134 void referenceSpaceChanged();
135 void depthSubmissionEnabledChanged();
136 void multiViewRenderingEnabledChanged();
137
138private:
139 // The XrView does not expose the View3D in its public interface. This is intentional.
140 QQuick3DViewport *view3d() const;
141
142 QPointer<QQuick3DSceneEnvironment> m_pendingSceneEnvironment;
143 QQuick3DXrManager m_xrManager;
144 mutable QQuick3DXrRuntimeInfo m_xrRuntimeInfo;
145 bool m_quitOnSessionEnd = true;
146 bool m_inDestructor = false;
147 bool m_isInitialized = false;
148
149 friend class QQuick3DXrVirtualMouse;
150 QList<QQuick3DXrItem *> m_xrItems;
151 struct XrTouchState;
152 XrTouchState *m_touchState = nullptr;
153 QQuick3DXrOrigin *m_xrOrigin = nullptr;
154};
155
156QT_END_NAMESPACE
157
158#endif // QQUICK3DXRVIEW_P_H
159

source code of qtquick3d/src/xr/quick3dxr/qquick3dxrview_p.h