]> git.mxchange.org Git - flightgear.git/blobdiff - src/Input/FGMouseInput.cxx
Allow using the system version of flite and the HTS engine
[flightgear.git] / src / Input / FGMouseInput.cxx
index eee13d6f6f25fdf1ba5b98317f4326bd46cf5ff2..6d052c8817f544e76db793991f40e92ef09e2e71 100644 (file)
@@ -33,6 +33,7 @@
 
 #include <simgear/scene/util/SGPickCallback.hxx>
 #include <simgear/timing/timestamp.hxx>
+#include <simgear/scene/model/SGPickAnimation.hxx>
 
 #include "FGButton.hxx"
 #include "Main/globals.hxx"
@@ -48,14 +49,20 @@ using std::ios_base;
 const int MAX_MICE = 1;
 const int MAX_MOUSE_BUTTONS = 8;
 
+typedef std::vector<SGSceneryPick> SGSceneryPicks;
+typedef SGSharedPtr<SGPickCallback> SGPickCallbackPtr;
+typedef std::list<SGPickCallbackPtr> SGPickCallbackList;
+
 ////////////////////////////////////////////////////////////////////////
 
 /**
  * List of currently pressed mouse button events
  */
-class ActivePickCallbacks : public std::map<int, std::list<SGSharedPtr<SGPickCallback> > > {
-public:
-    void update( double dt );
+class ActivePickCallbacks:
+  public std::map<int, SGPickCallbackList>
+{
+  public:
+    void update( double dt, unsigned int keyModState );
     void init( int button, const osgGA::GUIEventAdapter* ea );
 };
 
@@ -70,27 +77,27 @@ void ActivePickCallbacks::init( int button, const osgGA::GUIEventAdapter* ea )
   // That is they get sorted by distance and by scenegraph depth.
   // The nearest one is the first one and the deepest
   // (the most specialized one in the scenegraph) is the first.
-  std::vector<SGSceneryPick> pickList;
+  SGSceneryPicks pickList;
   if (!globals->get_renderer()->pick(pickList, windowPos)) {
     return;
   }
 
-  std::vector<SGSceneryPick>::const_iterator i;
+  SGSceneryPicks::const_iterator i;
   for (i = pickList.begin(); i != pickList.end(); ++i) {
-    if (i->callback->buttonPressed(button, ea, i->info)) {
+    if (i->callback->buttonPressed(button, *ea, i->info)) {
         (*this)[button].push_back(i->callback);
         return;
     }
   }
 }
 
-void ActivePickCallbacks::update( double dt )
+void ActivePickCallbacks::update( double dt, unsigned int keyModState )
 {
   // handle repeatable mouse press events
   for( iterator mi = begin(); mi != end(); ++mi ) {
-    std::list<SGSharedPtr<SGPickCallback> >::iterator li;
+    SGPickCallbackList::iterator li;
     for (li = mi->second.begin(); li != mi->second.end(); ++li) {
-      (*li)->update(dt);
+      (*li)->update(dt, keyModState);
     }
   }
 }
@@ -129,26 +136,45 @@ struct mouse {
     mouse_mode * modes;
 };
 
+static
+const SGSceneryPick*
+getPick( const SGSceneryPicks& pick_list,
+         const SGPickCallback* cb )
+{
+  for(size_t i = 0; i < pick_list.size(); ++i)
+    if( pick_list[i].callback == cb )
+      return &pick_list[i];
+
+  return 0;
+}
+
 ////////////////////////////////////////////////////////////////////////
 
-class FGMouseInput::FGMouseInputPrivate
+class FGMouseInput::FGMouseInputPrivate : public SGPropertyChangeListener
 {
 public:
     FGMouseInputPrivate() :
+        initialized(false),
         haveWarped(false),
         xSizeNode(fgGetNode("/sim/startup/xsize", false ) ),
         ySizeNode(fgGetNode("/sim/startup/ysize", false ) ),
         xAccelNode(fgGetNode("/devices/status/mice/mouse/accel-x", true ) ),
         yAccelNode(fgGetNode("/devices/status/mice/mouse/accel-y", true ) ),
-        hideCursorNode(fgGetNode("/sim/mouse/hide-cursor", true ) ),
-        cursorTimeoutNode(fgGetNode("/sim/mouse/cursor-timeout-sec", true ) ),
-        rightButtonModeCycleNode(fgGetNode("/sim/mouse/right-button-mode-cycle-enabled", true)),
-        tooltipShowDelayNode( fgGetNode("/sim/mouse/tooltip-delay-msec", true) ),
-        clickTriggersTooltipNode( fgGetNode("/sim/mouse/click-shows-tooltip", true) ),
         mouseXNode(fgGetNode("/devices/status/mice/mouse/x", true)),
         mouseYNode(fgGetNode("/devices/status/mice/mouse/y", true))
     {
         tooltipTimeoutDone = false;
+        hoverPickScheduled = false;
+        tooltipsEnabled = false;
+        
+        fgGetNode("/sim/mouse/hide-cursor", true )->addChangeListener(this, true);
+        fgGetNode("/sim/mouse/cursor-timeout-sec", true )->addChangeListener(this, true);
+        fgGetNode("/sim/mouse/right-button-mode-cycle-enabled", true)->addChangeListener(this, true);
+        fgGetNode("/sim/mouse/tooltip-delay-msec", true)->addChangeListener(this, true);
+        fgGetNode("/sim/mouse/click-shows-tooltip", true)->addChangeListener(this, true);
+        fgGetNode("/sim/mouse/tooltips-enabled", true)->addChangeListener(this, true);
+        fgGetNode("/sim/mouse/drag-sensitivity", true)->addChangeListener(this, true);
+        fgGetNode("/sim/mouse/invert-mouse-wheel", true)->addChangeListener(this, true);
     }
   
     void centerMouseCursor(mouse& m)
@@ -184,61 +210,138 @@ public:
         }
     }
 
