1 // fg_os_osgviewer.cxx -- common functions for fg_os interface
2 // implemented as an osgViewer
4 // Copyright (C) 2007 Tim Moore timoore@redhat.com
5 // Copyright (C) 2007 Mathias Froehlich
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
33 #include <boost/algorithm/string/case_conv.hpp>
34 #include <boost/foreach.hpp>
36 #include <simgear/compiler.h>
37 #include <simgear/structure/exception.hxx>
38 #include <simgear/debug/logstream.hxx>
39 #include <simgear/props/props_io.hxx>
42 #include <osg/GraphicsContext>
44 #include <osg/Matrixd>
45 #include <osg/Viewport>
46 #include <osg/Version>
49 #include <osgViewer/ViewerEventHandlers>
50 #include <osgViewer/Viewer>
51 #include <osgViewer/GraphicsWindow>
53 #include <Scenery/scenery.hxx>
54 #include <Main/fg_os.hxx>
55 #include <Main/fg_props.hxx>
56 #include <Main/util.hxx>
57 #include <Main/globals.hxx>
58 #include "renderer.hxx"
59 #include "CameraGroup.hxx"
60 #include "FGEventHandler.hxx"
61 #include "WindowBuilder.hxx"
62 #include "WindowSystemAdapter.hxx"
64 // Static linking of OSG needs special macros
65 #ifdef OSG_LIBRARY_STATIC
66 #include <osgDB/Registry>
76 #ifdef OSG_JPEG_ENABLED
79 #ifdef OSG_PNG_ENABLED
82 #ifdef OSG_TIFF_ENABLED
93 // fg_os implementation using OpenSceneGraph's osgViewer::Viewer class
94 // to create the graphics window and run the event/update/render loop.
97 // fg_os implementation
101 using namespace flightgear;
104 static osg::ref_ptr<osgViewer::Viewer> viewer;
105 static osg::ref_ptr<osg::Camera> mainCamera;
107 static void setStereoMode( const char * mode )
109 DisplaySettings::StereoMode stereoMode = DisplaySettings::QUAD_BUFFER;
110 bool stereoOn = true;
112 if (strcmp(mode,"QUAD_BUFFER")==0)
114 stereoMode = DisplaySettings::QUAD_BUFFER;
116 else if (strcmp(mode,"ANAGLYPHIC")==0)
118 stereoMode = DisplaySettings::ANAGLYPHIC;
120 else if (strcmp(mode,"HORIZONTAL_SPLIT")==0)
122 stereoMode = DisplaySettings::HORIZONTAL_SPLIT;
124 else if (strcmp(mode,"VERTICAL_SPLIT")==0)
126 stereoMode = DisplaySettings::VERTICAL_SPLIT;
128 else if (strcmp(mode,"LEFT_EYE")==0)
130 stereoMode = DisplaySettings::LEFT_EYE;
132 else if (strcmp(mode,"RIGHT_EYE")==0)
134 stereoMode = DisplaySettings::RIGHT_EYE;
136 else if (strcmp(mode,"HORIZONTAL_INTERLACE")==0)
138 stereoMode = DisplaySettings::HORIZONTAL_INTERLACE;
140 else if (strcmp(mode,"VERTICAL_INTERLACE")==0)
142 stereoMode = DisplaySettings::VERTICAL_INTERLACE;
144 else if (strcmp(mode,"CHECKERBOARD")==0)
146 stereoMode = DisplaySettings::CHECKERBOARD;
150 DisplaySettings::instance()->setStereo( stereoOn );
151 DisplaySettings::instance()->setStereoMode( stereoMode );
154 static const char * getStereoMode()
156 DisplaySettings::StereoMode stereoMode = DisplaySettings::instance()->getStereoMode();
157 bool stereoOn = DisplaySettings::instance()->getStereo();
158 if( !stereoOn ) return "OFF";
159 if( stereoMode == DisplaySettings::QUAD_BUFFER ) {
160 return "QUAD_BUFFER";
161 } else if( stereoMode == DisplaySettings::ANAGLYPHIC ) {
163 } else if( stereoMode == DisplaySettings::HORIZONTAL_SPLIT ) {
164 return "HORIZONTAL_SPLIT";
165 } else if( stereoMode == DisplaySettings::VERTICAL_SPLIT ) {
166 return "VERTICAL_SPLIT";
167 } else if( stereoMode == DisplaySettings::LEFT_EYE ) {
169 } else if( stereoMode == DisplaySettings::RIGHT_EYE ) {
171 } else if( stereoMode == DisplaySettings::HORIZONTAL_INTERLACE ) {
172 return "HORIZONTAL_INTERLACE";
173 } else if( stereoMode == DisplaySettings::VERTICAL_INTERLACE ) {
174 return "VERTICAL_INTERLACE";
175 } else if( stereoMode == DisplaySettings::CHECKERBOARD ) {
176 return "CHECKERBOARD";
182 * merge OSG output into our logging system, so it gets recorded to file,
183 * and so we can display a GUI console with renderer issues, especially
184 * shader compilation warnings and errors.
186 class NotifyLogger : public osg::NotifyHandler
189 // note this callback will be invoked by OSG from multiple threads.
190 // fortunately our Simgear logging implementation already handles
191 // that internally, so we simply pass the message on.
192 virtual void notify(osg::NotifySeverity severity, const char *message)
194 SG_LOG(SG_GL, translateSeverity(severity), message);
196 // Detect whether a osg::Reference derived object is deleted with a non-zero
197 // reference count. In this case trigger a segfault to get a stack trace.
198 if( strstr(message, "the final reference count was") )
201 int* trigger_segfault = 0;
202 *trigger_segfault = 0;
207 sgDebugPriority translateSeverity(osg::NotifySeverity severity)
211 case osg::FATAL: return SG_ALERT;
212 case osg::WARN: return SG_WARN;
214 case osg::INFO: return SG_INFO;
216 case osg::DEBUG_INFO: return SG_DEBUG;
217 default: return SG_ALERT;
222 class NotifyLevelListener : public SGPropertyChangeListener
225 void valueChanged(SGPropertyNode* node)
227 osg::NotifySeverity severity = osg::WARN;
228 string val = boost::to_lower_copy(string(node->getStringValue()));
230 if (val == "fatal") {
231 severity = osg::FATAL;
232 } else if (val == "warn") {
233 severity = osg::WARN;
234 } else if (val == "notice") {
235 severity = osg::NOTICE;
236 } else if (val == "info") {
237 severity = osg::INFO;
238 } else if ((val == "debug") || (val == "debug-info")) {
239 severity = osg::DEBUG_INFO;
242 osg::setNotifyLevel(severity);
246 void updateOSGNotifyLevel()
250 void fgOSOpenWindow(bool stencil)
252 osg::setNotifyHandler(new NotifyLogger);
254 SGPropertyNode* osgLevel = fgGetNode("/sim/rendering/osg-notify-level", true);
255 osgLevel->addChangeListener(new NotifyLevelListener, true);
257 viewer = new osgViewer::Viewer;
258 viewer->setDatabasePager(FGScenery::getPagerSingleton());
259 CameraGroup* cameraGroup = 0;
261 mode = fgGetString("/sim/rendering/multithreading-mode", "SingleThreaded");
262 if (mode == "AutomaticSelection")
263 viewer->setThreadingModel(osgViewer::Viewer::AutomaticSelection);
264 else if (mode == "CullDrawThreadPerContext")
265 viewer->setThreadingModel(osgViewer::Viewer::CullDrawThreadPerContext);
266 else if (mode == "DrawThreadPerContext")
267 viewer->setThreadingModel(osgViewer::Viewer::DrawThreadPerContext);
268 else if (mode == "CullThreadPerCameraDrawThreadPerContext")
269 viewer->setThreadingModel(osgViewer::Viewer::CullThreadPerCameraDrawThreadPerContext);
271 viewer->setThreadingModel(osgViewer::Viewer::SingleThreaded);
272 WindowBuilder::initWindowBuilder(stencil);
273 WindowBuilder *windowBuilder = WindowBuilder::getWindowBuilder();
275 // Look for windows, camera groups, and the old syntax of
277 SGPropertyNode* renderingNode = fgGetNode("/sim/rendering");
278 SGPropertyNode* cgroupNode = renderingNode->getNode("camera-group", true);
279 bool oldSyntax = !cgroupNode->hasChild("camera");
281 for (int i = 0; i < renderingNode->nChildren(); ++i) {
282 SGPropertyNode* propNode = renderingNode->getChild(i);
283 const char* propName = propNode->getName();
284 if (!strcmp(propName, "window") || !strcmp(propName, "camera")) {
285 SGPropertyNode* copiedNode
286 = cgroupNode->getNode(propName, propNode->getIndex(), true);
287 copyProperties(propNode, copiedNode);
290 vector<SGPropertyNode_ptr> cameras = cgroupNode->getChildren("camera");
291 SGPropertyNode* masterCamera = 0;
292 BOOST_FOREACH(SGPropertyNode_ptr& camera, cameras) {
293 if (camera->getDoubleValue("shear-x", 0.0) == 0.0
294 && camera->getDoubleValue("shear-y", 0.0) == 0.0) {
295 masterCamera = camera.ptr();
300 masterCamera = cgroupNode->getChild("camera", cameras.size(), true);
301 setValue(masterCamera->getNode("window/name", true),
302 windowBuilder->getDefaultWindowName());
304 SGPropertyNode* nameNode = masterCamera->getNode("window/name");
306 setValue(cgroupNode->getNode("gui/window/name", true),
307 nameNode->getStringValue());
309 cameraGroup = CameraGroup::buildCameraGroup(viewer.get(), cgroupNode);
310 Camera* guiCamera = getGUICamera(cameraGroup);
312 Viewport* guiViewport = guiCamera->getViewport();
313 fgSetInt("/sim/startup/xsize", guiViewport->width());
314 fgSetInt("/sim/startup/ysize", guiViewport->height());
316 FGEventHandler* manipulator = globals->get_renderer()->getEventHandler();
317 WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
318 if (wsa->windows.size() != 1) {
319 manipulator->setResizable(false);
321 viewer->getCamera()->setProjectionResizePolicy(osg::Camera::FIXED);
322 viewer->addEventHandler(manipulator);
323 // Let FG handle the escape key with a confirmation
324 viewer->setKeyEventSetsDone(0);
325 // The viewer won't start without some root.
326 viewer->setSceneData(new osg::Group);
327 globals->get_renderer()->setViewer(viewer.get());
328 CameraGroup::setDefault(cameraGroup);
330 DisplaySettings * displaySettings = DisplaySettings::instance();
331 fgTie("/sim/rendering/osg-displaysettings/eye-separation", displaySettings, &DisplaySettings::getEyeSeparation, &DisplaySettings::setEyeSeparation );
332 fgTie("/sim/rendering/osg-displaysettings/screen-distance", displaySettings, &DisplaySettings::getScreenDistance, &DisplaySettings::setScreenDistance );
333 fgTie("/sim/rendering/osg-displaysettings/screen-width", displaySettings, &DisplaySettings::getScreenWidth, &DisplaySettings::setScreenWidth );
334 fgTie("/sim/rendering/osg-displaysettings/screen-height", displaySettings, &DisplaySettings::getScreenHeight, &DisplaySettings::setScreenHeight );
335 fgTie("/sim/rendering/osg-displaysettings/stereo-mode", getStereoMode, setStereoMode );
336 fgTie("/sim/rendering/osg-displaysettings/double-buffer", displaySettings, &DisplaySettings::getDoubleBuffer, &DisplaySettings::setDoubleBuffer );
337 fgTie("/sim/rendering/osg-displaysettings/depth-buffer", displaySettings, &DisplaySettings::getDepthBuffer, &DisplaySettings::setDepthBuffer );
338 fgTie("/sim/rendering/osg-displaysettings/rgb", displaySettings, &DisplaySettings::getRGB, &DisplaySettings::setRGB );
342 static int status = 0;
344 void fgOSExit(int code)
346 viewer->setDone(true);
347 viewer->getDatabasePager()->cancel();
353 ref_ptr<FGEventHandler> manipulator
354 = globals->get_renderer()->getEventHandler();
355 viewer->setReleaseContextAtEndOfFrameHint(false);
356 if (!viewer->isRealized())
358 while (!viewer->done()) {
359 fgIdleHandler idleFunc = manipulator->getIdleHandler();
362 globals->get_renderer()->update();
363 viewer->frame( globals->get_sim_time_sec() );
369 int fgGetKeyModifiers()
371 if (!globals->get_renderer()) { // happens during shutdown
375 return globals->get_renderer()->getEventHandler()->getCurrentModifiers();
378 void fgWarpMouse(int x, int y)
380 warpGUIPointer(CameraGroup::getDefault(), x, y);
383 void fgOSInit(int* argc, char** argv)
385 globals->get_renderer()->init();
386 WindowSystemAdapter::setWSA(new WindowSystemAdapter);
389 void fgOSFullScreen()
391 std::vector<osgViewer::GraphicsWindow*> windows;
392 viewer->getWindows(windows);
397 /* Toggling window fullscreen is only supported for the main GUI window.
398 * The other windows should use fixed setup from the camera.xml file anyway. */
399 osgViewer::GraphicsWindow* window = windows[0];
402 osg::GraphicsContext::WindowingSystemInterface *wsi = osg::GraphicsContext::getWindowingSystemInterface();
406 SG_LOG(SG_VIEW, SG_ALERT, "ERROR: No WindowSystemInterface available. Cannot toggle window fullscreen.");
410 static int previous_x = 0;
411 static int previous_y = 0;
412 static int previous_width = 800;
413 static int previous_height = 600;
415 unsigned int screenWidth;
416 unsigned int screenHeight;
417 wsi->getScreenResolution(*(window->getTraits()), screenWidth, screenHeight);
423 window->getWindowRectangle(x, y, width, height);
425 /* Note: the simple "is window size == screen size" check to detect full screen state doesn't work with
426 * X screen servers in Xinerama mode, since the reported screen width (or height) exceeds the maximum width
427 * (or height) usable by a single window (Xserver automatically shrinks/moves the full screen window to fit a
428 * single display) - so we detect full screen mode using "WindowDecoration" state instead.
429 * "false" - even when a single window is display in fullscreen */
430 //bool isFullScreen = x == 0 && y == 0 && width == (int)screenWidth && height == (int)screenHeight;
431 bool isFullScreen = !window->getWindowDecoration();
433 SG_LOG(SG_VIEW, SG_DEBUG, "Toggling fullscreen. Previous window rectangle ("
434 << x << ", " << y << ") x (" << width << ", " << height << "), fullscreen: " << isFullScreen
435 << ", number of screens: " << wsi->getNumScreens());
438 // limit x,y coordinates and window size to screen area
439 if (previous_x + previous_width > (int)screenWidth)
441 if (previous_y + previous_height > (int)screenHeight)
444 // disable fullscreen mode, restore previous window size/coordinates
447 width = previous_width;
448 height = previous_height;
452 // remember previous setting
455 previous_width = width;
456 previous_height = height;
458 // enable fullscreen mode, set new width/height
462 height = screenHeight;
465 // set xsize/ysize properties to adapt GUI planes
466 fgSetInt("/sim/startup/xsize", width);
467 fgSetInt("/sim/startup/ysize", height);
469 // reconfigure window
470 window->setWindowDecoration(isFullScreen);
471 window->setWindowRectangle(x, y, width, height);
472 window->grabFocusIfPointerInWindow();
476 static void setMouseCursor(osgViewer::GraphicsWindow* gw, int cursor)
482 osgViewer::GraphicsWindow::MouseCursor mouseCursor;
483 mouseCursor = osgViewer::GraphicsWindow::InheritCursor;
484 if (cursor == MOUSE_CURSOR_NONE)
485 mouseCursor = osgViewer::GraphicsWindow::NoCursor;
486 else if(cursor == MOUSE_CURSOR_POINTER)
488 // osgViewer-Cocoa lacks RightArrowCursor, use Left
489 mouseCursor = osgViewer::GraphicsWindow::LeftArrowCursor;
491 mouseCursor = osgViewer::GraphicsWindow::RightArrowCursor;
493 else if(cursor == MOUSE_CURSOR_WAIT)
494 mouseCursor = osgViewer::GraphicsWindow::WaitCursor;
495 else if(cursor == MOUSE_CURSOR_CROSSHAIR)
496 mouseCursor = osgViewer::GraphicsWindow::CrosshairCursor;
497 else if(cursor == MOUSE_CURSOR_LEFTRIGHT)
498 mouseCursor = osgViewer::GraphicsWindow::LeftRightCursor;
499 else if(cursor == MOUSE_CURSOR_TOPSIDE)
500 mouseCursor = osgViewer::GraphicsWindow::TopSideCursor;
501 else if(cursor == MOUSE_CURSOR_BOTTOMSIDE)
502 mouseCursor = osgViewer::GraphicsWindow::BottomSideCursor;
503 else if(cursor == MOUSE_CURSOR_LEFTSIDE)
504 mouseCursor = osgViewer::GraphicsWindow::LeftSideCursor;
505 else if(cursor == MOUSE_CURSOR_RIGHTSIDE)
506 mouseCursor = osgViewer::GraphicsWindow::RightSideCursor;
507 else if(cursor == MOUSE_CURSOR_TOPLEFT)
508 mouseCursor = osgViewer::GraphicsWindow::TopLeftCorner;
509 else if(cursor == MOUSE_CURSOR_TOPRIGHT)
510 mouseCursor = osgViewer::GraphicsWindow::TopRightCorner;
511 else if(cursor == MOUSE_CURSOR_BOTTOMLEFT)
512 mouseCursor = osgViewer::GraphicsWindow::BottomLeftCorner;
513 else if(cursor == MOUSE_CURSOR_BOTTOMRIGHT)
514 mouseCursor = osgViewer::GraphicsWindow::BottomRightCorner;
516 gw->setCursor(mouseCursor);
519 static int _cursor = -1;
521 void fgSetMouseCursor(int cursor)
525 std::vector<osgViewer::GraphicsWindow*> windows;
526 viewer->getWindows(windows);
527 BOOST_FOREACH(osgViewer::GraphicsWindow* gw, windows) {
528 setMouseCursor(gw, cursor);
532 int fgGetMouseCursor()