VTK  9.4.20250303
vtkOpenXRRenderWindow.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
52#ifndef vtkOpenXRRenderWindow_h
53#define vtkOpenXRRenderWindow_h
54
55#include "vtkRenderingOpenXRModule.h" // For export macro
56#include "vtkVRRenderWindow.h"
57
58#include "vtkEventData.h" // for method sig
59
60#include <array> // array
61#include <memory> // unique_ptr
62#include <string> // string
63
64VTK_ABI_NAMESPACE_BEGIN
65
66class vtkMatrix4x4;
68
69class VTKRENDERINGOPENXR_EXPORT vtkOpenXRRenderWindow : public vtkVRRenderWindow
70{
71public:
74
79
83 void AddRenderer(vtkRenderer*) override;
84
89 void StereoUpdate() override;
90
95 void StereoMidpoint() override;
96
101 void StereoRenderComplete() override;
102
107 void Render() override;
108
115 void Initialize() override;
116
122 void Finalize() override;
123
127 const char* ReportCapabilities() override { return "OpenXR System"; }
128
132 bool GetSizeFromAPI() override;
133
139 vtkTypeBool GetEventPending() override { return 0; }
140
144 void SetModelActiveState(const int hand, bool state) { this->ModelsActiveState[hand] = state; }
145
146 uint32_t GetDeviceHandleForOpenXRHandle(uint32_t index);
148
154 void UpdateHMDMatrixPose() override;
155
159 void RenderModels() override;
160
164 std::string& GetCurrentInteractionProfile(uint32_t);
165 void SetCurrentInteractionProfile(uint32_t, const std::string& profile);
166
168
174 void SetModelsManifestDirectory(const std::string& path);
176
178
197 vtkSetMacro(UseDepthExtension, bool);
198 vtkGetMacro(UseDepthExtension, bool);
200
202
215 vtkSetMacro(EnableSceneUnderstanding, bool);
216 vtkGetMacro(EnableSceneUnderstanding, bool);
218
230
231protected:
234
235 // Create one framebuffer per view
236 bool CreateFramebuffers(uint32_t viewCount = 2) override;
237
239 void RenderFramebuffer(FramebufferDesc& framebufferDesc) override;
240
241 virtual void RenderOneEye(uint32_t eye);
242
244
245 // Store if a model is active or not here as openxr do not have a concept
246 // of active/inactive controller
247 std::array<bool, 2> ModelsActiveState = { true, true };
248
249private:
251 void operator=(const vtkOpenXRRenderWindow&) = delete;
252
253 class vtkInternals;
254 std::unique_ptr<vtkInternals> Internal;
255
256 bool UseDepthExtension = false;
257 bool EnableSceneUnderstanding = false;
258};
259
260VTK_ABI_NAMESPACE_END
261#endif
262// VTK-HeaderTest-Exclude: vtkOpenXRRenderWindow.h
represent and manipulate 4x4 transformation matrices
Allocate and hold a VTK object.
Definition vtkNew.h:167
OpenXR rendering window.
std::string & GetModelsManifestDirectory()
Get/Set a custom path to look for the controllers models.
static vtkOpenXRRenderWindow * New()
vtkOpenXRSceneObserver * GetSceneObserver()
Returns scene observer associated with this window.
void SetModelsManifestDirectory(const std::string &path)
Get/Set a custom path to look for the controllers models.
void SetCurrentInteractionProfile(uint32_t, const std::string &profile)
void RenderFramebuffer(FramebufferDesc &framebufferDesc) override
void Render() override
Overridden to not release resources that would interfere with an external application's rendering.
void StereoUpdate() override
Update the system, if needed, due to stereo rendering.
~vtkOpenXRRenderWindow() override
virtual void RenderOneEye(uint32_t eye)
std::string & GetCurrentInteractionProfile(uint32_t)
Get/Set the current interaction profile for a hand.
bool BindTextureToFramebuffer(FramebufferDesc &framebufferDesc)
vtkTypeBool GetEventPending() override
Check to see if a mouse button has been pressed or mouse wheel activated.
void AddRenderer(vtkRenderer *) override
Add a renderer to the list of renderers.
const char * ReportCapabilities() override
Get report of capabilities for the render window.
bool CreateFramebuffers(uint32_t viewCount=2) override
void Finalize() override
Finalize the rendering window.
vtkRenderWindowInteractor * MakeRenderWindowInteractor() override
Create an interactor to control renderers in this window.
void UpdateHMDMatrixPose() override
Update the HMD pose based on hardware pose and physical to world transform.
void StereoRenderComplete() override
Handles work required once both views have been rendered when using stereo rendering.
void SetModelActiveState(const int hand, bool state)
Set the active state (active: true / inactive: false) of the specified hand.
void Initialize() override
Initialize the rendering window.
uint32_t GetDeviceHandleForOpenXRHandle(uint32_t index)
vtkEventDataDevice GetDeviceForOpenXRHandle(uint32_t ohandle)
vtkNew< vtkMatrix4x4 > TempMatrix4x4
void StereoMidpoint() override
Intermediate method performs operations required between the rendering of the left and right eye.
bool GetSizeFromAPI() override
Get size of render window from OpenXR.
void RenderModels() override
Render the controllers.
platform-independent render window interaction including picking and frame rate control.
abstract specification for renderers
VR rendering window.
int vtkTypeBool
Definition vtkABI.h:64
vtkEventDataDevice
platform-independent event data structures
#define VTK_NEWINSTANCE