vtkOpenXRRenderWindowInteractor.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 vtkOpenXRRenderWindowInteractor_h
#define vtkOpenXRRenderWindowInteractor_h
 
#include "vtkRenderingOpenXRModule.h" // For export macro
#include "vtkVRRenderWindowInteractor.h"
 
#include "vtkEventData.h"     // for ivar
#include "vtkOpenXRManager.h" //for types
 
#include <functional> // for std::function
#include <map>        // for std::map
 
typedef vtkOpenXRManager::Action_t Action_t;
 
VTK_ABI_NAMESPACE_BEGIN
class VTKRENDERINGOPENXR_EXPORT vtkOpenXRRenderWindowInteractor : public vtkVRRenderWindowInteractor
{
public:
  static vtkOpenXRRenderWindowInteractor* New();
  vtkTypeMacro(vtkOpenXRRenderWindowInteractor, vtkVRRenderWindowInteractor);

  void Initialize() override;
 
  void DoOneEvent(vtkVRRenderWindow* renWin, vtkRenderer* ren) override;

  XrPosef* GetHandPose(uint32_t hand);


  void AddAction(const std::string& path, const vtkCommand::EventIds&);
  void AddAction(const std::string& path, const std::function<void(vtkEventData*)>&);


  void AddAction(const std::string& path, const vtkCommand::EventIds&, bool isAnalog) override;
  void AddAction(
    const std::string& path, bool isAnalog, const std::function<void(vtkEventData*)>&) override;
 
  void ConvertOpenXRPoseToWorldCoordinates(const XrPosef& xrPose,
    double pos[3],   // Output world position
    double wxyz[4],  // Output world orientation quaternion
    double ppos[3],  // Output physical position
    double wdir[3]); // Output world view direction (-Z)

  bool ApplyVibration(const std::string& actionName, int hand, float amplitude = 0.5,
    float duration = 25000000.0, float frequency = XR_FREQUENCY_UNSPECIFIED);
 
protected:
  vtkOpenXRRenderWindowInteractor();
 
  ~vtkOpenXRRenderWindowInteractor() override;
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void ProcessXrEvents();

  void PollXrActions();
 
  struct ActionData;
 
  XrActionType GetActionTypeFromString(const std::string& type);
  bool LoadActions(const std::string& actionFilename);
  bool LoadDefaultBinding(const std::string& bindingFilename);
  ActionData* GetActionDataFromName(const std::string& actionName);
 
  void HandleAction(const ActionData& actionData, int hand, vtkEventDataDevice3D* ed);
  void HandleBooleanAction(const ActionData& actionData, int hand, vtkEventDataDevice3D* ed);
  void HandlePoseAction(const ActionData& actionData, int hand, vtkEventDataDevice3D* ed);
  void HandleVector2fAction(const ActionData& actionData, int hand, vtkEventDataDevice3D* ed);
  void ApplyAction(const ActionData& actionData, vtkEventDataDevice3D* ed);
 
  struct ActionData
  {
    std::string Name;
 
    vtkEventDataDeviceInput DeviceInput = vtkEventDataDeviceInput::Unknown;
 
    // This structure is defined in vtkOpenXRManager
    // And hold OpenXR related data
    Action_t ActionStruct{ XR_NULL_HANDLE };
 
    vtkCommand::EventIds EventId;
    std::function<void(vtkEventData*)> Function;
    bool UseFunction = false;
  };
 
  using MapAction = std::map<std::string, ActionData*>;
  MapAction MapActionStruct_Name;
 
  vtkNew<vtkMatrix4x4> PoseToWorldMatrix; // used in calculations
 
private:
  vtkOpenXRRenderWindowInteractor(const vtkOpenXRRenderWindowInteractor&) = delete;
  void operator=(const vtkOpenXRRenderWindowInteractor&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkOpenXRRenderWindowInteractor.h