simgear/canvas/CanvasEventManager.hxx

   1 // Manage event handling inside a Canvas similar to the DOM Level 3 Event Model
   2 //
   3 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Library General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2 of the License, or (at your option) any later version.
   9 //
  10 // This library is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // Library General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Library General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  18
  19 #ifndef CANVAS_EVENT_MANAGER_HXX_
  20 #define CANVAS_EVENT_MANAGER_HXX_
  21
  22 #include "canvas_fwd.hxx"
  23 #include <deque>
  24
  25 namespace simgear
  26 {
  27 namespace canvas
  28 {
  29
  30   struct EventTarget
  31   {
  32     ElementWeakPtr  element;
  33     osg::Vec2f      local_pos,
  34                     local_delta;
  35   };
  36   typedef std::deque<EventTarget> EventPropagationPath;
  37   inline bool operator==(const EventTarget& t1, const EventTarget& t2)
  38   {
  39     return t1.element.lock() == t2.element.lock();
  40   }
  41
  42   class EventManager
  43   {
  44     public:
  45       EventManager();
  46
  47       bool handleEvent( const MouseEventPtr& event,
  48                         const EventPropagationPath& path );
  49
  50     protected:
  51       struct StampedPropagationPath
  52       {
  53         StampedPropagationPath();
  54         StampedPropagationPath(const EventPropagationPath& path, double time);
  55
  56         void clear();
  57         bool valid() const;
  58
  59         EventPropagationPath path;
  60         double time;
  61       };
  62
  63       // TODO if we really need the paths modify to not copy around the paths
  64       //      that much.
  65       StampedPropagationPath _last_mouse_down,
  66                              _last_click,
  67                              _last_mouse_over;
  68       size_t _current_click_count;
  69
  70       /**
  71        * Propagate click event and handle multi-click (eg. create dblclick)
  72        */
  73       void handleClick( const MouseEventPtr& event,
  74                         const EventPropagationPath& path );
  75
  76       /**
  77        * Handle mouseover/enter/out/leave
  78        */
  79       void handleMove( const MouseEventPtr& event,
  80                        const EventPropagationPath& path );
  81
  82       bool propagateEvent( const EventPtr& event,
  83                            const EventPropagationPath& path );
  84
  85       /**
  86        * Check if two click events (either mousedown/up or two consecutive
  87        * clicks) are inside a maximum distance to still create a click or
  88        * dblclick event respectively.
  89        */
  90       bool checkClickDistance( const EventPropagationPath& path1,
  91                                const EventPropagationPath& path2 ) const;
  92       EventPropagationPath
  93       getCommonAncestor( const EventPropagationPath& path1,
  94                          const EventPropagationPath& path2 ) const;
  95   };
  96
  97 } // namespace canvas
  98 } // namespace simgear
  99
 100 #endif /* CANVAS_EVENT_MANAGER_HXX_ */