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/fg_props.hxx>
40 #include <Main/globals.hxx>
52 ////////////////////////////////////////////////////////////////////////
53 // General binding support.
54 ////////////////////////////////////////////////////////////////////////
58 * An input binding of some sort.
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
64 class FGBinding : public FGConditional
69 * Default constructor.
75 * Convenience constructor.
77 * @param node The binding will be built from this node.
79 FGBinding (const SGPropertyNode * node);
85 virtual ~FGBinding ();
89 * Get the command name.
91 * @return The string name of the command for this binding.
93 virtual const string &getCommandName () const { return _command_name; }
97 * Get the command itself.
99 * @return The command associated with this binding, or 0 if none
102 virtual SGCommandMgr::command_t getCommand () const { return _command; }
106 * Get the argument that will be passed to the command.
108 * @return A property node that will be passed to the command as its
109 * argument, or 0 if none was supplied.
111 virtual const SGPropertyNode * getArg () { return _arg; }
115 * Read a binding from a property node.
117 * @param node The property node containing the binding.
119 virtual void read (const SGPropertyNode * node);
125 virtual void fire () const;
129 * Fire a binding with a scaled movement (rather than absolute position).
131 virtual void fire (double offset, double max) const;
135 * Fire a binding with a setting (i.e. joystick axis).
137 * A double 'setting' property will be added to the arguments.
139 * @param setting The input setting, usually between -1.0 and 1.0.
141 virtual void fire (double setting) const;
146 FGBinding (const FGBinding &binding);
148 string _command_name;
149 mutable SGCommandMgr::command_t _command;
150 mutable SGPropertyNode * _arg;
151 mutable SGPropertyNode_ptr _setting;
156 ////////////////////////////////////////////////////////////////////////
157 // General input mapping support.
158 ////////////////////////////////////////////////////////////////////////
162 * Generic input module.
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>
168 class FGInput : public FGSubsystem
174 FG_MOD_UP = 1, // key- or button-up
178 FG_MOD_MAX = 16 // enough to handle all combinations
183 * Default constructor.
194 // Implementation of FGSubsystem.
196 virtual void init ();
197 virtual void bind ();
198 virtual void unbind ();
199 virtual void update (double dt);
203 * Control whether this is the default module to receive events.
205 * The first input module created will set itself as the default
208 * @param status true if this should be the default module for
209 * events, false otherwise.
211 virtual void makeDefault (bool status = true);
215 * Handle a single keystroke.
217 * <p>Note: for special keys, the integer key code will be the Glut
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.
228 virtual void doKey (int k, int modifiers, int x, int y);
232 * Handle a mouse click event.
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.
239 virtual void doMouseClick (int button, int updown, int x, int y);
243 * Handle mouse motion.
245 * @param x The new mouse x position, in screen coordinates.
246 * @param y The new mouse y position, in screen coordinates.
248 virtual void doMouseMotion (int x, int y);
262 MAX_JOYSTICK_AXES = _JS_MAX_AXES,
263 MAX_JOYSTICK_BUTTONS = 32,
266 MAX_MOUSE_BUTTONS = 8
271 typedef vector<FGBinding *> binding_list_t;
274 * Settings for a key or button.
281 binding_list_t bindings[FG_MOD_MAX];
286 * Settings for a single joystick axis.
293 binding_list_t bindings[FG_MOD_MAX];
295 float high_threshold;
302 * Settings for a joystick.
306 virtual ~joystick ();
317 * Settings for a mouse mode.
321 virtual ~mouse_mode ();
326 binding_list_t x_bindings[FG_MOD_MAX];
327 binding_list_t y_bindings[FG_MOD_MAX];
332 * Settings for a mouse.
339 SGPropertyNode * mode_node;
340 SGPropertyNode * mouse_button_nodes[MAX_MOUSE_BUTTONS];
348 * Initialize key bindings.
350 void _init_keyboard ();
354 * Initialize joystick bindings.
356 void _init_joystick ();
360 * Initialize mouse bindings.
366 * Initialize a single button.
368 inline void _init_button (const SGPropertyNode * node,
374 * Update the keyboard.
376 void _update_keyboard ();
380 * Update the joystick.
382 void _update_joystick ();
388 void _update_mouse ();
392 * Update a single button.
394 inline void _update_button (button &b, int modifiers, bool pressed,
399 * Read bindings and modifiers.
401 void _read_bindings (const SGPropertyNode * node,
402 binding_list_t * binding_list,
406 * Look up the bindings for a key code.
408 const vector<FGBinding *> &_find_key_bindings (unsigned int k,
411 button _key_bindings[MAX_KEYS];
412 joystick _joystick_bindings[MAX_JOYSTICKS];
413 mouse _mouse_bindings[MAX_MICE];
419 ////////////////////////////////////////////////////////////////////////
421 ////////////////////////////////////////////////////////////////////////
423 // Handle GLUT events.
427 * Key-down event handler for Glut.
429 * <p>Pass the value on to the FGInput module unless PUI wants it.</p>
431 * @param k The integer value for the key pressed.
435 void GLUTkey (unsigned char k, int x, int y);
439 * Key-up event handler for GLUT.
441 * <p>PUI doesn't use this, so always pass it to the input manager.</p>
443 * @param k The integer value for the key pressed.
447 void GLUTkeyup (unsigned char k, int x, int y);
451 * Special key-down handler for Glut.
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>
456 * @param k The integer value for the key pressed (will have 256 added
461 void GLUTspecialkey (int k, int x, int y);
465 * Special key-up handler for Glut.
467 * @param k The integer value for the key pressed (will have 256 added
472 void GLUTspecialkeyup (int k, int x, int y);
476 * Mouse click handler for Glut.
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.
483 void GLUTmouse (int button, int updown, int x, int y);
487 * Mouse motion handler for Glut.
489 * @param x The new x-location of the mouse.
490 * @param y The new y-location of the mouse.
492 void GLUTmotion (int x, int y);