]> git.mxchange.org Git - flightgear.git/blobdiff - src/Input/input.hxx
add <mod-meta> and <mod-super> XML elements for key bindings
[flightgear.git] / src / Input / input.hxx
index bc7bb55c42bea973096520101eae86a7f6cc47ae..eef9e243457e90f8962c4993a7c291012893c0a3 100644 (file)
@@ -16,7 +16,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
 #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/SGBinding.hxx>
+#include <simgear/props/condition.hxx>
+#include <simgear/props/props.hxx>
+#include <simgear/scene/util/SGSceneUserData.hxx>
 
-#include <Main/fgfs.hxx>
+#include <Main/fg_os.hxx>
+#include <Main/fg_props.hxx>
 #include <Main/globals.hxx>
 
 #include <map>
+#include <list>
 #include <vector>
 
 SG_USING_STD(map);
 SG_USING_STD(vector);
 
-/**
- * An input binding of some sort.
- *
- * <p>This class represents a binding that can be assigned to a
- * keyboard key, a joystick button or axis, or even a panel
- * instrument.</p>
- */
-class FGBinding
-{
-public:
-
-  /**
-   * Default constructor.
-   */
-  FGBinding ();
-
-
-  /**
-   * Convenience constructor.
-   *
-   * @param node The binding will be built from this node.
-   */
-  FGBinding (const SGPropertyNode * node);
 
+\f
 
-  /**
-   * Destructor.
-   */
-  virtual ~FGBinding ();
-
-
-  /**
-   * Get the command name.
-   *
-   * @return The string name of the command for this binding.
-   */
-  virtual const string &getCommandName () const { return _command_name; }
-
-
-  /**
-   * Get the command itself.
-   *
-   * @return The command associated with this binding, or 0 if none
-   * is present.
-   */
-  virtual SGCommandMgr::command_t getCommand () const { return _command; }
-
-
-  /**
-   * Get the argument that will be passed to the command.
-   *
-   * @return A property node that will be passed to the command as its
-   * argument, or 0 if none was supplied.
-   */
-  virtual const SGPropertyNode * getArg () { return _arg; }
-  
-
-  /**
-   * Read a binding from a property node.
-   *
-   * @param node The property node containing the binding.
-   */
-  virtual void read (const SGPropertyNode * node);
-
-
-  /**
-   * Fire a binding.
-   */
-  virtual void fire () const;
-
-
-  /**
-   * Fire a binding with a setting (i.e. joystick axis).
-   *
-   * A double 'setting' property will be added to the arguments.
-   *
-   * @param setting The input setting, usually between -1.0 and 1.0.
-   */
-  virtual void fire (double setting) const;
+#if defined( UL_WIN32 )
+#define TGT_PLATFORM   "windows"
+#elif defined ( UL_MAC_OSX )
+#define TGT_PLATFORM    "mac"
+#else
+#define TGT_PLATFORM   "unix"
+#endif
 
 
-private:
-  void _fire (const SGPropertyNode *arg) const;
-  string _command_name;
-  SGCommandMgr::command_t _command;
-  const SGPropertyNode * _arg;
-};
+\f
+////////////////////////////////////////////////////////////////////////
+// General input mapping support.
+////////////////////////////////////////////////////////////////////////
 
 
 /**
@@ -140,78 +76,104 @@ 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 reinit ();
+  virtual void postinit ();
   virtual void bind ();
   virtual void unbind ();
-  virtual void update ();
+  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.
+   *
+   * The first input module created will set itself as the default
+   * automatically.
    *
-   * <p>Note: for special keys, the integer key code will be the Glut
-   * code + 256.</p>
+   * @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, bool mainWindow, const osgGA::GUIEventAdapter*);
+
 
+  /**
+   * 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);
+
+
+private:
                                // Constants
   enum 
   {
     MAX_KEYS = 1024,
-
-  #ifdef WIN32
-    MAX_JOYSTICKS = 2,
-  #else
     MAX_JOYSTICKS = 10,
-  #endif
-    MAX_AXES = _JS_MAX_AXES,
-    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;
+  typedef vector<SGSharedPtr<SGBinding> > 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];
   };
 
 
@@ -219,19 +181,17 @@ private:
    * Settings for a single joystick axis.
    */
   struct axis {
-    axis ()
-      : last_value(9999999),
-       tolerance(0.002),
-       low_threshold(-0.9),
-       high_threshold(0.9)
-    {}
+    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;
   };
 
 
@@ -239,23 +199,49 @@ 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;
   };
 
 
   /**
-   * Initialize key bindings.
+   * 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.
    */
-  void _init_keyboard ();
+  struct mouse {
+    mouse ();
+    virtual ~mouse ();
+    int x;
+    int y;
+    SGPropertyNode_ptr mode_node;
+    SGPropertyNode_ptr mouse_button_nodes[MAX_MOUSE_BUTTONS];
+    int nModes;
+    int current_mode;
+    double timeout;
+    int save_x;
+    int save_y;
+    mouse_mode * modes;
+  };
 
 
   /**
@@ -264,6 +250,19 @@ 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.
    */
@@ -271,6 +270,12 @@ private:
                            button &b,
                            const string name);
 
+  /**
+   * Initialize key bindings, as well as those joystick parts that
+   * depend on a working Nasal subsystem.
+   */
+  void _postinit_keyboard ();
+  void _postinit_joystick ();
 
   /**
    * Update the keyboard.
@@ -281,13 +286,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);
+  inline void _update_button (button &b, int modifiers, bool pressed,
+                             int x, int y);
 
 
   /**
@@ -300,19 +312,35 @@ private:
   /**
    * Look up the bindings for a key code.
    */
-  const vector<FGBinding> &_find_key_bindings (unsigned int k, int modifiers);
+  const binding_list_t& _find_key_bindings (unsigned int k,
+                                            int modifiers);
 
   button _key_bindings[MAX_KEYS];
   joystick _joystick_bindings[MAX_JOYSTICKS];
+  mouse _mouse_bindings[MAX_MICE];
 
-};
+  /**
+   * Nasal module name/namespace.
+   */
+  string _module;
 
-// 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);
+  /**
+   * List of currently pressed mouse button events
+   */
+  std::map<int, std::list<SGSharedPtr<SGPickCallback> > > _activePickCallbacks;
 
-extern FGInput current_input;
+  /**
+   * Key listener interface.
+   */
+  SGPropertyNode_ptr _key_event;
+  int  _key_code;
+  int  _key_modifiers;
+  bool _key_pressed;
+  bool _key_shift;
+  bool _key_ctrl;
+  bool _key_alt;
+  bool _key_meta;
+  bool _key_super;
+};
 
-#endif // _CONTROLS_HXX
+#endif // _INPUT_HXX