1 // Canvas gui/dialog manager
3 // Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
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, MA 02110-1301, USA.
19 #include "gui_mgr.hxx"
20 #include <Canvas/window.hxx>
22 #include <Main/fg_os.hxx>
23 #include <Main/fg_props.hxx>
24 #include <Main/globals.hxx>
25 #include <Viewer/CameraGroup.hxx>
26 #include <Viewer/renderer.hxx>
28 #include <simgear/canvas/Canvas.hxx>
29 #include <simgear/canvas/CanvasPlacement.hxx>
30 #include <simgear/scene/util/OsgMath.hxx>
32 #include <osg/BlendFunc>
33 #include <osgViewer/Viewer>
34 #include <osgGA/GUIEventHandler>
36 #include <boost/bind.hpp>
37 #include <boost/lexical_cast.hpp>
40 typedef boost::shared_ptr<DesktopGroup> DesktopPtr;
41 typedef boost::weak_ptr<DesktopGroup> DesktopWeakPtr;
46 class GUIEventHandler:
47 public osgGA::GUIEventHandler
50 GUIEventHandler(const DesktopWeakPtr& desktop_group);
52 bool handle( const osgGA::GUIEventAdapter& ea,
53 osgGA::GUIActionAdapter&,
58 DesktopWeakPtr _desktop;
62 * Track a canvas placement on a window
64 class WindowPlacement:
65 public simgear::canvas::Placement
68 WindowPlacement( SGPropertyNode* node,
69 canvas::WindowPtr window,
70 simgear::canvas::CanvasPtr canvas ):
77 * Remove placement from window
79 virtual ~WindowPlacement()
81 canvas::WindowPtr window = _window.lock();
82 simgear::canvas::CanvasPtr canvas = _canvas.lock();
84 if( window && canvas && canvas == window->getCanvasContent().lock() )
85 window->setCanvasContent( simgear::canvas::CanvasPtr() );
89 canvas::WindowWeakPtr _window;
90 simgear::canvas::CanvasWeakPtr _canvas;
97 public simgear::canvas::Group
101 bool handleEvent(const osgGA::GUIEventAdapter& ea);
107 SGPropertyChangeCallback<DesktopGroup> _cb_mouse_mode;
110 simgear::PropertyObject<int> _width,
113 canvas::WindowWeakPtr _last_push,
119 osg::Vec2 _drag_start;
122 double _last_scroll_time;
124 bool handleMouse(const osgGA::GUIEventAdapter& ea);
125 void handleResize(int x, int y, int width, int height);
126 void handleMouseMode(SGPropertyNode* node);
131 simgear::canvas::ElementFactory
132 getChildFactory(const std::string& type) const
134 if( type == "window" )
135 return &Element::create<canvas::Window>;
137 return Group::getChildFactory(type);
141 //------------------------------------------------------------------------------
142 GUIEventHandler::GUIEventHandler(const DesktopWeakPtr& desktop_group):
143 _desktop( desktop_group )
148 //------------------------------------------------------------------------------
149 bool GUIEventHandler::handle( const osgGA::GUIEventAdapter& ea,
150 osgGA::GUIActionAdapter&,
154 if( ea.getHandled() )
157 DesktopPtr desktop = _desktop.lock();
158 return desktop && desktop->handleEvent(ea);
161 //------------------------------------------------------------------------------
162 DesktopGroup::DesktopGroup():
163 Group(simgear::canvas::CanvasPtr(), fgGetNode("/sim/gui/canvas", true)),
164 _cb_mouse_mode( this,
165 &DesktopGroup::handleMouseMode,
166 fgGetNode("/devices/status/mice/mouse[0]/mode") ),
167 _handle_events(true),
168 _width(_node, "size[0]"),
169 _height(_node, "size[1]"),
170 _resize(canvas::Window::NONE),
171 _last_cursor(MOUSE_CURSOR_NONE),
176 osg::Camera* camera =
177 flightgear::getGUICamera( flightgear::CameraGroup::getDefault() );
179 camera->addChild( getMatrixTransform() );
181 osg::StateSet* stateSet = _transform->getOrCreateStateSet();
182 stateSet->setDataVariance(osg::Object::STATIC);
183 stateSet->setRenderBinDetails(1000, "RenderBin");
185 // speed optimization?
186 stateSet->setMode(GL_CULL_FACE, osg::StateAttribute::OFF);
187 stateSet->setAttribute(new osg::BlendFunc(
188 osg::BlendFunc::SRC_ALPHA,
189 osg::BlendFunc::ONE_MINUS_SRC_ALPHA)
191 stateSet->setMode(GL_BLEND, osg::StateAttribute::ON);
192 stateSet->setMode(GL_LIGHTING, osg::StateAttribute::OFF);
193 stateSet->setMode(GL_FOG, osg::StateAttribute::OFF);
194 stateSet->setMode(GL_DEPTH_TEST, osg::StateAttribute::OFF);
196 _width = _height = -1;
198 // Do not change values on reinit
199 _width.node()->setAttribute(SGPropertyNode::PRESERVE, true);
200 _height.node()->setAttribute(SGPropertyNode::PRESERVE, true);
202 // Do not restore windows on reinit (all windows will need to be recreated,
203 // but hey it's a reset ;-))
204 _node->setAttribute(SGPropertyNode::PRESERVE, true);
207 //------------------------------------------------------------------------------
208 bool DesktopGroup::handleEvent(const osgGA::GUIEventAdapter& ea)
210 switch( ea.getEventType() )
212 case osgGA::GUIEventAdapter::PUSH:
213 case osgGA::GUIEventAdapter::RELEASE:
214 // case osgGA::GUIEventAdapter::DOUBLECLICK:
215 // // DOUBLECLICK doesn't seem to be triggered...
216 case osgGA::GUIEventAdapter::DRAG:
217 case osgGA::GUIEventAdapter::MOVE:
218 case osgGA::GUIEventAdapter::SCROLL:
219 return handleMouse(ea);
220 case osgGA::GUIEventAdapter::RESIZE:
221 handleResize( ea.getWindowX(),
224 ea.getWindowHeight() );
225 return false; // Let other event handlers also consume resize events
235 | || | _ inside corner region (L-shaped part inside margin) both
236 |___||_|_ _ _/ directions can be resized (outside only one axis)
240 | || | } margin_neg \
241 | ========|== <-- window border |_ area where resize
242 | | } margin_pos | can be initiated
246 const float resize_margin_pos = 12;
247 const float resize_margin_neg = 2;
248 const float resize_corner = 20;
250 //------------------------------------------------------------------------------
251 bool DesktopGroup::handleMouse(const osgGA::GUIEventAdapter& ea)
253 if( !_transform->getNumChildren() || !_handle_events )
256 namespace sc = simgear::canvas;
257 sc::MouseEventPtr event(new sc::MouseEvent(ea));
259 event->screen_pos.x() = 0.5 * (ea.getXnormalized() + 1) * _width + 0.5;
260 event->screen_pos.y() = 0.5 * (ea.getYnormalized() + 1) * _height + 0.5;
261 if( ea.getMouseYOrientation()
262 != osgGA::GUIEventAdapter::Y_INCREASING_DOWNWARDS )
263 event->screen_pos.y() = _height - event->screen_pos.y();
265 event->delta.x() = event->getScreenX() - _last_x;
266 event->delta.y() = event->getScreenY() - _last_y;
268 _last_x = event->getScreenX();
269 _last_y = event->getScreenY();
271 event->local_pos = event->client_pos = event->screen_pos;
273 if( !_resize_window.expired() )
275 switch( ea.getEventType() )
277 case osgGA::GUIEventAdapter::RELEASE:
278 _resize_window.lock()->handleResize(canvas::Window::NONE);
279 _resize_window.reset();
281 case osgGA::GUIEventAdapter::DRAG:
282 _resize_window.lock()->handleResize( _resize,
283 event->screen_pos - _drag_start );
290 canvas::WindowPtr window_at_cursor;
291 for( int i = _transform->getNumChildren() - 1; i >= 0; --i )
293 osg::Group *element = _transform->getChild(i)->asGroup();
296 assert(element->getUserData());
298 canvas::WindowPtr window =
299 boost::dynamic_pointer_cast<canvas::Window>
301 static_cast<sc::Element::OSGUserData*>(element->getUserData())->element
304 if( !window || !window->isCapturingEvents() || !window->isVisible() )
307 float margin = window->isResizable() ? resize_margin_pos : 0;
308 if( window->getScreenRegion().contains( event->getScreenX(),
312 window_at_cursor = window;
317 if( window_at_cursor )
319 const SGRect<float>& reg = window_at_cursor->getScreenRegion();
321 if( window_at_cursor->isResizable()
322 && ( ea.getEventType() == osgGA::GUIEventAdapter::MOVE
323 || ea.getEventType() == osgGA::GUIEventAdapter::PUSH
324 || ea.getEventType() == osgGA::GUIEventAdapter::RELEASE
326 && !reg.contains( event->getScreenX(),
328 -resize_margin_neg ) )
331 _last_cursor = fgGetMouseCursor();
335 if( event->getScreenX() <= reg.l() + resize_corner )
336 _resize |= canvas::Window::LEFT;
337 else if( event->getScreenX() >= reg.r() - resize_corner )
338 _resize |= canvas::Window::RIGHT;
340 if( event->getScreenY() <= reg.t() + resize_corner )
341 _resize |= canvas::Window::TOP;
342 else if( event->getScreenY() >= reg.b() - resize_corner )
343 _resize |= canvas::Window::BOTTOM;
345 static const int cursor_mapping[] =
347 0, MOUSE_CURSOR_LEFTSIDE, MOUSE_CURSOR_RIGHTSIDE, 0,
348 MOUSE_CURSOR_TOPSIDE, MOUSE_CURSOR_TOPLEFT, MOUSE_CURSOR_TOPRIGHT, 0,
349 MOUSE_CURSOR_BOTTOMSIDE, MOUSE_CURSOR_BOTTOMLEFT, MOUSE_CURSOR_BOTTOMRIGHT,
352 if( !cursor_mapping[_resize] )
355 fgSetMouseCursor(cursor_mapping[_resize]);
357 if( ea.getEventType() == osgGA::GUIEventAdapter::PUSH )
359 _resize_window = window_at_cursor;
360 _drag_start = event->screen_pos;
362 window_at_cursor->raise();
363 window_at_cursor->handleResize(_resize | canvas::Window::INIT);
372 fgSetMouseCursor(_last_cursor);
377 canvas::WindowPtr target_window = window_at_cursor;
378 switch( ea.getEventType() )
380 case osgGA::GUIEventAdapter::PUSH:
381 _last_push = window_at_cursor;
382 event->type = sc::Event::MOUSE_DOWN;
384 case osgGA::GUIEventAdapter::SCROLL:
385 switch( ea.getScrollingMotion() )
387 case osgGA::GUIEventAdapter::SCROLL_UP:
388 event->delta.y() = 1;
390 case osgGA::GUIEventAdapter::SCROLL_DOWN:
391 event->delta.y() = -1;
397 // osg sends two events for every scrolling motion. We don't need
398 // duplicate events, so lets ignore the second event with the same
400 if( _last_scroll_time == ea.getTime() )
401 return window_at_cursor ? true : false;
402 _last_scroll_time = ea.getTime();
404 event->type = sc::Event::WHEEL;
406 case osgGA::GUIEventAdapter::MOVE:
408 canvas::WindowPtr last_mouse_over = _last_mouse_over.lock();
409 if( last_mouse_over != window_at_cursor && last_mouse_over )
411 sc::MouseEventPtr move_event( new sc::MouseEvent(*event) );
412 move_event->type = sc::Event::MOUSE_LEAVE;
413 move_event->client_pos -= toOsg(last_mouse_over->getPosition());
414 move_event->local_pos = move_event->client_pos;
416 last_mouse_over->handleEvent(move_event);
418 _last_mouse_over = window_at_cursor;
419 event->type = sc::Event::MOUSE_MOVE;
422 case osgGA::GUIEventAdapter::RELEASE:
424 event->type = sc::Event::MOUSE_UP;
426 canvas::WindowPtr last_push = _last_push.lock();
429 if( last_push && last_push != target_window )
432 sc::MouseEventPtr leave_event( new sc::MouseEvent(*event) );
433 leave_event->type = sc::Event::MOUSE_LEAVE;
434 leave_event->client_pos -= toOsg(last_push->getPosition());
435 leave_event->local_pos = leave_event->client_pos;
437 last_push->handleEvent(leave_event);
441 case osgGA::GUIEventAdapter::DRAG:
442 target_window = _last_push.lock();
443 event->type = sc::Event::DRAG;
452 event->client_pos -= toOsg(target_window->getPosition());
453 event->local_pos = event->client_pos;
454 return target_window->handleEvent(event);
460 //------------------------------------------------------------------------------
461 void DesktopGroup::handleResize(int x, int y, int width, int height)
463 if( _width == width && _height == height )
469 // Origin should be at top left corner, therefore we need to mirror the y-axis
470 _transform->setMatrix(osg::Matrix(
478 //------------------------------------------------------------------------------
479 void DesktopGroup::handleMouseMode(SGPropertyNode* node)
481 // pass-through indicates events should pass through to the UI
482 _handle_events = fgGetNode("/input/mice/mouse[0]/mode", node->getIntValue())
483 ->getBoolValue("pass-through");
486 //------------------------------------------------------------------------------
492 //------------------------------------------------------------------------------
493 canvas::WindowPtr GUIMgr::createWindow(const std::string& name)
495 canvas::WindowPtr window = _desktop->createChild<canvas::Window>(name);
497 window->set<std::string>
500 boost::lexical_cast<std::string>(window->getProps()->getIndex())
505 //------------------------------------------------------------------------------
508 DesktopPtr desktop( new DesktopGroup );
509 desktop->handleResize
513 fgGetInt("/sim/startup/xsize"),
514 fgGetInt("/sim/startup/ysize")
518 _event_handler = new GUIEventHandler(desktop);
519 globals->get_renderer()
522 // GUI is on top of everything so lets install as first event handler
523 .push_front( _event_handler );
525 simgear::canvas::Canvas::addPlacementFactory
528 boost::bind(&GUIMgr::addWindowPlacement, this, _1, _2)
531 _desktop->getProps()->fireCreatedRecursive();
534 //------------------------------------------------------------------------------
535 void GUIMgr::shutdown()
539 simgear::canvas::Canvas::removePlacementFactory("window");
541 globals->get_renderer()
543 ->removeEventHandler( _event_handler );
547 //------------------------------------------------------------------------------
548 void GUIMgr::update(double dt)
550 _desktop->update(dt);
553 //------------------------------------------------------------------------------
554 simgear::canvas::GroupPtr GUIMgr::getDesktop()
559 //------------------------------------------------------------------------------
560 simgear::canvas::Placements
561 GUIMgr::addWindowPlacement( SGPropertyNode* placement,
562 simgear::canvas::CanvasPtr canvas )
564 const std::string& id = placement->getStringValue("id");
566 simgear::canvas::Placements placements;
567 canvas::WindowPtr window = _desktop->getChild<canvas::Window>(id);
570 window->setCanvasContent(canvas);
571 placements.push_back(
572 simgear::canvas::PlacementPtr(
573 new WindowPlacement(placement, window, canvas)