vtkOpenVROverlay.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 vtkOpenVROverlay_h
#define vtkOpenVROverlay_h
 
#include "vtkNew.h" // for ivars
#include "vtkObject.h"
#include "vtkRenderingOpenVRModule.h" // For export macro
#include "vtkWeakPointer.h"           // for ivars
#include <map>                        // ivars
#include <openvr.h>                   // for ivars
#include <vector>                     // ivars
 
VTK_ABI_NAMESPACE_BEGIN
class vtkJPEGReader;
class vtkOpenVROverlaySpot;
class vtkOpenVRRenderWindow;
class vtkTextureObject;
class vtkOpenVRCameraPose;
class vtkOpenVRCamera;
class vtkXMLDataElement;
 
class VTKRENDERINGOPENVR_EXPORT vtkOpenVROverlay : public vtkObject
{
public:
  static vtkOpenVROverlay* New();
  vtkTypeMacro(vtkOpenVROverlay, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual void Render();
 
  virtual void Create(vtkOpenVRRenderWindow* rw);
 
  vr::VROverlayHandle_t GetOverlayHandle() { return this->OverlayHandle; }
 
  vtkTextureObject* GetOverlayTexture() { return this->OverlayTexture.Get(); }
 
 
  virtual void MouseMoved(int x, int y);
  virtual void MouseButtonPress(int x, int y);
  virtual void MouseButtonRelease(int x, int y);
 
  vtkOpenVROverlaySpot* GetLastSpot() { return this->LastSpot; }
 
  std::vector<vtkOpenVROverlaySpot>& GetSpots() { return this->Spots; }
 
  /***
   * update the texture because this spot has changed
   */
  virtual void UpdateSpot(vtkOpenVROverlaySpot* spot);
 
 
  void SetSessionName(const std::string& name) { this->SessionName = name; }
  std::string GetSessionName() { return this->SessionName; }
 
 
  void SetDashboardImageFileName(VTK_FILEPATH const std::string& name)
  {
    this->DashboardImageFileName = name;
  }
  VTK_FILEPATH std::string GetDashboardImageFileName() { return this->DashboardImageFileName; }
 
  vtkOpenVRCameraPose* GetSavedCameraPose(int i);
  virtual void SetSavedCameraPose(int i, vtkOpenVRCameraPose*);
  virtual void WriteCameraPoses(ostream& os);
  virtual void WriteCameraPoses();
  virtual void ReadCameraPoses();
  virtual void ReadCameraPoses(istream& is);
  virtual void ReadCameraPoses(vtkXMLDataElement* xml);
  virtual void SaveCameraPose(int num);
  virtual void LoadCameraPose(int num);
  virtual void LoadNextCameraPose();
  virtual std::map<int, vtkOpenVRCameraPose>& GetSavedCameraPoses()
  {
    return this->SavedCameraPoses;
  }
 
  // not used for dashboard overlays
  void Show();
  void Hide();
 
protected:
  vtkOpenVROverlay();
  ~vtkOpenVROverlay() override;
 
  virtual void SetupSpots() {}
 
  vr::IVRSystem* VRSystem;
 
  // for the overlay
  vr::VROverlayHandle_t OverlayHandle;
  vr::VROverlayHandle_t OverlayThumbnailHandle;
  vtkNew<vtkTextureObject> OverlayTexture;
 
  virtual void SetDashboardImageData(vtkJPEGReader* rdr);
 
  // std::vector<vtkOpenVRActiveSpot> ActiveSpots;
  unsigned char* OriginalTextureData;
  unsigned char* CurrentTextureData;
 
  std::vector<vtkOpenVROverlaySpot> Spots;
  vtkOpenVROverlaySpot* LastSpot;
 
  std::string SessionName;
  std::string DashboardImageFileName;
  std::map<int, vtkOpenVRCameraPose> SavedCameraPoses;
 
  vtkWeakPointer<vtkOpenVRRenderWindow> Window;
  int LastCameraPoseIndex;
 
  double LastSpotIntensity;
  double ActiveSpotIntensity;
 
private:
  vtkOpenVROverlay(const vtkOpenVROverlay&) = delete;
  void operator=(const vtkOpenVROverlay&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif