VTK  9.4.20251007
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
32
33#ifndef vtkOpenXRRenderWindow_h
34#define vtkOpenXRRenderWindow_h
35
36#include "vtkRenderingOpenXRModule.h" // For export macro
37#include "vtkVRRenderWindow.h"
38
39#include "vtkEventData.h" // for method sig
40
41#include <array> // array
42#include <memory> // unique_ptr
43#include <string> // string
44
45VTK_ABI_NAMESPACE_BEGIN
46class vtkMatrix4x4;
47
48class VTKRENDERINGOPENXR_EXPORT vtkOpenXRRenderWindow : public vtkVRRenderWindow
49{
50public:
53
58
62 void AddRenderer(vtkRenderer*) override;
63
68 void StereoUpdate() override;
69
74 void StereoMidpoint() override;
75
80 void StereoRenderComplete() override;
81
86 void Render() override;
87
94 void Initialize() override;
95
101 void Finalize() override;
102
106 const char* ReportCapabilities() override { return "OpenXR System"; }
107
111 bool GetSizeFromAPI() override;
112
118 vtkTypeBool GetEventPending() override { return 0; }
119
123 void SetModelActiveState(const int hand, bool state) { this->ModelsActiveState[hand] = state; }
124
125 uint32_t GetDeviceHandleForOpenXRHandle(uint32_t index);
127
133 void UpdateHMDMatrixPose() override;
134
138 void RenderModels() override;
139
143 std::string& GetCurrentInteractionProfile(uint32_t);
144 void SetCurrentInteractionProfile(uint32_t, const std::string& profile);
145
146protected:
149
150 // Create one framebuffer per view
151 bool CreateFramebuffers(uint32_t viewCount = 2) override;
152
154 void RenderFramebuffer(FramebufferDesc& framebufferDesc) override;
155
156 virtual void RenderOneEye(uint32_t eye);
157
159
160 // Store if a model is active or not here as openxr do not have a concept
161 // of active/inactive controller
162 std::array<bool, 2> ModelsActiveState = { true, true };
163
164private:
166 void operator=(const vtkOpenXRRenderWindow&) = delete;
167
168 class vtkInternals;
169 std::unique_ptr<vtkInternals> Internal;
170};
171
172VTK_ABI_NAMESPACE_END
173#endif
174// VTK-HeaderTest-Exclude: vtkOpenXRRenderWindow.h
represent and manipulate 4x4 transformation matrices
Allocate and hold a VTK object.
Definition vtkNew.h:58
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.
std::array< bool, 2 > ModelsActiveState
~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
Definition vtkRenderer.h:63
int vtkTypeBool
Definition vtkABI.h:64
vtkEventDataDevice
platform-independent event data structures
#define VTK_NEWINSTANCE