1 // FGMouseInput.cxx -- handle user input from mouse 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 "FGMouseInput.hxx"
31 #include <boost/foreach.hpp>
32 #include <osgGA/GUIEventAdapter>
34 #include <simgear/scene/util/SGPickCallback.hxx>
35 #include <simgear/timing/timestamp.hxx>
36 #include <simgear/scene/model/SGPickAnimation.hxx>
38 #include "FGButton.hxx"
39 #include "Main/globals.hxx"
40 #include <Viewer/renderer.hxx>
42 #include <Model/panelnode.hxx>
43 #include <Cockpit/panel.hxx>
44 #include <Viewer/FGEventHandler.hxx>
45 #include <GUI/MouseCursor.hxx>
49 const int MAX_MICE = 1;
50 const int MAX_MOUSE_BUTTONS = 8;
52 ////////////////////////////////////////////////////////////////////////
55 * List of currently pressed mouse button events
57 class ActivePickCallbacks : public std::map<int, std::list<SGSharedPtr<SGPickCallback> > > {
59 void update( double dt, unsigned int keyModState );
60 void init( int button, const osgGA::GUIEventAdapter* ea );
64 void ActivePickCallbacks::init( int button, const osgGA::GUIEventAdapter* ea )
67 flightgear::eventToWindowCoords(ea, windowPos.x(), windowPos.y());
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)) {
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);
88 void ActivePickCallbacks::update( double dt, unsigned int keyModState )
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);
99 ////////////////////////////////////////////////////////////////////////
103 * Settings for a mouse mode.
107 virtual ~mouse_mode ();
108 FGMouseCursor::Cursor cursor;
112 SGBindingList x_bindings[KEYMOD_MAX];
113 SGBindingList y_bindings[KEYMOD_MAX];
118 * Settings for a mouse.
124 SGPropertyNode_ptr mode_node;
125 SGPropertyNode_ptr mouse_button_nodes[MAX_MOUSE_BUTTONS];
129 SGTimeStamp timeSinceLastMove;
133 ////////////////////////////////////////////////////////////////////////
135 class FGMouseInput::FGMouseInputPrivate : public SGPropertyChangeListener
138 FGMouseInputPrivate() :
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))
147 tooltipTimeoutDone = false;
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);
158 void centerMouseCursor(mouse& m)
161 m.x = (xSizeNode ? xSizeNode->getIntValue() : 800) / 2;
162 m.y = (ySizeNode ? ySizeNode->getIntValue() : 600) / 2;
163 fgWarpMouse(m.x, m.y);
167 void constrainMouse(int x, int y)
170 int xsize = xSizeNode ? xSizeNode->getIntValue() : 800;
171 int ysize = ySizeNode ? ySizeNode->getIntValue() : 600;
173 bool need_warp = false;
174 if (x <= (xsize * .25) || x >= (xsize * .75)) {
175 new_x = int(xsize * .5);
179 if (y <= (ysize * .25) || y >= (ysize * .75)) {
180 new_y = int(ysize * .5);
186 fgWarpMouse(new_x, new_y);
191 void doHoverPick(const osg::Vec2d& windowPos)
193 std::vector<SGSceneryPick> pickList;
194 SGPickCallback::Priority priority = SGPickCallback::PriorityScenery;
196 FGMouseCursor::Cursor cur = FGMouseCursor::CURSOR_ARROW;
197 bool explicitCursor = false;
199 if (globals->get_renderer()->pick(pickList, windowPos)) {
201 std::vector<SGSceneryPick>::const_iterator i;
202 for (i = pickList.begin(); i != pickList.end(); ++i) {
203 bool done = i->callback->hover(windowPos, i->info);
204 std::string curName(i->callback->getCursor());
205 if (!curName.empty()) {
206 explicitCursor = true;
207 cur = FGMouseCursor::cursorFromString(curName.c_str());
210 // if the callback is of higher prioirty (lower enum index),
212 if (i->callback->getPriority() < priority) {
213 priority = i->callback->getPriority();
219 } // of picks iteration
220 } // of have valid pick
223 if (!explicitCursor && (priority == SGPickCallback::PriorityPanel)) {
224 cur = FGMouseCursor::CURSOR_HAND;
227 FGMouseCursor::instance()->setCursor(cur);
231 void doMouseMoveWithCallbacks(const osgGA::GUIEventAdapter* ea)
233 FGMouseCursor::Cursor cur = FGMouseCursor::CURSOR_CLOSED_HAND;
235 BOOST_FOREACH(SGPickCallback* cb, activePickCallbacks[0]) {
237 std::string curName(cb->getCursor());
238 if (!curName.empty()) {
239 cur = FGMouseCursor::cursorFromString(curName.c_str());
243 FGMouseCursor::instance()->setCursor(cur);
248 SGPropertyNode_ptr args(new SGPropertyNode);
249 globals->get_commands()->execute("update-hover", args);
253 // implement the property-change-listener interfacee
254 virtual void valueChanged( SGPropertyNode * node )
256 if (node->getNameString() == "drag-sensitivity") {
257 SGKnobAnimation::setDragSensitivity(node->getDoubleValue());
258 } else if (node->getNameString() == "invert-mouse-wheel") {
259 SGKnobAnimation::setAlternateMouseWheelDirection(node->getBoolValue());
260 } else if (node->getNameString() == "hide-cursor") {
261 hideCursor = node->getBoolValue();
262 } else if (node->getNameString() == "cursor-timeout-sec") {
263 cursorTimeoutMsec = node->getDoubleValue() * 1000;
264 } else if (node->getNameString() == "tooltip-delay-msec") {
265 tooltipDelayMsec = node->getIntValue();
266 } else if (node->getNameString() == "right-button-mode-cycle-enabled") {
267 rightClickModeCycle = node->getBoolValue();
268 } else if (node->getNameString() == "click-shows-tooltip") {
269 clickTriggersTooltip = node->getBoolValue();
274 ActivePickCallbacks activePickCallbacks;
276 mouse mice[MAX_MICE];
278 bool hideCursor, haveWarped;
279 bool tooltipTimeoutDone;
280 bool clickTriggersTooltip;
281 int tooltipDelayMsec, cursorTimeoutMsec;
282 bool rightClickModeCycle;
284 SGPropertyNode_ptr xSizeNode;
285 SGPropertyNode_ptr ySizeNode;
286 SGPropertyNode_ptr xAccelNode;
287 SGPropertyNode_ptr yAccelNode;
288 SGPropertyNode_ptr mouseXNode, mouseYNode;
292 ////////////////////////////////////////////////////////////////////////
293 // The Mouse Input Implementation
294 ////////////////////////////////////////////////////////////////////////
296 static FGMouseInput* global_mouseInput = NULL;
298 static void mouseClickHandler(int button, int updown, int x, int y, bool mainWindow, const osgGA::GUIEventAdapter* ea)
300 if(global_mouseInput)
301 global_mouseInput->doMouseClick(button, updown, x, y, mainWindow, ea);
304 static void mouseMotionHandler(int x, int y, const osgGA::GUIEventAdapter* ea)
306 if (global_mouseInput != 0)
307 global_mouseInput->doMouseMotion(x, y, ea);
312 FGMouseInput::FGMouseInput() :
313 d(new FGMouseInputPrivate)
315 global_mouseInput = this;
318 FGMouseInput::~FGMouseInput()
320 global_mouseInput = NULL;
323 void FGMouseInput::init()
325 SG_LOG(SG_INPUT, SG_DEBUG, "Initializing mouse bindings");
328 SGPropertyNode * mouse_nodes = fgGetNode("/input/mice");
329 if (mouse_nodes == 0) {
330 SG_LOG(SG_INPUT, SG_WARN, "No mouse bindings (/input/mice)!!");
331 mouse_nodes = fgGetNode("/input/mice", true);
335 for (int i = 0; i < MAX_MICE; i++) {
336 SGPropertyNode * mouse_node = mouse_nodes->getChild("mouse", i, true);
337 mouse &m = d->mice[i];
339 // Grab node pointers
340 std::ostringstream buf;
341 buf << "/devices/status/mice/mouse[" << i << "]/mode";
342 m.mode_node = fgGetNode(buf.str().c_str());
343 if (m.mode_node == NULL) {
344 m.mode_node = fgGetNode(buf.str().c_str(), true);
345 m.mode_node->setIntValue(0);
347 for (j = 0; j < MAX_MOUSE_BUTTONS; j++) {
348 buf.seekp(ios_base::beg);
349 buf << "/devices/status/mice/mouse["<< i << "]/button[" << j << "]";
350 m.mouse_button_nodes[j] = fgGetNode(buf.str().c_str(), true);
351 m.mouse_button_nodes[j]->setBoolValue(false);
354 // Read all the modes
355 m.nModes = mouse_node->getIntValue("mode-count", 1);
356 m.modes = new mouse_mode[m.nModes];
358 for (int j = 0; j < m.nModes; j++) {
360 SGPropertyNode * mode_node = mouse_node->getChild("mode", j, true);
362 // Read the mouse cursor for this mode
363 m.modes[j].cursor = FGMouseCursor::cursorFromString(mode_node->getStringValue("cursor", "inherit"));
365 // Read other properties for this mode
366 m.modes[j].constrained = mode_node->getBoolValue("constrained", false);
367 m.modes[j].pass_through = mode_node->getBoolValue("pass-through", false);
369 // Read the button bindings for this mode
370 m.modes[j].buttons = new FGButton[MAX_MOUSE_BUTTONS];
371 std::ostringstream buf;
372 for (k = 0; k < MAX_MOUSE_BUTTONS; k++) {
373 buf.seekp(ios_base::beg);
374 buf << "mouse button " << k;
375 m.modes[j].buttons[k].init( mode_node->getChild("button", k), buf.str(), module );
378 // Read the axis bindings for this mode
379 read_bindings(mode_node->getChild("x-axis", 0, true), m.modes[j].x_bindings, KEYMOD_NONE, module );
380 read_bindings(mode_node->getChild("y-axis", 0, true), m.modes[j].y_bindings, KEYMOD_NONE, module );
382 if (mode_node->hasChild("x-axis-ctrl")) {
383 read_bindings(mode_node->getChild("x-axis-ctrl"), m.modes[j].x_bindings, KEYMOD_CTRL, module );
386 if (mode_node->hasChild("y-axis-ctrl")) {
387 read_bindings(mode_node->getChild("y-axis-ctrl"), m.modes[j].y_bindings, KEYMOD_CTRL, module );
389 } // of modes iteration
392 fgRegisterMouseClickHandler(mouseClickHandler);
393 fgRegisterMouseMotionHandler(mouseMotionHandler);
396 void FGMouseInput::update ( double dt )
398 mouse &m = d->mice[0];
399 int mode = m.mode_node->getIntValue();
400 if (mode != m.current_mode) {
401 // current mode has changed
402 m.current_mode = mode;
403 m.timeSinceLastMove.stamp();
405 if (mode >= 0 && mode < m.nModes) {
406 FGMouseCursor::instance()->setCursor(m.modes[mode].cursor);
407 d->centerMouseCursor(m);
409 SG_LOG(SG_INPUT, SG_WARN, "Mouse mode " << mode << " out of range");
410 FGMouseCursor::instance()->setCursor(FGMouseCursor::CURSOR_ARROW);
414 // if delay is <= 0, disable tooltips
415 if ( !d->tooltipTimeoutDone &&
416 (d->tooltipDelayMsec > 0) &&
417 (m.timeSinceLastMove.elapsedMSec() > d->tooltipDelayMsec))
419 d->tooltipTimeoutDone = true;
420 SGPropertyNode_ptr arg(new SGPropertyNode);
421 globals->get_commands()->execute("tooltip-timeout", arg);
424 if ( d->hideCursor ) {
425 if ( m.timeSinceLastMove.elapsedMSec() > d->cursorTimeoutMsec) {
426 FGMouseCursor::instance()->hideCursorUntilMouseMove();
427 m.timeSinceLastMove.stamp();
431 d->activePickCallbacks.update( dt, fgGetKeyModifiers() );
448 mouse_mode::mouse_mode ()
449 : cursor(FGMouseCursor::CURSOR_ARROW),
456 mouse_mode::~mouse_mode ()
458 // FIXME: memory leak
459 // for (int i = 0; i < KEYMOD_MAX; i++) {
461 // for (j = 0; i < x_bindings[i].size(); j++)
462 // delete bindings[i][j];
463 // for (j = 0; j < y_bindings[i].size(); j++)
464 // delete bindings[i][j];
471 void FGMouseInput::doMouseClick (int b, int updown, int x, int y, bool mainWindow, const osgGA::GUIEventAdapter* ea)
473 int modifiers = fgGetKeyModifiers();
475 mouse &m = d->mice[0];
476 mouse_mode &mode = m.modes[m.current_mode];
477 // Let the property manager know.
478 if (b >= 0 && b < MAX_MOUSE_BUTTONS)
479 m.mouse_button_nodes[b]->setBoolValue(updown == MOUSE_BUTTON_DOWN);
481 if (!d->rightClickModeCycle && (b == 2)) {
482 // in spring-loaded look mode, ignore right clicks entirely here
486 // Pass on to PUI and the panel if
487 // requested, and return if one of
488 // them consumes the event.
490 if (updown != MOUSE_BUTTON_DOWN) {
491 // Execute the mouse up event in any case, may be we should
492 // stop processing here?
493 while (!d->activePickCallbacks[b].empty()) {
494 d->activePickCallbacks[b].front()->buttonReleased(ea->getModKeyMask());
495 d->activePickCallbacks[b].pop_front();
499 if (mode.pass_through) {
500 // remove once PUI uses standard picking mechanism
501 if (0 <= x && 0 <= y && puMouse(b, updown, x, y))
502 return; // pui handled it
504 // pui didn't want the click event so compute a
505 // scenegraph intersection point corresponding to the mouse click
506 if (updown == MOUSE_BUTTON_DOWN) {
507 d->activePickCallbacks.init( b, ea );
509 if (d->clickTriggersTooltip) {
510 SGPropertyNode_ptr args(new SGPropertyNode);
511 args->setStringValue("reason", "click");
512 globals->get_commands()->execute("tooltip-timeout", args);
513 d->tooltipTimeoutDone = true;
516 // do a hover pick now, to fix up cursor
517 osg::Vec2d windowPos;
518 flightgear::eventToWindowCoords(ea, windowPos.x(), windowPos.y());
519 d->doHoverPick(windowPos);
520 } // mouse button was released
521 } // of pass-through mode
523 // OK, PUI and the panel didn't want the click
524 if (b >= MAX_MOUSE_BUTTONS) {
525 SG_LOG(SG_INPUT, SG_ALERT, "Mouse button " << b
526 << " where only " << MAX_MOUSE_BUTTONS << " expected");
530 m.modes[m.current_mode].buttons[b].update( modifiers, 0 != updown, x, y);
533 void FGMouseInput::processMotion(int x, int y, const osgGA::GUIEventAdapter* ea)
535 if (!d->activePickCallbacks[0].empty()) {
536 d->doMouseMoveWithCallbacks(ea);
540 mouse &m = d->mice[0];
541 int modeIndex = m.current_mode;
542 // are we in spring-loaded look mode?
543 if (!d->rightClickModeCycle) {
544 if (m.mouse_button_nodes[2]->getBoolValue()) {
545 // right mouse is down, force look mode
550 if (modeIndex == 0) {
551 osg::Vec2d windowPos;
552 flightgear::eventToWindowCoords(ea, windowPos.x(), windowPos.y());
553 d->doHoverPick(windowPos);
554 // mouse has moved, so we may need to issue tooltip-timeout command again
555 d->tooltipTimeoutDone = false;
558 mouse_mode &mode = m.modes[modeIndex];
560 // Pass on to PUI if requested, and return
561 // if PUI consumed the event.
562 if (mode.pass_through && puMouse(x, y)) {
568 // don't fire mouse-movement events at the first update after warping the mouse,
569 // just remember the new mouse position
570 d->haveWarped = false;
574 int modifiers = fgGetKeyModifiers();
575 int xsize = d->xSizeNode ? d->xSizeNode->getIntValue() : 800;
576 int ysize = d->ySizeNode ? d->ySizeNode->getIntValue() : 600;
578 // OK, PUI didn't want the event,
579 // so we can play with it.
582 d->xAccelNode->setIntValue( delta );
583 for (unsigned int i = 0; i < mode.x_bindings[modifiers].size(); i++)
584 mode.x_bindings[modifiers][i]->fire(double(delta), double(xsize));
588 d->yAccelNode->setIntValue( -delta );
589 for (unsigned int i = 0; i < mode.y_bindings[modifiers].size(); i++)
590 mode.y_bindings[modifiers][i]->fire(double(delta), double(ysize));
594 // Constrain the mouse if requested
595 if (mode.constrained) {
596 d->constrainMouse(x, y);
600 void FGMouseInput::doMouseMotion (int x, int y, const osgGA::GUIEventAdapter* ea)
602 mouse &m = d->mice[0];
604 if (m.current_mode < 0 || m.current_mode >= m.nModes) {
610 m.timeSinceLastMove.stamp();
611 FGMouseCursor::instance()->mouseMoved();
613 processMotion(x, y, ea);
617 d->mouseXNode->setIntValue(x);
618 d->mouseYNode->setIntValue(y);