simgear/canvas/CanvasEventVisitor.hxx

   1 // Visitor for traversing a canvas element hierarchy similar to the traversal
   2 // of the DOM Level 3 Event Model
   3 //
   4 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Library General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Library General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Library General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  19
  20 #ifndef CANVAS_EVENT_VISITOR_HXX_
  21 #define CANVAS_EVENT_VISITOR_HXX_
  22
  23 #include "canvas_fwd.hxx"
  24 #include "CanvasEventManager.hxx"
  25
  26 namespace simgear
  27 {
  28 namespace canvas
  29 {
  30
  31   class EventVisitor
  32   {
  33     public:
  34
  35       enum TraverseMode
  36       {
  37         TRAVERSE_UP,
  38         TRAVERSE_DOWN
  39       };
  40
  41       /**
  42        *
  43        * @param mode
  44        * @param pos     Mouse position
  45        * @param root    Element to dispatch events to if no element is hit
  46        */
  47       EventVisitor( TraverseMode mode,
  48                     const osg::Vec2f& pos,
  49                     const ElementPtr& root = ElementPtr() );
  50       virtual ~EventVisitor();
  51       virtual bool traverse(Element& el);
  52       virtual bool apply(Element& el);
  53
  54       const EventPropagationPath& getPropagationPath() const;
  55
  56     protected:
  57
  58       TraverseMode          _traverse_mode;
  59       EventPropagationPath  _target_path;
  60       ElementPtr            _root;
  61
  62   };
  63
  64 } // namespace canvas
  65 } // namespace simgear
  66
  67
  68 #endif /* CANVAS_EVENTVISITOR_HXX_ */