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/props/condition.hxx>
37 #include <simgear/props/props.hxx>
39 #include <Main/fgfs.hxx>
40 #include <Main/fg_props.hxx>
41 #include <Main/globals.hxx>
53 ////////////////////////////////////////////////////////////////////////
54 // General binding support.
55 ////////////////////////////////////////////////////////////////////////
59 * An input binding of some sort.
61 * <p>This class represents a binding that can be assigned to a
62 * keyboard key, a joystick button or axis, or even a panel
65 class FGBinding : public SGConditional
70 * Default constructor.
76 * Convenience constructor.
78 * @param node The binding will be built from this node.
80 FGBinding (const SGPropertyNode * node);
86 virtual ~FGBinding ();
90 * Get the command name.
92 * @return The string name of the command for this binding.
94 virtual const string &getCommandName () const { return _command_name; }
98 * Get the command itself.
100 * @return The command associated with this binding, or 0 if none
103 virtual SGCommandMgr::command_t getCommand () const { return _command; }
107 * Get the argument that will be passed to the command.
109 * @return A property node that will be passed to the command as its
110 * argument, or 0 if none was supplied.
112 virtual const SGPropertyNode * getArg () { return _arg; }
116 * Read a binding from a property node.
118 * @param node The property node containing the binding.
120 virtual void read (const SGPropertyNode * node);
126 virtual void fire () const;
130 * Fire a binding with a scaled movement (rather than absolute position).
132 virtual void fire (double offset, double max) const;
136 * Fire a binding with a setting (i.e. joystick axis).
138 * A double 'setting' property will be added to the arguments.
140 * @param setting The input setting, usually between -1.0 and 1.0.
142 virtual void fire (double setting) const;
147 FGBinding (const FGBinding &binding);
149 string _command_name;
150 mutable SGCommandMgr::command_t _command;
151 mutable SGPropertyNode * _arg;
152 mutable SGPropertyNode_ptr _setting;
157 ////////////////////////////////////////////////////////////////////////
158 // General input mapping support.
159 ////////////////////////////////////////////////////////////////////////
163 * Generic input module.
165 * <p>This module is designed to handle input from multiple sources --
166 * keyboard, joystick, mouse, or even panel switches -- in a consistent
167 * way, and to allow users to rebind any of the actions at runtime.</p>
169 class FGInput : public FGSubsystem
175 FG_MOD_UP = 1, // key- or button-up
179 FG_MOD_MAX = 16 // enough to handle all combinations
184 * Default constructor.
195 // Implementation of FGSubsystem.
197 virtual void init ();
198 virtual void update (double dt);
199 virtual void suspend ();
200 virtual void resume ();
201 virtual bool is_suspended () const;
205 * Control whether this is the default module to receive events.
207 * The first input module created will set itself as the default
210 * @param status true if this should be the default module for
211 * events, false otherwise.
213 virtual void makeDefault (bool status = true);
217 * Handle a single keystroke.
219 * <p>Note: for special keys, the integer key code will be the Glut
222 * @param k The integer key code, as returned by glut.
223 * @param modifiers Modifier keys pressed (bitfield).
224 * @param x The mouse x position at the time of keypress.
225 * @param y The mouse y position at the time of keypress.
230 virtual void doKey (int k, int modifiers, int x, int y);
234 * Handle a mouse click event.
236 * @param button The mouse button selected.
237 * @param updown Button status.
238 * @param x The X position of the mouse event, in screen coordinates.
239 * @param y The Y position of the mouse event, in screen coordinates.
241 virtual void doMouseClick (int button, int updown, int x, int y);
245 * Handle mouse motion.
247 * @param x The new mouse x position, in screen coordinates.
248 * @param y The new mouse y position, in screen coordinates.
250 virtual void doMouseMotion (int x, int y);
264 MAX_JOYSTICK_AXES = _JS_MAX_AXES,
265 MAX_JOYSTICK_BUTTONS = 32,
268 MAX_MOUSE_BUTTONS = 8
273 typedef vector<FGBinding *> binding_list_t;
276 * Settings for a key or button.
283 binding_list_t bindings[FG_MOD_MAX];
288 * Settings for a single joystick axis.
295 binding_list_t bindings[FG_MOD_MAX];
297 float high_threshold;
306 * Settings for a joystick.
310 virtual ~joystick ();
321 * Settings for a mouse mode.
325 virtual ~mouse_mode ();
330 binding_list_t x_bindings[FG_MOD_MAX];
331 binding_list_t y_bindings[FG_MOD_MAX];
336 * Settings for a mouse.
343 SGPropertyNode * mode_node;
344 SGPropertyNode * mouse_button_nodes[MAX_MOUSE_BUTTONS];
352 * Initialize key bindings.
354 void _init_keyboard ();
358 * Initialize joystick bindings.
360 void _init_joystick ();
364 * Initialize mouse bindings.
370 * Initialize a single button.
372 inline void _init_button (const SGPropertyNode * node,
378 * Update the keyboard.
380 void _update_keyboard ();
384 * Update the joystick.
386 void _update_joystick (double dt);
392 void _update_mouse ();
396 * Update a single button.
398 inline void _update_button (button &b, int modifiers, bool pressed,
403 * Read bindings and modifiers.
405 void _read_bindings (const SGPropertyNode * node,
406 binding_list_t * binding_list,
410 * Look up the bindings for a key code.
412 const vector<FGBinding *> &_find_key_bindings (unsigned int k,
415 button _key_bindings[MAX_KEYS];
416 joystick _joystick_bindings[MAX_JOYSTICKS];
417 mouse _mouse_bindings[MAX_MICE];
423 ////////////////////////////////////////////////////////////////////////
425 ////////////////////////////////////////////////////////////////////////
427 // Handle GLUT events.
431 * Key-down event handler for Glut.
433 * <p>Pass the value on to the FGInput module unless PUI wants it.</p>
435 * @param k The integer value for the key pressed.
439 void GLUTkey (unsigned char k, int x, int y);
443 * Key-up event handler for GLUT.
445 * <p>PUI doesn't use this, so always pass it to the input manager.</p>
447 * @param k The integer value for the key pressed.
451 void GLUTkeyup (unsigned char k, int x, int y);
455 * Special key-down handler for Glut.
457 * <p>Pass the value on to the FGInput module unless PUI wants it.
458 * The key value will have 256 added to it.</p>
460 * @param k The integer value for the key pressed (will have 256 added
465 void GLUTspecialkey (int k, int x, int y);
469 * Special key-up handler for Glut.
471 * @param k The integer value for the key pressed (will have 256 added
476 void GLUTspecialkeyup (int k, int x, int y);
480 * Mouse click handler for Glut.
482 * @param button The mouse button pressed.
483 * @param updown Press or release flag.
484 * @param x The x-location of the click.
485 * @param y The y-location of the click.
487 void GLUTmouse (int button, int updown, int x, int y);
491 * Mouse motion handler for Glut.
493 * @param x The new x-location of the mouse.
494 * @param y The new y-location of the mouse.
496 void GLUTmotion (int x, int y);