GHOST_NDOFManager.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2002-2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#ifndef WITH_INPUT_NDOF
#  error NDOF code included in non-NDOF-enabled build
#endif
 
#include "GHOST_System.hh"
 
#include <array>
 
enum NDOF_DeviceT {
  NDOF_UnknownDevice = 0,
 
  /* Current devices. */
  NDOF_SpaceNavigator,
  NDOF_SpaceExplorer,
  NDOF_SpacePilotPro,
  NDOF_SpaceMousePro,
  NDOF_SpaceMouseWireless,
  NDOF_SpaceMouseProWireless,
  NDOF_SpaceMouseEnterprise,
  NDOF_KeyboardPro,
  NDOF_NumpadPro,
 
  /* Older devices. */
  NDOF_SpacePilot,
  NDOF_Spaceball5000,
  NDOF_SpaceTraveler
 
};

#define NDOF_TIME_DELTA_STARTING 0.0125f
 
using NDOF_Button_Array = std::array<GHOST_NDOF_ButtonT, 6>;
 
enum NDOF_Button_Type { ShortButton, LongButton };
 
class GHOST_NDOFManager {
 public:
  GHOST_NDOFManager(GHOST_System &);
  virtual ~GHOST_NDOFManager() = default;

  virtual bool available() = 0;

  bool setDevice(unsigned short vendor_id, unsigned short product_id);

  void setDeadZone(float);

  void updateTranslation(const int t[3], uint64_t time);
  void updateRotation(const int r[3], uint64_t time);

  void updateButtonRAW(int button_number, bool press, uint64_t time);
  void updateButton(GHOST_NDOF_ButtonT button, bool press, uint64_t time);
  void updateButtonsBitmask(int button_bits, uint64_t time);
  void updateButtonsArray(NDOF_Button_Array buttons, uint64_t time, NDOF_Button_Type type);
  /* #NDOFButton events are sent immediately */

  bool sendMotionEvent();
 
 protected:
  GHOST_System &system_;
 
 private:
  void sendButtonEvent(GHOST_NDOF_ButtonT, bool press, uint64_t time, GHOST_IWindow *);
  void sendKeyEvent(GHOST_TKey, bool press, uint64_t time, GHOST_IWindow *);
 
  NDOF_DeviceT device_type_;
  int hid_map_button_num_;
  int hid_map_button_mask_;
  const GHOST_NDOF_ButtonT *hid_map_;
 
  int translation_[3];
  int rotation_[3];
 
  int button_depressed_; /* Bit field. */
  NDOF_Button_Array pressed_buttons_cache_;
  NDOF_Button_Array pressed_long_buttons_cache_;
 
  uint64_t motion_time_;      /* In milliseconds. */
  uint64_t motion_time_prev_; /* Time of most recent motion event sent. */
 
  GHOST_TProgress motion_state_;
  bool motion_event_pending_;
  float motion_dead_zone_; /* Discard motion with each component < this. */
 
  inline static std::array<NDOF_DeviceT, 9> bitmask_devices_ = {
      NDOF_SpaceNavigator,
      NDOF_SpaceExplorer,
      NDOF_SpacePilotPro,
      NDOF_SpaceMousePro,
      NDOF_SpaceMouseWireless,
      NDOF_SpaceMouseProWireless,
      NDOF_SpacePilot,
      NDOF_Spaceball5000,
      NDOF_SpaceTraveler,
  };
};