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 <Scripting/NasalSys.hxx>
33 using simgear::PropertyList;
35 FGEventSetting::FGEventSetting( SGPropertyNode_ptr base ) :
40 if( (n = base->getNode( "value" )) != NULL ) {
42 value = n->getDoubleValue();
44 n = base->getNode( "property" );
46 SG_LOG( SG_INPUT, SG_WARN, "Neither <value> nor <property> defined for event setting." );
48 valueNode = fgGetNode( n->getStringValue(), true );
52 if( (n = base->getChild("condition")) != NULL )
53 condition = sgReadCondition(base, n);
55 SG_LOG( SG_INPUT, SG_ALERT, "No condition for event setting." );
58 double FGEventSetting::GetValue()
60 return valueNode == NULL ? value : valueNode->getDoubleValue();
63 bool FGEventSetting::Test()
65 return condition == NULL ? true : condition->test();
68 static inline bool StartsWith( string & s, const char * cp )
70 return s.find( cp ) == 0;
73 FGInputEvent * FGInputEvent::NewObject( FGInputDevice * device, SGPropertyNode_ptr node )
75 string name = node->getStringValue( "name", "" );
76 if( StartsWith( name, "button-" ) )
77 return new FGButtonEvent( device, node );
79 if( StartsWith( name, "rel-" ) )
80 return new FGRelAxisEvent( device, node );
82 if( StartsWith( name, "abs-" ) )
83 return new FGAbsAxisEvent( device, node );
85 return new FGInputEvent( device, node );
88 FGInputEvent::FGInputEvent( FGInputDevice * aDevice, SGPropertyNode_ptr node ) :
91 lastSettingValue(std::numeric_limits<float>::quiet_NaN())
93 name = node->getStringValue( "name", "" );
94 desc = node->getStringValue( "desc", "" );
95 intervalSec = node->getDoubleValue("interval-sec",0.0);
97 read_bindings( node, bindings, KEYMOD_NONE, device->GetNasalModule() );
99 PropertyList settingNodes = node->getChildren("setting");
100 for( PropertyList::iterator it = settingNodes.begin(); it != settingNodes.end(); it++ )
101 settings.push_back( new FGEventSetting( *it ) );
104 FGInputEvent::~FGInputEvent()
108 void FGInputEvent::update( double dt )
110 for( setting_list_t::iterator it = settings.begin(); it != settings.end(); it++ ) {
111 if( (*it)->Test() ) {
112 double value = (*it)->GetValue();
113 if( value != lastSettingValue ) {
114 device->Send( GetName(), (*it)->GetValue() );
115 lastSettingValue = value;
121 void FGInputEvent::fire( FGEventData & eventData )
123 lastDt += eventData.dt;
124 if( lastDt >= intervalSec ) {
126 for( binding_list_t::iterator it = bindings[eventData.modifiers].begin(); it != bindings[eventData.modifiers].end(); it++ )
127 fire( *it, eventData );
129 lastDt -= intervalSec;
133 void FGInputEvent::fire( SGBinding * binding, FGEventData & eventData )
140 FGAxisEvent::FGAxisEvent( FGInputDevice * device, SGPropertyNode_ptr node ) :
141 FGInputEvent( device, node )
143 tolerance = node->getDoubleValue("tolerance", 0.002);
144 minRange = node->getDoubleValue("min-range", 0.0 );
145 maxRange = node->getDoubleValue("max-range", 0.0 );
146 center = node->getDoubleValue("center", 0.0);
147 deadband = node->getDoubleValue("dead-band", 0.0);
148 lowThreshold = node->getDoubleValue("low-threshold", -0.9);
149 highThreshold = node->getDoubleValue("high-threshold", 0.9);
153 void FGAxisEvent::fire( FGEventData & eventData )
155 if (fabs( eventData.value - lastValue) < tolerance)
157 lastValue = eventData.value;
159 // We need a copy of the FGEventData struct to set the new value and to avoid side effects
160 FGEventData ed = eventData;
162 if( fabs(ed.value) < deadband )
165 if( minRange != maxRange )
166 ed.value = 2.0*(eventData.value-minRange)/(maxRange-minRange)-1.0;
168 FGInputEvent::fire( ed );
171 void FGAbsAxisEvent::fire( SGBinding * binding, FGEventData & eventData )
173 // sets the "setting" node
174 binding->fire( eventData.value );
177 FGRelAxisEvent::FGRelAxisEvent( FGInputDevice * device, SGPropertyNode_ptr node ) :
178 FGAxisEvent( device, node )
180 // relative axes can't use tolerance
184 void FGRelAxisEvent::fire( SGBinding * binding, FGEventData & eventData )
186 // sets the "offset" node
187 binding->fire( eventData.value, 1.0 );
190 FGButtonEvent::FGButtonEvent( FGInputDevice * device, SGPropertyNode_ptr node ) :
191 FGInputEvent( device, node ),
195 repeatable = node->getBoolValue("repeatable", repeatable);
198 void FGButtonEvent::fire( FGEventData & eventData )
200 bool pressed = eventData.value > 0.0;
202 // The press event may be repeated.
203 if (!lastState || repeatable) {
204 SG_LOG( SG_INPUT, SG_DEBUG, "Button has been pressed" );
205 FGInputEvent::fire( eventData );
208 // The release event is never repeated.
210 SG_LOG( SG_INPUT, SG_DEBUG, "Button has been released" );
211 eventData.modifiers|=KEYMOD_RELEASED;
212 FGInputEvent::fire( eventData );
219 FGInputDevice::~FGInputDevice()
221 FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
222 if (nas && deviceNode ) {
223 SGPropertyNode_ptr nasal = deviceNode->getNode("nasal");
225 SGPropertyNode_ptr nasalClose = nasal->getNode("close");
227 const string s = nasalClose->getStringValue();
228 nas->createModule(nasalModule.c_str(), nasalModule.c_str(), s.c_str(), s.length(), deviceNode );
231 nas->deleteModule(nasalModule.c_str());
235 void FGInputDevice::Configure( SGPropertyNode_ptr aDeviceNode )
237 deviceNode = aDeviceNode;
239 nasalModule = string("__event:") + GetName();
241 PropertyList eventNodes = deviceNode->getChildren( "event" );
242 for( PropertyList::iterator it = eventNodes.begin(); it != eventNodes.end(); it++ )
243 AddHandledEvent( FGInputEvent::NewObject( this, *it ) );
245 debugEvents = deviceNode->getBoolValue("debug-events", debugEvents );
246 grab = deviceNode->getBoolValue("grab", grab );
249 // add nodes for the last event:
250 // last-event/name [string]
251 // last-event/value [double]
253 SGPropertyNode_ptr nasal = deviceNode->getNode("nasal");
255 SGPropertyNode_ptr open = nasal->getNode("open");
257 const string s = open->getStringValue();
258 FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
260 nas->createModule(nasalModule.c_str(), nasalModule.c_str(), s.c_str(), s.length(), deviceNode );
266 void FGInputDevice::update( double dt )
268 for( map<string,FGInputEvent_ptr>::iterator it = handledEvents.begin(); it != handledEvents.end(); it++ )
269 (*it).second->update( dt );
272 void FGInputDevice::HandleEvent( FGEventData & eventData )
274 string eventName = TranslateEventName( eventData );
276 cout << GetName() << " has event " <<
277 eventName << " modifiers=" << eventData.modifiers << " value=" << eventData.value << endl;
279 if( handledEvents.count( eventName ) > 0 ) {
280 handledEvents[ eventName ]->fire( eventData );
284 void FGInputDevice::SetName( string name )
289 const char * FGEventInput::PROPERTY_ROOT = "/input/event";
291 FGEventInput::FGEventInput() :
292 configMap( "Input/Event", fgGetNode( PROPERTY_ROOT, true ), "device-named" )
296 FGEventInput::~FGEventInput()
298 for( map<int,FGInputDevice*>::iterator it = input_devices.begin(); it != input_devices.end(); it++ )
300 input_devices.clear();
303 void FGEventInput::init( )
305 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing event bindings");
306 // SGPropertyNode * base = fgGetNode("/input/event", true);
310 void FGEventInput::postinit ()
314 void FGEventInput::update( double dt )
316 // call each associated device's update() method
317 for( map<int,FGInputDevice*>::iterator it = input_devices.begin(); it != input_devices.end(); it++ )
318 (*it).second->update( dt );
321 unsigned FGEventInput::AddDevice( FGInputDevice * inputDevice )
323 SGPropertyNode_ptr baseNode = fgGetNode( PROPERTY_ROOT, true );
324 SGPropertyNode_ptr deviceNode = NULL;
326 // look for configuration in the device map
327 if( configMap.count( inputDevice->GetName() ) > 0 ) {
328 // found - copy to /input/event/device[n]
332 for( index = 0; index < MAX_DEVICES; index++ )
333 if( (deviceNode = baseNode->getNode( "device", index, false ) ) == NULL )
336 if( index == MAX_DEVICES ) {
337 SG_LOG(SG_INPUT, SG_WARN, "To many event devices - ignoring " << inputDevice->GetName() );
338 return INVALID_DEVICE_INDEX;
342 deviceNode = baseNode->getNode( "device", index, true );
344 // and copy the properties from the configuration tree
345 copyProperties( configMap[ inputDevice->GetName() ], deviceNode );
349 if( deviceNode == NULL ) {
350 SG_LOG(SG_INPUT, SG_DEBUG, "No configuration found for device " << inputDevice->GetName() );
352 return INVALID_DEVICE_INDEX;
355 inputDevice->Configure( deviceNode );
359 input_devices[ deviceNode->getIndex() ] = inputDevice;
363 SG_LOG(SG_INPUT, SG_ALERT, "can't open InputDevice " << inputDevice->GetName() );
364 return INVALID_DEVICE_INDEX;
367 SG_LOG(SG_INPUT, SG_DEBUG, "using InputDevice " << inputDevice->GetName() );
368 return deviceNode->getIndex();
371 void FGEventInput::RemoveDevice( unsigned index )
373 // not fully implemented yet
374 SGPropertyNode_ptr baseNode = fgGetNode( PROPERTY_ROOT, true );
375 SGPropertyNode_ptr deviceNode = NULL;
377 FGInputDevice *inputDevice = input_devices[index];
379 input_devices.erase(index);
383 deviceNode = baseNode->removeChild("device", index, false);