vtkVRInteractorStyle.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 vtkVRInteractorStyle_h
#define vtkVRInteractorStyle_h

#include "vtkEventData.h" // for enums
#include "vtkInteractorStyle3D.h"
#include "vtkNew.h"               // for vtkNew
#include "vtkRenderingVRModule.h" // For export macro
#include "vtkSmartPointer.h"      // for vtkSmartPointer
#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO

#include <map>    // for std::map
#include <vector> // for std::vector

VTK_ABI_NAMESPACE_BEGIN
class vtkCallbackCommand;
class vtkCell;
class vtkPlane;
class vtkRenderWindowInteractor;
class vtkSelection;
class vtkSphereSource;
class vtkTextActor3D;
class vtkVRControlsHelper;
class vtkVRHardwarePicker;
class vtkVRMenuRepresentation;
class vtkVRMenuWidget;

class VTKRENDERINGVR_EXPORT VTK_MARSHALAUTO vtkVRInteractorStyle : public vtkInteractorStyle3D
{
public:
  vtkTypeMacro(vtkVRInteractorStyle, vtkInteractorStyle3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void OnSelect3D(vtkEventData* edata) override;
  void OnNextPose3D(vtkEventData* edata) override;
  void OnViewerMovement3D(vtkEventData* edata) override;
  void OnMove3D(vtkEventData* edata) override;
  void OnMenu3D(vtkEventData* edata) override;
  void OnElevation3D(vtkEventData* edata) override;


  virtual void StartPick(vtkEventDataDevice3D*);
  virtual void EndPick(vtkEventDataDevice3D*);
  virtual void StartLoadCamPose(vtkEventDataDevice3D*);
  virtual void EndLoadCamPose(vtkEventDataDevice3D*);
  virtual void StartPositionProp(vtkEventDataDevice3D*);
  virtual void EndPositionProp(vtkEventDataDevice3D*);
  virtual void StartClip(vtkEventDataDevice3D*);
  virtual void EndClip(vtkEventDataDevice3D*);
  virtual void StartMovement3D(int interactionState, vtkEventDataDevice3D*);
  virtual void EndMovement3D(vtkEventDataDevice3D*);


  void OnPan() override;
  void OnPinch() override;
  void OnRotate() override;


  void ProbeData(vtkEventDataDevice controller);
  void PositionProp(vtkEventData*, double* lwpos = nullptr, double* lwori = nullptr) override;
  void Clip(vtkEventDataDevice3D*);
  virtual void LoadNextCameraPose() = 0;

  void GroundMovement3D(vtkEventDataDevice3D*);

  void Elevation3D(vtkEventDataDevice3D*);

  void Teleportation3D(vtkEventDataDevice3D* edd);


  void MapInputToAction(vtkCommand::EventIds eid, int state);
  void MapInputToAction(vtkCommand::EventIds eid, vtkEventDataAction action, int state);
  int GetMappedAction(
    vtkCommand::EventIds eid, vtkEventDataAction action = vtkEventDataAction::Press);

  void AddTooltipForInput(
    vtkEventDataDevice device, vtkEventDataDeviceInput input, const std::string& text = {});

  virtual vtkVRControlsHelper* MakeControlsHelper() = 0;


  vtkSetMacro(HoverPick, bool);
  vtkGetMacro(HoverPick, bool);
  vtkBooleanMacro(HoverPick, bool);


  vtkSetMacro(GrabWithRay, bool);
  vtkGetMacro(GrabWithRay, bool);
  vtkBooleanMacro(GrabWithRay, bool);

  enum MovementStyle
  {
    FLY_STYLE,
    GROUNDED_STYLE
  };


  vtkSetMacro(Style, MovementStyle);
  vtkGetMacro(Style, MovementStyle);

  int GetInteractionState(vtkEventDataDevice device)
  {
    int deviceIndex = static_cast<int>(device);
    if (deviceIndex < 0 || deviceIndex >= vtkEventDataNumberOfDevices)
    {
      // Since VTKIS_*STATE* are expected to be >= VTKIS_NONE with VTKIS_NONE == 0,
      // return -1 if device is invalid.
      return -1;
    }
    return this->InteractionState[static_cast<int>(device)];
  }

  void SetInteractionState(vtkEventDataDevice device, int state);


  void ShowRay(vtkEventDataDevice controller);
  void HideRay(vtkEventDataDevice controller);


  void ShowBillboard(const std::string& text);
  void HideBillboard();

  void ShowPickSphere(double* pos, double radius, vtkProp3D*);

  void ShowPickCell(vtkCell* cell, vtkProp3D*);

  void HidePickActor();


  void ToggleDrawControls();
  void SetDrawControls(bool);

  void SetInteractor(vtkRenderWindowInteractor* iren) override;

  virtual void SetupActions(vtkRenderWindowInteractor* iren) = 0;

  vtkVRMenuWidget* GetMenu() { return this->Menu.Get(); }

protected:
  vtkVRInteractorStyle();
  ~vtkVRInteractorStyle() override;

  virtual void UpdateRay(vtkEventDataDevice controller);

  void EndPickCallback(vtkSelection* sel);
  static void MenuCallback(
    vtkObject* object, unsigned long event, void* clientdata, void* calldata);

  void StartAction(int VTKIS_STATE, vtkEventDataDevice3D* edata);
  void EndAction(int VTKIS_STATE, vtkEventDataDevice3D* edata);

  bool HardwareSelect(vtkEventDataDevice controller, bool actorPassOnly);

  void Movement3D(int interactionState, vtkEventData* edata);

  bool HoverPick = false;
  bool GrabWithRay = true;

  vtkNew<vtkVRMenuWidget> Menu;
  vtkNew<vtkVRMenuRepresentation> MenuRepresentation;
  vtkNew<vtkCallbackCommand> MenuCommand;

  vtkNew<vtkTextActor3D> TextActor3D;
  vtkNew<vtkActor> PickActor;
  vtkNew<vtkSphereSource> Sphere;
  vtkNew<vtkVRHardwarePicker> HardwarePicker;

  // Device input to interaction state mapping
  std::map<std::tuple<vtkCommand::EventIds, vtkEventDataAction>, int> InputMap;
  vtkVRControlsHelper* ControlsHelpers[vtkEventDataNumberOfDevices][vtkEventDataNumberOfInputs];

  // Store required controllers information when performing action
  int InteractionState[vtkEventDataNumberOfDevices];
  std::vector<vtkSmartPointer<vtkProp3D>> InteractionProps;
  std::vector<vtkSmartPointer<vtkPlane>> ClippingPlanes;

  // Store headset world orientation
  double HeadsetDir[3] = { 0, 0, 0 };

  // Store movement style
  MovementStyle Style = vtkVRInteractorStyle::FLY_STYLE;

  // Interaction timers
  vtkNew<vtkTimerLog> LastGroundMovement3DEventTime;
  vtkNew<vtkTimerLog> LastElevation3DEventTime;

  // Interaction trackpad position
  double LastGroundMovementTrackPadPosition[2] = { 0, 0 };
  double LastElevationTrackPadPosition[2] = { 0, 0 };

private:
  vtkVRInteractorStyle(const vtkVRInteractorStyle&) = delete;
  void operator=(const vtkVRInteractorStyle&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif