src/Input/input.hxx

   1 // input.hxx -- handle user input from various sources.
   2 //
   3 // Written by David Megginson, started May 2001.
   4 //
   5 // Copyright (C) 2001 David Megginson, david@megginson.com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _INPUT_HXX
  25 #define _INPUT_HXX
  26
  27 #ifndef __cplusplus
  28 # error This library requires C++
  29 #endif
  30
  31 #include <plib/js.h>
  32
  33 #include <simgear/compiler.h>
  34
  35 #include <simgear/misc/commands.hxx>
  36 #include <simgear/misc/props.hxx>
  37
  38 #include <Main/fgfs.hxx>
  39 #include <Main/globals.hxx>
  40
  41 #include <map>
  42 #include <vector>
  43
  44 SG_USING_STD(map);
  45 SG_USING_STD(vector);
  46
  47
  48 \f
  49 ////////////////////////////////////////////////////////////////////////
  50 // General binding support.
  51 ////////////////////////////////////////////////////////////////////////
  52
  53
  54 /**
  55  * An input binding of some sort.
  56  *
  57  * <p>This class represents a binding that can be assigned to a
  58  * keyboard key, a joystick button or axis, or even a panel
  59  * instrument.</p>
  60  */
  61 class FGBinding : public FGConditional
  62 {
  63 public:
  64
  65   /**
  66    * Default constructor.
  67    */
  68   FGBinding ();
  69
  70
  71   /**
  72    * Convenience constructor.
  73    *
  74    * @param node The binding will be built from this node.
  75    */
  76   FGBinding (const SGPropertyNode * node);
  77
  78
  79   /**
  80    * Destructor.
  81    */
  82   virtual ~FGBinding ();
  83
  84
  85   /**
  86    * Get the command name.
  87    *
  88    * @return The string name of the command for this binding.
  89    */
  90   virtual const string &getCommandName () const { return _command_name; }
  91
  92
  93   /**
  94    * Get the command itself.
  95    *
  96    * @return The command associated with this binding, or 0 if none
  97    * is present.
  98    */
  99   virtual SGCommandMgr::command_t getCommand () const { return _command; }
 100
 101
 102   /**
 103    * Get the argument that will be passed to the command.
 104    *
 105    * @return A property node that will be passed to the command as its
 106    * argument, or 0 if none was supplied.
 107    */
 108   virtual const SGPropertyNode * getArg () { return _arg; }
 109
 110
 111   /**
 112    * Read a binding from a property node.
 113    *
 114    * @param node The property node containing the binding.
 115    */
 116   virtual void read (const SGPropertyNode * node);
 117
 118
 119   /**
 120    * Fire a binding.
 121    */
 122   virtual void fire () const;
 123
 124
 125   /**
 126    * Fire a binding with a scaled movement (rather than absolute position).
 127    */
 128   virtual void fire (double offset, double max) const;
 129
 130
 131   /**
 132    * Fire a binding with a setting (i.e. joystick axis).
 133    *
 134    * A double 'setting' property will be added to the arguments.
 135    *
 136    * @param setting The input setting, usually between -1.0 and 1.0.
 137    */
 138   virtual void fire (double setting) const;
 139
 140
 141 private:
 142   string _command_name;
 143   SGCommandMgr::command_t _command;
 144   mutable SGPropertyNode * _arg;
 145   mutable SGPropertyNode * _setting;
 146   mutable SGCommandState * _command_state;
 147 };
 148
 149
 150 \f
 151 ////////////////////////////////////////////////////////////////////////
 152 // General input mapping support.
 153 ////////////////////////////////////////////////////////////////////////
 154
 155
 156 /**
 157  * Generic input module.
 158  *
 159  * <p>This module is designed to handle input from multiple sources --
 160  * keyboard, joystick, mouse, or even panel switches -- in a consistent
 161  * way, and to allow users to rebind any of the actions at runtime.</p>
 162  */
 163 class FGInput : public FGSubsystem
 164 {
 165 public:
 166
 167   enum {
 168     FG_MOD_NONE = 0,
 169     FG_MOD_UP = 1,              // key- or button-up
 170     FG_MOD_SHIFT = 2,
 171     FG_MOD_CTRL = 4,
 172     FG_MOD_ALT = 8,
 173     FG_MOD_MAX = 16             // enough to handle all combinations
 174   };
 175
 176
 177   /**
 178    * Default constructor.
 179    */
 180   FGInput ();
 181
 182
 183   /**
 184    * Destructor.
 185    */
 186   virtual ~FGInput();
 187
 188   //
 189   // Implementation of FGSubsystem.
 190   //
 191   virtual void init ();
 192   virtual void bind ();
 193   virtual void unbind ();
 194   virtual void update (double dt);
 195
 196
 197   /**
 198    * Handle a single keystroke.
 199    *
 200    * <p>Note: for special keys, the integer key code will be the Glut
 201    * code + 256.</p>
 202    *
 203    * @param k The integer key code, as returned by glut.
 204    * @param modifiers Modifier keys pressed (bitfield).
 205    * @param x The mouse x position at the time of keypress.
 206    * @param y The mouse y position at the time of keypress.
 207    * @see #FG_MOD_SHIFT
 208    * @see #FG_MOD_CTRL
 209    * @see #FG_MOD_ALT
 210    */
 211   virtual void doKey (int k, int modifiers, int x, int y);
 212
 213
 214   /**
 215    * Handle a mouse click event.
 216    *
 217    * @param button The mouse button selected.
 218    * @param updown Button status.
 219    * @param x The X position of the mouse event, in screen coordinates.
 220    * @param y The Y position of the mouse event, in screen coordinates.
 221    */
 222   virtual void doMouseClick (int button, int updown, int x, int y);
 223
 224
 225   /**
 226    * Handle mouse motion.
 227    *
 228    * @param x The new mouse x position, in screen coordinates.
 229    * @param y The new mouse y position, in screen coordinates.
 230    */
 231   virtual void doMouseMotion (int x, int y);
 232
 233
 234 private:
 235                                 // Constants
 236   enum
 237   {
 238     MAX_KEYS = 1024,
 239
 240   #ifdef WIN32
 241     MAX_JOYSTICKS = 2,
 242   #else
 243     MAX_JOYSTICKS = 10,
 244   #endif
 245     MAX_JOYSTICK_AXES = _JS_MAX_AXES,
 246     MAX_JOYSTICK_BUTTONS = 32,
 247
 248     MAX_MICE = 1,
 249     MAX_MOUSE_BUTTONS = 8
 250   };
 251   struct mouse;
 252   friend struct mouse;
 253
 254   typedef vector<FGBinding *> binding_list_t;
 255
 256   /**
 257    * Settings for a key or button.
 258    */
 259   struct button {
 260     button ();
 261     virtual ~button ();
 262     bool is_repeatable;
 263     int last_state;
 264     binding_list_t bindings[FG_MOD_MAX];
 265   };
 266
 267
 268   /**
 269    * Settings for a single joystick axis.
 270    */
 271   struct axis {
 272     axis ();
 273     virtual ~axis ();
 274     float last_value;
 275     float tolerance;
 276     binding_list_t bindings[FG_MOD_MAX];
 277     float low_threshold;
 278     float high_threshold;
 279     struct button low;
 280     struct button high;
 281   };
 282
 283
 284   /**
 285    * Settings for a joystick.
 286    */
 287   struct joystick {
 288     joystick ();
 289     virtual ~joystick ();
 290     int jsnum;
 291     jsJoystick * js;
 292     int naxes;
 293     int nbuttons;
 294     axis * axes;
 295     button * buttons;
 296   };
 297
 298
 299   /**
 300    * Settings for a mouse mode.
 301    */
 302   struct mouse_mode {
 303     mouse_mode ();
 304     virtual ~mouse_mode ();
 305     int cursor;
 306     bool constrained;
 307     bool pass_through;
 308     button * buttons;
 309     binding_list_t x_bindings[FG_MOD_MAX];
 310     binding_list_t y_bindings[FG_MOD_MAX];
 311   };
 312
 313
 314   /**
 315    * Settings for a mouse.
 316    */
 317   struct mouse {
 318     mouse ();
 319     virtual ~mouse ();
 320     int x;
 321     int y;
 322     SGPropertyNode * mode_node;
 323     SGPropertyNode * mouse_button_nodes[MAX_MOUSE_BUTTONS];
 324     int nModes;
 325     int current_mode;
 326     mouse_mode * modes;
 327   };
 328
 329
 330   /**
 331    * Initialize key bindings.
 332    */
 333   void _init_keyboard ();
 334
 335
 336   /**
 337    * Initialize joystick bindings.
 338    */
 339   void _init_joystick ();
 340
 341
 342   /**
 343    * Initialize mouse bindings.
 344    */
 345   void _init_mouse ();
 346
 347
 348   /**
 349    * Initialize a single button.
 350    */
 351   inline void _init_button (const SGPropertyNode * node,
 352                             button &b,
 353                             const string name);
 354
 355
 356   /**
 357    * Update the keyboard.
 358    */
 359   void _update_keyboard ();
 360
 361
 362   /**
 363    * Update the joystick.
 364    */
 365   void _update_joystick ();
 366
 367
 368   /**
 369    * Update the mouse.
 370    */
 371   void _update_mouse ();
 372
 373
 374   /**
 375    * Update a single button.
 376    */
 377   inline void _update_button (button &b, int modifiers, bool pressed,
 378                               int x, int y);
 379
 380
 381   /**
 382    * Read bindings and modifiers.
 383    */
 384   void _read_bindings (const SGPropertyNode * node,
 385                        binding_list_t * binding_list,
 386                        int modifiers);
 387
 388   /**
 389    * Look up the bindings for a key code.
 390    */
 391   const vector<FGBinding *> &_find_key_bindings (unsigned int k,
 392                                                  int modifiers);
 393
 394   button _key_bindings[MAX_KEYS];
 395   joystick _joystick_bindings[MAX_JOYSTICKS];
 396   mouse _mouse_bindings[MAX_MICE];
 397
 398 };
 399
 400
 401 extern FGInput current_input;
 402
 403
 404 \f
 405 ////////////////////////////////////////////////////////////////////////
 406 // GLUT callbacks.
 407 ////////////////////////////////////////////////////////////////////////
 408
 409 // Handle GLUT events.
 410 extern "C" {
 411
 412 /**
 413  * Key-down event handler for Glut.
 414  *
 415  * <p>Pass the value on to the FGInput module unless PUI wants it.</p>
 416  *
 417  * @param k The integer value for the key pressed.
 418  * @param x (unused)
 419  * @param y (unused)
 420  */
 421 void GLUTkey (unsigned char k, int x, int y);
 422
 423
 424 /**
 425  * Key-up event handler for GLUT.
 426  *
 427  * <p>PUI doesn't use this, so always pass it to the input manager.</p>
 428  *
 429  * @param k The integer value for the key pressed.
 430  * @param x (unused)
 431  * @param y (unused)
 432  */
 433 void GLUTkeyup (unsigned char k, int x, int y);
 434
 435
 436 /**
 437  * Special key-down handler for Glut.
 438  *
 439  * <p>Pass the value on to the FGInput module unless PUI wants it.
 440  * The key value will have 256 added to it.</p>
 441  *
 442  * @param k The integer value for the key pressed (will have 256 added
 443  * to it).
 444  * @param x (unused)
 445  * @param y (unused)
 446  */
 447 void GLUTspecialkey (int k, int x, int y);
 448
 449
 450 /**
 451  * Special key-up handler for Glut.
 452  *
 453  * @param k The integer value for the key pressed (will have 256 added
 454  * to it).
 455  * @param x (unused)
 456  * @param y (unused)
 457  */
 458 void GLUTspecialkeyup (int k, int x, int y);
 459
 460
 461 /**
 462  * Mouse click handler for Glut.
 463  *
 464  * @param button The mouse button pressed.
 465  * @param updown Press or release flag.
 466  * @param x The x-location of the click.
 467  * @param y The y-location of the click.
 468  */
 469 void GLUTmouse (int button, int updown, int x, int y);
 470
 471
 472 /**
 473  * Mouse motion handler for Glut.
 474  *
 475  * @param x The new x-location of the mouse.
 476  * @param y The new y-location of the mouse.
 477  */
 478 void GLUTmotion (int x, int y);
 479
 480 } // extern "C"
 481
 482 #endif // _INPUT_HXX