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