vtkOpenXRSceneObserver.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 vtkOpenXRSceneObserver_h
#define vtkOpenXRSceneObserver_h

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

#include <memory> // For std::unique_ptr

VTK_ABI_NAMESPACE_BEGIN

class vtkOpenXRRenderWindow;
class vtkOpenXRSceneComponent;

class VTKRENDERINGOPENXR_EXPORT vtkOpenXRSceneObserver : public vtkObject
{
  struct vtkInternals;

public:
  static vtkOpenXRSceneObserver* New();
  vtkTypeMacro(vtkOpenXRSceneObserver, vtkObject);

  bool Initialize();

  bool UpdateSceneData();


  enum SceneConsistency
  {
    // enum values from OpenXR
    SnapshotComplete = 1,
    SnapshotIncompleteFast = 2,
    OcclusionOptimized = 3,
  };
  vtkGetMacro(ComputeConsistency, SceneConsistency);
  vtkSetMacro(ComputeConsistency, SceneConsistency);


  vtkGetMacro(ClippingRadius, double);
  vtkSetClampMacro(ClippingRadius, double, 0.0, 1e100);

  enum SceneFeature
  {
    // enum values from XrSceneComputeFeatureMSFT
    Markers = 1000147000,
  };


  bool EnableComputeFeature(SceneFeature feature);
  void DisableComputeFeature(SceneFeature feature);
  bool IsComputeFeatureEnabled(SceneFeature feature) const;
  bool IsComputeFeatureSupported(SceneFeature feature) const;


  vtkSetMacro(MinimumInterval, double);
  vtkGetMacro(MinimumInterval, double);

protected:
  vtkOpenXRSceneObserver();
  ~vtkOpenXRSceneObserver() override;

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

  bool CreateMSFTSceneObserver();

  std::unique_ptr<vtkInternals> Impl;

  double MinimumInterval{ 2.0 };
  double ClippingRadius{ 2.0 };
  SceneConsistency ComputeConsistency{ SceneConsistency::SnapshotComplete };
};

VTK_ABI_NAMESPACE_END

#endif