]> git.mxchange.org Git - flightgear.git/blob - src/Input/FGMouseInput.cxx
Tweak hover logic.
[flightgear.git] / src / Input / FGMouseInput.cxx
1 // FGMouseInput.cxx -- handle user input from mouse devices
2 //
3 // Written by Torsten Dreyer, started August 2009
4 // Based on work from David Megginson, started May 2001.
5 //
6 // Copyright (C) 2009 Torsten Dreyer, Torsten (at) t3r _dot_ de
7 // Copyright (C) 2001 David Megginson, david@megginson.com
8 //
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.
13 //
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.
18 //
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.
22 //
23 // $Id$
24
25 #ifdef HAVE_CONFIG_H
26 #  include "config.h"
27 #endif
28
29 #include "FGMouseInput.hxx"
30
31 #include <boost/foreach.hpp>
32 #include <osgGA/GUIEventAdapter>
33
34 #include <simgear/scene/util/SGPickCallback.hxx>
35 #include <simgear/timing/timestamp.hxx>
36 #include <simgear/scene/model/SGPickAnimation.hxx>
37
38 #include "FGButton.hxx"
39 #include "Main/globals.hxx"
40 #include <Viewer/renderer.hxx>
41 #include <plib/pu.h>
42 #include <Model/panelnode.hxx>
43 #include <Cockpit/panel.hxx>
44 #include <Viewer/FGEventHandler.hxx>
45 #include <GUI/MouseCursor.hxx>
46
47 using std::ios_base;
48
49 const int MAX_MICE = 1;
50 const int MAX_MOUSE_BUTTONS = 8;
51
52 ////////////////////////////////////////////////////////////////////////
53
54 /**
55  * List of currently pressed mouse button events
56  */
57 class ActivePickCallbacks : public std::map<int, std::list<SGSharedPtr<SGPickCallback> > > {
58 public:
59     void update( double dt, unsigned int keyModState );
60     void init( int button, const osgGA::GUIEventAdapter* ea );
61 };
62
63
64 void ActivePickCallbacks::init( int button, const osgGA::GUIEventAdapter* ea )
65 {
66   osg::Vec2d windowPos;
67   flightgear::eventToWindowCoords(ea, windowPos.x(), windowPos.y());
68     
69   // Get the list of hit callbacks. Take the first callback that
70   // accepts the mouse button press and ignore the rest of them
71   // That is they get sorted by distance and by scenegraph depth.
72   // The nearest one is the first one and the deepest
73   // (the most specialized one in the scenegraph) is the first.
74   std::vector<SGSceneryPick> pickList;
75   if (!globals->get_renderer()->pick(pickList, windowPos)) {
76     return;
77   }
78
79   std::vector<SGSceneryPick>::const_iterator i;
80   for (i = pickList.begin(); i != pickList.end(); ++i) {
81     if (i->callback->buttonPressed(button, ea, i->info)) {
82         (*this)[button].push_back(i->callback);
83         return;
84     }
85   }
86 }
87
88 void ActivePickCallbacks::update( double dt, unsigned int keyModState )
89 {
90   // handle repeatable mouse press events
91   for( iterator mi = begin(); mi != end(); ++mi ) {
92     std::list<SGSharedPtr<SGPickCallback> >::iterator li;
93     for (li = mi->second.begin(); li != mi->second.end(); ++li) {
94       (*li)->update(dt, keyModState);
95     }
96   }
97 }
98
99 ////////////////////////////////////////////////////////////////////////
100
101
102 /**
103  * Settings for a mouse mode.
104  */
105 struct mouse_mode {
106     mouse_mode ();
107     virtual ~mouse_mode ();
108     FGMouseCursor::Cursor cursor;
109     bool constrained;
110     bool pass_through;
111     FGButton * buttons;
112     SGBindingList x_bindings[KEYMOD_MAX];
113     SGBindingList y_bindings[KEYMOD_MAX];
114 };
115
116
117 /**
118  * Settings for a mouse.
119  */
120 struct mouse {
121     mouse ();
122     virtual ~mouse ();
123     int x, y;
124     SGPropertyNode_ptr mode_node;
125     SGPropertyNode_ptr mouse_button_nodes[MAX_MOUSE_BUTTONS];
126     int nModes;
127     int current_mode;
128     
129     SGTimeStamp timeSinceLastMove;
130     mouse_mode * modes;
131 };
132
133 ////////////////////////////////////////////////////////////////////////
134
135 class FGMouseInput::FGMouseInputPrivate : public SGPropertyChangeListener
136 {
137 public:
138     FGMouseInputPrivate() :
139         haveWarped(false),
140         xSizeNode(fgGetNode("/sim/startup/xsize", false ) ),
141         ySizeNode(fgGetNode("/sim/startup/ysize", false ) ),
142         xAccelNode(fgGetNode("/devices/status/mice/mouse/accel-x", true ) ),
143         yAccelNode(fgGetNode("/devices/status/mice/mouse/accel-y", true ) ),
144         mouseXNode(fgGetNode("/devices/status/mice/mouse/x", true)),
145         mouseYNode(fgGetNode("/devices/status/mice/mouse/y", true))
146     {
147         tooltipTimeoutDone = false;
148
149         fgGetNode("/sim/mouse/hide-cursor", true )->addChangeListener(this, true);
150         fgGetNode("/sim/mouse/cursor-timeout-sec", true )->addChangeListener(this, true);
151         fgGetNode("/sim/mouse/right-button-mode-cycle-enabled", true)->addChangeListener(this, true);
152         fgGetNode("/sim/mouse/tooltip-delay-msec", true)->addChangeListener(this, true);
153         fgGetNode("/sim/mouse/click-shows-tooltip", true)->addChangeListener(this, true);
154         fgGetNode("/sim/mouse/drag-sensitivity", true)->addChangeListener(this, true);
155         fgGetNode("/sim/mouse/invert-mouse-wheel", true)->addChangeListener(this, true);
156     }
157   
158     void centerMouseCursor(mouse& m)
159     {    
160       // center the cursor
161       m.x = (xSizeNode ? xSizeNode->getIntValue() : 800) / 2;
162       m.y = (ySizeNode ? ySizeNode->getIntValue() : 600) / 2;
163       fgWarpMouse(m.x, m.y);
164       haveWarped = true;
165     }
166   
167     void constrainMouse(int x, int y)
168     {
169         int new_x=x,new_y=y;
170         int xsize = xSizeNode ? xSizeNode->getIntValue() : 800;
171         int ysize = ySizeNode ? ySizeNode->getIntValue() : 600;
172         
173         bool need_warp = false;
174         if (x <= (xsize * .25) || x >= (xsize * .75)) {
175           new_x = int(xsize * .5);
176           need_warp = true;
177         }
178
179         if (y <= (ysize * .25) || y >= (ysize * .75)) {
180           new_y = int(ysize * .5);
181           need_warp = true;
182         }
183
184         if (need_warp)
185         {
186           fgWarpMouse(new_x, new_y);
187           haveWarped = true;
188         }
189     }
190
191     void doHoverPick(const osg::Vec2d& windowPos)
192     {
193         std::vector<SGSceneryPick> pickList;
194         SGPickCallback::Priority priority = SGPickCallback::PriorityScenery;
195       
196         FGMouseCursor::Cursor cur = FGMouseCursor::CURSOR_ARROW;
197         bool explicitCursor = false;
198         bool didPick = false;
199       
200         if (globals->get_renderer()->pick(pickList, windowPos)) {
201             
202             std::vector<SGSceneryPick>::const_iterator i;
203             for (i = pickList.begin(); i != pickList.end(); ++i) {
204                 bool done = i->callback->hover(windowPos, i->info);
205                 std::string curName(i->callback->getCursor());
206                 if (!curName.empty()) {
207                     explicitCursor = true;
208                     cur = FGMouseCursor::cursorFromString(curName.c_str());
209                 }
210                 
211             // if the callback is of higher prioirty (lower enum index),
212             // record that.
213                 if (i->callback->getPriority() < priority) {
214                     priority = i->callback->getPriority();
215                 }
216                 
217                 if (done) {
218                     didPick = true;
219                     break;
220                 }
221             } // of picks iteration
222         } else { // of have valid pick
223         }
224       
225         if (!explicitCursor && (priority == SGPickCallback::PriorityPanel)) {
226             cur = FGMouseCursor::CURSOR_HAND;
227         }
228         
229         FGMouseCursor::instance()->setCursor(cur);
230         if (!didPick) {
231           updateHover();
232         }
233     }
234     
235     void doMouseMoveWithCallbacks(const osgGA::GUIEventAdapter* ea)
236     {
237         FGMouseCursor::Cursor cur = FGMouseCursor::CURSOR_CLOSED_HAND;
238         
239         BOOST_FOREACH(SGPickCallback* cb, activePickCallbacks[0]) {
240             cb->mouseMoved(ea);
241             std::string curName(cb->getCursor());
242             if (!curName.empty()) {
243                 cur = FGMouseCursor::cursorFromString(curName.c_str());
244             }
245         }
246
247         FGMouseCursor::instance()->setCursor(cur);
248     }
249     
250     void updateHover()
251     {
252         SGPropertyNode_ptr args(new SGPropertyNode);
253         globals->get_commands()->execute("update-hover", args);
254     }
255
256     
257     // implement the property-change-listener interfacee
258     virtual void valueChanged( SGPropertyNode * node )
259     {
260         if (node->getNameString() == "drag-sensitivity") {
261             SGKnobAnimation::setDragSensitivity(node->getDoubleValue());
262         } else if (node->getNameString() == "invert-mouse-wheel") {
263             SGKnobAnimation::setAlternateMouseWheelDirection(node->getBoolValue());
264         } else if (node->getNameString() == "hide-cursor") {
265             hideCursor = node->getBoolValue();
266         } else if (node->getNameString() == "cursor-timeout-sec") {
267             cursorTimeoutMsec = node->getDoubleValue() * 1000;
268         } else if (node->getNameString() == "tooltip-delay-msec") {
269             tooltipDelayMsec = node->getIntValue();
270         } else if (node->getNameString() == "right-button-mode-cycle-enabled") {
271             rightClickModeCycle = node->getBoolValue();
272         } else if (node->getNameString() == "click-shows-tooltip") {
273             clickTriggersTooltip = node->getBoolValue();
274
275         }
276     }
277     
278     ActivePickCallbacks activePickCallbacks;
279
280     mouse mice[MAX_MICE];
281     
282     bool hideCursor, haveWarped;
283     bool tooltipTimeoutDone;
284     bool clickTriggersTooltip;
285     int tooltipDelayMsec, cursorTimeoutMsec;
286     bool rightClickModeCycle;
287     
288     SGPropertyNode_ptr xSizeNode;
289     SGPropertyNode_ptr ySizeNode;
290     SGPropertyNode_ptr xAccelNode;
291     SGPropertyNode_ptr yAccelNode;
292     SGPropertyNode_ptr mouseXNode, mouseYNode;
293 };
294
295
296 ////////////////////////////////////////////////////////////////////////
297 // The Mouse Input Implementation
298 ////////////////////////////////////////////////////////////////////////
299
300 static FGMouseInput* global_mouseInput = NULL;
301
302 static void mouseClickHandler(int button, int updown, int x, int y, bool mainWindow, const osgGA::GUIEventAdapter* ea)
303 {
304     if(global_mouseInput)
305         global_mouseInput->doMouseClick(button, updown, x, y, mainWindow, ea);
306 }
307
308 static void mouseMotionHandler(int x, int y, const osgGA::GUIEventAdapter* ea)
309 {
310     if (global_mouseInput != 0)
311         global_mouseInput->doMouseMotion(x, y, ea);
312 }
313
314
315
316 FGMouseInput::FGMouseInput() :
317   d(new FGMouseInputPrivate)
318 {
319     global_mouseInput = this;
320 }
321
322 FGMouseInput::~FGMouseInput()
323 {
324     global_mouseInput = NULL;
325 }
326
327 void FGMouseInput::init()
328 {
329   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing mouse bindings");
330   string module = "";
331
332   SGPropertyNode * mouse_nodes = fgGetNode("/input/mice");
333   if (mouse_nodes == 0) {
334     SG_LOG(SG_INPUT, SG_WARN, "No mouse bindings (/input/mice)!!");
335     mouse_nodes = fgGetNode("/input/mice", true);
336   }
337
338   int j;
339   for (int i = 0; i < MAX_MICE; i++) {
340     SGPropertyNode * mouse_node = mouse_nodes->getChild("mouse", i, true);
341     mouse &m = d->mice[i];
342
343                                 // Grab node pointers
344     std::ostringstream buf;
345     buf <<  "/devices/status/mice/mouse[" << i << "]/mode";
346     m.mode_node = fgGetNode(buf.str().c_str());
347     if (m.mode_node == NULL) {
348       m.mode_node = fgGetNode(buf.str().c_str(), true);
349       m.mode_node->setIntValue(0);
350     }
351     for (j = 0; j < MAX_MOUSE_BUTTONS; j++) {
352       buf.seekp(ios_base::beg);
353       buf << "/devices/status/mice/mouse["<< i << "]/button[" << j << "]";
354       m.mouse_button_nodes[j] = fgGetNode(buf.str().c_str(), true);
355       m.mouse_button_nodes[j]->setBoolValue(false);
356     }
357
358    // Read all the modes
359     m.nModes = mouse_node->getIntValue("mode-count", 1);
360     m.modes = new mouse_mode[m.nModes];
361
362     for (int j = 0; j < m.nModes; j++) {
363       int k;
364       SGPropertyNode * mode_node = mouse_node->getChild("mode", j, true);
365
366     // Read the mouse cursor for this mode
367       m.modes[j].cursor = FGMouseCursor::cursorFromString(mode_node->getStringValue("cursor", "inherit"));
368         
369       // Read other properties for this mode
370       m.modes[j].constrained = mode_node->getBoolValue("constrained", false);
371       m.modes[j].pass_through = mode_node->getBoolValue("pass-through", false);
372
373       // Read the button bindings for this mode
374       m.modes[j].buttons = new FGButton[MAX_MOUSE_BUTTONS];
375       std::ostringstream buf;
376       for (k = 0; k < MAX_MOUSE_BUTTONS; k++) {
377         buf.seekp(ios_base::beg);
378         buf << "mouse button " << k;
379         m.modes[j].buttons[k].init( mode_node->getChild("button", k), buf.str(), module );
380       }
381
382       // Read the axis bindings for this mode
383       read_bindings(mode_node->getChild("x-axis", 0, true), m.modes[j].x_bindings, KEYMOD_NONE, module );
384       read_bindings(mode_node->getChild("y-axis", 0, true), m.modes[j].y_bindings, KEYMOD_NONE, module );
385       
386       if (mode_node->hasChild("x-axis-ctrl")) {
387         read_bindings(mode_node->getChild("x-axis-ctrl"), m.modes[j].x_bindings, KEYMOD_CTRL, module );
388       }
389       
390       if (mode_node->hasChild("y-axis-ctrl")) {
391         read_bindings(mode_node->getChild("y-axis-ctrl"), m.modes[j].y_bindings, KEYMOD_CTRL, module );
392       }
393     } // of modes iteration
394   }
395
396   fgRegisterMouseClickHandler(mouseClickHandler);
397   fgRegisterMouseMotionHandler(mouseMotionHandler);
398 }
399
400 void FGMouseInput::update ( double dt )
401 {
402   mouse &m = d->mice[0];
403   int mode =  m.mode_node->getIntValue();
404   if (mode != m.current_mode) {
405     // current mode has changed
406     m.current_mode = mode;
407     m.timeSinceLastMove.stamp();
408       
409     if (mode >= 0 && mode < m.nModes) {
410       FGMouseCursor::instance()->setCursor(m.modes[mode].cursor);
411       d->centerMouseCursor(m);
412     } else {
413       SG_LOG(SG_INPUT, SG_WARN, "Mouse mode " << mode << " out of range");
414       FGMouseCursor::instance()->setCursor(FGMouseCursor::CURSOR_ARROW);
415     }
416   }
417
418   // if delay is <= 0, disable tooltips
419   if ( !d->tooltipTimeoutDone &&
420       (d->tooltipDelayMsec > 0) &&
421       (m.timeSinceLastMove.elapsedMSec() > d->tooltipDelayMsec))
422   {
423       d->tooltipTimeoutDone = true;
424       SGPropertyNode_ptr arg(new SGPropertyNode);
425       globals->get_commands()->execute("tooltip-timeout", arg);
426   }
427   
428   if ( d->hideCursor ) {
429       if ( m.timeSinceLastMove.elapsedMSec() > d->cursorTimeoutMsec) {
430           FGMouseCursor::instance()->hideCursorUntilMouseMove();
431           m.timeSinceLastMove.stamp();
432       }
433   }
434     
435   d->activePickCallbacks.update( dt, fgGetKeyModifiers() );
436 }
437
438 mouse::mouse ()
439   : x(-1),
440     y(-1),
441     nModes(1),
442     current_mode(0),
443     modes(NULL)
444 {
445 }
446
447 mouse::~mouse ()
448 {
449   delete [] modes;
450 }
451
452 mouse_mode::mouse_mode ()
453   : cursor(FGMouseCursor::CURSOR_ARROW),
454     constrained(false),
455     pass_through(false),
456     buttons(NULL)
457 {
458 }
459
460 mouse_mode::~mouse_mode ()
461 {
462                                 // FIXME: memory leak
463 //   for (int i = 0; i < KEYMOD_MAX; i++) {
464 //     int j;
465 //     for (j = 0; i < x_bindings[i].size(); j++)
466 //       delete bindings[i][j];
467 //     for (j = 0; j < y_bindings[i].size(); j++)
468 //       delete bindings[i][j];
469 //   }
470   if (buttons) {
471     delete [] buttons;
472   }
473 }
474
475 void FGMouseInput::doMouseClick (int b, int updown, int x, int y, bool mainWindow, const osgGA::GUIEventAdapter* ea)
476 {
477   int modifiers = fgGetKeyModifiers();
478
479   mouse &m = d->mice[0];
480   mouse_mode &mode = m.modes[m.current_mode];
481                                 // Let the property manager know.
482   if (b >= 0 && b < MAX_MOUSE_BUTTONS)
483     m.mouse_button_nodes[b]->setBoolValue(updown == MOUSE_BUTTON_DOWN);
484
485   if (!d->rightClickModeCycle && (b == 2)) {
486     // in spring-loaded look mode, ignore right clicks entirely here
487     return;
488   }
489   
490   // Pass on to PUI and the panel if
491   // requested, and return if one of
492   // them consumes the event.
493
494   if (updown != MOUSE_BUTTON_DOWN) {
495     // Execute the mouse up event in any case, may be we should
496     // stop processing here?
497     while (!d->activePickCallbacks[b].empty()) {
498       d->activePickCallbacks[b].front()->buttonReleased(ea->getModKeyMask());
499       d->activePickCallbacks[b].pop_front();
500     }
501   }
502
503   if (mode.pass_through) {
504     // remove once PUI uses standard picking mechanism
505     if (0 <= x && 0 <= y && puMouse(b, updown, x, y))
506       return; // pui handled it
507
508     // pui didn't want the click event so compute a
509     // scenegraph intersection point corresponding to the mouse click
510     if (updown == MOUSE_BUTTON_DOWN) {
511       d->activePickCallbacks.init( b, ea );
512         
513       if (d->clickTriggersTooltip) {
514             SGPropertyNode_ptr args(new SGPropertyNode);
515             args->setStringValue("reason", "click");
516             globals->get_commands()->execute("tooltip-timeout", args);
517             d->tooltipTimeoutDone = true;
518       }
519     } else {
520       // do a hover pick now, to fix up cursor
521       osg::Vec2d windowPos;
522       flightgear::eventToWindowCoords(ea, windowPos.x(), windowPos.y());
523       d->doHoverPick(windowPos);
524     } // mouse button was released
525   } // of pass-through mode
526
527   // OK, PUI and the panel didn't want the click
528   if (b >= MAX_MOUSE_BUTTONS) {
529     SG_LOG(SG_INPUT, SG_ALERT, "Mouse button " << b
530            << " where only " << MAX_MOUSE_BUTTONS << " expected");
531     return;
532   }
533
534   m.modes[m.current_mode].buttons[b].update( modifiers, 0 != updown, x, y);  
535 }
536
537 void FGMouseInput::processMotion(int x, int y, const osgGA::GUIEventAdapter* ea)
538 {
539   if (!d->activePickCallbacks[0].empty()) {
540     d->doMouseMoveWithCallbacks(ea);
541     return;
542   }
543   
544   mouse &m = d->mice[0];
545   int modeIndex = m.current_mode;
546   // are we in spring-loaded look mode?
547   if (!d->rightClickModeCycle) {
548     if (m.mouse_button_nodes[2]->getBoolValue()) {
549       // right mouse is down, force look mode
550       modeIndex = 3;
551     }
552   }
553
554   if (modeIndex == 0) {
555     osg::Vec2d windowPos;
556     flightgear::eventToWindowCoords(ea, windowPos.x(), windowPos.y());
557     d->doHoverPick(windowPos);
558     // mouse has moved, so we may need to issue tooltip-timeout command again
559     d->tooltipTimeoutDone = false;
560   }
561   
562   mouse_mode &mode = m.modes[modeIndex];
563   
564   // Pass on to PUI if requested, and return
565   // if PUI consumed the event.
566   if (mode.pass_through && puMouse(x, y)) {
567     return;
568   }
569
570   if (d->haveWarped)
571   {
572     // don't fire mouse-movement events at the first update after warping the mouse,
573     // just remember the new mouse position
574     d->haveWarped = false;
575   }
576   else
577   {
578     int modifiers = fgGetKeyModifiers();
579     int xsize = d->xSizeNode ? d->xSizeNode->getIntValue() : 800;
580     int ysize = d->ySizeNode ? d->ySizeNode->getIntValue() : 600;
581       
582     // OK, PUI didn't want the event,
583     // so we can play with it.
584     if (x != m.x) {
585       int delta = x - m.x;
586       d->xAccelNode->setIntValue( delta );
587       for (unsigned int i = 0; i < mode.x_bindings[modifiers].size(); i++)
588         mode.x_bindings[modifiers][i]->fire(double(delta), double(xsize));
589     }
590     if (y != m.y) {
591       int delta = y - m.y;
592       d->yAccelNode->setIntValue( -delta );
593       for (unsigned int i = 0; i < mode.y_bindings[modifiers].size(); i++)
594         mode.y_bindings[modifiers][i]->fire(double(delta), double(ysize));
595     }
596   }
597   
598   // Constrain the mouse if requested
599   if (mode.constrained) {
600     d->constrainMouse(x, y);
601   }
602 }
603
604 void FGMouseInput::doMouseMotion (int x, int y, const osgGA::GUIEventAdapter* ea)
605 {
606   mouse &m = d->mice[0];
607
608   if (m.current_mode < 0 || m.current_mode >= m.nModes) {
609       m.x = x;
610       m.y = y;
611       return;
612   }
613
614   m.timeSinceLastMove.stamp();
615   FGMouseCursor::instance()->mouseMoved();
616
617   processMotion(x, y, ea);
618     
619   m.x = x;
620   m.y = y;
621   d->mouseXNode->setIntValue(x);
622   d->mouseYNode->setIntValue(y);
623 }
624
625
626