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.
29 #include "FGJoystickInput.hxx"
31 #include <simgear/props/props_io.hxx>
32 #include "FGDeviceConfigurationMap.hxx"
33 #include <Main/fg_props.hxx>
34 #include <Scripting/NasalSys.hxx>
36 using simgear::PropertyList;
38 FGJoystickInput::axis::axis ()
39 : last_value(9999999),
48 FGJoystickInput::axis::~axis ()
52 FGJoystickInput::joystick::joystick ()
63 FGJoystickInput::joystick::~joystick ()
65 // delete js? no, since js == this - and we're in the destructor already.
77 FGJoystickInput::FGJoystickInput()
81 FGJoystickInput::~FGJoystickInput()
86 void FGJoystickInput::_remove(bool all)
88 SGPropertyNode * js_nodes = fgGetNode("/input/joysticks", true);
90 for (int i = 0; i < MAX_JOYSTICKS; i++)
92 // do not remove predefined joysticks info on reinit
93 if ((all)||(!bindings[i].predefined))
94 js_nodes->removeChild("js", i, false);
96 delete bindings[i].js;
97 bindings[i].js = NULL;
101 void FGJoystickInput::init()
104 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick bindings");
105 SGPropertyNode_ptr js_nodes = fgGetNode("/input/joysticks", true);
107 FGDeviceConfigurationMap configMap("Input/Joysticks", js_nodes, "js-named");
109 for (int i = 0; i < MAX_JOYSTICKS; i++) {
110 jsJoystick * js = new jsJoystick(i);
113 if (js->notWorking()) {
114 SG_LOG(SG_INPUT, SG_DEBUG, "Joystick " << i << " not found");
118 const char * name = js->getName();
119 SGPropertyNode_ptr js_node = js_nodes->getChild("js", i);
122 SG_LOG(SG_INPUT, SG_INFO, "Using existing bindings for joystick " << i);
125 bindings[i].predefined = false;
126 SG_LOG(SG_INPUT, SG_INFO, "Looking for bindings for joystick \"" << name << '"');
127 SGPropertyNode_ptr named;
129 if ((named = configMap[name])) {
130 string source = named->getStringValue("source", "user defined");
131 SG_LOG(SG_INPUT, SG_INFO, "... found joystick: " << source);
133 } else if ((named = configMap["default"])) {
134 string source = named->getStringValue("source", "user defined");
135 SG_LOG(SG_INPUT, SG_INFO, "No config found for joystick \"" << name
136 << "\"\nUsing default: \"" << source << '"');
139 SG_LOG(SG_INPUT, SG_WARN, "No joystick configuration file with <name>" << name << "</name> entry found!");
142 js_node = js_nodes->getChild("js", i, true);
143 copyProperties(named, js_node);
144 js_node->setStringValue("id", name);
149 void FGJoystickInput::reinit() {
150 SG_LOG(SG_INPUT, SG_DEBUG, "Re-Initializing joystick bindings");
152 FGJoystickInput::init();
153 FGJoystickInput::postinit();
156 void FGJoystickInput::postinit()
158 FGNasalSys *nasalsys = (FGNasalSys *)globals->get_subsystem("nasal");
159 SGPropertyNode_ptr js_nodes = fgGetNode("/input/joysticks");
161 for (int i = 0; i < MAX_JOYSTICKS; i++) {
162 SGPropertyNode_ptr js_node = js_nodes->getChild("js", i);
163 jsJoystick *js = bindings[i].js;
164 if (!js_node || js->notWorking())
169 joyGetDevCaps( i, &jsCaps, sizeof(jsCaps) );
170 unsigned int nbuttons = jsCaps.wNumButtons;
171 if (nbuttons > MAX_JOYSTICK_BUTTONS) nbuttons = MAX_JOYSTICK_BUTTONS;
173 unsigned int nbuttons = MAX_JOYSTICK_BUTTONS;
176 int naxes = js->getNumAxes();
177 if (naxes > MAX_JOYSTICK_AXES) naxes = MAX_JOYSTICK_AXES;
178 bindings[i].naxes = naxes;
179 bindings[i].nbuttons = nbuttons;
181 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick " << i);
183 // Set up range arrays
184 float minRange[MAX_JOYSTICK_AXES];
185 float maxRange[MAX_JOYSTICK_AXES];
186 float center[MAX_JOYSTICK_AXES];
188 // Initialize with default values
189 js->getMinRange(minRange);
190 js->getMaxRange(maxRange);
191 js->getCenter(center);
193 // Allocate axes and buttons
194 bindings[i].axes = new axis[naxes];
195 bindings[i].buttons = new FGButton[nbuttons];
198 // Initialize nasal groups.
200 std::ostringstream str;
202 string module = str.str();
203 nasalsys->createModule(module.c_str(), module.c_str(), "", 0);
205 PropertyList nasal = js_node->getChildren("nasal");
207 for (j = 0; j < nasal.size(); j++) {
208 nasal[j]->setStringValue("module", module.c_str());
209 nasalsys->handleCommand(nasal[j]);
213 // Initialize the axes.
215 PropertyList axes = js_node->getChildren("axis");
216 size_t nb_axes = axes.size();
217 for (j = 0; j < nb_axes; j++ ) {
218 const SGPropertyNode * axis_node = axes[j];
219 const SGPropertyNode * num_node = axis_node->getChild("number");
220 int n_axis = axis_node->getIndex();
222 n_axis = num_node->getIntValue(TGT_PLATFORM, -1);
225 // Mac falls back to Unix by default - avoids specifying many
226 // duplicate <mac> entries in joystick config files
228 n_axis = num_node->getIntValue("unix", -1);
232 // Silently ignore platforms that are not specified within the
233 // <number></number> section
239 if (n_axis >= naxes) {
240 SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for axis " << n_axis);
243 axis &a = bindings[i].axes[n_axis];
245 js->setDeadBand(n_axis, axis_node->getDoubleValue("dead-band", 0.0));
247 a.tolerance = axis_node->getDoubleValue("tolerance", 0.002);
248 minRange[n_axis] = axis_node->getDoubleValue("min-range", minRange[n_axis]);
249 maxRange[n_axis] = axis_node->getDoubleValue("max-range", maxRange[n_axis]);
250 center[n_axis] = axis_node->getDoubleValue("center", center[n_axis]);
252 read_bindings(axis_node, a.bindings, KEYMOD_NONE, module );
254 // Initialize the virtual axis buttons.
255 a.low.init(axis_node->getChild("low"), "low", module );
256 a.low_threshold = axis_node->getDoubleValue("low-threshold", -0.9);
258 a.high.init(axis_node->getChild("high"), "high", module );
259 a.high_threshold = axis_node->getDoubleValue("high-threshold", 0.9);
260 a.interval_sec = axis_node->getDoubleValue("interval-sec",0.0);
265 // Initialize the buttons.
267 PropertyList buttons = js_node->getChildren("button");
269 for (j = 0; j < buttons.size() && j < nbuttons; j++) {
270 const SGPropertyNode * button_node = buttons[j];
271 const SGPropertyNode * num_node = button_node->getChild("number");
272 size_t n_but = button_node->getIndex();
274 n_but = num_node->getIntValue(TGT_PLATFORM,n_but);
277 if (n_but >= nbuttons) {
278 SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for button " << n_but);
282 sprintf(buf, "%u", (unsigned)n_but);
283 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing button " << n_but);
284 bindings[i].buttons[n_but].init(button_node, buf, module );
286 // get interval-sec property
287 FGButton &b = bindings[i].buttons[n_but];
288 if (button_node != 0) {
289 b.interval_sec = button_node->getDoubleValue("interval-sec",0.0);
294 js->setMinRange(minRange);
295 js->setMaxRange(maxRange);
296 js->setCenter(center);
300 void FGJoystickInput::update( double dt )
302 float axis_values[MAX_JOYSTICK_AXES];
303 int modifiers = fgGetKeyModifiers();
306 for (int i = 0; i < MAX_JOYSTICKS; i++) {
308 jsJoystick * js = bindings[i].js;
309 if (js == 0 || js->notWorking())
312 js->read(&buttons, axis_values);
313 if (js->notWorking()) // If js is disconnected
316 // Fire bindings for the axes.
317 for (int j = 0; j < bindings[i].naxes; j++) {
318 axis &a = bindings[i].axes[j];
320 // Do nothing if the axis position
321 // is unchanged; only a change in
322 // position fires the bindings.
323 // But only if there are bindings
324 if (fabs(axis_values[j] - a.last_value) > a.tolerance
325 && a.bindings[KEYMOD_NONE].size() > 0 ) {
326 a.last_value = axis_values[j];
327 for (unsigned int k = 0; k < a.bindings[KEYMOD_NONE].size(); k++)
328 a.bindings[KEYMOD_NONE][k]->fire(axis_values[j]);
331 // do we have to emulate axis buttons?
333 if(a.last_dt >= a.interval_sec) {
334 if (a.low.bindings[modifiers].size())
335 bindings[i].axes[j].low.update( modifiers, axis_values[j] < a.low_threshold );
337 if (a.high.bindings[modifiers].size())
338 bindings[i].axes[j].high.update( modifiers, axis_values[j] > a.high_threshold );
340 a.last_dt -= a.interval_sec;
344 // Fire bindings for the buttons.
345 for (int j = 0; j < bindings[i].nbuttons; j++) {
346 FGButton &b = bindings[i].buttons[j];
348 if(b.last_dt >= b.interval_sec) {
349 bindings[i].buttons[j].update( modifiers, (buttons & (1u << j)) > 0 );
350 b.last_dt -= b.interval_sec;