1 // FGEventInput.cxx -- handle event driven input devices
3 // Written by Torsten Dreyer, started July 2009.
5 // Copyright (C) 2009 Torsten Dreyer, Torsten (at) t3r _dot_ de
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 #include "FGEventInput.hxx"
29 #include <Main/fg_props.hxx>
30 #include <simgear/io/sg_file.hxx>
31 #include <simgear/props/props_io.hxx>
32 #include <Scripting/NasalSys.hxx>
34 using simgear::PropertyList;
39 FGEventSetting::FGEventSetting( SGPropertyNode_ptr base ) :
44 if( (n = base->getNode( "value" )) != NULL ) {
46 value = n->getDoubleValue();
48 n = base->getNode( "property" );
50 SG_LOG( SG_INPUT, SG_WARN, "Neither <value> nor <property> defined for event setting." );
52 valueNode = fgGetNode( n->getStringValue(), true );
56 if( (n = base->getChild("condition")) != NULL )
57 condition = sgReadCondition(base, n);
59 SG_LOG( SG_INPUT, SG_ALERT, "No condition for event setting." );
62 double FGEventSetting::GetValue()
64 return valueNode == NULL ? value : valueNode->getDoubleValue();
67 bool FGEventSetting::Test()
69 return condition == NULL ? true : condition->test();
72 static inline bool StartsWith( string & s, const char * cp )
74 return s.find( cp ) == 0;
77 FGInputEvent * FGInputEvent::NewObject( FGInputDevice * device, SGPropertyNode_ptr node )
79 string name = node->getStringValue( "name", "" );
80 if( StartsWith( name, "button-" ) )
81 return new FGButtonEvent( device, node );
83 if( StartsWith( name, "rel-" ) )
84 return new FGRelAxisEvent( device, node );
86 if( StartsWith( name, "abs-" ) )
87 return new FGAbsAxisEvent( device, node );
89 return new FGInputEvent( device, node );
92 FGInputEvent::FGInputEvent( FGInputDevice * aDevice, SGPropertyNode_ptr node ) :
95 lastSettingValue(std::numeric_limits<float>::quiet_NaN())
97 name = node->getStringValue( "name", "" );
98 desc = node->getStringValue( "desc", "" );
99 intervalSec = node->getDoubleValue("interval-sec",0.0);
101 read_bindings( node, bindings, KEYMOD_NONE, device->GetNasalModule() );
103 PropertyList settingNodes = node->getChildren("setting");
104 for( PropertyList::iterator it = settingNodes.begin(); it != settingNodes.end(); ++it )
105 settings.push_back( new FGEventSetting( *it ) );
108 FGInputEvent::~FGInputEvent()
112 void FGInputEvent::update( double dt )
114 for( setting_list_t::iterator it = settings.begin(); it != settings.end(); ++it ) {
115 if( (*it)->Test() ) {
116 double value = (*it)->GetValue();
117 if( value != lastSettingValue ) {
118 device->Send( GetName(), (*it)->GetValue() );
119 lastSettingValue = value;
125 void FGInputEvent::fire( FGEventData & eventData )
127 lastDt += eventData.dt;
128 if( lastDt >= intervalSec ) {
130 for( binding_list_t::iterator it = bindings[eventData.modifiers].begin(); it != bindings[eventData.modifiers].end(); ++it )
131 fire( *it, eventData );
133 lastDt -= intervalSec;
137 void FGInputEvent::fire( SGBinding * binding, FGEventData & eventData )
144 FGAxisEvent::FGAxisEvent( FGInputDevice * device, SGPropertyNode_ptr node ) :
145 FGInputEvent( device, node )
147 tolerance = node->getDoubleValue("tolerance", 0.002);
148 minRange = node->getDoubleValue("min-range", 0.0 );
149 maxRange = node->getDoubleValue("max-range", 0.0 );
150 center = node->getDoubleValue("center", 0.0);
151 deadband = node->getDoubleValue("dead-band", 0.0);
152 lowThreshold = node->getDoubleValue("low-threshold", -0.9);
153 highThreshold = node->getDoubleValue("high-threshold", 0.9);
157 void FGAxisEvent::fire( FGEventData & eventData )
159 if (fabs( eventData.value - lastValue) < tolerance)
161 lastValue = eventData.value;
163 // We need a copy of the FGEventData struct to set the new value and to avoid side effects
164 FGEventData ed = eventData;
166 if( fabs(ed.value) < deadband )
169 if( minRange != maxRange )
170 ed.value = 2.0*(eventData.value-minRange)/(maxRange-minRange)-1.0;
172 FGInputEvent::fire( ed );
175 void FGAbsAxisEvent::fire( SGBinding * binding, FGEventData & eventData )
177 // sets the "setting" node
178 binding->fire( eventData.value );
181 FGRelAxisEvent::FGRelAxisEvent( FGInputDevice * device, SGPropertyNode_ptr node ) :
182 FGAxisEvent( device, node )
184 // relative axes can't use tolerance
188 void FGRelAxisEvent::fire( SGBinding * binding, FGEventData & eventData )
190 // sets the "offset" node
191 binding->fire( eventData.value, 1.0 );
194 FGButtonEvent::FGButtonEvent( FGInputDevice * device, SGPropertyNode_ptr node ) :
195 FGInputEvent( device, node ),
199 repeatable = node->getBoolValue("repeatable", repeatable);
202 void FGButtonEvent::fire( FGEventData & eventData )
204 bool pressed = eventData.value > 0.0;
206 // The press event may be repeated.
207 if (!lastState || repeatable) {
208 SG_LOG( SG_INPUT, SG_DEBUG, "Button has been pressed" );
209 FGInputEvent::fire( eventData );
212 // The release event is never repeated.
214 SG_LOG( SG_INPUT, SG_DEBUG, "Button has been released" );
215 eventData.modifiers|=KEYMOD_RELEASED;
216 FGInputEvent::fire( eventData );
223 FGInputDevice::~FGInputDevice()
225 FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
226 if (nas && deviceNode ) {
227 SGPropertyNode_ptr nasal = deviceNode->getNode("nasal");
229 SGPropertyNode_ptr nasalClose = nasal->getNode("close");
231 const string s = nasalClose->getStringValue();
232 nas->createModule(nasalModule.c_str(), nasalModule.c_str(), s.c_str(), s.length(), deviceNode );
235 nas->deleteModule(nasalModule.c_str());
239 void FGInputDevice::Configure( SGPropertyNode_ptr aDeviceNode )
241 deviceNode = aDeviceNode;
243 nasalModule = string("__event:") + GetName();
245 PropertyList eventNodes = deviceNode->getChildren( "event" );
246 for( PropertyList::iterator it = eventNodes.begin(); it != eventNodes.end(); ++it )
247 AddHandledEvent( FGInputEvent::NewObject( this, *it ) );
249 debugEvents = deviceNode->getBoolValue("debug-events", debugEvents );
250 grab = deviceNode->getBoolValue("grab", grab );
253 // add nodes for the last event:
254 // last-event/name [string]
255 // last-event/value [double]
257 SGPropertyNode_ptr nasal = deviceNode->getNode("nasal");
259 SGPropertyNode_ptr open = nasal->getNode("open");
261 const string s = open->getStringValue();
262 FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
264 nas->createModule(nasalModule.c_str(), nasalModule.c_str(), s.c_str(), s.length(), deviceNode );
270 void FGInputDevice::update( double dt )
272 for( map<string,FGInputEvent_ptr>::iterator it = handledEvents.begin(); it != handledEvents.end(); it++ )
273 (*it).second->update( dt );
276 void FGInputDevice::HandleEvent( FGEventData & eventData )
278 string eventName = TranslateEventName( eventData );
280 cout << GetName() << " has event " <<
281 eventName << " modifiers=" << eventData.modifiers << " value=" << eventData.value << endl;
283 if( handledEvents.count( eventName ) > 0 ) {
284 handledEvents[ eventName ]->fire( eventData );
288 void FGInputDevice::SetName( string name )
293 const char * FGEventInput::PROPERTY_ROOT = "/input/event";
295 FGEventInput::FGEventInput() :
296 configMap( "Input/Event", fgGetNode( PROPERTY_ROOT, true ), "device-named" )
300 FGEventInput::~FGEventInput()
302 for( map<int,FGInputDevice*>::iterator it = input_devices.begin(); it != input_devices.end(); ++it )
304 input_devices.clear();
307 void FGEventInput::init( )
309 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing event bindings");
310 // SGPropertyNode * base = fgGetNode("/input/event", true);
314 void FGEventInput::postinit ()
318 void FGEventInput::update( double dt )
320 // call each associated device's update() method
321 for( map<int,FGInputDevice*>::iterator it = input_devices.begin(); it != input_devices.end(); ++it )
322 (*it).second->update( dt );
325 unsigned FGEventInput::AddDevice( FGInputDevice * inputDevice )
327 SGPropertyNode_ptr baseNode = fgGetNode( PROPERTY_ROOT, true );
328 SGPropertyNode_ptr deviceNode = NULL;
330 // look for configuration in the device map
331 if( configMap.count( inputDevice->GetName() ) > 0 ) {
332 // found - copy to /input/event/device[n]
336 for( index = 0; index < MAX_DEVICES; index++ )
337 if( (deviceNode = baseNode->getNode( "device", index, false ) ) == NULL )
340 if( index == MAX_DEVICES ) {
341 SG_LOG(SG_INPUT, SG_WARN, "To many event devices - ignoring " << inputDevice->GetName() );
342 return INVALID_DEVICE_INDEX;
346 deviceNode = baseNode->getNode( "device", index, true );
348 // and copy the properties from the configuration tree
349 copyProperties( configMap[ inputDevice->GetName() ], deviceNode );
353 if( deviceNode == NULL ) {
354 SG_LOG(SG_INPUT, SG_DEBUG, "No configuration found for device " << inputDevice->GetName() );
356 return INVALID_DEVICE_INDEX;
359 inputDevice->Configure( deviceNode );
363 input_devices[ deviceNode->getIndex() ] = inputDevice;
367 SG_LOG(SG_INPUT, SG_ALERT, "can't open InputDevice " << inputDevice->GetName() );
368 return INVALID_DEVICE_INDEX;
371 SG_LOG(SG_INPUT, SG_DEBUG, "using InputDevice " << inputDevice->GetName() );
372 return deviceNode->getIndex();
375 void FGEventInput::RemoveDevice( unsigned index )
377 // not fully implemented yet
378 SGPropertyNode_ptr baseNode = fgGetNode( PROPERTY_ROOT, true );
379 SGPropertyNode_ptr deviceNode = NULL;
381 FGInputDevice *inputDevice = input_devices[index];
383 input_devices.erase(index);
387 deviceNode = baseNode->removeChild("device", index, false);