]> git.mxchange.org Git - flightgear.git/blobdiff - src/Input/input.hxx
throw an exception if not even a default joystick could be found;
[flightgear.git] / src / Input / input.hxx
index b63dac855a434c975a5c133026203a9824b8ca7f..faad8acdc2462eef1cbeffd87325306118055b87 100644 (file)
 #endif
 
 #include <plib/js.h>
+#include <plib/ul.h>
 
 #include <simgear/compiler.h>
 
-#include <simgear/misc/commands.hxx>
-#include <simgear/misc/props.hxx>
+#include <simgear/misc/sg_path.hxx>
+#include <simgear/structure/subsystem_mgr.hxx>
+#include <simgear/structure/commands.hxx>
+#include <simgear/props/condition.hxx>
+#include <simgear/props/props.hxx>
 
-#include <Main/fgfs.hxx>
+#include <Main/fg_os.hxx>
+#include <Main/fg_props.hxx>
 #include <Main/globals.hxx>
 
 #include <map>
 SG_USING_STD(map);
 SG_USING_STD(vector);
 
+
+\f
+
+#if defined( UL_WIN32 )
+#define TGT_PLATFORM   "windows"
+#elif defined ( UL_MAC_OSX )
+#define TGT_PLATFORM    "mac"
+#else
+#define TGT_PLATFORM   "unix"
+#endif
+
+
+\f
+////////////////////////////////////////////////////////////////////////
+// General binding support.
+////////////////////////////////////////////////////////////////////////
+
+
 /**
  * An input binding of some sort.
  *
@@ -51,7 +74,7 @@ SG_USING_STD(vector);
  * keyboard key, a joystick button or axis, or even a panel
  * instrument.</p>
  */
