src/Viewer/fg_os_osgviewer.cxx

   1 // fg_os_osgviewer.cxx -- common functions for fg_os interface
   2 // implemented as an osgViewer
   3 //
   4 // Copyright (C) 2007  Tim Moore timoore@redhat.com
   5 // Copyright (C) 2007 Mathias Froehlich
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include <config.h>
  23 #endif
  24
  25 #include <algorithm>
  26 #include <iostream>
  27 #include <sstream>
  28 #include <string>
  29
  30 #include <stdlib.h>
  31
  32 #include <boost/foreach.hpp>
  33
  34 #include <simgear/compiler.h>
  35 #include <simgear/structure/exception.hxx>
  36 #include <simgear/debug/logstream.hxx>
  37 #include <simgear/props/props_io.hxx>
  38
  39 #include <osg/Camera>
  40 #include <osg/GraphicsContext>
  41 #include <osg/Group>
  42 #include <osg/Matrixd>
  43 #include <osg/Viewport>
  44 #include <osg/Version>
  45 #include <osg/View>
  46 #include <osgViewer/ViewerEventHandlers>
  47 #include <osgViewer/Viewer>
  48 #include <osgViewer/GraphicsWindow>
  49
  50 #include <Scenery/scenery.hxx>
  51 #include <Main/fg_os.hxx>
  52 #include <Main/fg_props.hxx>
  53 #include <Main/util.hxx>
  54 #include <Main/globals.hxx>
  55 #include "renderer.hxx"
  56 #include "CameraGroup.hxx"
  57 #include "FGEventHandler.hxx"
  58 #include "WindowBuilder.hxx"
  59 #include "WindowSystemAdapter.hxx"
  60
  61 // Static linking of OSG needs special macros
  62 #ifdef OSG_LIBRARY_STATIC
  63 #include <osgDB/Registry>
  64 USE_GRAPHICSWINDOW();
  65 // Image formats
  66 USE_OSGPLUGIN(bmp);
  67 USE_OSGPLUGIN(dds);
  68 USE_OSGPLUGIN(hdr);
  69 USE_OSGPLUGIN(pic);
  70 USE_OSGPLUGIN(pnm);
  71 USE_OSGPLUGIN(rgb);
  72 USE_OSGPLUGIN(tga);
  73 #ifdef OSG_JPEG_ENABLED
  74   USE_OSGPLUGIN(jpeg);
  75 #endif
  76 #ifdef OSG_PNG_ENABLED
  77   USE_OSGPLUGIN(png);
  78 #endif
  79 #ifdef OSG_TIFF_ENABLED
  80   USE_OSGPLUGIN(tiff);
  81 #endif
  82 // Model formats
  83 USE_OSGPLUGIN(3ds);
  84 USE_OSGPLUGIN(ac);
  85 USE_OSGPLUGIN(ive);
  86 USE_OSGPLUGIN(osg);
  87 USE_OSGPLUGIN(txf);
  88 #endif
  89
  90 // fg_os implementation using OpenSceneGraph's osgViewer::Viewer class
  91 // to create the graphics window and run the event/update/render loop.
  92
  93 //
  94 // fg_os implementation
  95 //
  96
  97 using namespace std;
  98 using namespace flightgear;
  99 using namespace osg;
 100
 101 static osg::ref_ptr<osgViewer::Viewer> viewer;
 102 static osg::ref_ptr<osg::Camera> mainCamera;
 103
 104 static void setStereoMode( const char * mode )
 105 {
 106     DisplaySettings::StereoMode stereoMode = DisplaySettings::QUAD_BUFFER;
 107     bool stereoOn = true;
 108
 109     if (strcmp(mode,"QUAD_BUFFER")==0)
 110     {
 111         stereoMode = DisplaySettings::QUAD_BUFFER;
 112     }
 113     else if (strcmp(mode,"ANAGLYPHIC")==0)
 114     {
 115         stereoMode = DisplaySettings::ANAGLYPHIC;
 116     }
 117     else if (strcmp(mode,"HORIZONTAL_SPLIT")==0)
 118     {
 119         stereoMode = DisplaySettings::HORIZONTAL_SPLIT;
 120     }
 121     else if (strcmp(mode,"VERTICAL_SPLIT")==0)
 122     {
 123         stereoMode = DisplaySettings::VERTICAL_SPLIT;
 124     }
 125     else if (strcmp(mode,"LEFT_EYE")==0)
 126     {
 127         stereoMode = DisplaySettings::LEFT_EYE;
 128     }
 129     else if (strcmp(mode,"RIGHT_EYE")==0)
 130     {
 131         stereoMode = DisplaySettings::RIGHT_EYE;
 132     }
 133     else if (strcmp(mode,"HORIZONTAL_INTERLACE")==0)
 134     {
 135         stereoMode = DisplaySettings::HORIZONTAL_INTERLACE;
 136     }
 137     else if (strcmp(mode,"VERTICAL_INTERLACE")==0)
 138     {
 139         stereoMode = DisplaySettings::VERTICAL_INTERLACE;
 140     }
 141     else if (strcmp(mode,"CHECKERBOARD")==0)
 142     {
 143         stereoMode = DisplaySettings::CHECKERBOARD;
 144     } else {
 145         stereoOn = false;
 146     }
 147     DisplaySettings::instance()->setStereo( stereoOn );
 148     DisplaySettings::instance()->setStereoMode( stereoMode );
 149 }
 150
 151 static const char * getStereoMode()
 152 {
 153     DisplaySettings::StereoMode stereoMode = DisplaySettings::instance()->getStereoMode();
 154     bool stereoOn = DisplaySettings::instance()->getStereo();
 155     if( !stereoOn ) return "OFF";
 156     if( stereoMode == DisplaySettings::QUAD_BUFFER ) {
 157         return "QUAD_BUFFER";
 158     } else if( stereoMode == DisplaySettings::ANAGLYPHIC ) {
 159         return "ANAGLYPHIC";
 160     } else if( stereoMode == DisplaySettings::HORIZONTAL_SPLIT ) {
 161         return "HORIZONTAL_SPLIT";
 162     } else if( stereoMode == DisplaySettings::VERTICAL_SPLIT ) {
 163         return "VERTICAL_SPLIT";
 164     } else if( stereoMode == DisplaySettings::LEFT_EYE ) {
 165         return "LEFT_EYE";
 166     } else if( stereoMode == DisplaySettings::RIGHT_EYE ) {
 167         return "RIGHT_EYE";
 168     } else if( stereoMode == DisplaySettings::HORIZONTAL_INTERLACE ) {
 169         return "HORIZONTAL_INTERLACE";
 170     } else if( stereoMode == DisplaySettings::VERTICAL_INTERLACE ) {
 171         return "VERTICAL_INTERLACE";
 172     } else if( stereoMode == DisplaySettings::CHECKERBOARD ) {
 173         return "CHECKERBOARD";
 174     }
 175     return "OFF";
 176 }
 177
 178 void fgOSOpenWindow(bool stencil)
 179 {
 180     viewer = new osgViewer::Viewer;
 181     viewer->setDatabasePager(FGScenery::getPagerSingleton());
 182     CameraGroup* cameraGroup = 0;
 183     std::string mode;
 184     mode = fgGetString("/sim/rendering/multithreading-mode", "SingleThreaded");
 185     if (mode == "AutomaticSelection")
 186       viewer->setThreadingModel(osgViewer::Viewer::AutomaticSelection);
 187     else if (mode == "CullDrawThreadPerContext")
 188       viewer->setThreadingModel(osgViewer::Viewer::CullDrawThreadPerContext);
 189     else if (mode == "DrawThreadPerContext")
 190       viewer->setThreadingModel(osgViewer::Viewer::DrawThreadPerContext);
 191     else if (mode == "CullThreadPerCameraDrawThreadPerContext")
 192       viewer->setThreadingModel(osgViewer::Viewer::CullThreadPerCameraDrawThreadPerContext);
 193     else
 194       viewer->setThreadingModel(osgViewer::Viewer::SingleThreaded);
 195     WindowBuilder::initWindowBuilder(stencil);
 196     WindowBuilder *windowBuilder = WindowBuilder::getWindowBuilder();
 197
 198     // Look for windows, camera groups, and the old syntax of
 199     // top-level cameras
 200     SGPropertyNode* renderingNode = fgGetNode("/sim/rendering");
 201     SGPropertyNode* cgroupNode = renderingNode->getNode("camera-group", true);
 202     bool oldSyntax = !cgroupNode->hasChild("camera");
 203     if (oldSyntax) {
 204         for (int i = 0; i < renderingNode->nChildren(); ++i) {
 205             SGPropertyNode* propNode = renderingNode->getChild(i);
 206             const char* propName = propNode->getName();
 207             if (!strcmp(propName, "window") || !strcmp(propName, "camera")) {
 208                 SGPropertyNode* copiedNode
 209                     = cgroupNode->getNode(propName, propNode->getIndex(), true);
 210                 copyProperties(propNode, copiedNode);
 211             }
 212         }
 213         vector<SGPropertyNode_ptr> cameras = cgroupNode->getChildren("camera");
 214         SGPropertyNode* masterCamera = 0;
 215         BOOST_FOREACH(SGPropertyNode_ptr& camera, cameras) {
 216             if (camera->getDoubleValue("shear-x", 0.0) == 0.0
 217                 && camera->getDoubleValue("shear-y", 0.0) == 0.0) {
 218                 masterCamera = camera.ptr();
 219                 break;
 220             }
 221         }
 222         if (!masterCamera) {
 223             masterCamera = cgroupNode->getChild("camera", cameras.size(), true);
 224             setValue(masterCamera->getNode("window/name", true),
 225                      windowBuilder->getDefaultWindowName());
 226         }
 227         SGPropertyNode* nameNode = masterCamera->getNode("window/name");
 228         if (nameNode)
 229             setValue(cgroupNode->getNode("gui/window/name", true),
 230                      nameNode->getStringValue());
 231     }
 232     cameraGroup = CameraGroup::buildCameraGroup(viewer.get(), cgroupNode);
 233     Camera* guiCamera = getGUICamera(cameraGroup);
 234     if (guiCamera) {
 235         Viewport* guiViewport = guiCamera->getViewport();
 236         fgSetInt("/sim/startup/xsize", guiViewport->width());
 237         fgSetInt("/sim/startup/ysize", guiViewport->height());
 238     }
 239     FGEventHandler* manipulator = globals->get_renderer()->getEventHandler();
 240     WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
 241     if (wsa->windows.size() != 1) {
 242         manipulator->setResizable(false);
 243     }
 244     viewer->getCamera()->setProjectionResizePolicy(osg::Camera::FIXED);
 245     viewer->addEventHandler(manipulator);
 246     // Let FG handle the escape key with a confirmation
 247     viewer->setKeyEventSetsDone(0);
 248     // The viewer won't start without some root.
 249     viewer->setSceneData(new osg::Group);
 250     globals->get_renderer()->setViewer(viewer.get());
 251     CameraGroup::setDefault(cameraGroup);
 252
 253     DisplaySettings * displaySettings = DisplaySettings::instance();
 254     fgTie("/sim/rendering/osg-displaysettings/eye-separation", displaySettings, &DisplaySettings::getEyeSeparation, &DisplaySettings::setEyeSeparation );
 255     fgTie("/sim/rendering/osg-displaysettings/screen-distance", displaySettings, &DisplaySettings::getScreenDistance, &DisplaySettings::setScreenDistance );
 256     fgTie("/sim/rendering/osg-displaysettings/screen-width", displaySettings, &DisplaySettings::getScreenWidth, &DisplaySettings::setScreenWidth );
 257     fgTie("/sim/rendering/osg-displaysettings/screen-height", displaySettings, &DisplaySettings::getScreenHeight, &DisplaySettings::setScreenHeight );
 258     fgTie("/sim/rendering/osg-displaysettings/stereo-mode", getStereoMode, setStereoMode );
 259     fgTie("/sim/rendering/osg-displaysettings/double-buffer", displaySettings, &DisplaySettings::getDoubleBuffer, &DisplaySettings::setDoubleBuffer );
 260     fgTie("/sim/rendering/osg-displaysettings/depth-buffer", displaySettings, &DisplaySettings::getDepthBuffer, &DisplaySettings::setDepthBuffer );
 261     fgTie("/sim/rendering/osg-displaysettings/rgb", displaySettings, &DisplaySettings::getRGB, &DisplaySettings::setRGB );
 262 }
 263
 264
 265 static int status = 0;
 266
 267 void fgOSExit(int code)
 268 {
 269     viewer->setDone(true);
 270     viewer->getDatabasePager()->cancel();
 271     status = code;
 272 }
 273
 274 int fgOSMainLoop()
 275 {
 276     ref_ptr<FGEventHandler> manipulator
 277         = globals->get_renderer()->getEventHandler();
 278     viewer->setReleaseContextAtEndOfFrameHint(false);
 279     if (!viewer->isRealized())
 280         viewer->realize();
 281     while (!viewer->done()) {
 282         fgIdleHandler idleFunc = manipulator->getIdleHandler();
 283         if (idleFunc)
 284             (*idleFunc)();
 285         globals->get_renderer()->update();
 286         viewer->frame();
 287     }
 288
 289     return status;
 290 }
 291
 292 int fgGetKeyModifiers()
 293 {
 294     if (!globals->get_renderer()) { // happens during shutdown
 295       return 0;
 296     }
 297
 298     return globals->get_renderer()->getEventHandler()->getCurrentModifiers();
 299 }
 300
 301 void fgWarpMouse(int x, int y)
 302 {
 303     warpGUIPointer(CameraGroup::getDefault(), x, y);
 304 }
 305
 306 void fgOSInit(int* argc, char** argv)
 307 {
 308     globals->get_renderer()->init();
 309     WindowSystemAdapter::setWSA(new WindowSystemAdapter);
 310 }
 311
 312 void fgOSFullScreen()
 313 {
 314     std::vector<osgViewer::GraphicsWindow*> windows;
 315     viewer->getWindows(windows);
 316
 317     if (windows.size() == 0)
 318         return; // Huh?!?
 319
 320     /* Toggling window fullscreen is only supported for the main GUI window.
 321      * The other windows should use fixed setup from the camera.xml file anyway. */
 322     osgViewer::GraphicsWindow* window = windows[0];
 323
 324     {
 325         osg::GraphicsContext::WindowingSystemInterface    *wsi = osg::GraphicsContext::getWindowingSystemInterface();
 326
 327         if (wsi == NULL)
 328         {
 329             SG_LOG(SG_VIEW, SG_ALERT, "ERROR: No WindowSystemInterface available. Cannot toggle window fullscreen.");
 330             return;
 331         }
 332
 333         static int previous_x = 0;
 334         static int previous_y = 0;
 335         static int previous_width = 800;
 336         static int previous_height = 600;
 337
 338         unsigned int screenWidth;
 339         unsigned int screenHeight;
 340         wsi->getScreenResolution(*(window->getTraits()), screenWidth, screenHeight);
 341
 342         int x;
 343         int y;
 344         int width;
 345         int height;
 346         window->getWindowRectangle(x, y, width, height);
 347
 348         bool isFullScreen = x == 0 && y == 0 && width == (int)screenWidth && height == (int)screenHeight;
 349
 350         SG_LOG(SG_VIEW, SG_DEBUG, "Toggling fullscreen. Previous window rectangle ("
 351                << x << ", " << y << ") x (" << width << ", " << height << "), fullscreen: " << isFullScreen);
 352         if (isFullScreen)
 353         {
 354             // disable fullscreen mode, restore previous window size/coordinates
 355             window->setWindowDecoration(true);
 356             // limit x,y coordinates and window size to screen area
 357             if (previous_x + previous_width > (int)screenWidth)
 358                 previous_x = 0;
 359             if (previous_y + previous_height > (int)screenHeight)
 360                 previous_y = 0;
 361             window->setWindowRectangle(previous_x, previous_y, previous_width, previous_height);
 362         }
 363         else
 364         {
 365             // remember previous setting
 366             previous_x = x;
 367             previous_y = y;
 368             previous_width = width;
 369             previous_height = height;
 370
 371             // enable fullscreen
 372             window->setWindowDecoration(false);
 373             window->setWindowRectangle(0, 0, screenWidth, screenHeight);
 374         }
 375
 376         window->grabFocusIfPointerInWindow();
 377     }
 378 }
 379
 380 static void setMouseCursor(osgViewer::GraphicsWindow* gw, int cursor)
 381 {
 382     if (!gw) {
 383         return;
 384     }
 385
 386     osgViewer::GraphicsWindow::MouseCursor mouseCursor;
 387     mouseCursor = osgViewer::GraphicsWindow::InheritCursor;
 388     if (cursor == MOUSE_CURSOR_NONE)
 389         mouseCursor = osgViewer::GraphicsWindow::NoCursor;
 390     else if(cursor == MOUSE_CURSOR_POINTER)
 391 #ifdef SG_MAC
 392         // osgViewer-Cocoa lacks RightArrowCursor, use Left
 393         mouseCursor = osgViewer::GraphicsWindow::LeftArrowCursor;
 394 #else
 395         mouseCursor = osgViewer::GraphicsWindow::RightArrowCursor;
 396 #endif
 397     else if(cursor == MOUSE_CURSOR_WAIT)
 398         mouseCursor = osgViewer::GraphicsWindow::WaitCursor;
 399     else if(cursor == MOUSE_CURSOR_CROSSHAIR)
 400         mouseCursor = osgViewer::GraphicsWindow::CrosshairCursor;
 401     else if(cursor == MOUSE_CURSOR_LEFTRIGHT)
 402         mouseCursor = osgViewer::GraphicsWindow::LeftRightCursor;
 403     else if(cursor == MOUSE_CURSOR_TOPSIDE)
 404         mouseCursor = osgViewer::GraphicsWindow::TopSideCursor;
 405     else if(cursor == MOUSE_CURSOR_BOTTOMSIDE)
 406         mouseCursor = osgViewer::GraphicsWindow::BottomSideCursor;
 407     else if(cursor == MOUSE_CURSOR_LEFTSIDE)
 408         mouseCursor = osgViewer::GraphicsWindow::LeftSideCursor;
 409     else if(cursor == MOUSE_CURSOR_RIGHTSIDE)
 410         mouseCursor = osgViewer::GraphicsWindow::RightSideCursor;
 411     else if(cursor == MOUSE_CURSOR_TOPLEFT)
 412         mouseCursor = osgViewer::GraphicsWindow::TopLeftCorner;
 413     else if(cursor == MOUSE_CURSOR_TOPRIGHT)
 414         mouseCursor = osgViewer::GraphicsWindow::TopRightCorner;
 415     else if(cursor == MOUSE_CURSOR_BOTTOMLEFT)
 416         mouseCursor = osgViewer::GraphicsWindow::BottomLeftCorner;
 417     else if(cursor == MOUSE_CURSOR_BOTTOMRIGHT)
 418         mouseCursor = osgViewer::GraphicsWindow::BottomRightCorner;
 419
 420     gw->setCursor(mouseCursor);
 421 }
 422
 423 static int _cursor = -1;
 424
 425 void fgSetMouseCursor(int cursor)
 426 {
 427     _cursor = cursor;
 428
 429     std::vector<osgViewer::GraphicsWindow*> windows;
 430     viewer->getWindows(windows);
 431     BOOST_FOREACH(osgViewer::GraphicsWindow* gw, windows) {
 432         setMouseCursor(gw, cursor);
 433     }
 434 }
 435
 436 int fgGetMouseCursor()
 437 {
 438     return _cursor;
 439 }