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