1 // FGJoystickInput.cxx -- handle user input from joystick devices
3 // Written by Torsten Dreyer, started August 2009
4 // Based on work from David Megginson, started May 2001.
6 // Copyright (C) 2009 Torsten Dreyer, Torsten (at) t3r _dot_ de
7 // Copyright (C) 2001 David Megginson, david@megginson.com
9 // This program is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU General Public License as
11 // published by the Free Software Foundation; either version 2 of the
12 // License, or (at your option) any later version.
14 // This program is distributed in the hope that it will be useful, but
15 // WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // General Public License for more details.
19 // You should have received a copy of the GNU General Public License
20 // along with this program; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 #include "FGJoystickInput.hxx"
26 #include "FGDeviceConfigurationMap.hxx"
27 #include <Main/fg_props.hxx>
28 #include <Scripting/NasalSys.hxx>
30 using simgear::PropertyList;
32 FGJoystickInput::axis::axis ()
33 : last_value(9999999),
42 FGJoystickInput::axis::~axis ()
46 FGJoystickInput::joystick::joystick ()
56 FGJoystickInput::joystick::~joystick ()
58 // delete js? why not?
65 FGJoystickInput::FGJoystickInput()
69 FGJoystickInput::~FGJoystickInput()
74 void FGJoystickInput::init()
77 // TODO: zero the old bindings first.
78 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick bindings");
79 SGPropertyNode * js_nodes = fgGetNode("/input/joysticks", true);
81 FGDeviceConfigurationMap configMap("Input/Joysticks", js_nodes, "js-named");
83 for (int i = 0; i < MAX_JOYSTICKS; i++) {
84 jsJoystick * js = new jsJoystick(i);
87 if (js->notWorking()) {
88 SG_LOG(SG_INPUT, SG_DEBUG, "Joystick " << i << " not found");
92 std::string name = js->getName();
93 SGPropertyNode_ptr js_node = js_nodes->getChild("js", i);
96 SG_LOG(SG_INPUT, SG_INFO, "Using existing bindings for joystick " << i);
99 SG_LOG(SG_INPUT, SG_INFO, "Looking for bindings for joystick \"" << name << '"');
100 SGPropertyNode_ptr named;
102 if ((named = configMap[name])) {
103 string source = named->getStringValue("source", "user defined");
104 SG_LOG(SG_INPUT, SG_INFO, "... found joystick: " << source);
106 } else if ((named = configMap["default"])) {
107 string source = named->getStringValue("source", "user defined");
108 SG_LOG(SG_INPUT, SG_INFO, "No config found for joystick \"" << name
109 << "\"\nUsing default: \"" << source << '"');
112 SG_LOG(SG_INPUT, SG_WARN, "No joystick configuration file with <name>" << name << "</name> entry found!");
115 js_node = js_nodes->getChild("js", i, true);
116 copyProperties(named, js_node);
117 js_node->setStringValue("id", name);
122 void FGJoystickInput::postinit()
124 FGNasalSys *nasalsys = (FGNasalSys *)globals->get_subsystem("nasal");
125 SGPropertyNode_ptr js_nodes = fgGetNode("/input/joysticks");
127 for (int i = 0; i < MAX_JOYSTICKS; i++) {
128 SGPropertyNode_ptr js_node = js_nodes->getChild("js", i);
129 jsJoystick *js = bindings[i].js;
130 if (!js_node || js->notWorking())
133 int nbuttons = js->getNumButtons();
134 if (nbuttons > MAX_JOYSTICK_BUTTONS) nbuttons = MAX_JOYSTICK_BUTTONS;
136 int naxes = js->getNumAxes();
137 if (naxes > MAX_JOYSTICK_AXES) naxes = MAX_JOYSTICK_AXES;
138 bindings[i].naxes = naxes;
139 bindings[i].nbuttons = nbuttons;
141 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick " << i);
143 // Set up range arrays
144 float minRange[MAX_JOYSTICK_AXES];
145 float maxRange[MAX_JOYSTICK_AXES];
146 float center[MAX_JOYSTICK_AXES];
148 // Initialize with default values
149 js->getMinRange(minRange);
150 js->getMaxRange(maxRange);
151 js->getCenter(center);
153 // Allocate axes and buttons
154 bindings[i].axes = new axis[naxes];
155 bindings[i].buttons = new FGButton[nbuttons];
158 // Initialize nasal groups.
162 string module = str.str();
163 nasalsys->createModule(module.c_str(), module.c_str(), "", 0);
165 PropertyList nasal = js_node->getChildren("nasal");
167 for (j = 0; j < nasal.size(); j++) {
168 nasal[j]->setStringValue("module", module.c_str());
169 nasalsys->handleCommand(nasal[j]);
173 // Initialize the axes.
175 PropertyList axes = js_node->getChildren("axis");
176 size_t nb_axes = axes.size();
177 for (j = 0; j < nb_axes; j++ ) {
178 const SGPropertyNode * axis_node = axes[j];
179 const SGPropertyNode * num_node = axis_node->getChild("number");
180 int n_axis = axis_node->getIndex();
182 n_axis = num_node->getIntValue(TGT_PLATFORM, -1);
184 // Silently ignore platforms that are not specified within the
185 // <number></number> section
190 if (n_axis >= naxes) {
191 SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for axis " << n_axis);
194 axis &a = bindings[i].axes[n_axis];
196 js->setDeadBand(n_axis, axis_node->getDoubleValue("dead-band", 0.0));
198 a.tolerance = axis_node->getDoubleValue("tolerance", 0.002);
199 minRange[n_axis] = axis_node->getDoubleValue("min-range", minRange[n_axis]);
200 maxRange[n_axis] = axis_node->getDoubleValue("max-range", maxRange[n_axis]);
201 center[n_axis] = axis_node->getDoubleValue("center", center[n_axis]);
203 read_bindings(axis_node, a.bindings, KEYMOD_NONE, module );
205 // Initialize the virtual axis buttons.
206 a.low.init(axis_node->getChild("low"), "low", module );
207 a.low_threshold = axis_node->getDoubleValue("low-threshold", -0.9);
209 a.high.init(axis_node->getChild("high"), "high", module );
210 a.high_threshold = axis_node->getDoubleValue("high-threshold", 0.9);
211 a.interval_sec = axis_node->getDoubleValue("interval-sec",0.0);
216 // Initialize the buttons.
218 PropertyList buttons = js_node->getChildren("button");
220 for (j = 0; j < buttons.size() && j < nbuttons; j++) {
221 const SGPropertyNode * button_node = buttons[j];
222 const SGPropertyNode * num_node = button_node->getChild("number");
223 size_t n_but = button_node->getIndex();
225 n_but = num_node->getIntValue(TGT_PLATFORM,n_but);
228 if (n_but >= nbuttons) {
229 SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for button " << n_but);
233 sprintf(buf, "%u", (unsigned)n_but);
234 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing button " << n_but);
235 bindings[i].buttons[n_but].init(button_node, buf, module );
237 // get interval-sec property
238 FGButton &b = bindings[i].buttons[n_but];
239 if (button_node != 0) {
240 b.interval_sec = button_node->getDoubleValue("interval-sec",0.0);
245 js->setMinRange(minRange);
246 js->setMaxRange(maxRange);
247 js->setCenter(center);
251 void FGJoystickInput::update( double dt )
253 float axis_values[MAX_JOYSTICK_AXES];
254 int modifiers = fgGetKeyModifiers();
257 for (int i = 0; i < MAX_JOYSTICKS; i++) {
259 jsJoystick * js = bindings[i].js;
260 if (js == 0 || js->notWorking())
263 js->read(&buttons, axis_values);
265 // Fire bindings for the axes.
266 for (int j = 0; j < bindings[i].naxes; j++) {
267 axis &a = bindings[i].axes[j];
269 // Do nothing if the axis position
270 // is unchanged; only a change in
271 // position fires the bindings.
272 if (fabs(axis_values[j] - a.last_value) > a.tolerance) {
273 a.last_value = axis_values[j];
274 for (unsigned int k = 0; k < a.bindings[KEYMOD_NONE].size(); k++)
275 a.bindings[KEYMOD_NONE][k]->fire(axis_values[j]);
278 // do we have to emulate axis buttons?
280 if(a.last_dt >= a.interval_sec) {
281 if (a.low.bindings[modifiers].size())
282 bindings[i].axes[j].low.update( modifiers, axis_values[j] < a.low_threshold );
284 if (a.high.bindings[modifiers].size())
285 bindings[i].axes[j].high.update( modifiers, axis_values[j] > a.high_threshold );
287 a.last_dt -= a.interval_sec;
291 // Fire bindings for the buttons.
292 for (int j = 0; j < bindings[i].nbuttons; j++) {
293 FGButton &b = bindings[i].buttons[j];
295 if(b.last_dt >= b.interval_sec) {
296 bindings[i].buttons[j].update( modifiers, (buttons & (1 << j)) > 0 );
297 b.last_dt -= b.interval_sec;