simgear/scene/util/SGPickCallback.hxx

   1 /* -*-c++-*-
   2  *
   3  * Copyright (C) 2006-2007 Mathias Froehlich
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  18  * MA 02110-1301, USA.
  19  *
  20  */
  21
  22 #ifndef SG_SCENE_PICKCALLBACK_HXX
  23 #define SG_SCENE_PICKCALLBACK_HXX
  24
  25 #include <osg/Vec2d>
  26
  27 #include <simgear/structure/SGReferenced.hxx>
  28 #include <simgear/structure/SGSharedPtr.hxx>
  29 #include <simgear/math/SGMath.hxx>
  30
  31 namespace osgGA { class GUIEventAdapter; }
  32
  33 // Used to implement scenery interaction.
  34 // The interface is still under development
  35 class SGPickCallback : public SGReferenced {
  36 public:
  37   enum Priority {
  38     PriorityGUI = 0,
  39     PriorityPanel = 1,
  40     PriorityOther = 2,
  41     PriorityScenery = 3
  42   };
  43
  44   struct Info {
  45     SGVec3d wgs84;
  46     SGVec3d local;
  47     SGVec2d uv;
  48   };
  49
  50   SGPickCallback(Priority priority = PriorityOther) :
  51     _priority(priority)
  52   { }
  53
  54   virtual ~SGPickCallback() {}
  55
  56   // TODO maybe better provide a single callback to handle all events
  57   virtual bool buttonPressed( int button,
  58                               const osgGA::GUIEventAdapter& ea,
  59                               const Info& info )
  60   { return false; }
  61
  62   virtual void update(double dt, int keyModState)
  63   { }
  64
  65   /**
  66    * @param info    Can be null if no info is available (eg. mouse not over 3d
  67    *                object anymore)
  68    */
  69   virtual void buttonReleased( int keyModState,
  70                                const osgGA::GUIEventAdapter& ea,
  71                                const Info* info )
  72   { }
  73
  74   /**
  75    * @param info    Can be null if no info is available (eg. mouse not over 3d
  76    *                object anymore)
  77    */
  78   virtual void mouseMoved( const osgGA::GUIEventAdapter& ea,
  79                            const Info* info )
  80   { }
  81
  82   /**
  83    * The mouse is not hovering anymore over the element.
  84    */
  85   virtual void mouseLeave(const osg::Vec2d& windowPos)
  86   { }
  87
  88   virtual bool hover( const osg::Vec2d& windowPos,
  89                       const Info& info )
  90   {  return false; }
  91
  92   virtual Priority getPriority() const
  93   { return _priority; }
  94
  95   /**
  96    * retrieve the name of the cursor to user when hovering this pickable
  97    * object. Mapping is undefined, since SimGear doesn't know about cursors.
  98    */
  99   virtual std::string getCursor() const
 100   { return std::string(); }
 101
 102   /**
 103    * Whether the uv coordinates of the picking action should be calculated upon
 104    * an intersection.
 105    */
 106   virtual bool needsUV() const
 107   { return false; }
 108
 109 private:
 110   Priority _priority;
 111 };
 112
 113 struct SGSceneryPick {
 114   SGPickCallback::Info info;
 115   SGSharedPtr<SGPickCallback> callback;
 116 };
 117
 118 #endif