+    void scheduleHoverPick(const osg::Vec2d& windowPos)
+    {
+      hoverPickScheduled = true;
+      hoverPos = windowPos;
+    }
+  
     void doHoverPick(const osg::Vec2d& windowPos)
     {
-        std::vector<SGSceneryPick> pickList;
+        FGMouseCursor::Cursor cur = FGMouseCursor::CURSOR_ARROW;
+        bool explicitCursor = false;
+        bool didPick = false;
+
         SGPickCallback::Priority priority = SGPickCallback::PriorityScenery;
-        
-        if (globals->get_renderer()->pick(pickList, windowPos)) {
+        SGSceneryPicks pickList;
+        globals->get_renderer()->pick(pickList, windowPos);
+
+        SGSceneryPicks::const_iterator i;
+        for( i = pickList.begin(); i != pickList.end(); ++i )
+        {
+            bool done = i->callback->hover(windowPos, i->info);
+            std::string curName(i->callback->getCursor());
+            if (!curName.empty()) {
+                explicitCursor = true;
+                cur = FGMouseCursor::cursorFromString(curName.c_str());
+            }
             
-            std::vector<SGSceneryPick>::const_iterator i;
-            for (i = pickList.begin(); i != pickList.end(); ++i) {
-                if (i->callback->hover(windowPos, i->info)) {
-                    return;
-                }
-                
             // if the callback is of higher prioirty (lower enum index),
             // record that.
-                if (i->callback->getPriority() < priority) {
-                    priority = i->callback->getPriority();
-                }
+            if (i->callback->getPriority() < priority) {
+                priority = i->callback->getPriority();
             }
-        } // of have valid pick
-                
-        if (priority == SGPickCallback::PriorityPanel) {
-            FGMouseCursor::instance()->setCursor(FGMouseCursor::CURSOR_HAND);
-        } else {
-            // restore normal cursor
-            FGMouseCursor::instance()->setCursor(FGMouseCursor::CURSOR_ARROW);
+
+            if (done) {
+                didPick = true;
+                break;
+            }
+        } // of picks iteration
+
+        // Check if any pick from the previous iteration has disappeared. If so
+        // notify the callback that the mouse has left its element.
+        for( i = _previous_picks.begin(); i != _previous_picks.end(); ++i )
+        {
+          if( !getPick(pickList, i->callback) )
+            i->callback->mouseLeave(windowPos);
+        }
+        _previous_picks = pickList;
+      
+        if (!explicitCursor && (priority == SGPickCallback::PriorityPanel)) {
+            cur = FGMouseCursor::CURSOR_HAND;
         }
         
-        updateHover();
+        FGMouseCursor::instance()->setCursor(cur);
+        if (!didPick) {
+          SGPropertyNode_ptr args(new SGPropertyNode);
+          globals->get_commands()->execute("update-hover", args);
+
+        }
     }
     
-    void updateHover()
+    void doMouseMoveWithCallbacks(const osgGA::GUIEventAdapter* ea)
     {
-        SGPropertyNode_ptr args(new SGPropertyNode);
-        globals->get_commands()->execute("update-hover", args);
+        FGMouseCursor::Cursor cur = FGMouseCursor::CURSOR_CLOSED_HAND;
+        
+        osg::Vec2d windowPos;
+        flightgear::eventToWindowCoords(ea, windowPos.x(), windowPos.y());
+
+        SGSceneryPicks pickList;
+        if( !globals->get_renderer()->pick(pickList, windowPos) )
+          return;
+
+        for( ActivePickCallbacks::iterator mi = activePickCallbacks.begin();
+                                           mi != activePickCallbacks.end();
+                                         ++mi )
+        {
+          SGPickCallbackList::iterator li;
+          for( li = mi->second.begin(); li != mi->second.end(); ++li )
+          {
+            const SGSceneryPick* pick = getPick(pickList, *li);
+            (*li)->mouseMoved(*ea, pick ? &pick->info : 0);
+
+            std::string curName((*li)->getCursor());
+            if( !curName.empty() )
+              cur = FGMouseCursor::cursorFromString(curName.c_str());
+          }
+        }
+
+        FGMouseCursor::instance()->setCursor(cur);
     }
 
+    // implement the property-change-listener interfacee
+    virtual void valueChanged( SGPropertyNode * node )
+    {
+        if (node->getNameString() == "drag-sensitivity") {
+            SGKnobAnimation::setDragSensitivity(node->getDoubleValue());
+        } else if (node->getNameString() == "invert-mouse-wheel") {
+            SGKnobAnimation::setAlternateMouseWheelDirection(node->getBoolValue());
+        } else if (node->getNameString() == "hide-cursor") {
+            hideCursor = node->getBoolValue();
+        } else if (node->getNameString() == "cursor-timeout-sec") {
+            cursorTimeoutMsec = node->getDoubleValue() * 1000;
+        } else if (node->getNameString() == "tooltip-delay-msec") {
+            tooltipDelayMsec = node->getIntValue();
+        } else if (node->getNameString() == "right-button-mode-cycle-enabled") {
+            rightClickModeCycle = node->getBoolValue();
+        } else if (node->getNameString() == "click-shows-tooltip") {
+            clickTriggersTooltip = node->getBoolValue();
+        } else if (node->getNameString() == "tooltips-enabled") {
+            tooltipsEnabled = node->getBoolValue();
+        }
+    }
     
     ActivePickCallbacks activePickCallbacks;
+    SGSceneryPicks _previous_picks;
 
     mouse mice[MAX_MICE];
     
-    bool haveWarped;
+    bool initialized;
+    bool hideCursor, haveWarped;
     bool tooltipTimeoutDone;
-  
+    bool clickTriggersTooltip;
+    int tooltipDelayMsec, cursorTimeoutMsec;
+    bool rightClickModeCycle;
+    bool tooltipsEnabled;
+    
     SGPropertyNode_ptr xSizeNode;
     SGPropertyNode_ptr ySizeNode;
     SGPropertyNode_ptr xAccelNode;
     SGPropertyNode_ptr yAccelNode;
-    SGPropertyNode_ptr hideCursorNode;
-    SGPropertyNode_ptr cursorTimeoutNode;
-    SGPropertyNode_ptr rightButtonModeCycleNode;
-    SGPropertyNode_ptr tooltipShowDelayNode;
-    SGPropertyNode_ptr clickTriggersTooltipNode;
     SGPropertyNode_ptr mouseXNode, mouseYNode;
+  
+    bool hoverPickScheduled;
+    osg::Vec2d hoverPos;
 };
 
 
@@ -275,8 +378,16 @@ FGMouseInput::~FGMouseInput()
 
 void FGMouseInput::init()
 {
+    if (d->initialized) {
+        SG_LOG(SG_INPUT, SG_WARN, "Duplicate init of FGMouseInput");
+
+        return;
+    }
+    
+    d->initialized = true;
+    
   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing mouse bindings");
-  string module = "";
+  std::string module = "";
 
   SGPropertyNode * mouse_nodes = fgGetNode("/input/mice");
   if (mouse_nodes == 0) {
@@ -304,7 +415,7 @@ void FGMouseInput::init()
       m.mouse_button_nodes[j]->setBoolValue(false);
     }
 
-                                // Read all the modes
+   // Read all the modes
     m.nModes = mouse_node->getIntValue("mode-count", 1);
     m.modes = new mouse_mode[m.nModes];
 
@@ -315,11 +426,11 @@ void FGMouseInput::init()
     // Read the mouse cursor for this mode
       m.modes[j].cursor = FGMouseCursor::cursorFromString(mode_node->getStringValue("cursor", "inherit"));
         
-                                // Read other properties for this mode
+      // Read other properties for this mode
       m.modes[j].constrained = mode_node->getBoolValue("constrained", false);
       m.modes[j].pass_through = mode_node->getBoolValue("pass-through", false);
 
-                                // Read the button bindings for this mode
+      // Read the button bindings for this mode
       m.modes[j].buttons = new FGButton[MAX_MOUSE_BUTTONS];
       std::ostringstream buf;
       for (k = 0; k < MAX_MOUSE_BUTTONS; k++) {
@@ -328,10 +439,30 @@ void FGMouseInput::init()
         m.modes[j].buttons[k].init( mode_node->getChild("button", k), buf.str(), module );
       }
 
-                                // Read the axis bindings for this mode
+      // Read the axis bindings for this mode
       read_bindings(mode_node->getChild("x-axis", 0, true), m.modes[j].x_bindings, KEYMOD_NONE, module );
       read_bindings(mode_node->getChild("y-axis", 0, true), m.modes[j].y_bindings, KEYMOD_NONE, module );
-    }
+      
+      if (mode_node->hasChild("x-axis-ctrl")) {
+        read_bindings(mode_node->getChild("x-axis-ctrl"), m.modes[j].x_bindings, KEYMOD_CTRL, module );
+      }
+      if (mode_node->hasChild("x-axis-shift")) {
+        read_bindings(mode_node->getChild("x-axis-shift"), m.modes[j].x_bindings, KEYMOD_SHIFT, module );
+      }
+      if (mode_node->hasChild("x-axis-ctrl-shift")) {
+        read_bindings(mode_node->getChild("x-axis-ctrl-shift"), m.modes[j].x_bindings, KEYMOD_CTRL|KEYMOD_SHIFT, module );
+      }
+      
+      if (mode_node->hasChild("y-axis-ctrl")) {
+        read_bindings(mode_node->getChild("y-axis-ctrl"), m.modes[j].y_bindings, KEYMOD_CTRL, module );
+      }
+      if (mode_node->hasChild("y-axis-shift")) {
+        read_bindings(mode_node->getChild("y-axis-shift"), m.modes[j].y_bindings, KEYMOD_SHIFT, module );
+      }
+      if (mode_node->hasChild("y-axis-ctrl-shift")) {
+        read_bindings(mode_node->getChild("y-axis-ctrl-shift"), m.modes[j].y_bindings, KEYMOD_CTRL|KEYMOD_SHIFT, module );
+      }
+    } // of modes iteration
   }
 
   fgRegisterMouseClickHandler(mouseClickHandler);
