vtkVRRenderWindowInteractor.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 vtkVRRenderWindowInteractor_h
#define vtkVRRenderWindowInteractor_h

#include "vtkEventData.h" // for ivar
#include "vtkNew.h"       // for ivar
#include "vtkRenderWindowInteractor3D.h"
#include "vtkRenderingVRModule.h" // for export macro
#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO

#include <string> // for ivar

VTK_ABI_NAMESPACE_BEGIN
class vtkMatrix4x4;
class vtkVRRenderWindow;

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

  void Initialize() override;

  void ProcessEvents() override;

  virtual void DoOneEvent(vtkVRRenderWindow* renWin, vtkRenderer* ren) = 0;


  static void SetClassExitMethod(void (*f)(void*), void* arg);
  static void SetClassExitMethodArgDelete(void (*f)(void*));

  void ExitCallback() override;


  void SetPhysicalViewDirection(double, double, double) override;
  double* GetPhysicalViewDirection() override;


  void SetPhysicalViewUp(double, double, double) override;
  double* GetPhysicalViewUp() override;


  void SetPhysicalTranslation(vtkCamera*, double, double, double) override;
  double* GetPhysicalTranslation(vtkCamera*) override;


  void SetPhysicalScale(double) override;
  double GetPhysicalScale() override;

  /*
   * Return the pointer index as a device.
   */
  vtkEventDataDevice GetPointerDevice();

  /*
   * Convert a device pose to a world coordinate position and orientation.
   * \param pos  Output world position
   * \param wxyz Output world orientation quaternion
   * \param ppos Output physical position
   * \param wdir Output world view direction (-Z)
   */
  void ConvertPoseToWorldCoordinates(vtkMatrix4x4* poseInTrackingCoordinates, double pos[3],
    double wxyz[4], double ppos[3], double wdir[3]);


  virtual void AddAction(const std::string& path, const vtkCommand::EventIds&, bool isAnalog) = 0;
  virtual void AddAction(
    const std::string& path, bool isAnalog, const std::function<void(vtkEventData*)>&) = 0;


  vtkGetMacro(ActionManifestFileName, std::string);
  vtkSetMacro(ActionManifestFileName, std::string);


  vtkGetMacro(ActionManifestDirectory, std::string);
  vtkSetMacro(ActionManifestDirectory, std::string);


  vtkGetMacro(ActionSetName, std::string);
  vtkSetMacro(ActionSetName, std::string);


  virtual void HandleComplexGestureEvents(vtkEventData* ed);
  virtual void RecognizeComplexGesture(vtkEventDataDevice3D* edata);


  int GetDeviceInputDownCount(vtkEventDataDevice device) const;


  void SetDeviceInputDownCount(vtkEventDataDevice device, int count);

protected:
  vtkVRRenderWindowInteractor();
  ~vtkVRRenderWindowInteractor() override;


  int InternalCreateTimer(int timerId, int timerType, unsigned long duration) override;
  int InternalDestroyTimer(int platformTimerId) override;

  void StartEventLoop() override;


  static void (*ClassExitMethod)(void*);
  static void (*ClassExitMethodArgDelete)(void*);
  static void* ClassExitMethodArg;

  int DeviceInputDownCount[vtkEventDataNumberOfDevices];

  std::string ActionManifestFileName;
  std::string ActionManifestDirectory;

  std::string ActionSetName;

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

VTK_ABI_NAMESPACE_END
#endif