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    * Control whether this is the default module to receive events.
 199    *
 200    * The first input module created will set itself as the default
 201    * automatically.
 202    *
 203    * @param status true if this should be the default module for
 204    * events, false otherwise.
 205    */
 206   virtual void makeDefault (bool status = true);
 207
 208
 209   /**
 210    * Handle a single keystroke.
 211    *
 212    * <p>Note: for special keys, the integer key code will be the Glut
 213    * code + 256.</p>
 214    *
 215    * @param k The integer key code, as returned by glut.
 216    * @param modifiers Modifier keys pressed (bitfield).
 217    * @param x The mouse x position at the time of keypress.
 218    * @param y The mouse y position at the time of keypress.
 219    * @see #FG_MOD_SHIFT
 220    * @see #FG_MOD_CTRL
 221    * @see #FG_MOD_ALT
 222    */
 223   virtual void doKey (int k, int modifiers, int x, int y);
 224
 225
 226   /**
 227    * Handle a mouse click event.
 228    *
 229    * @param button The mouse button selected.
 230    * @param updown Button status.
 231    * @param x The X position of the mouse event, in screen coordinates.
 232    * @param y The Y position of the mouse event, in screen coordinates.
 233    */
 234   virtual void doMouseClick (int button, int updown, int x, int y);
 235
 236
 237   /**
 238    * Handle mouse motion.
 239    *
 240    * @param x The new mouse x position, in screen coordinates.
 241    * @param y The new mouse y position, in screen coordinates.
 242    */
 243   virtual void doMouseMotion (int x, int y);
 244
 245
 246 private:
 247                                 // Constants
 248   enum
 249   {
 250     MAX_KEYS = 1024,
 251
 252   #ifdef WIN32
 253     MAX_JOYSTICKS = 2,
 254   #else
 255     MAX_JOYSTICKS = 10,
 256   #endif
 257     MAX_JOYSTICK_AXES = _JS_MAX_AXES,
 258     MAX_JOYSTICK_BUTTONS = 32,
 259
 260     MAX_MICE = 1,
 261     MAX_MOUSE_BUTTONS = 8
 262   };
 263   struct mouse;
 264   friend struct mouse;
 265
 266   typedef vector<FGBinding *> binding_list_t;
 267
 268   /**
 269    * Settings for a key or button.
 270    */
 271   struct button {
 272     button ();
 273     virtual ~button ();
 274     bool is_repeatable;
 275     int last_state;
 276     binding_list_t bindings[FG_MOD_MAX];
 277   };
 278
 279
 280   /**
 281    * Settings for a single joystick axis.
 282    */
 283   struct axis {
 284     axis ();
 285     virtual ~axis ();
 286     float last_value;
 287     float tolerance;
 288     binding_list_t bindings[FG_MOD_MAX];
 289     float low_threshold;
 290     float high_threshold;
 291     struct button low;
 292     struct button high;
 293   };
 294
 295
 296   /**
 297    * Settings for a joystick.
 298    */
 299   struct joystick {
 300     joystick ();
 301     virtual ~joystick ();
 302     int jsnum;
 303     jsJoystick * js;
 304     int naxes;
 305     int nbuttons;
 306     axis * axes;
 307     button * buttons;
 308   };
 309
 310
 311   /**
 312    * Settings for a mouse mode.
 313    */
 314   struct mouse_mode {
 315     mouse_mode ();
 316     virtual ~mouse_mode ();
 317     int cursor;
 318     bool constrained;
 319     bool pass_through;
 320     button * buttons;
 321     binding_list_t x_bindings[FG_MOD_MAX];
 322     binding_list_t y_bindings[FG_MOD_MAX];
 323   };
 324
 325
 326   /**
 327    * Settings for a mouse.
 328    */
 329   struct mouse {
 330     mouse ();
 331     virtual ~mouse ();
 332     int x;
 333     int y;
 334     SGPropertyNode * mode_node;
 335     SGPropertyNode * mouse_button_nodes[MAX_MOUSE_BUTTONS];
 336     int nModes;
 337     int current_mode;
 338     mouse_mode * modes;
 339   };
 340
 341
 342   /**
 343    * Initialize key bindings.
 344    */
 345   void _init_keyboard ();
 346
 347
 348   /**
 349    * Initialize joystick bindings.
 350    */
 351   void _init_joystick ();
 352
 353
 354   /**
 355    * Initialize mouse bindings.
 356    */
 357   void _init_mouse ();
 358
 359
 360   /**
 361    * Initialize a single button.
 362    */
 363   inline void _init_button (const SGPropertyNode * node,
 364                             button &b,
 365                             const string name);
 366
 367
 368   /**
 369    * Update the keyboard.
 370    */
 371   void _update_keyboard ();
 372
 373
 374   /**
 375    * Update the joystick.
 376    */
 377   void _update_joystick ();
 378
 379
 380   /**
 381    * Update the mouse.
 382    */
 383   void _update_mouse ();
 384
 385
 386   /**
 387    * Update a single button.
 388    */
 389   inline void _update_button (button &b, int modifiers, bool pressed,
 390                               int x, int y);
 391
 392
 393   /**
 394    * Read bindings and modifiers.
 395    */
 396   void _read_bindings (const SGPropertyNode * node,
 397                        binding_list_t * binding_list,
 398                        int modifiers);
 399
 400   /**
 401    * Look up the bindings for a key code.
 402    */
 403   const vector<FGBinding *> &_find_key_bindings (unsigned int k,
 404                                                  int modifiers);
 405
 406   button _key_bindings[MAX_KEYS];
 407   joystick _joystick_bindings[MAX_JOYSTICKS];
 408   mouse _mouse_bindings[MAX_MICE];
 409
 410 };
 411
 412
 413 \f
 414 ////////////////////////////////////////////////////////////////////////
 415 // GLUT callbacks.
 416 ////////////////////////////////////////////////////////////////////////
 417
 418 // Handle GLUT events.
 419 extern "C" {
 420
 421 /**
 422  * Key-down event handler for Glut.
 423  *
 424  * <p>Pass the value on to the FGInput module unless PUI wants it.</p>
 425  *
 426  * @param k The integer value for the key pressed.
 427  * @param x (unused)
 428  * @param y (unused)
 429  */
 430 void GLUTkey (unsigned char k, int x, int y);
 431
 432
 433 /**
 434  * Key-up event handler for GLUT.
 435  *
 436  * <p>PUI doesn't use this, so always pass it to the input manager.</p>
 437  *
 438  * @param k The integer value for the key pressed.
 439  * @param x (unused)
 440  * @param y (unused)
 441  */
 442 void GLUTkeyup (unsigned char k, int x, int y);
 443
 444
 445 /**
 446  * Special key-down handler for Glut.
 447  *
 448  * <p>Pass the value on to the FGInput module unless PUI wants it.
 449  * The key value will have 256 added to it.</p>
 450  *
 451  * @param k The integer value for the key pressed (will have 256 added
 452  * to it).
 453  * @param x (unused)
 454  * @param y (unused)
 455  */
 456 void GLUTspecialkey (int k, int x, int y);
 457
 458
 459 /**
 460  * Special key-up handler for Glut.
 461  *
 462  * @param k The integer value for the key pressed (will have 256 added
 463  * to it).
 464  * @param x (unused)
 465  * @param y (unused)
 466  */
 467 void GLUTspecialkeyup (int k, int x, int y);
 468
 469
 470 /**
 471  * Mouse click handler for Glut.
 472  *
 473  * @param button The mouse button pressed.
 474  * @param updown Press or release flag.
 475  * @param x The x-location of the click.
 476  * @param y The y-location of the click.
 477  */
 478 void GLUTmouse (int button, int updown, int x, int y);
 479
 480
 481 /**
 482  * Mouse motion handler for Glut.
 483  *
 484  * @param x The new x-location of the mouse.
 485  * @param y The new y-location of the mouse.
 486  */
 487 void GLUTmotion (int x, int y);
 488
 489 } // extern "C"
 490
 491 #endif // _INPUT_HXX