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 <simgear/structure/SGReferenced.hxx>
  26 #include <simgear/structure/SGSharedPtr.hxx>
  27 #include <simgear/math/SGMath.hxx>
  28
  29 namespace osgGA { class GUIEventAdapter; }
  30
  31 // Used to implement scenery interaction.
  32 // The interface is still under development
  33 class SGPickCallback : public SGReferenced {
  34 public:
  35   enum Priority {
  36     PriorityGUI = 0,
  37     PriorityPanel = 1,
  38     PriorityOther = 2
  39   };
  40
  41   struct Info {
  42     SGVec3d wgs84;
  43     SGVec3d local;
  44   };
  45
  46   SGPickCallback(Priority priority = PriorityOther) :
  47     _priority(priority)
  48   { }
  49
  50   virtual ~SGPickCallback() {}
  51   virtual bool buttonPressed(int button, const osgGA::GUIEventAdapter* event, const Info& info)
  52   { return false; }
  53
  54   virtual void update(double dt)
  55   { }
  56   virtual void buttonReleased(void)
  57   { }
  58
  59   virtual bool hover(const osg::Vec2d& windowPos, const Info& info)
  60   {  return false; }
  61
  62   Priority getPriority() const
  63   { return _priority; }
  64
  65 private:
  66   Priority _priority;
  67 };
  68
  69 struct SGSceneryPick {
  70   SGPickCallback::Info info;
  71   SGSharedPtr<SGPickCallback> callback;
  72 };
  73
  74 #endif