3 * Copyright (C) 2006-2007 Mathias Froehlich
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.
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.
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,
22 #ifndef SG_SCENE_PICKCALLBACK_HXX
23 #define SG_SCENE_PICKCALLBACK_HXX
27 #include <simgear/structure/SGReferenced.hxx>
28 #include <simgear/structure/SGSharedPtr.hxx>
29 #include <simgear/math/SGMath.hxx>
31 namespace osgGA { class GUIEventAdapter; }
33 // Used to implement scenery interaction.
34 // The interface is still under development
35 class SGPickCallback : public SGReferenced {
50 SGPickCallback(Priority priority = PriorityOther) :
54 virtual ~SGPickCallback() {}
56 // TODO maybe better provide a single callback to handle all events
57 virtual bool buttonPressed( int button,
58 const osgGA::GUIEventAdapter& ea,
62 virtual void update(double dt, int keyModState)
66 * @param info Can be null if no info is available (eg. mouse not over 3d
69 virtual void buttonReleased( int keyModState,
70 const osgGA::GUIEventAdapter& ea,
75 * @param info Can be null if no info is available (eg. mouse not over 3d
78 virtual void mouseMoved( const osgGA::GUIEventAdapter& ea,
83 * The mouse is not hovering anymore over the element.
85 virtual void mouseLeave(const osg::Vec2d& windowPos)
88 virtual bool hover( const osg::Vec2d& windowPos,
92 virtual Priority getPriority() const
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.
99 virtual std::string getCursor() const
100 { return std::string(); }
103 * Whether the uv coordinates of the picking action should be calculated upon
106 virtual bool needsUV() const
113 struct SGSceneryPick {
114 SGPickCallback::Info info;
115 SGSharedPtr<SGPickCallback> callback;