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