@@ -340,9 +471,10 @@ void FGMouseInput::init()
 
 void FGMouseInput::update ( double dt )
 {
-  int cursorTimeoutMsec = d->cursorTimeoutNode->getDoubleValue() * 1000;
-  int tooltipDelayMsec = d->tooltipShowDelayNode->getIntValue();
-  
+    if (!d->initialized) {
+        SG_LOG(SG_INPUT, SG_WARN, "update of mouse before init");
+    }
+    
   mouse &m = d->mice[0];
   int mode =  m.mode_node->getIntValue();
   if (mode != m.current_mode) {
@@ -359,24 +491,28 @@ void FGMouseInput::update ( double dt )
     }
   }
 
-  if ( d->hideCursorNode == NULL || d->hideCursorNode->getBoolValue() ) {
-      // if delay is <= 0, disable tooltips
-      if ( !d->tooltipTimeoutDone &&
-           (tooltipDelayMsec > 0) &&
-           (m.timeSinceLastMove.elapsedMSec() > tooltipDelayMsec))
-      {
-          d->tooltipTimeoutDone = true;
-          SGPropertyNode_ptr arg(new SGPropertyNode);
-          globals->get_commands()->execute("tooltip-timeout", arg);
-      }
-    
-      if ( m.timeSinceLastMove.elapsedMSec() > cursorTimeoutMsec) {
+  if ((mode == 0) && d->hoverPickScheduled) {
+    d->doHoverPick(d->hoverPos);
+    d->hoverPickScheduled = false;
+  }
+  
+  if ( !d->tooltipTimeoutDone &&
+      d->tooltipsEnabled &&
+      (m.timeSinceLastMove.elapsedMSec() > d->tooltipDelayMsec))
+  {
+      d->tooltipTimeoutDone = true;
+      SGPropertyNode_ptr arg(new SGPropertyNode);
+      globals->get_commands()->execute("tooltip-timeout", arg);
+  }
+  
+  if ( d->hideCursor ) {
+      if ( m.timeSinceLastMove.elapsedMSec() > d->cursorTimeoutMsec) {
           FGMouseCursor::instance()->hideCursorUntilMouseMove();
           m.timeSinceLastMove.stamp();
       }
   }
     
-  d->activePickCallbacks.update( dt );
+  d->activePickCallbacks.update( dt, fgGetKeyModifiers() );
 }
 
 mouse::mouse ()
@@ -418,6 +554,11 @@ mouse_mode::~mouse_mode ()
 
 void FGMouseInput::doMouseClick (int b, int updown, int x, int y, bool mainWindow, const osgGA::GUIEventAdapter* ea)
 {
+    if (!d->initialized) {
+        // can occur during reset
+        return;
+    }
+    
   int modifiers = fgGetKeyModifiers();
 
   mouse &m = d->mice[0];
@@ -426,7 +567,7 @@ void FGMouseInput::doMouseClick (int b, int updown, int x, int y, bool mainWindo
   if (b >= 0 && b < MAX_MOUSE_BUTTONS)
     m.mouse_button_nodes[b]->setBoolValue(updown == MOUSE_BUTTON_DOWN);
 
-  if (!d->rightButtonModeCycleNode->getBoolValue() && (b == 2)) {
+  if (!d->rightClickModeCycle && (b == 2)) {
     // in spring-loaded look mode, ignore right clicks entirely here
     return;
   }
@@ -435,27 +576,50 @@ void FGMouseInput::doMouseClick (int b, int updown, int x, int y, bool mainWindo
   // requested, and return if one of
   // them consumes the event.
 
-  if (updown != MOUSE_BUTTON_DOWN) {
+  osg::Vec2d windowPos;
+  flightgear::eventToWindowCoords(ea, windowPos.x(), windowPos.y());
+
+  SGSceneryPicks pickList;
+  globals->get_renderer()->pick(pickList, windowPos);
+
+  if( updown != MOUSE_BUTTON_DOWN )
+  {
     // Execute the mouse up event in any case, may be we should
     // stop processing here?
-    while (!d->activePickCallbacks[b].empty()) {
-      d->activePickCallbacks[b].front()->buttonReleased();
-      d->activePickCallbacks[b].pop_front();
+
+    SGPickCallbackList& callbacks = d->activePickCallbacks[b];
+
+    while( !callbacks.empty() )
+    {
+      SGPickCallbackPtr& cb = callbacks.front();
+      const SGSceneryPick* pick = getPick(pickList, cb);
+      cb->buttonReleased(ea->getModKeyMask(), *ea, pick ? &pick->info : 0);
+
+      callbacks.pop_front();
     }
   }
 
   if (mode.pass_through) {
     // remove once PUI uses standard picking mechanism
     if (0 <= x && 0 <= y && puMouse(b, updown, x, y))
-      return;
-    else {
-      // pui didn't want the click event so compute a
-      // scenegraph intersection point corresponding to the mouse click
-      if (updown == MOUSE_BUTTON_DOWN) {
-        d->activePickCallbacks.init( b, ea );
+      return; // pui handled it
+
+    // pui didn't want the click event so compute a
+    // scenegraph intersection point corresponding to the mouse click
+    if (updown == MOUSE_BUTTON_DOWN) {
+      d->activePickCallbacks.init( b, ea );
+        
+      if (d->clickTriggersTooltip) {
+            SGPropertyNode_ptr args(new SGPropertyNode);
+            args->setStringValue("reason", "click");
+            globals->get_commands()->execute("tooltip-timeout", args);
+            d->tooltipTimeoutDone = true;
       }
-    }
-  }
+    } else {
+      // do a hover pick now, to fix up cursor
+      d->doHoverPick(windowPos);
+    } // mouse button was released
+  } // of pass-through mode
 
   // OK, PUI and the panel didn't want the click
   if (b >= MAX_MOUSE_BUTTONS) {
@@ -464,30 +628,20 @@ void FGMouseInput::doMouseClick (int b, int updown, int x, int y, bool mainWindo
     return;
   }
 
-  m.modes[m.current_mode].buttons[b].update( modifiers, 0 != updown, x, y);
-  
-  if (d->clickTriggersTooltipNode->getBoolValue()) {
-    SGPropertyNode_ptr args(new SGPropertyNode);
-    args->setStringValue("reason", "click");
-    globals->get_commands()->execute("tooltip-timeout", args);
-    d->tooltipTimeoutDone = true;
-  }
+  m.modes[m.current_mode].buttons[b].update( modifiers, 0 != updown, x, y);  
 }
 
 void FGMouseInput::processMotion(int x, int y, const osgGA::GUIEventAdapter* ea)
 {
   if (!d->activePickCallbacks[0].empty()) {
-    //SG_LOG(SG_GENERAL, SG_INFO, "mouse-motion, have active pick callback");
-    BOOST_FOREACH(SGPickCallback* cb, d->activePickCallbacks[0]) {
-      cb->mouseMoved(ea);
-    }
+    d->doMouseMoveWithCallbacks(ea);
     return;
   }
   
   mouse &m = d->mice[0];
   int modeIndex = m.current_mode;
   // are we in spring-loaded look mode?
-  if (!d->rightButtonModeCycleNode->getBoolValue()) {
+  if (!d->rightClickModeCycle) {
     if (m.mouse_button_nodes[2]->getBoolValue()) {
       // right mouse is down, force look mode
       modeIndex = 3;
@@ -497,7 +651,7 @@ void FGMouseInput::processMotion(int x, int y, const osgGA::GUIEventAdapter* ea)
   if (modeIndex == 0) {
     osg::Vec2d windowPos;
     flightgear::eventToWindowCoords(ea, windowPos.x(), windowPos.y());
-    d->doHoverPick(windowPos);
+    d->scheduleHoverPick(windowPos);
     // mouse has moved, so we may need to issue tooltip-timeout command again
     d->tooltipTimeoutDone = false;
   }
@@ -546,6 +700,11 @@ void FGMouseInput::processMotion(int x, int y, const osgGA::GUIEventAdapter* ea)
 
 void FGMouseInput::doMouseMotion (int x, int y, const osgGA::GUIEventAdapter* ea)
 {
+    if (!d->initialized) {
+        // can occur during reset
+        return;
+    }
+    
   mouse &m = d->mice[0];
 
   if (m.current_mode < 0 || m.current_mode >= m.nModes) {
@@ -557,6 +716,10 @@ void FGMouseInput::doMouseMotion (int x, int y, const osgGA::GUIEventAdapter* ea
   m.timeSinceLastMove.stamp();
   FGMouseCursor::instance()->mouseMoved();
 
+  // TODO Get rid of this as soon as soon as cursor hide timeout works globally
+  if( ea->getHandled() )
+    return;
+
   processMotion(x, y, ea);
     
   m.x = x;