1 // input.hxx -- handle user input from various sources.
3 // Written by David Megginson, started May 2001.
5 // Copyright (C) 2001 David Megginson, david@megginson.com
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.
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.
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.
28 # error This library requires C++
33 #include <simgear/compiler.h>
35 #include <simgear/misc/commands.hxx>
36 #include <simgear/misc/props.hxx>
38 #include <Main/fgfs.hxx>
39 #include <Main/globals.hxx>
49 ////////////////////////////////////////////////////////////////////////
50 // General binding support.
51 ////////////////////////////////////////////////////////////////////////
55 * An input binding of some sort.
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
61 class FGBinding : public FGConditional
66 * Default constructor.
72 * Convenience constructor.
74 * @param node The binding will be built from this node.
76 FGBinding (const SGPropertyNode * node);
82 virtual ~FGBinding ();
86 * Get the command name.
88 * @return The string name of the command for this binding.
90 virtual const string &getCommandName () const { return _command_name; }
94 * Get the command itself.
96 * @return The command associated with this binding, or 0 if none
99 virtual SGCommandMgr::command_t getCommand () const { return _command; }
103 * Get the argument that will be passed to the command.
105 * @return A property node that will be passed to the command as its
106 * argument, or 0 if none was supplied.
108 virtual const SGPropertyNode * getArg () { return _arg; }
112 * Read a binding from a property node.
114 * @param node The property node containing the binding.
116 virtual void read (const SGPropertyNode * node);
122 virtual void fire () const;
126 * Fire a binding with a scaled movement (rather than absolute position).
128 virtual void fire (double offset, double max) const;
132 * Fire a binding with a setting (i.e. joystick axis).
134 * A double 'setting' property will be added to the arguments.
136 * @param setting The input setting, usually between -1.0 and 1.0.
138 virtual void fire (double setting) const;
143 FGBinding (const FGBinding &binding);
146 string _command_name;
147 SGCommandMgr::command_t _command;
148 mutable SGPropertyNode_ptr _arg;
149 mutable SGPropertyNode_ptr _setting;
154 ////////////////////////////////////////////////////////////////////////
155 // General input mapping support.
156 ////////////////////////////////////////////////////////////////////////
160 * Generic input module.
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>
166 class FGInput : public FGSubsystem
172 FG_MOD_UP = 1, // key- or button-up
176 FG_MOD_MAX = 16 // enough to handle all combinations
181 * Default constructor.
192 // Implementation of FGSubsystem.
194 virtual void init ();
195 virtual void bind ();
196 virtual void unbind ();
197 virtual void update (double dt);
201 * Control whether this is the default module to receive events.
203 * The first input module created will set itself as the default
206 * @param status true if this should be the default module for
207 * events, false otherwise.
209 virtual void makeDefault (bool status = true);
213 * Handle a single keystroke.
215 * <p>Note: for special keys, the integer key code will be the Glut
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.
226 virtual void doKey (int k, int modifiers, int x, int y);
230 * Handle a mouse click event.
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.
237 virtual void doMouseClick (int button, int updown, int x, int y);
241 * Handle mouse motion.
243 * @param x The new mouse x position, in screen coordinates.
244 * @param y The new mouse y position, in screen coordinates.
246 virtual void doMouseMotion (int x, int y);
260 MAX_JOYSTICK_AXES = _JS_MAX_AXES,
261 MAX_JOYSTICK_BUTTONS = 32,
264 MAX_MOUSE_BUTTONS = 8
269 typedef vector<FGBinding *> binding_list_t;
272 * Settings for a key or button.
279 binding_list_t bindings[FG_MOD_MAX];
284 * Settings for a single joystick axis.
291 binding_list_t bindings[FG_MOD_MAX];
293 float high_threshold;
300 * Settings for a joystick.
304 virtual ~joystick ();
315 * Settings for a mouse mode.
319 virtual ~mouse_mode ();
324 binding_list_t x_bindings[FG_MOD_MAX];
325 binding_list_t y_bindings[FG_MOD_MAX];
330 * Settings for a mouse.
337 SGPropertyNode * mode_node;
338 SGPropertyNode * mouse_button_nodes[MAX_MOUSE_BUTTONS];
346 * Initialize key bindings.
348 void _init_keyboard ();
352 * Initialize joystick bindings.
354 void _init_joystick ();
358 * Initialize mouse bindings.
364 * Initialize a single button.
366 inline void _init_button (const SGPropertyNode * node,
372 * Update the keyboard.
374 void _update_keyboard ();
378 * Update the joystick.
380 void _update_joystick ();
386 void _update_mouse ();
390 * Update a single button.
392 inline void _update_button (button &b, int modifiers, bool pressed,
397 * Read bindings and modifiers.
399 void _read_bindings (const SGPropertyNode * node,
400 binding_list_t * binding_list,
404 * Look up the bindings for a key code.
406 const vector<FGBinding *> &_find_key_bindings (unsigned int k,
409 button _key_bindings[MAX_KEYS];
410 joystick _joystick_bindings[MAX_JOYSTICKS];
411 mouse _mouse_bindings[MAX_MICE];
417 ////////////////////////////////////////////////////////////////////////
419 ////////////////////////////////////////////////////////////////////////
421 // Handle GLUT events.
425 * Key-down event handler for Glut.
427 * <p>Pass the value on to the FGInput module unless PUI wants it.</p>
429 * @param k The integer value for the key pressed.
433 void GLUTkey (unsigned char k, int x, int y);
437 * Key-up event handler for GLUT.
439 * <p>PUI doesn't use this, so always pass it to the input manager.</p>
441 * @param k The integer value for the key pressed.
445 void GLUTkeyup (unsigned char k, int x, int y);
449 * Special key-down handler for Glut.
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>
454 * @param k The integer value for the key pressed (will have 256 added
459 void GLUTspecialkey (int k, int x, int y);
463 * Special key-up handler for Glut.
465 * @param k The integer value for the key pressed (will have 256 added
470 void GLUTspecialkeyup (int k, int x, int y);
474 * Mouse click handler for Glut.
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.
481 void GLUTmouse (int button, int updown, int x, int y);
485 * Mouse motion handler for Glut.
487 * @param x The new x-location of the mouse.
488 * @param y The new y-location of the mouse.
490 void GLUTmotion (int x, int y);