VTK  9.4.20241016
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
65class vtkMatrix4x4;
66
67class VTKRENDERINGOPENXR_EXPORT vtkOpenXRRenderWindow : public vtkVRRenderWindow
68{
69public:
72
77
81 void AddRenderer(vtkRenderer*) override;
82
87 void StereoUpdate() override;
88
93 void StereoMidpoint() override;
94
99 void StereoRenderComplete() override;
100
105 void Render() override;
106
113 void Initialize() override;
114
120 void Finalize() override;
121
125 const char* ReportCapabilities() override { return "OpenXR System"; }
126
130 bool GetSizeFromAPI() override;
131
137 vtkTypeBool GetEventPending() override { return 0; }
138
142 void SetModelActiveState(const int hand, bool state) { this->ModelsActiveState[hand] = state; }
143
144 uint32_t GetDeviceHandleForOpenXRHandle(uint32_t index);
146
152 void UpdateHMDMatrixPose() override;
153
157 void RenderModels() override;
158
162 std::string& GetCurrentInteractionProfile(uint32_t);
163 void SetCurrentInteractionProfile(uint32_t, const std::string& profile);
164
165protected:
168
169 // Create one framebuffer per view
170 bool CreateFramebuffers(uint32_t viewCount = 2) override;
171
173 void RenderFramebuffer(FramebufferDesc& framebufferDesc) override;
174
175 virtual void RenderOneEye(uint32_t eye);
176
178
179 // Store if a model is active or not here as openxr do not have a concept
180 // of active/inactive controller
181 std::array<bool, 2> ModelsActiveState = { true, true };
182
183private:
185 void operator=(const vtkOpenXRRenderWindow&) = delete;
186
187 class vtkInternals;
188 std::unique_ptr<vtkInternals> Internal;
189};
190
191VTK_ABI_NAMESPACE_END
192#endif
193// VTK-HeaderTest-Exclude: vtkOpenXRRenderWindow.h
represent and manipulate 4x4 transformation matrices
Allocate and hold a VTK object.
Definition vtkNew.h:167
OpenXR rendering window.
static vtkOpenXRRenderWindow * New()
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