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   virtual bool buttonPressed(int button, const osgGA::GUIEventAdapter* event, const Info& info)
  56   { return false; }
  57
  58   virtual void update(double dt, int keyModState)
  59   { }
  60
  61   virtual void buttonReleased(int keyModState)
  62   { }
  63
  64   virtual void mouseMoved(const osgGA::GUIEventAdapter* event)
  65   { }
  66
  67   virtual bool hover(const osg::Vec2d& windowPos, const Info& info)
  68   {  return false; }
  69
  70   virtual Priority getPriority() const
  71   { return _priority; }
  72
  73   /**
  74    * retrieve the name of the cursor to user when hovering this pickable
  75    * object. Mapping is undefined, since SimGear doesn't know about cursors.
  76    */
  77   virtual std::string getCursor() const
  78   { return std::string(); }
  79
  80   /**
  81    * Whether the uv coordinates of the picking action should be calculated upon
  82    * an intersection.
  83    */
  84   virtual bool needsUV() const
  85   { return false; }
  86
  87 private:
  88   Priority _priority;
  89 };
  90
  91 struct SGSceneryPick {
  92   SGPickCallback::Info info;
  93   SGSharedPtr<SGPickCallback> callback;
  94 };
  95
  96 #endif