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;
38 FGEventSetting::FGEventSetting( SGPropertyNode_ptr base ) :
43 if( (n = base->getNode( "value" )) != NULL ) {
45 value = n->getDoubleValue();
47 n = base->getNode( "property" );
49 SG_LOG( SG_INPUT, SG_WARN, "Neither <value> nor <property> defined for event setting." );
51 valueNode = fgGetNode( n->getStringValue(), true );
55 if( (n = base->getChild("condition")) != NULL )
56 condition = sgReadCondition(base, n);
58 SG_LOG( SG_INPUT, SG_ALERT, "No condition for event setting." );
61 double FGEventSetting::GetValue()
63 return valueNode == NULL ? value : valueNode->getDoubleValue();
66 bool FGEventSetting::Test()
68 return condition == NULL ? true : condition->test();
71 static inline bool StartsWith( string & s, const char * cp )
73 return s.find( cp ) == 0;
76 FGInputEvent * FGInputEvent::NewObject( FGInputDevice * device, SGPropertyNode_ptr node )
78 string name = node->getStringValue( "name", "" );
79 if( StartsWith( name, "button-" ) )
80 return new FGButtonEvent( device, node );
82 if( StartsWith( name, "rel-" ) )
83 return new FGRelAxisEvent( device, node );
85 if( StartsWith( name, "abs-" ) )
86 return new FGAbsAxisEvent( device, node );
88 return new FGInputEvent( device, node );
91 FGInputEvent::FGInputEvent( FGInputDevice * aDevice, SGPropertyNode_ptr node ) :
94 lastSettingValue(std::numeric_limits<float>::quiet_NaN())
96 name = node->getStringValue( "name", "" );
97 desc = node->getStringValue( "desc", "" );
98 intervalSec = node->getDoubleValue("interval-sec",0.0);
100 read_bindings( node, bindings, KEYMOD_NONE, device->GetNasalModule() );
102 PropertyList settingNodes = node->getChildren("setting");
103 for( PropertyList::iterator it = settingNodes.begin(); it != settingNodes.end(); it++ )
104 settings.push_back( new FGEventSetting( *it ) );
107 FGInputEvent::~FGInputEvent()
111 void FGInputEvent::update( double dt )
113 for( setting_list_t::iterator it = settings.begin(); it != settings.end(); it++ ) {
114 if( (*it)->Test() ) {
115 double value = (*it)->GetValue();
116 if( value != lastSettingValue ) {
117 device->Send( GetName(), (*it)->GetValue() );
118 lastSettingValue = value;
124 void FGInputEvent::fire( FGEventData & eventData )
126 lastDt += eventData.dt;
127 if( lastDt >= intervalSec ) {
129 for( binding_list_t::iterator it = bindings[eventData.modifiers].begin(); it != bindings[eventData.modifiers].end(); it++ )
130 fire( *it, eventData );
132 lastDt -= intervalSec;
136 void FGInputEvent::fire( SGBinding * binding, FGEventData & eventData )
143 FGAxisEvent::FGAxisEvent( FGInputDevice * device, SGPropertyNode_ptr node ) :
144 FGInputEvent( device, node )
146 tolerance = node->getDoubleValue("tolerance", 0.002);
147 minRange = node->getDoubleValue("min-range", 0.0 );
148 maxRange = node->getDoubleValue("max-range", 0.0 );
149 center = node->getDoubleValue("center", 0.0);
150 deadband = node->getDoubleValue("dead-band", 0.0);
151 lowThreshold = node->getDoubleValue("low-threshold", -0.9);
152 highThreshold = node->getDoubleValue("high-threshold", 0.9);
156 void FGAxisEvent::fire( FGEventData & eventData )
158 if (fabs( eventData.value - lastValue) < tolerance)
160 lastValue = eventData.value;
162 // We need a copy of the FGEventData struct to set the new value and to avoid side effects
163 FGEventData ed = eventData;
165 if( fabs(ed.value) < deadband )
168 if( minRange != maxRange )
169 ed.value = 2.0*(eventData.value-minRange)/(maxRange-minRange)-1.0;
171 FGInputEvent::fire( ed );
174 void FGAbsAxisEvent::fire( SGBinding * binding, FGEventData & eventData )
176 // sets the "setting" node
177 binding->fire( eventData.value );
180 FGRelAxisEvent::FGRelAxisEvent( FGInputDevice * device, SGPropertyNode_ptr node ) :
181 FGAxisEvent( device, node )
183 // relative axes can't use tolerance
187 void FGRelAxisEvent::fire( SGBinding * binding, FGEventData & eventData )
189 // sets the "offset" node
190 binding->fire( eventData.value, 1.0 );
193 FGButtonEvent::FGButtonEvent( FGInputDevice * device, SGPropertyNode_ptr node ) :
194 FGInputEvent( device, node ),
198 repeatable = node->getBoolValue("repeatable", repeatable);
201 void FGButtonEvent::fire( FGEventData & eventData )
203 bool pressed = eventData.value > 0.0;
205 // The press event may be repeated.
206 if (!lastState || repeatable) {
207 SG_LOG( SG_INPUT, SG_DEBUG, "Button has been pressed" );
208 FGInputEvent::fire( eventData );
211 // The release event is never repeated.
213 SG_LOG( SG_INPUT, SG_DEBUG, "Button has been released" );
214 eventData.modifiers|=KEYMOD_RELEASED;
215 FGInputEvent::fire( eventData );
222 FGInputDevice::~FGInputDevice()
224 FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
225 if (nas && deviceNode ) {
226 SGPropertyNode_ptr nasal = deviceNode->getNode("nasal");
228 SGPropertyNode_ptr nasalClose = nasal->getNode("close");
230 const string s = nasalClose->getStringValue();
231 nas->createModule(nasalModule.c_str(), nasalModule.c_str(), s.c_str(), s.length(), deviceNode );
234 nas->deleteModule(nasalModule.c_str());
238 void FGInputDevice::Configure( SGPropertyNode_ptr aDeviceNode )
240 deviceNode = aDeviceNode;
242 nasalModule = string("__event:") + GetName();
244 PropertyList eventNodes = deviceNode->getChildren( "event" );
245 for( PropertyList::iterator it = eventNodes.begin(); it != eventNodes.end(); it++ )
246 AddHandledEvent( FGInputEvent::NewObject( this, *it ) );
248 debugEvents = deviceNode->getBoolValue("debug-events", debugEvents );
249 grab = deviceNode->getBoolValue("grab", grab );
252 // add nodes for the last event:
253 // last-event/name [string]
254 // last-event/value [double]
256 SGPropertyNode_ptr nasal = deviceNode->getNode("nasal");
258 SGPropertyNode_ptr open = nasal->getNode("open");
260 const string s = open->getStringValue();
261 FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
263 nas->createModule(nasalModule.c_str(), nasalModule.c_str(), s.c_str(), s.length(), deviceNode );
269 void FGInputDevice::update( double dt )
271 for( map<string,FGInputEvent_ptr>::iterator it = handledEvents.begin(); it != handledEvents.end(); it++ )
272 (*it).second->update( dt );
275 void FGInputDevice::HandleEvent( FGEventData & eventData )
277 string eventName = TranslateEventName( eventData );
279 cout << GetName() << " has event " <<
280 eventName << " modifiers=" << eventData.modifiers << " value=" << eventData.value << endl;
282 if( handledEvents.count( eventName ) > 0 ) {
283 handledEvents[ eventName ]->fire( eventData );
287 void FGInputDevice::SetName( string name )
292 const char * FGEventInput::PROPERTY_ROOT = "/input/event";
294 FGEventInput::FGEventInput() :
295 configMap( "Input/Event", fgGetNode( PROPERTY_ROOT, true ), "device-named" )
299 FGEventInput::~FGEventInput()
301 for( map<int,FGInputDevice*>::iterator it = input_devices.begin(); it != input_devices.end(); it++ )
303 input_devices.clear();
306 void FGEventInput::init( )
308 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing event bindings");
309 // SGPropertyNode * base = fgGetNode("/input/event", true);
313 void FGEventInput::postinit ()
317 void FGEventInput::update( double dt )
319 // call each associated device's update() method
320 for( map<int,FGInputDevice*>::iterator it = input_devices.begin(); it != input_devices.end(); it++ )
321 (*it).second->update( dt );
324 unsigned FGEventInput::AddDevice( FGInputDevice * inputDevice )
326 SGPropertyNode_ptr baseNode = fgGetNode( PROPERTY_ROOT, true );
327 SGPropertyNode_ptr deviceNode = NULL;
329 // look for configuration in the device map
330 if( configMap.count( inputDevice->GetName() ) > 0 ) {
331 // found - copy to /input/event/device[n]
335 for( index = 0; index < MAX_DEVICES; index++ )
336 if( (deviceNode = baseNode->getNode( "device", index, false ) ) == NULL )
339 if( index == MAX_DEVICES ) {
340 SG_LOG(SG_INPUT, SG_WARN, "To many event devices - ignoring " << inputDevice->GetName() );
341 return INVALID_DEVICE_INDEX;
345 deviceNode = baseNode->getNode( "device", index, true );
347 // and copy the properties from the configuration tree
348 copyProperties( configMap[ inputDevice->GetName() ], deviceNode );
352 if( deviceNode == NULL ) {
353 SG_LOG(SG_INPUT, SG_DEBUG, "No configuration found for device " << inputDevice->GetName() );
355 return INVALID_DEVICE_INDEX;
358 inputDevice->Configure( deviceNode );
362 input_devices[ deviceNode->getIndex() ] = inputDevice;
366 SG_LOG(SG_INPUT, SG_ALERT, "can't open InputDevice " << inputDevice->GetName() );
367 return INVALID_DEVICE_INDEX;
370 SG_LOG(SG_INPUT, SG_DEBUG, "using InputDevice " << inputDevice->GetName() );
371 return deviceNode->getIndex();
374 void FGEventInput::RemoveDevice( unsigned index )
376 // not fully implemented yet
377 SGPropertyNode_ptr baseNode = fgGetNode( PROPERTY_ROOT, true );
378 SGPropertyNode_ptr deviceNode = NULL;
380 FGInputDevice *inputDevice = input_devices[index];
382 input_devices.erase(index);
386 deviceNode = baseNode->removeChild("device", index, false);