src/Main/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
  49 #include <Scenery/scenery.hxx>
  50 #include "fg_os.hxx"
  51 #include "fg_props.hxx"
  52 #include "util.hxx"
  53 #include "globals.hxx"
  54 #include "renderer.hxx"
  55 #include "CameraGroup.hxx"
  56 #include "FGEventHandler.hxx"
  57 #include "WindowBuilder.hxx"
  58 #include "WindowSystemAdapter.hxx"
  59
  60 // Static linking of OSG needs special macros
  61 #ifdef OSG_LIBRARY_STATIC
  62 #include <osgDB/Registry>
  63 USE_GRAPHICSWINDOW();
  64 // Image formats
  65 USE_OSGPLUGIN(bmp);
  66 USE_OSGPLUGIN(dds);
  67 USE_OSGPLUGIN(hdr);
  68 USE_OSGPLUGIN(pic);
  69 USE_OSGPLUGIN(pnm);
  70 USE_OSGPLUGIN(rgb);
  71 USE_OSGPLUGIN(tga);
  72 #ifdef OSG_JPEG_ENABLED
  73   USE_OSGPLUGIN(jpeg);
  74 #endif
  75 #ifdef OSG_PNG_ENABLED
  76   USE_OSGPLUGIN(png);
  77 #endif
  78 #ifdef OSG_TIFF_ENABLED
  79   USE_OSGPLUGIN(tiff);
  80 #endif
  81 // Model formats
  82 USE_OSGPLUGIN(3ds);
  83 USE_OSGPLUGIN(ac);
  84 USE_OSGPLUGIN(ive);
  85 USE_OSGPLUGIN(osg);
  86 USE_OSGPLUGIN(txf);
  87 #endif
  88
  89 // fg_os implementation using OpenSceneGraph's osgViewer::Viewer class
  90 // to create the graphics window and run the event/update/render loop.
  91
  92 //
  93 // fg_os implementation
  94 //
  95
  96 using namespace std;
  97 using namespace flightgear;
  98 using namespace osg;
  99
 100 static osg::ref_ptr<osgViewer::Viewer> viewer;
 101 static osg::ref_ptr<osg::Camera> mainCamera;
 102
 103 static void setStereoMode( const char * mode )
 104 {
 105     DisplaySettings::StereoMode stereoMode = DisplaySettings::QUAD_BUFFER;
 106     bool stereoOn = true;
 107
 108     if (strcmp(mode,"QUAD_BUFFER")==0)
 109     {
 110         stereoMode = DisplaySettings::QUAD_BUFFER;
 111     }
 112     else if (strcmp(mode,"ANAGLYPHIC")==0)
 113     {
 114         stereoMode = DisplaySettings::ANAGLYPHIC;
 115     }
 116     else if (strcmp(mode,"HORIZONTAL_SPLIT")==0)
 117     {
 118         stereoMode = DisplaySettings::HORIZONTAL_SPLIT;
 119     }
 120     else if (strcmp(mode,"VERTICAL_SPLIT")==0)
 121     {
 122         stereoMode = DisplaySettings::VERTICAL_SPLIT;
 123     }
 124     else if (strcmp(mode,"LEFT_EYE")==0)
 125     {
 126         stereoMode = DisplaySettings::LEFT_EYE;
 127     }
 128     else if (strcmp(mode,"RIGHT_EYE")==0)
 129     {
 130         stereoMode = DisplaySettings::RIGHT_EYE;
 131     }
 132     else if (strcmp(mode,"HORIZONTAL_INTERLACE")==0)
 133     {
 134         stereoMode = DisplaySettings::HORIZONTAL_INTERLACE;
 135     }
 136     else if (strcmp(mode,"VERTICAL_INTERLACE")==0)
 137     {
 138         stereoMode = DisplaySettings::VERTICAL_INTERLACE;
 139     }
 140     else if (strcmp(mode,"CHECKERBOARD")==0)
 141     {
 142         stereoMode = DisplaySettings::CHECKERBOARD;
 143     } else {
 144         stereoOn = false;
 145     }
 146     DisplaySettings::instance()->setStereo( stereoOn );
 147     DisplaySettings::instance()->setStereoMode( stereoMode );
 148 }
 149
 150 static const char * getStereoMode()
 151 {
 152     DisplaySettings::StereoMode stereoMode = DisplaySettings::instance()->getStereoMode();
 153     bool stereoOn = DisplaySettings::instance()->getStereo();
 154     if( !stereoOn ) return "OFF";
 155     if( stereoMode == DisplaySettings::QUAD_BUFFER ) {
 156         return "QUAD_BUFFER";
 157     } else if( stereoMode == DisplaySettings::ANAGLYPHIC ) {
 158         return "ANAGLYPHIC";
 159     } else if( stereoMode == DisplaySettings::HORIZONTAL_SPLIT ) {
 160         return "HORIZONTAL_SPLIT";
 161     } else if( stereoMode == DisplaySettings::VERTICAL_SPLIT ) {
 162         return "VERTICAL_SPLIT";
 163     } else if( stereoMode == DisplaySettings::LEFT_EYE ) {
 164         return "LEFT_EYE";
 165     } else if( stereoMode == DisplaySettings::RIGHT_EYE ) {
 166         return "RIGHT_EYE";
 167     } else if( stereoMode == DisplaySettings::HORIZONTAL_INTERLACE ) {
 168         return "HORIZONTAL_INTERLACE";
 169     } else if( stereoMode == DisplaySettings::VERTICAL_INTERLACE ) {
 170         return "VERTICAL_INTERLACE";
 171     } else if( stereoMode == DisplaySettings::CHECKERBOARD ) {
 172         return "CHECKERBOARD";
 173     }
 174     return "OFF";
 175 }
 176
 177 void fgOSOpenWindow(bool stencil)
 178 {
 179     viewer = new osgViewer::Viewer;
 180     viewer->setDatabasePager(FGScenery::getPagerSingleton());
 181     CameraGroup* cameraGroup = 0;
 182     std::string mode;
 183     mode = fgGetString("/sim/rendering/multithreading-mode", "SingleThreaded");
 184     if (mode == "AutomaticSelection")
 185       viewer->setThreadingModel(osgViewer::Viewer::AutomaticSelection);
 186     else if (mode == "CullDrawThreadPerContext")
 187       viewer->setThreadingModel(osgViewer::Viewer::CullDrawThreadPerContext);
 188     else if (mode == "DrawThreadPerContext")
 189       viewer->setThreadingModel(osgViewer::Viewer::DrawThreadPerContext);
 190     else if (mode == "CullThreadPerCameraDrawThreadPerContext")
 191       viewer->setThreadingModel(osgViewer::Viewer::CullThreadPerCameraDrawThreadPerContext);
 192     else
 193       viewer->setThreadingModel(osgViewer::Viewer::SingleThreaded);
 194     WindowBuilder::initWindowBuilder(stencil);
 195     WindowBuilder *windowBuilder = WindowBuilder::getWindowBuilder();
 196
 197     // Look for windows, camera groups, and the old syntax of
 198     // top-level cameras
 199     SGPropertyNode* renderingNode = fgGetNode("/sim/rendering");
 200     SGPropertyNode* cgroupNode = renderingNode->getNode("camera-group", true);
 201     bool oldSyntax = !cgroupNode->hasChild("camera");
 202     if (oldSyntax) {
 203         for (int i = 0; i < renderingNode->nChildren(); ++i) {
 204             SGPropertyNode* propNode = renderingNode->getChild(i);
 205             const char* propName = propNode->getName();
 206             if (!strcmp(propName, "window") || !strcmp(propName, "camera")) {
 207                 SGPropertyNode* copiedNode
 208                     = cgroupNode->getNode(propName, propNode->getIndex(), true);
 209                 copyProperties(propNode, copiedNode);
 210             }
 211         }
 212         vector<SGPropertyNode_ptr> cameras = cgroupNode->getChildren("camera");
 213         SGPropertyNode* masterCamera = 0;
 214         BOOST_FOREACH(SGPropertyNode_ptr& camera, cameras) {
 215             if (camera->getDoubleValue("shear-x", 0.0) == 0.0
 216                 && camera->getDoubleValue("shear-y", 0.0) == 0.0) {
 217                 masterCamera = camera.ptr();
 218                 break;
 219             }
 220         }
 221         if (!masterCamera) {
 222             masterCamera = cgroupNode->getChild("camera", cameras.size(), true);
 223             setValue(masterCamera->getNode("window/name", true),
 224                      windowBuilder->getDefaultWindowName());
 225         }
 226         SGPropertyNode* nameNode = masterCamera->getNode("window/name");
 227         if (nameNode)
 228             setValue(cgroupNode->getNode("gui/window/name", true),
 229                      nameNode->getStringValue());
 230     }
 231     cameraGroup = CameraGroup::buildCameraGroup(viewer.get(), cgroupNode);
 232     Camera* guiCamera = getGUICamera(cameraGroup);
 233     if (guiCamera) {
 234         Viewport* guiViewport = guiCamera->getViewport();
 235         fgSetInt("/sim/startup/xsize", guiViewport->width());
 236         fgSetInt("/sim/startup/ysize", guiViewport->height());
 237     }
 238     FGEventHandler* manipulator = globals->get_renderer()->getEventHandler();
 239     WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
 240     if (wsa->windows.size() != 1) {
 241         manipulator->setResizable(false);
 242     }
 243     viewer->getCamera()->setProjectionResizePolicy(osg::Camera::FIXED);
 244     viewer->addEventHandler(manipulator);
 245     // Let FG handle the escape key with a confirmation
 246     viewer->setKeyEventSetsDone(0);
 247     // The viewer won't start without some root.
 248     viewer->setSceneData(new osg::Group);
 249     globals->get_renderer()->setViewer(viewer.get());
 250     CameraGroup::setDefault(cameraGroup);
 251
 252     DisplaySettings * displaySettings = DisplaySettings::instance();
 253     fgTie("/sim/rendering/osg-displaysettings/eye-separation", displaySettings, &DisplaySettings::getEyeSeparation, &DisplaySettings::setEyeSeparation );
 254     fgTie("/sim/rendering/osg-displaysettings/screen-distance", displaySettings, &DisplaySettings::getScreenDistance, &DisplaySettings::setScreenDistance );
 255     fgTie("/sim/rendering/osg-displaysettings/screen-width", displaySettings, &DisplaySettings::getScreenWidth, &DisplaySettings::setScreenWidth );
 256     fgTie("/sim/rendering/osg-displaysettings/screen-height", displaySettings, &DisplaySettings::getScreenHeight, &DisplaySettings::setScreenHeight );
 257     fgTie("/sim/rendering/osg-displaysettings/stereo-mode", getStereoMode, setStereoMode );
 258     fgTie("/sim/rendering/osg-displaysettings/double-buffer", displaySettings, &DisplaySettings::getDoubleBuffer, &DisplaySettings::setDoubleBuffer );
 259     fgTie("/sim/rendering/osg-displaysettings/depth-buffer", displaySettings, &DisplaySettings::getDepthBuffer, &DisplaySettings::setDepthBuffer );
 260     fgTie("/sim/rendering/osg-displaysettings/rgb", displaySettings, &DisplaySettings::getRGB, &DisplaySettings::setRGB );
 261 }
 262
 263
 264 static int status = 0;
 265
 266 void fgOSExit(int code)
 267 {
 268     viewer->setDone(true);
 269     viewer->getDatabasePager()->cancel();
 270     status = code;
 271 }
 272
 273 int fgOSMainLoop()
 274 {
 275     ref_ptr<FGEventHandler> manipulator
 276         = globals->get_renderer()->getEventHandler();
 277     viewer->setReleaseContextAtEndOfFrameHint(false);
 278     if (!viewer->isRealized())
 279         viewer->realize();
 280     while (!viewer->done()) {
 281         fgIdleHandler idleFunc = manipulator->getIdleHandler();
 282         fgDrawHandler drawFunc = manipulator->getDrawHandler();
 283         if (idleFunc)
 284             (*idleFunc)();
 285         if (drawFunc)
 286             (*drawFunc)();
 287         viewer->frame();
 288     }
 289
 290     return status;
 291 }
 292
 293 int fgGetKeyModifiers()
 294 {
 295     if (!globals->get_renderer()) { // happens during shutdown
 296       return 0;
 297     }
 298
 299     return globals->get_renderer()->getEventHandler()->getCurrentModifiers();
 300 }
 301
 302 void fgWarpMouse(int x, int y)
 303 {
 304     warpGUIPointer(CameraGroup::getDefault(), x, y);
 305 }
 306
 307 void fgOSInit(int* argc, char** argv)
 308 {
 309     WindowSystemAdapter::setWSA(new WindowSystemAdapter);
 310 }
 311
 312 // Noop
 313 void fgOSFullScreen()
 314 {
 315 }
 316
 317 static void setMouseCursor(osg::Camera* camera, int cursor)
 318 {
 319     if (!camera)
 320         return;
 321     osg::GraphicsContext* gc = camera->getGraphicsContext();
 322     if (!gc)
 323         return;
 324     osgViewer::GraphicsWindow* gw;
 325     gw = dynamic_cast<osgViewer::GraphicsWindow*>(gc);
 326     if (!gw)
 327         return;
 328
 329     osgViewer::GraphicsWindow::MouseCursor mouseCursor;
 330     mouseCursor = osgViewer::GraphicsWindow::InheritCursor;
 331     if     (cursor == MOUSE_CURSOR_NONE)
 332         mouseCursor = osgViewer::GraphicsWindow::NoCursor;
 333     else if(cursor == MOUSE_CURSOR_POINTER)
 334         mouseCursor = osgViewer::GraphicsWindow::RightArrowCursor;
 335     else if(cursor == MOUSE_CURSOR_WAIT)
 336         mouseCursor = osgViewer::GraphicsWindow::WaitCursor;
 337     else if(cursor == MOUSE_CURSOR_CROSSHAIR)
 338         mouseCursor = osgViewer::GraphicsWindow::CrosshairCursor;
 339     else if(cursor == MOUSE_CURSOR_LEFTRIGHT)
 340         mouseCursor = osgViewer::GraphicsWindow::LeftRightCursor;
 341     else if(cursor == MOUSE_CURSOR_TOPSIDE)
 342         mouseCursor = osgViewer::GraphicsWindow::TopSideCursor;
 343     else if(cursor == MOUSE_CURSOR_BOTTOMSIDE)
 344         mouseCursor = osgViewer::GraphicsWindow::BottomSideCursor;
 345     else if(cursor == MOUSE_CURSOR_LEFTSIDE)
 346         mouseCursor = osgViewer::GraphicsWindow::LeftSideCursor;
 347     else if(cursor == MOUSE_CURSOR_RIGHTSIDE)
 348         mouseCursor = osgViewer::GraphicsWindow::RightSideCursor;
 349     else if(cursor == MOUSE_CURSOR_TOPLEFT)
 350         mouseCursor = osgViewer::GraphicsWindow::TopLeftCorner;
 351     else if(cursor == MOUSE_CURSOR_TOPRIGHT)
 352         mouseCursor = osgViewer::GraphicsWindow::TopRightCorner;
 353     else if(cursor == MOUSE_CURSOR_BOTTOMLEFT)
 354         mouseCursor = osgViewer::GraphicsWindow::BottomLeftCorner;
 355     else if(cursor == MOUSE_CURSOR_BOTTOMRIGHT)
 356         mouseCursor = osgViewer::GraphicsWindow::BottomRightCorner;
 357
 358     gw->setCursor(mouseCursor);
 359 }
 360
 361 static int _cursor = -1;
 362
 363 void fgSetMouseCursor(int cursor)
 364 {
 365     _cursor = cursor;
 366     setMouseCursor(viewer->getCamera(), cursor);
 367     for (unsigned i = 0; i < viewer->getNumSlaves(); ++i)
 368         setMouseCursor(viewer->getSlave(i)._camera.get(), cursor);
 369 }
 370
 371 int fgGetMouseCursor()
 372 {
 373     return _cursor;
 374 }