1 // input.cxx -- 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.
31 #include <simgear/compiler.h>
44 #include <simgear/compiler.h>
46 #include <simgear/constants.h>
47 #include <simgear/debug/logstream.hxx>
48 #include <simgear/misc/props.hxx>
50 #include <Aircraft/aircraft.hxx>
51 #include <Autopilot/auto_gui.hxx>
52 #include <Autopilot/newauto.hxx>
53 #include <Cockpit/hud.hxx>
54 #include <Cockpit/panel.hxx>
55 #include <Cockpit/panel_io.hxx>
58 #ifndef FG_OLD_WEATHER
59 # include <WeatherCM/FGLocalWeatherDatabase.h>
61 # include <Weather/weather.hxx>
64 #include <Main/globals.hxx>
65 #include <Main/fg_props.hxx>
66 #include <Main/options.hxx>
70 #if !defined(SG_HAVE_NATIVE_SGI_COMPILERS)
71 SG_USING_STD(ifstream);
78 ////////////////////////////////////////////////////////////////////////
79 // Local data structures.
80 ////////////////////////////////////////////////////////////////////////
83 ////////////////////////////////////////////////////////////////////////
84 // Implementation of FGBinding.
85 ////////////////////////////////////////////////////////////////////////
87 FGBinding::FGBinding ()
89 _arg(new SGPropertyNode),
95 FGBinding::FGBinding (const FGBinding &binding)
96 : _command_name(binding._command_name),
97 _command(binding._command),
98 _arg(new SGPropertyNode),
102 copyProperties(binding._arg, _arg);
105 FGBinding::FGBinding (const SGPropertyNode * node)
107 _arg(new SGPropertyNode),
114 FGBinding::~FGBinding ()
116 delete _arg; // Delete the saved arguments
117 delete _command_state; // Delete the saved command state
121 FGBinding::read (const SGPropertyNode * node)
123 _command_name = node->getStringValue("command", "");
124 if (_command_name == "") {
125 SG_LOG(SG_INPUT, SG_ALERT, "No command supplied for binding.");
130 _command = globals->get_commands()->getCommand(_command_name);
132 SG_LOG(SG_INPUT, SG_ALERT, "Command " << _command_name << " is undefined");
138 _arg = new SGPropertyNode;
140 copyProperties(node, _arg); // FIXME: don't use whole node!!!
144 FGBinding::fire () const
147 SG_LOG(SG_INPUT, SG_ALERT, "No command attached to binding");
148 } else if (!(*_command)(_arg, &_command_state)) {
149 SG_LOG(SG_INPUT, SG_ALERT, "Failed to execute command " << _command_name);
154 FGBinding::fire (double setting) const
156 // A value is automatically added to
158 if (_setting == 0) // save the setting node for efficiency
159 _setting = _arg->getChild("setting", 0, true);
160 _setting->setDoubleValue(setting);
166 ////////////////////////////////////////////////////////////////////////
167 // Implementation of FGInput.
168 ////////////////////////////////////////////////////////////////////////
171 extern void fgReshape( int width, int height );
173 FGInput current_input;
213 FGInput::doKey (int k, int modifiers, int x, int y)
215 SG_LOG(SG_INPUT, SG_INFO, "User pressed key " << k
216 << " with modifiers " << modifiers);
219 if (k < 0 || k >= MAX_KEYS) {
220 SG_LOG(SG_INPUT, SG_ALERT, "Key value " << k << " out of range");
224 button &b = _key_bindings[k];
227 if (modifiers&FG_MOD_UP == 0) {
228 // SG_LOG( SG_INPUT, SG_INFO, "User pressed key " << k
229 // << " with modifiers " << modifiers );
230 if (!b.last_state || b.is_repeatable) {
231 const binding_list_t &bindings =
232 _find_key_bindings(k, modifiers);
233 int max = bindings.size();
235 for (int i = 0; i < max; i++)
244 // SG_LOG(SG_INPUT, SG_INFO, "User released key " << k
245 // << " with modifiers " << modifiers);
247 const binding_list_t &bindings =
248 _find_key_bindings(k, modifiers);
249 int max = bindings.size();
251 for (int i = 0; i < max; i++)
259 // Use the old, default actions.
260 SG_LOG(SG_INPUT, SG_INFO, "(No user binding.)");
261 if (modifiers&FG_MOD_UP)
265 static bool winding_ccw = true;
267 // FGInterface *f = current_aircraft.fdm_state;
268 // FGViewer *v = globals->get_current_view();
270 // everything after here will be removed sooner or later...
272 if (modifiers & FG_MOD_SHIFT) {
275 case 18: // Ctrl-R key
277 winding_ccw = !winding_ccw;
279 glFrontFace ( GL_CCW );
281 glFrontFace ( GL_CW );
285 HUD_brightkey( true );
289 fgHUDInit2(¤t_aircraft);
292 #if defined(FX) && !defined(WIN32)
293 global_fullscreen = ( !global_fullscreen );
294 # if defined(XMESA_FX_FULLSCREEN) && defined(XMESA_FX_WINDOW)
295 XMesaSetFXmode( global_fullscreen ?
296 XMESA_FX_FULLSCREEN : XMESA_FX_WINDOW );
303 case 256+GLUT_KEY_F10: {
304 fgToggleFDMdataLogging();
314 SG_LOG( SG_INPUT, SG_DEBUG, "" );
317 HUD_masterswitch( true );
320 fgHUDInit(¤t_aircraft); // normal HUD
325 case 256+GLUT_KEY_F6: // F6 toggles Autopilot target location
326 if ( current_autopilot->get_HeadingMode() !=
327 FGAutopilot::FG_HEADING_WAYPOINT ) {
328 current_autopilot->set_HeadingMode(
329 FGAutopilot::FG_HEADING_WAYPOINT );
330 current_autopilot->set_HeadingEnabled( true );
332 current_autopilot->set_HeadingMode(
333 FGAutopilot::FG_TC_HEADING_LOCK );
336 case 256+GLUT_KEY_F8: {// F8 toggles fog ... off fastest nicest...
337 const string &fog = fgGetString("/sim/rendering/fog");
338 if (fog == "disabled") {
339 fgSetString("/sim/rendering/fog", "fastest");
340 SG_LOG(SG_INPUT, SG_INFO, "Fog enabled, hint=fastest");
341 } else if (fog == "fastest") {
342 fgSetString("/sim/rendering/fog", "nicest");
343 SG_LOG(SG_INPUT, SG_INFO, "Fog enabled, hint=nicest");
344 } else if (fog == "nicest") {
345 fgSetString("/sim/rendering/fog", "disabled");
346 SG_LOG(SG_INPUT, SG_INFO, "Fog disabled");
348 fgSetString("/sim/rendering/fog", "disabled");
349 SG_LOG(SG_INPUT, SG_ALERT, "Unrecognized fog type "
350 << fog << ", changed to 'disabled'");
354 case 256+GLUT_KEY_F10: // F10 toggles menu on and off...
355 SG_LOG(SG_INPUT, SG_INFO, "Invoking call back function");
358 case 256+GLUT_KEY_F11: // F11 Altitude Dialog.
359 SG_LOG(SG_INPUT, SG_INFO, "Invoking Altitude call back function");
362 case 256+GLUT_KEY_F12: // F12 Heading Dialog...
363 SG_LOG(SG_INPUT, SG_INFO, "Invoking Heading call back function");
375 FGInput::_init_keyboard ()
377 // TODO: zero the old bindings first.
378 SG_LOG(SG_INPUT, SG_INFO, "Initializing key bindings");
379 SGPropertyNode * key_nodes = fgGetNode("/input/keyboard");
380 if (key_nodes == 0) {
381 SG_LOG(SG_INPUT, SG_ALERT, "No key bindings (/input/keyboard)!!");
385 vector<SGPropertyNode *> keys = key_nodes->getChildren("key");
386 for (unsigned int i = 0; i < keys.size(); i++) {
387 int index = keys[i]->getIndex();
388 SG_LOG(SG_INPUT, SG_INFO, "Binding key " << index);
389 _key_bindings[index].is_repeatable = keys[i]->getBoolValue("repeatable");
390 _read_bindings(keys[i], _key_bindings[index].bindings, FG_MOD_NONE);
396 FGInput::_init_joystick ()
398 // TODO: zero the old bindings first.
399 SG_LOG(SG_INPUT, SG_INFO, "Initializing joystick bindings");
400 SGPropertyNode * js_nodes = fgGetNode("/input/joysticks");
402 SG_LOG(SG_INPUT, SG_ALERT, "No joystick bindings (/input/joysticks)!!");
406 for (int i = 0; i < MAX_JOYSTICKS; i++) {
407 const SGPropertyNode * js_node = js_nodes->getChild("js", i);
409 SG_LOG(SG_INPUT, SG_ALERT, "No bindings for joystick " << i);
412 jsJoystick * js = new jsJoystick(i);
413 _joystick_bindings[i].js = js;
414 if (js->notWorking()) {
415 SG_LOG(SG_INPUT, SG_INFO, "Joystick " << i << " not found");
420 joyGetDevCaps( i, &jsCaps, sizeof(jsCaps) );
421 int nbuttons = jsCaps.wNumButtons;
422 if (nbuttons > MAX_BUTTONS) nbuttons = MAX_BUTTONS;
424 int nbuttons = MAX_BUTTONS;
427 int naxes = js->getNumAxes();
428 if (naxes > MAX_AXES) naxes = MAX_AXES;
429 _joystick_bindings[i].naxes = naxes;
430 _joystick_bindings[i].nbuttons = nbuttons;
432 SG_LOG(SG_INPUT, SG_INFO, "Initializing joystick " << i);
434 // Set up range arrays
435 float minRange[MAX_AXES];
436 float maxRange[MAX_AXES];
437 float center[MAX_AXES];
439 // Initialize with default values
440 js->getMinRange(minRange);
441 js->getMaxRange(maxRange);
442 js->getCenter(center);
444 // Allocate axes and buttons
445 _joystick_bindings[i].axes = new axis[naxes];
446 _joystick_bindings[i].buttons = new button[nbuttons];
450 // Initialize the axes.
453 for (j = 0; j < naxes; j++) {
454 const SGPropertyNode * axis_node = js_node->getChild("axis", j);
455 if (axis_node == 0) {
456 SG_LOG(SG_INPUT, SG_INFO, "No bindings for axis " << j);
460 axis &a = _joystick_bindings[i].axes[j];
462 js->setDeadBand(j, axis_node->getDoubleValue("dead-band", 0.0));
464 a.tolerance = axis_node->getDoubleValue("tolerance", 0.002);
465 minRange[j] = axis_node->getDoubleValue("min-range", minRange[j]);
466 maxRange[j] = axis_node->getDoubleValue("max-range", maxRange[j]);
467 center[j] = axis_node->getDoubleValue("center", center[j]);
469 _read_bindings(axis_node, a.bindings, FG_MOD_NONE);
471 // Initialize the virtual axis buttons.
472 _init_button(axis_node->getChild("low"), a.low, "low");
473 a.low_threshold = axis_node->getDoubleValue("low-threshold", -0.9);
475 _init_button(axis_node->getChild("high"), a.high, "high");
476 a.high_threshold = axis_node->getDoubleValue("high-threshold", 0.9);
480 // Initialize the buttons.
483 for (j = 0; j < nbuttons; j++) {
484 sprintf(buf, "%d", j);
485 _init_button(js_node->getChild("button", j),
486 _joystick_bindings[i].buttons[j],
491 js->setMinRange(minRange);
492 js->setMaxRange(maxRange);
493 js->setCenter(center);
499 FGInput::_init_button (const SGPropertyNode * node,
504 SG_LOG(SG_INPUT, SG_INFO, "No bindings for button " << name);
506 _read_bindings(node, b.bindings, FG_MOD_NONE);
507 b.is_repeatable = node->getBoolValue("repeatable", b.is_repeatable);
509 // Get the bindings for the button
510 _read_bindings(node, b.bindings, FG_MOD_NONE);
516 FGInput::_update_keyboard ()
523 FGInput::_update_joystick ()
525 int modifiers = FG_MOD_NONE; // FIXME: any way to get the real ones?
527 // float js_val, diff;
528 float axis_values[MAX_AXES];
533 for ( i = 0; i < MAX_JOYSTICKS; i++) {
535 jsJoystick * js = _joystick_bindings[i].js;
536 if (js == 0 || js->notWorking())
539 js->read(&buttons, axis_values);
542 // Fire bindings for the axes.
543 for ( j = 0; j < _joystick_bindings[i].naxes; j++) {
544 axis &a = _joystick_bindings[i].axes[j];
546 // Do nothing if the axis position
547 // is unchanged; only a change in
548 // position fires the bindings.
549 if (fabs(axis_values[j] - a.last_value) > a.tolerance) {
550 // SG_LOG(SG_INPUT, SG_INFO, "Axis " << j << " has moved");
552 a.last_value = axis_values[j];
553 // SG_LOG(SG_INPUT, SG_INFO, "There are "
554 // << a.bindings[modifiers].size() << " bindings");
555 for (unsigned int k = 0; k < a.bindings[modifiers].size(); k++)
556 a.bindings[modifiers][k].fire(axis_values[j]);
559 // do we have to emulate axis buttons?
560 if (a.low.bindings[modifiers].size())
561 _update_button(_joystick_bindings[i].axes[j].low,
563 axis_values[j] < a.low_threshold);
565 if (a.high.bindings[modifiers].size())
566 _update_button(_joystick_bindings[i].axes[j].high,
568 axis_values[j] > a.high_threshold);
571 // Fire bindings for the buttons.
572 for (j = 0; j < _joystick_bindings[i].nbuttons; j++)
573 _update_button(_joystick_bindings[i].buttons[j],
575 (buttons & (1 << j)) > 0);
581 FGInput::_update_button (button &b, int modifiers, bool pressed)
584 // The press event may be repeated.
585 if (!b.last_state || b.is_repeatable) {
586 // SG_LOG(SG_INPUT, SG_INFO, "Button " << j << " has been pressed");
587 for (unsigned int k = 0; k < b.bindings[modifiers].size(); k++)
588 b.bindings[modifiers][k].fire();
591 // The release event is never repeated.
593 // SG_LOG(SG_INPUT, SG_INFO, "Button " << j << " has been released");
594 for (unsigned int k = 0; k < b.bindings[modifiers|FG_MOD_UP].size(); k++)
595 b.bindings[modifiers|FG_MOD_UP][k].fire();
598 b.last_state = pressed;
603 FGInput::_read_bindings (const SGPropertyNode * node,
604 binding_list_t * binding_list,
607 vector<const SGPropertyNode *> bindings = node->getChildren("binding");
608 for (unsigned int i = 0; i < bindings.size(); i++) {
609 SG_LOG(SG_INPUT, SG_INFO, "Reading binding "
610 << bindings[i]->getStringValue("command"));
611 binding_list[modifiers].push_back(FGBinding(bindings[i]));
614 // Read nested bindings for modifiers
615 if (node->getChild("mod-up") != 0)
616 _read_bindings(node->getChild("mod-up"), binding_list,
617 modifiers|FG_MOD_UP);
619 if (node->getChild("mod-shift") != 0)
620 _read_bindings(node->getChild("mod-shift"), binding_list,
621 modifiers|FG_MOD_SHIFT);
623 if (node->getChild("mod-ctrl") != 0)
624 _read_bindings(node->getChild("mod-ctrl"), binding_list,
625 modifiers|FG_MOD_CTRL);
627 if (node->getChild("mod-alt") != 0)
628 _read_bindings(node->getChild("mod-alt"), binding_list,
629 modifiers|FG_MOD_ALT);
633 const vector<FGBinding> &
634 FGInput::_find_key_bindings (unsigned int k, int modifiers)
636 button &b = _key_bindings[k];
638 // Try it straight, first.
639 if (b.bindings[modifiers].size() > 0)
640 return b.bindings[modifiers];
642 // Try removing the control modifier
644 else if ((modifiers&FG_MOD_CTRL) && iscntrl(k))
645 return _find_key_bindings(k, modifiers&~FG_MOD_CTRL);
647 // Try removing shift modifier
648 // for upper case or any punctuation
649 // (since different keyboards will
650 // shift different punctuation types)
651 else if ((modifiers&FG_MOD_SHIFT) && (isupper(k) || ispunct(k)))
652 return _find_key_bindings(k, modifiers&~FG_MOD_SHIFT);
654 // Try removing alt modifier for
655 // high-bit characters.
656 else if ((modifiers&FG_MOD_ALT) && k >= 128 && k < 256)
657 return _find_key_bindings(k, modifiers&~FG_MOD_ALT);
659 // Give up and return the empty vector.
661 return b.bindings[modifiers];
666 * Construct the modifiers.
668 static inline int get_mods ()
670 int glut_modifiers = glutGetModifiers();
673 if (glut_modifiers & GLUT_ACTIVE_SHIFT)
674 modifiers |= FGInput::FG_MOD_SHIFT;
675 if (glut_modifiers & GLUT_ACTIVE_CTRL)
676 modifiers |= FGInput::FG_MOD_CTRL;
677 if (glut_modifiers & GLUT_ACTIVE_ALT)
678 modifiers |= FGInput::FG_MOD_ALT;
685 * Key-down event handler for Glut.
687 * <p>Pass the value on to the FGInput module unless PUI wants it.</p>
689 * @param k The integer value for the key pressed.
693 void GLUTkey(unsigned char k, int x, int y)
695 // Give PUI a chance to grab it first.
696 if (!puKeyboard(k, PU_DOWN))
697 current_input.doKey(k, get_mods(), x, y);
702 * Key-up event handler for GLUT.
704 * <p>PUI doesn't use this, so always pass it to the input manager.</p>
706 * @param k The integer value for the key pressed.
710 void GLUTkeyup(unsigned char k, int x, int y)
712 current_input.doKey(k, get_mods()|FGInput::FG_MOD_UP, x, y);
717 * Special key-down handler for Glut.
719 * <p>Pass the value on to the FGInput module unless PUI wants it.
720 * The key value will have 256 added to it.</p>
722 * @param k The integer value for the key pressed (will have 256 added
727 void GLUTspecialkey(int k, int x, int y)
729 // Give PUI a chance to grab it first.
730 if (!puKeyboard(k + PU_KEY_GLUT_SPECIAL_OFFSET, PU_DOWN))
731 current_input.doKey(k + 256, get_mods(), x, y);
736 * Special key-up handler for Glut.
738 * @param k The integer value for the key pressed (will have 256 added
743 void GLUTspecialkeyup(int k, int x, int y)
745 current_input.doKey(k + 256, get_mods()|FGInput::FG_MOD_UP, x, y);