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 #include <osgGA/MatrixManipulator>
  49
  50 #include <Include/general.hxx>
  51 #include <Scenery/scenery.hxx>
  52 #include "fg_os.hxx"
  53 #include "fg_props.hxx"
  54 #include "util.hxx"
  55 #include "globals.hxx"
  56 #include "renderer.hxx"
  57 #include "CameraGroup.hxx"
  58 #include "FGEventHandler.hxx"
  59 #include "WindowBuilder.hxx"
  60 #include "WindowSystemAdapter.hxx"
  61
  62 #if (FG_OSG_VERSION >= 19008)
  63 #define OSG_HAS_MOUSE_CURSOR_PATCH
  64 #endif
  65
  66 // fg_os implementation using OpenSceneGraph's osgViewer::Viewer class
  67 // to create the graphics window and run the event/update/render loop.
  68
  69 //
  70 // fg_os implementation
  71 //
  72
  73 using namespace std;
  74 using namespace flightgear;
  75 using namespace osg;
  76
  77 static osg::ref_ptr<osgViewer::Viewer> viewer;
  78 static osg::ref_ptr<osg::Camera> mainCamera;
  79
  80 void fgOSOpenWindow(bool stencil)
  81 {
  82     viewer = new osgViewer::Viewer;
  83     viewer->setDatabasePager(FGScenery::getPagerSingleton());
  84     CameraGroup* cameraGroup = 0;
  85     std::string mode;
  86     mode = fgGetString("/sim/rendering/multithreading-mode", "SingleThreaded");
  87     if (mode == "AutomaticSelection")
  88       viewer->setThreadingModel(osgViewer::Viewer::AutomaticSelection);
  89     else if (mode == "CullDrawThreadPerContext")
  90       viewer->setThreadingModel(osgViewer::Viewer::CullDrawThreadPerContext);
  91     else if (mode == "DrawThreadPerContext")
  92       viewer->setThreadingModel(osgViewer::Viewer::DrawThreadPerContext);
  93     else if (mode == "CullThreadPerCameraDrawThreadPerContext")
  94       viewer->setThreadingModel(osgViewer::Viewer::CullThreadPerCameraDrawThreadPerContext);
  95     else
  96       viewer->setThreadingModel(osgViewer::Viewer::SingleThreaded);
  97     WindowBuilder::initWindowBuilder(stencil);
  98     WindowBuilder *windowBuilder = WindowBuilder::getWindowBuilder();
  99
 100     // Look for windows, camera groups, and the old syntax of
 101     // top-level cameras
 102     SGPropertyNode* renderingNode = fgGetNode("/sim/rendering");
 103     SGPropertyNode* cgroupNode = renderingNode->getNode("camera-group", true);
 104     bool oldSyntax = !cgroupNode->hasChild("camera");
 105     if (oldSyntax) {
 106         for (int i = 0; i < renderingNode->nChildren(); ++i) {
 107             SGPropertyNode* propNode = renderingNode->getChild(i);
 108             const char* propName = propNode->getName();
 109             if (!strcmp(propName, "window") || !strcmp(propName, "camera")) {
 110                 SGPropertyNode* copiedNode
 111                     = cgroupNode->getNode(propName, propNode->getIndex(), true);
 112                 copyProperties(propNode, copiedNode);
 113             }
 114         }
 115         vector<SGPropertyNode_ptr> cameras = cgroupNode->getChildren("camera");
 116         SGPropertyNode* masterCamera = 0;
 117         BOOST_FOREACH(SGPropertyNode_ptr& camera, cameras) {
 118             if (camera->getDoubleValue("shear-x", 0.0) == 0.0
 119                 && camera->getDoubleValue("shear-y", 0.0) == 0.0) {
 120                 masterCamera = camera.ptr();
 121                 break;
 122             }
 123         }
 124         if (!masterCamera) {
 125             masterCamera = cgroupNode->getChild("camera", cameras.size(), true);
 126             setValue(masterCamera->getNode("window/name", true),
 127                      windowBuilder->getDefaultWindowName());
 128         }
 129         SGPropertyNode* nameNode = masterCamera->getNode("window/name");
 130         if (nameNode)
 131             setValue(cgroupNode->getNode("gui/window/name", true),
 132                      nameNode->getStringValue());
 133     }
 134     cameraGroup = CameraGroup::buildCameraGroup(viewer.get(), cgroupNode);
 135     Camera* guiCamera = getGUICamera(cameraGroup);
 136     if (guiCamera) {
 137         Viewport* guiViewport = guiCamera->getViewport();
 138         fgSetInt("/sim/startup/xsize", guiViewport->width());
 139         fgSetInt("/sim/startup/ysize", guiViewport->height());
 140     }
 141     FGEventHandler* manipulator = globals->get_renderer()->getEventHandler();
 142     WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
 143     if (wsa->windows.size() != 1) {
 144         manipulator->setResizable(false);
 145     }
 146     viewer->getCamera()->setProjectionResizePolicy(osg::Camera::FIXED);
 147     viewer->addEventHandler(manipulator);
 148     // Let FG handle the escape key with a confirmation
 149     viewer->setKeyEventSetsDone(0);
 150     // The viewer won't start without some root.
 151     viewer->setSceneData(new osg::Group);
 152     globals->get_renderer()->setViewer(viewer.get());
 153     CameraGroup::setDefault(cameraGroup);
 154 }
 155
 156 static int status = 0;
 157
 158 void fgOSExit(int code)
 159 {
 160     viewer->setDone(true);
 161     viewer->getDatabasePager()->cancel();
 162     status = code;
 163 }
 164
 165 void fgOSMainLoop()
 166 {
 167     ref_ptr<FGEventHandler> manipulator
 168         = globals->get_renderer()->getEventHandler();
 169     viewer->setReleaseContextAtEndOfFrameHint(false);
 170     if (!viewer->isRealized())
 171         viewer->realize();
 172     while (!viewer->done()) {
 173         fgIdleHandler idleFunc = manipulator->getIdleHandler();
 174         fgDrawHandler drawFunc = manipulator->getDrawHandler();
 175         if (idleFunc)
 176             (*idleFunc)();
 177         if (drawFunc)
 178             (*drawFunc)();
 179         viewer->frame();
 180     }
 181     fgExit(status);
 182 }
 183
 184 int fgGetKeyModifiers()
 185 {
 186     return globals->get_renderer()->getEventHandler()->getCurrentModifiers();
 187 }
 188
 189 void fgWarpMouse(int x, int y)
 190 {
 191     warpGUIPointer(CameraGroup::getDefault(), x, y);
 192 }
 193
 194 void fgOSInit(int* argc, char** argv)
 195 {
 196     WindowSystemAdapter::setWSA(new WindowSystemAdapter);
 197 }
 198
 199 // Noop
 200 void fgOSFullScreen()
 201 {
 202 }
 203
 204 #ifdef OSG_HAS_MOUSE_CURSOR_PATCH
 205 static void setMouseCursor(osg::Camera* camera, int cursor)
 206 {
 207     if (!camera)
 208         return;
 209     osg::GraphicsContext* gc = camera->getGraphicsContext();
 210     if (!gc)
 211         return;
 212     osgViewer::GraphicsWindow* gw;
 213     gw = dynamic_cast<osgViewer::GraphicsWindow*>(gc);
 214     if (!gw)
 215         return;
 216
 217     osgViewer::GraphicsWindow::MouseCursor mouseCursor;
 218     mouseCursor = osgViewer::GraphicsWindow::InheritCursor;
 219     if     (cursor == MOUSE_CURSOR_NONE)
 220         mouseCursor = osgViewer::GraphicsWindow::NoCursor;
 221     else if(cursor == MOUSE_CURSOR_POINTER)
 222         mouseCursor = osgViewer::GraphicsWindow::RightArrowCursor;
 223     else if(cursor == MOUSE_CURSOR_WAIT)
 224         mouseCursor = osgViewer::GraphicsWindow::WaitCursor;
 225     else if(cursor == MOUSE_CURSOR_CROSSHAIR)
 226         mouseCursor = osgViewer::GraphicsWindow::CrosshairCursor;
 227     else if(cursor == MOUSE_CURSOR_LEFTRIGHT)
 228         mouseCursor = osgViewer::GraphicsWindow::LeftRightCursor;
 229     else if(cursor == MOUSE_CURSOR_TOPSIDE)
 230         mouseCursor = osgViewer::GraphicsWindow::TopSideCursor;
 231     else if(cursor == MOUSE_CURSOR_BOTTOMSIDE)
 232         mouseCursor = osgViewer::GraphicsWindow::BottomSideCursor;
 233     else if(cursor == MOUSE_CURSOR_LEFTSIDE)
 234         mouseCursor = osgViewer::GraphicsWindow::LeftSideCursor;
 235     else if(cursor == MOUSE_CURSOR_RIGHTSIDE)
 236         mouseCursor = osgViewer::GraphicsWindow::RightSideCursor;
 237     else if(cursor == MOUSE_CURSOR_TOPLEFT)
 238         mouseCursor = osgViewer::GraphicsWindow::TopLeftCorner;
 239     else if(cursor == MOUSE_CURSOR_TOPRIGHT)
 240         mouseCursor = osgViewer::GraphicsWindow::TopRightCorner;
 241     else if(cursor == MOUSE_CURSOR_BOTTOMLEFT)
 242         mouseCursor = osgViewer::GraphicsWindow::BottomLeftCorner;
 243     else if(cursor == MOUSE_CURSOR_BOTTOMRIGHT)
 244         mouseCursor = osgViewer::GraphicsWindow::BottomRightCorner;
 245
 246     gw->setCursor(mouseCursor);
 247 }
 248 #endif
 249
 250 static int _cursor = -1;
 251
 252 void fgSetMouseCursor(int cursor)
 253 {
 254     _cursor = cursor;
 255 #ifdef OSG_HAS_MOUSE_CURSOR_PATCH
 256     setMouseCursor(viewer->getCamera(), cursor);
 257     for (unsigned i = 0; i < viewer->getNumSlaves(); ++i)
 258         setMouseCursor(viewer->getSlave(i)._camera.get(), cursor);
 259 #endif
 260 }
 261
 262 int fgGetMouseCursor()
 263 {
 264     return _cursor;
 265 }