-class FGBinding
+class FGBinding : public SGConditional
 {
 public:
 
@@ -72,7 +95,7 @@ public:
   /**
    * Destructor.
    */
-  virtual ~FGBinding ();
+  virtual ~FGBinding () {}
 
 
   /**
@@ -115,6 +138,12 @@ public:
   virtual void fire () const;
 
 
+  /**
+   * Fire a binding with a scaled movement (rather than absolute position).
+   */
+  virtual void fire (double offset, double max) const;
+
+
   /**
    * Fire a binding with a setting (i.e. joystick axis).
    *
@@ -126,13 +155,22 @@ public:
 
 
 private:
-  void _fire (const SGPropertyNode *arg) const;
+                                // just to be safe.
+  FGBinding (const FGBinding &binding);
+
   string _command_name;
-  SGCommandMgr::command_t _command;
-  const SGPropertyNode * _arg;
+  mutable SGCommandMgr::command_t _command;
+  mutable SGPropertyNode_ptr _arg;
+  mutable SGPropertyNode_ptr _setting;
 };
 
 
+\f
+////////////////////////////////////////////////////////////////////////
+// General input mapping support.
+////////////////////////////////////////////////////////////////////////
+
+
 /**
  * Generic input module.
  *
@@ -140,74 +178,107 @@ private:
  * keyboard, joystick, mouse, or even panel switches -- in a consistent
  * way, and to allow users to rebind any of the actions at runtime.</p>
  */
-class FGInput : public FGSubsystem
+class FGInput : public SGSubsystem
 {
 public:
+  /**
+   * Default constructor.
+   */
+  FGInput ();
 
-  enum {
-    FG_MOD_NONE = 0,
-    FG_MOD_UP = 1,             // key- or button-up
-    FG_MOD_SHIFT = 2,
-    FG_MOD_CTRL = 4,
-    FG_MOD_ALT = 8,
-    FG_MOD_MAX = 16            // enough to handle all combinations
-  };
-
-  FGInput();
+  /**
+   * Destructor.
+   */
   virtual ~FGInput();
 
   //
-  // Implementation of FGSubsystem.
+  // Implementation of SGSubsystem.
   //
   virtual void init ();
-  virtual void bind ();
-  virtual void unbind ();
-  virtual void update ();
+  virtual void reinit ();
+  virtual void postinit ();
+  virtual void update (double dt);
+  virtual void suspend ();
+  virtual void resume ();
+  virtual bool is_suspended () const;
 
 
   /**
-   * Handle a single keystroke.
+   * Control whether this is the default module to receive events.
    *
-   * <p>Note: for special keys, the integer key code will be the Glut
-   * code + 256.</p>
+   * The first input module created will set itself as the default
+   * automatically.
+   *
+   * @param status true if this should be the default module for
+   * events, false otherwise.
+   */
+  virtual void makeDefault (bool status = true);
+
+
+  /**
+   * Handle a single keystroke.
    *
-   * @param k The integer key code, as returned by glut.
+   * @param k The integer key code, see Main/fg_os.hxx
    * @param modifiers Modifier keys pressed (bitfield).
    * @param x The mouse x position at the time of keypress.
    * @param y The mouse y position at the time of keypress.
-   * @see #FG_MOD_SHIFT
-   * @see #FG_MOD_CTRL
-   * @see #FG_MOD_ALT
    */
   virtual void doKey (int k, int modifiers, int x, int y);
 
 
-private:
+  /**
+   * Handle a mouse click event.
+   *
+   * @param button The mouse button selected.
+   * @param updown Button status.
+   * @param x The X position of the mouse event, in screen coordinates.
+   * @param y The Y position of the mouse event, in screen coordinates.
+   */
+  virtual void doMouseClick (int button, int updown, int x, int y);
+
+
+  /**
+   * Handle mouse motion.
+   *
+   * @param x The new mouse x position, in screen coordinates.
+   * @param y The new mouse y position, in screen coordinates.
+   */
+  virtual void doMouseMotion (int x, int y);
 
-  typedef vector<FGBinding> binding_list_t;
 
+private:
                                // Constants
-  static const int MAX_KEYS = 1024;
+  enum 
+  {
+    MAX_KEYS = 1024,
+
   #ifdef WIN32
-  static const int MAX_JOYSTICKS = 2;
+    MAX_JOYSTICKS = 2,
   #else
-  static const int MAX_JOYSTICKS = 10;
+    MAX_JOYSTICKS = 10,
   #endif
-  static const int MAX_AXES = _JS_MAX_AXES;
-  static const int MAX_BUTTONS = 32;
+    MAX_JOYSTICK_AXES = _JS_MAX_AXES,
+    MAX_JOYSTICK_BUTTONS = 32,
 
+    MAX_MICE = 1,
+    MAX_MOUSE_BUTTONS = 8
+  };
+  struct mouse;
+  friend struct mouse;
+
+  typedef vector<FGBinding *> binding_list_t;
 
   /**
    * Settings for a key or button.
    */
   struct button {
-    button ()
-      : is_repeatable(false),
-       last_state(-1)
-    {}
+    button ();
+    virtual ~button ();
     bool is_repeatable;
+    float interval_sec;
+    float last_dt;
     int last_state;
-    binding_list_t bindings[FG_MOD_MAX];
+    binding_list_t bindings[KEYMOD_MAX];
   };
 
 
@@ -215,13 +286,17 @@ private:
    * Settings for a single joystick axis.
    */
   struct axis {
-    axis ()
-      : last_value(9999999),
-       tolerance(0.002)
-    {}
+    axis ();
+    virtual ~axis ();
     float last_value;
     float tolerance;
-    binding_list_t bindings[FG_MOD_MAX];
+    binding_list_t bindings[KEYMOD_MAX];
+    float low_threshold;
+    float high_threshold;
+    struct button low;
+    struct button high;
+    float interval_sec;
+    double last_dt;
   };
 
 
@@ -229,19 +304,51 @@ private:
    * Settings for a joystick.
    */
   struct joystick {
-    virtual ~joystick () {
-      delete js;
-      delete[] axes;
-      delete[] buttons;
-    }
+    joystick ();
+    virtual ~joystick ();
+    int jsnum;
+    jsJoystick * js;
     int naxes;
     int nbuttons;
-    jsJoystick * js;
     axis * axes;
     button * buttons;
   };
 
 
+  /**
+   * Settings for a mouse mode.
+   */
+  struct mouse_mode {
+    mouse_mode ();
+    virtual ~mouse_mode ();
+    int cursor;
+    bool constrained;
+    bool pass_through;
+    button * buttons;
+    binding_list_t x_bindings[KEYMOD_MAX];
+    binding_list_t y_bindings[KEYMOD_MAX];
+  };
+
+
+  /**
+   * Settings for a mouse.
+   */
+  struct mouse {
+    mouse ();
+    virtual ~mouse ();
+    int x;
+    int y;
+    SGPropertyNode * mode_node;
+    SGPropertyNode * mouse_button_nodes[MAX_MOUSE_BUTTONS];
+    int nModes;
+    int current_mode;
+    double timeout;
+    int save_x;
+    int save_y;
+    mouse_mode * modes;
+  };
+
+
   /**
    * Initialize key bindings.
    */
@@ -254,6 +361,32 @@ private:
   void _init_joystick ();
 
 
+  /**
+   * Scan directory recursively for "named joystick" configuration files,
+   * and read them into /input/joysticks/js-named[index]++.
+   */
+  void _scan_joystick_dir (SGPath *path, SGPropertyNode* node, int *index);
+
+
+  /**
+   * Initialize mouse bindings.
+   */
+  void _init_mouse ();
+
+
+  /**
+   * Initialize a single button.
+   */
+  inline void _init_button (const SGPropertyNode * node,
+                           button &b,
+                           const string name);
+
+  /**
+   * Initialize nasal parts that had to wait for the nasal to get
+   * functional.
+   */
+  void _postinit_joystick ();
+
   /**
    * Update the keyboard.
    */
@@ -263,7 +396,20 @@ private:
   /**
    * Update the joystick.
    */
-  void _update_joystick ();
+  void _update_joystick (double dt);
+
+
+  /**
+   * Update the mouse.
+   */
+  void _update_mouse (double dt);
+
+
+  /**
+   * Update a single button.
+   */
+  inline void _update_button (button &b, int modifiers, bool pressed,
+                             int x, int y);
 
 
   /**
@@ -276,19 +422,13 @@ private:
   /**
    * Look up the bindings for a key code.
    */
-  const vector<FGBinding> &_find_key_bindings (unsigned int k, int modifiers);
+  const vector<FGBinding *> &_find_key_bindings (unsigned int k,
+                                                int modifiers);
 
   button _key_bindings[MAX_KEYS];
   joystick _joystick_bindings[MAX_JOYSTICKS];
+  mouse _mouse_bindings[MAX_MICE];
 
 };
 
-// Handle keyboard events
-void GLUTkey(unsigned char k, int x, int y);
-void GLUTkeyup(unsigned char k, int x, int y);
-void GLUTspecialkey(int k, int x, int y);
-void GLUTspecialkeyup(int k, int x, int y);
-
-extern FGInput current_input;
-
-#endif // _CONTROLS_HXX
+#endif // _INPUT_HXX