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  * An input binding of some sort.
  49  *
  50  * <p>This class represents a binding that can be assigned to a
  51  * keyboard key, a joystick button or axis, or even a panel
  52  * instrument.</p>
  53  */
  54 class FGBinding
  55 {
  56 public:
  57
  58   /**
  59    * Default constructor.
  60    */
  61   FGBinding ();
  62
  63
  64   /**
  65    * Convenience constructor.
  66    *
  67    * @param node The binding will be built from this node.
  68    */
  69   FGBinding (const SGPropertyNode * node);
  70
  71
  72   /**
  73    * Destructor.
  74    */
  75   virtual ~FGBinding ();
  76
  77
  78   /**
  79    * Get the command name.
  80    *
  81    * @return The string name of the command for this binding.
  82    */
  83   virtual const string &getCommandName () const { return _command_name; }
  84
  85
  86   /**
  87    * Get the command itself.
  88    *
  89    * @return The command associated with this binding, or 0 if none
  90    * is present.
  91    */
  92   virtual SGCommandMgr::command_t getCommand () const { return _command; }
  93
  94
  95   /**
  96    * Get the argument that will be passed to the command.
  97    *
  98    * @return A property node that will be passed to the command as its
  99    * argument, or 0 if none was supplied.
 100    */
 101   virtual const SGPropertyNode * getArg () { return _arg; }
 102
 103
 104   /**
 105    * Read a binding from a property node.
 106    *
 107    * @param node The property node containing the binding.
 108    */
 109   virtual void read (const SGPropertyNode * node);
 110
 111
 112   /**
 113    * Fire a binding.
 114    */
 115   virtual void fire () const;
 116
 117
 118   /**
 119    * Fire a binding with a setting (i.e. joystick axis).
 120    *
 121    * A double 'setting' property will be added to the arguments.
 122    *
 123    * @param setting The input setting, usually between -1.0 and 1.0.
 124    */
 125   virtual void fire (double setting) const;
 126
 127
 128 private:
 129   void _fire (const SGPropertyNode *arg) const;
 130   string _command_name;
 131   SGCommandMgr::command_t _command;
 132   const SGPropertyNode * _arg;
 133 };
 134
 135
 136 /**
 137  * Generic input module.
 138  *
 139  * <p>This module is designed to handle input from multiple sources --
 140  * keyboard, joystick, mouse, or even panel switches -- in a consistent
 141  * way, and to allow users to rebind any of the actions at runtime.</p>
 142  */
 143 class FGInput : public FGSubsystem
 144 {
 145 public:
 146
 147   enum {
 148     FG_MOD_NONE = 0,
 149     FG_MOD_UP = 1,              // key- or button-up
 150     FG_MOD_SHIFT = 2,
 151     FG_MOD_CTRL = 4,
 152     FG_MOD_ALT = 8,
 153     FG_MOD_MAX = 16             // enough to handle all combinations
 154   };
 155
 156   FGInput();
 157   virtual ~FGInput();
 158
 159   //
 160   // Implementation of FGSubsystem.
 161   //
 162   virtual void init ();
 163   virtual void bind ();
 164   virtual void unbind ();
 165   virtual void update ();
 166
 167
 168   /**
 169    * Handle a single keystroke.
 170    *
 171    * <p>Note: for special keys, the integer key code will be the Glut
 172    * code + 256.</p>
 173    *
 174    * @param k The integer key code, as returned by glut.
 175    * @param modifiers Modifier keys pressed (bitfield).
 176    * @param x The mouse x position at the time of keypress.
 177    * @param y The mouse y position at the time of keypress.
 178    * @see #FG_MOD_SHIFT
 179    * @see #FG_MOD_CTRL
 180    * @see #FG_MOD_ALT
 181    */
 182   virtual void doKey (int k, int modifiers, int x, int y);
 183
 184
 185 private:
 186
 187                                 // Constants
 188   enum
 189   {
 190     MAX_KEYS = 1024,
 191
 192   #ifdef WIN32
 193     MAX_JOYSTICKS = 2,
 194   #else
 195     MAX_JOYSTICKS = 10,
 196   #endif
 197     MAX_AXES = _JS_MAX_AXES,
 198     MAX_BUTTONS = 32
 199   };
 200
 201
 202   typedef vector<FGBinding> binding_list_t;
 203
 204   /**
 205    * Settings for a key or button.
 206    */
 207   struct button {
 208     button ()
 209       : is_repeatable(false),
 210         last_state(-1)
 211     {}
 212     bool is_repeatable;
 213     int last_state;
 214     binding_list_t bindings[FG_MOD_MAX];
 215   };
 216
 217
 218   /**
 219    * Settings for a single joystick axis.
 220    */
 221   struct axis {
 222     axis ()
 223       : last_value(9999999),
 224         tolerance(0.002),
 225         low_threshold(-0.9),
 226         high_threshold(0.9)
 227     {}
 228     float last_value;
 229     float tolerance;
 230     binding_list_t bindings[FG_MOD_MAX];
 231     float low_threshold;
 232     float high_threshold;
 233     struct button low;
 234     struct button high;
 235   };
 236
 237
 238   /**
 239    * Settings for a joystick.
 240    */
 241   struct joystick {
 242     virtual ~joystick () {
 243       delete js;
 244       delete[] axes;
 245       delete[] buttons;
 246     }
 247     int naxes;
 248     int nbuttons;
 249     jsJoystick * js;
 250     axis * axes;
 251     button * buttons;
 252   };
 253
 254
 255   /**
 256    * Initialize key bindings.
 257    */
 258   void _init_keyboard ();
 259
 260
 261   /**
 262    * Initialize joystick bindings.
 263    */
 264   void _init_joystick ();
 265
 266
 267   /**
 268    * Initialize a single button.
 269    */
 270   inline void _init_button (const SGPropertyNode * node,
 271                             button &b,
 272                             const string name);
 273
 274
 275   /**
 276    * Update the keyboard.
 277    */
 278   void _update_keyboard ();
 279
 280
 281   /**
 282    * Update the joystick.
 283    */
 284   void _update_joystick ();
 285
 286
 287   /**
 288    * Update a single button.
 289    */
 290   inline void _update_button (button &b, int modifiers, bool pressed);
 291
 292
 293   /**
 294    * Read bindings and modifiers.
 295    */
 296   void _read_bindings (const SGPropertyNode * node,
 297                        binding_list_t * binding_list,
 298                        int modifiers);
 299
 300   /**
 301    * Look up the bindings for a key code.
 302    */
 303   const vector<FGBinding> &_find_key_bindings (unsigned int k, int modifiers);
 304
 305   button _key_bindings[MAX_KEYS];
 306   joystick _joystick_bindings[MAX_JOYSTICKS];
 307
 308 };
 309
 310 // Handle keyboard events
 311 void GLUTkey(unsigned char k, int x, int y);
 312 void GLUTkeyup(unsigned char k, int x, int y);
 313 void GLUTspecialkey(int k, int x, int y);
 314 void GLUTspecialkeyup(int k, int x, int y);
 315
 316 extern FGInput current_input;
 317
 318 #endif // _CONTROLS_HXX