vtkWebXRRenderWindowInteractor.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 vtkWebXRRenderWindowInteractor_h
#define vtkWebXRRenderWindowInteractor_h

#include "vtkRenderingWebXRModule.h" // For export macro
#include "vtkVRRenderWindowInteractor.h"
#include "vtkWebXR.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN

class VTKRENDERINGWEBXR_EXPORT VTK_MARSHALAUTO vtkWebXRRenderWindowInteractor
  : public vtkVRRenderWindowInteractor
{
public:
  vtkTypeMacro(vtkWebXRRenderWindowInteractor, vtkVRRenderWindowInteractor);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkWebXRRenderWindowInteractor* New();

  enum class SessionMode
  {
    VR = WEBXR_SESSION_MODE_IMMERSIVE_VR,
    AR = WEBXR_SESSION_MODE_IMMERSIVE_AR,
    INLINE = WEBXR_SESSION_MODE_INLINE,
  };

  void Initialize() override;

  void StartEventLoop() override;

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

  void TerminateApp() override;

  void ConvertWebXRPoseToWorldCoordinates(const WebXRRigidTransform& xrPose, double pos[3],
    double wxyz[4], double ppos[3], double wdir[3]);


  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 UpdateXRControllers();


  static void StartXR(SessionMode mode = SessionMode::VR, vtkTypeUInt32 requiredFeatures = 1,
    vtkTypeUInt32 optionalFeatures = 2);
  static void StopXR();

protected:
  vtkWebXRRenderWindowInteractor();
  ~vtkWebXRRenderWindowInteractor() override;

  class ActionData
  {
  public:
    vtkCommand::EventIds EventId;
    vtkEventDataDeviceInput DeviceInput = vtkEventDataDeviceInput::Unknown;
    std::function<void(vtkEventData*)> Function;
    bool UseFunction = false;
    bool IsHandPose = false;
  };

  bool LoadActions(const std::string& actionFilename);
  const ActionData* GetActionData(const std::string& actionName);
  const ActionData* GetActionData(
    WebXRHandedness hand, WebXRGamepadButtonMapping button, WebXRInputPoseMode mode);

  void ApplyAction(const ActionData& actionData, vtkEventDataDevice3D* ed);

  std::map<std::string, ActionData> ActionMap;
  struct WebXRInput
  {
    WebXRHandedness hand;
    WebXRGamepadButtonMapping button;
    WebXRInputPoseMode mode;

    bool operator<(const WebXRInput& other) const
    {
      if (this->hand != other.hand)
      {
        return this->hand < other.hand;
      }
      else if (this->button != other.button)
      {
        return this->button < other.button;
      }
      else
      {
        return this->mode < other.mode;
      }
    }
  };
  std::map<WebXRInput, ActionData*> ButtonToActionMap;

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

  vtkNew<vtkMatrix4x4> PoseToWorldMatrix; // used in calculations
#ifdef __EMSCRIPTEN__
  WebXRGamepad LastGamepadState[2]; // support 2 controllers (left and right)
#endif
};

VTK_ABI_NAMESPACE_END
#endif