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;
142 string _command_name;
143 SGCommandMgr::command_t _command;
144 mutable SGPropertyNode * _arg;
145 mutable SGPropertyNode * _setting;
150 ////////////////////////////////////////////////////////////////////////
151 // General input mapping support.
152 ////////////////////////////////////////////////////////////////////////
156 * Generic input module.
158 * <p>This module is designed to handle input from multiple sources --
159 * keyboard, joystick, mouse, or even panel switches -- in a consistent
160 * way, and to allow users to rebind any of the actions at runtime.</p>
162 class FGInput : public FGSubsystem
168 FG_MOD_UP = 1, // key- or button-up
172 FG_MOD_MAX = 16 // enough to handle all combinations
177 * Default constructor.
188 // Implementation of FGSubsystem.
190 virtual void init ();
191 virtual void bind ();
192 virtual void unbind ();
193 virtual void update (double dt);
197 * Control whether this is the default module to receive events.
199 * The first input module created will set itself as the default
202 * @param status true if this should be the default module for
203 * events, false otherwise.
205 virtual void makeDefault (bool status = true);
209 * Handle a single keystroke.
211 * <p>Note: for special keys, the integer key code will be the Glut
214 * @param k The integer key code, as returned by glut.
215 * @param modifiers Modifier keys pressed (bitfield).
216 * @param x The mouse x position at the time of keypress.
217 * @param y The mouse y position at the time of keypress.
222 virtual void doKey (int k, int modifiers, int x, int y);
226 * Handle a mouse click event.
228 * @param button The mouse button selected.
229 * @param updown Button status.
230 * @param x The X position of the mouse event, in screen coordinates.
231 * @param y The Y position of the mouse event, in screen coordinates.
233 virtual void doMouseClick (int button, int updown, int x, int y);
237 * Handle mouse motion.
239 * @param x The new mouse x position, in screen coordinates.
240 * @param y The new mouse y position, in screen coordinates.
242 virtual void doMouseMotion (int x, int y);
256 MAX_JOYSTICK_AXES = _JS_MAX_AXES,
257 MAX_JOYSTICK_BUTTONS = 32,
260 MAX_MOUSE_BUTTONS = 8
265 typedef vector<FGBinding *> binding_list_t;
268 * Settings for a key or button.
275 binding_list_t bindings[FG_MOD_MAX];
280 * Settings for a single joystick axis.
287 binding_list_t bindings[FG_MOD_MAX];
289 float high_threshold;
296 * Settings for a joystick.
300 virtual ~joystick ();
311 * Settings for a mouse mode.
315 virtual ~mouse_mode ();
320 binding_list_t x_bindings[FG_MOD_MAX];
321 binding_list_t y_bindings[FG_MOD_MAX];
326 * Settings for a mouse.
333 SGPropertyNode * mode_node;
334 SGPropertyNode * mouse_button_nodes[MAX_MOUSE_BUTTONS];
342 * Initialize key bindings.
344 void _init_keyboard ();
348 * Initialize joystick bindings.
350 void _init_joystick ();
354 * Initialize mouse bindings.
360 * Initialize a single button.
362 inline void _init_button (const SGPropertyNode * node,
368 * Update the keyboard.
370 void _update_keyboard ();
374 * Update the joystick.
376 void _update_joystick ();
382 void _update_mouse ();
386 * Update a single button.
388 inline void _update_button (button &b, int modifiers, bool pressed,
393 * Read bindings and modifiers.
395 void _read_bindings (const SGPropertyNode * node,
396 binding_list_t * binding_list,
400 * Look up the bindings for a key code.
402 const vector<FGBinding *> &_find_key_bindings (unsigned int k,
405 button _key_bindings[MAX_KEYS];
406 joystick _joystick_bindings[MAX_JOYSTICKS];
407 mouse _mouse_bindings[MAX_MICE];
413 ////////////////////////////////////////////////////////////////////////
415 ////////////////////////////////////////////////////////////////////////
417 // Handle GLUT events.
421 * Key-down event handler for Glut.
423 * <p>Pass the value on to the FGInput module unless PUI wants it.</p>
425 * @param k The integer value for the key pressed.
429 void GLUTkey (unsigned char k, int x, int y);
433 * Key-up event handler for GLUT.
435 * <p>PUI doesn't use this, so always pass it to the input manager.</p>
437 * @param k The integer value for the key pressed.
441 void GLUTkeyup (unsigned char k, int x, int y);
445 * Special key-down handler for Glut.
447 * <p>Pass the value on to the FGInput module unless PUI wants it.
448 * The key value will have 256 added to it.</p>
450 * @param k The integer value for the key pressed (will have 256 added
455 void GLUTspecialkey (int k, int x, int y);
459 * Special key-up handler for Glut.
461 * @param k The integer value for the key pressed (will have 256 added
466 void GLUTspecialkeyup (int k, int x, int y);
470 * Mouse click handler for Glut.
472 * @param button The mouse button pressed.
473 * @param updown Press or release flag.
474 * @param x The x-location of the click.
475 * @param y The y-location of the click.
477 void GLUTmouse (int button, int updown, int x, int y);
481 * Mouse motion handler for Glut.
483 * @param x The new x-location of the mouse.
484 * @param y The new y-location of the mouse.
486 void GLUTmotion (int x, int y);