vtkOpenXRRenderWindow.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkOpenXRRenderWindow_h
#define vtkOpenXRRenderWindow_h

#include "vtkRenderingOpenXRModule.h" // For export macro
#include "vtkVRRenderWindow.h"

#include "vtkEventData.h" // for method sig

#include <array>   // array
#include <cstdint> // uint32_t
#include <memory>  // unique_ptr
#include <string>  // string

VTK_ABI_NAMESPACE_BEGIN

class vtkMatrix4x4;
class vtkOpenXRSceneObserver;
class vtkOpenXRManagerConnection;

class VTKRENDERINGOPENXR_EXPORT vtkOpenXRRenderWindow : public vtkVRRenderWindow
{
public:
  static vtkOpenXRRenderWindow* New();
  vtkTypeMacro(vtkOpenXRRenderWindow, vtkVRRenderWindow);

  VTK_NEWINSTANCE vtkRenderWindowInteractor* MakeRenderWindowInteractor() override;

  void AddRenderer(vtkRenderer*) override;

  void StereoUpdate() override;

  void StereoMidpoint() override;

  void StereoRenderComplete() override;

  void Render() override;

  void Initialize() override;

  void Finalize() override;

  const char* ReportCapabilities() override { return "OpenXR System"; }

  bool GetSizeFromAPI() override;

  vtkTypeBool GetEventPending() override { return 0; }

  void SetModelActiveState(const int hand, bool state) { this->ModelsActiveState[hand] = state; }

  uint32_t GetDeviceHandleForOpenXRHandle(uint32_t index);
  vtkEventDataDevice GetDeviceForOpenXRHandle(uint32_t ohandle);

  void UpdateHMDMatrixPose() override;

  void RenderModels() override;

  std::string& GetCurrentInteractionProfile(uint32_t);
  void SetCurrentInteractionProfile(uint32_t, const std::string& profile);


  std::string& GetModelsManifestDirectory();
  void SetModelsManifestDirectory(const std::string& path);


  vtkSetMacro(UseDepthExtension, bool);
  vtkGetMacro(UseDepthExtension, bool);


  vtkSetMacro(EnableSceneUnderstanding, bool);
  vtkGetMacro(EnableSceneUnderstanding, bool);

  vtkOpenXRSceneObserver* GetSceneObserver();

  struct VTKRENDERINGOPENXR_EXPORT InstanceVersion
  {
    std::uint16_t Major{};
    std::uint16_t Minor{};
    std::uint32_t Patch{};
  };

  static InstanceVersion QueryInstanceVersion(vtkOpenXRManagerConnection* cs);

protected:
  vtkOpenXRRenderWindow();
  ~vtkOpenXRRenderWindow() override;

  // Create one framebuffer per view
  bool CreateFramebuffers(uint32_t viewCount = 2) override;

  bool BindTextureToFramebuffer(FramebufferDesc& framebufferDesc);
  void RenderFramebuffer(FramebufferDesc& framebufferDesc) override;

  virtual void RenderOneEye(uint32_t eye);

  vtkNew<vtkMatrix4x4> TempMatrix4x4;

  // Store if a model is active or not here as openxr do not have a concept
  // of active/inactive controller
  std::array<bool, 2> ModelsActiveState = { true, true };

private:
  vtkOpenXRRenderWindow(const vtkOpenXRRenderWindow&) = delete;
  void operator=(const vtkOpenXRRenderWindow&) = delete;

  class vtkInternals;
  std::unique_ptr<vtkInternals> Internal;

  bool UseDepthExtension = false;
  bool EnableSceneUnderstanding = false;
};

VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkOpenXRRenderWindow.h