VTK  9.2.6
vtkOpenVRRenderWindow.h
Go to the documentation of this file.
1/*=========================================================================
2
3Program: Visualization Toolkit
4Module: vtkOpenVRRenderWindow.h
5
6Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7All rights reserved.
8See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10This software is distributed WITHOUT ANY WARRANTY; without even
11the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
64#ifndef vtkOpenVRRenderWindow_h
65#define vtkOpenVRRenderWindow_h
66
67#include "vtkEventData.h" // for enums
68#include "vtkOpenVROverlay.h" // used for ivars
69#include "vtkRenderingOpenVRModule.h" // For export macro
70#include "vtkSmartPointer.h" // used for ivars
71#include "vtkVRRenderWindow.h"
72
73#include <openvr.h> // for ivars
74
75class vtkMatrix4x4;
76class vtkOpenVRModel;
77
78class VTKRENDERINGOPENVR_EXPORT vtkOpenVRRenderWindow : public vtkVRRenderWindow
79{
80public:
83
87 static bool IsHMDPresent();
88
92 void Initialize() override;
93
98 void ReleaseGraphicsResources(vtkWindow* renWin) override;
99
103 vr::IVRSystem* GetHMD() { return this->HMD; }
104
109
114 void Render() override;
115
120 void StereoMidpoint() override;
121
126 void StereoRenderComplete() override;
127
132
133 /*
134 * Get the overlay to use on the VR dashboard.
135 */
137
143 void UpdateHMDMatrixPose() override;
144
148 void SetMatrixFromOpenVRPose(vtkMatrix4x4* result, const vr::TrackedDevicePose_t& vrPose);
149
153 vr::IVRRenderModels* GetOpenVRRenderModels() { return this->OpenVRRenderModels; }
154
158 void RenderModels() override;
159
160 uint32_t GetDeviceHandleForOpenVRHandle(vr::TrackedDeviceIndex_t index);
161 vtkEventDataDevice GetDeviceForOpenVRHandle(vr::TrackedDeviceIndex_t ohandle);
162
163protected:
165 ~vtkOpenVRRenderWindow() override = default;
166
167 std::string GetWindowTitleFromAPI() override;
168 bool GetSizeFromAPI() override;
169
170 bool CreateFramebuffers(uint32_t viewCount = 2) override;
171 bool CreateOneFramebuffer(int nWidth, int nHeight, FramebufferDesc& framebufferDesc);
172
176 std::string GetTrackedDeviceString(vr::IVRSystem* pHmd, vr::TrackedDeviceIndex_t unDevice,
177 vr::TrackedDeviceProperty prop, vr::TrackedPropertyError* peError = nullptr);
178
182 vtkOpenVRModel* FindOrLoadRenderModel(const char* modelName);
183
185 vr::IVRSystem* HMD = nullptr;
186 vr::IVRRenderModels* OpenVRRenderModels = nullptr;
187
188private:
190 void operator=(const vtkOpenVRRenderWindow&) = delete;
191};
192
193#endif
represent and manipulate 4x4 transformation matrices
OpenVR device model.
OpenVR overlay.
OpenVR rendering window.
vtkEventDataDevice GetDeviceForOpenVRHandle(vr::TrackedDeviceIndex_t ohandle)
bool GetSizeFromAPI() override
Attempt to get the size of the display from the API and store it in this->Size.
void UpdateHMDMatrixPose() override
Update the HMD pose based on hardware pose and physical to world transform.
vr::IVRSystem * GetHMD()
Get the system pointer.
static vtkOpenVRRenderWindow * New()
~vtkOpenVRRenderWindow() override=default
vtkRenderWindowInteractor * MakeRenderWindowInteractor() override
Create an interactor specific to OpenVR to control renderers in this window.
void RenderModels() override
Render the controller and base station models.
vr::IVRRenderModels * GetOpenVRRenderModels()
Get the openVR Render Models.
uint32_t GetDeviceHandleForOpenVRHandle(vr::TrackedDeviceIndex_t index)
std::string GetWindowTitleFromAPI() override
vtkOpenVRModel * FindOrLoadRenderModel(const char *modelName)
Find a render model that has already been loaded or load a new one.
bool CreateOneFramebuffer(int nWidth, int nHeight, FramebufferDesc &framebufferDesc)
bool CreateFramebuffers(uint32_t viewCount=2) override
void StereoRenderComplete() override
Handles work required once both views have been rendered when using stereo rendering.
void ReleaseGraphicsResources(vtkWindow *renWin) override
Free up any graphics resources associated with this window a value of nullptr means the context may a...
void SetMatrixFromOpenVRPose(vtkMatrix4x4 *result, const vr::TrackedDevicePose_t &vrPose)
Convert an OpenVR pose struct to a vtkMatrix4x4 object.
void RenderOverlay()
Draw the overlay.
vtkSmartPointer< vtkOpenVROverlay > DashboardOverlay
void StereoMidpoint() override
Intermediate method performs operations required between the rendering of the left and right eye.
vtkGetSmartPointerMacro(DashboardOverlay, vtkOpenVROverlay)
void Initialize() override
Initialize the rendering window.
std::string GetTrackedDeviceString(vr::IVRSystem *pHmd, vr::TrackedDeviceIndex_t unDevice, vr::TrackedDeviceProperty prop, vr::TrackedPropertyError *peError=nullptr)
Convert a device index to a human-readable string.
void Render() override
Overridden to not release resources that would interfere with an external application's rendering.
static bool IsHMDPresent()
Returns true if the system believes that an HMD is present on the system.
platform-independent render window interaction including picking and frame rate control.
Hold a reference to a vtkObjectBase instance.
VR rendering window.
window superclass for vtkRenderWindow
Definition vtkWindow.h:48
vtkEventDataDevice
platform-independent event data structures