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.
32 #include <boost/foreach.hpp>
34 #include <simgear/compiler.h>
35 #include <simgear/structure/exception.hxx>
36 #include <simgear/debug/logstream.hxx>
37 #include <simgear/props/props_io.hxx>
40 #include <osg/GraphicsContext>
42 #include <osg/Matrixd>
43 #include <osg/Viewport>
44 #include <osg/Version>
46 #include <osgViewer/ViewerEventHandlers>
47 #include <osgViewer/Viewer>
49 #include <Scenery/scenery.hxx>
51 #include "fg_props.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"
60 // Static linking of OSG needs special macros
61 #ifdef OSG_LIBRARY_STATIC
62 #include <osgDB/Registry>
72 #ifdef OSG_JPEG_ENABLED
75 #ifdef OSG_PNG_ENABLED
78 #ifdef OSG_TIFF_ENABLED
89 // fg_os implementation using OpenSceneGraph's osgViewer::Viewer class
90 // to create the graphics window and run the event/update/render loop.
93 // fg_os implementation
97 using namespace flightgear;
100 static osg::ref_ptr<osgViewer::Viewer> viewer;
101 static osg::ref_ptr<osg::Camera> mainCamera;
103 static void setStereoMode( const char * mode )
105 DisplaySettings::StereoMode stereoMode = DisplaySettings::QUAD_BUFFER;
106 bool stereoOn = true;
108 if (strcmp(mode,"QUAD_BUFFER")==0)
110 stereoMode = DisplaySettings::QUAD_BUFFER;
112 else if (strcmp(mode,"ANAGLYPHIC")==0)
114 stereoMode = DisplaySettings::ANAGLYPHIC;
116 else if (strcmp(mode,"HORIZONTAL_SPLIT")==0)
118 stereoMode = DisplaySettings::HORIZONTAL_SPLIT;
120 else if (strcmp(mode,"VERTICAL_SPLIT")==0)
122 stereoMode = DisplaySettings::VERTICAL_SPLIT;
124 else if (strcmp(mode,"LEFT_EYE")==0)
126 stereoMode = DisplaySettings::LEFT_EYE;
128 else if (strcmp(mode,"RIGHT_EYE")==0)
130 stereoMode = DisplaySettings::RIGHT_EYE;
132 else if (strcmp(mode,"HORIZONTAL_INTERLACE")==0)
134 stereoMode = DisplaySettings::HORIZONTAL_INTERLACE;
136 else if (strcmp(mode,"VERTICAL_INTERLACE")==0)
138 stereoMode = DisplaySettings::VERTICAL_INTERLACE;
140 else if (strcmp(mode,"CHECKERBOARD")==0)
142 stereoMode = DisplaySettings::CHECKERBOARD;
146 DisplaySettings::instance()->setStereo( stereoOn );
147 DisplaySettings::instance()->setStereoMode( stereoMode );
150 static const char * getStereoMode()
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 ) {
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 ) {
165 } else if( stereoMode == DisplaySettings::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";
177 void fgOSOpenWindow(bool stencil)
179 viewer = new osgViewer::Viewer;
180 viewer->setDatabasePager(FGScenery::getPagerSingleton());
181 CameraGroup* cameraGroup = 0;
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);
193 viewer->setThreadingModel(osgViewer::Viewer::SingleThreaded);
194 WindowBuilder::initWindowBuilder(stencil);
195 WindowBuilder *windowBuilder = WindowBuilder::getWindowBuilder();
197 // Look for windows, camera groups, and the old syntax of
199 SGPropertyNode* renderingNode = fgGetNode("/sim/rendering");
200 SGPropertyNode* cgroupNode = renderingNode->getNode("camera-group", true);
201 bool oldSyntax = !cgroupNode->hasChild("camera");
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);
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();
222 masterCamera = cgroupNode->getChild("camera", cameras.size(), true);
223 setValue(masterCamera->getNode("window/name", true),
224 windowBuilder->getDefaultWindowName());
226 SGPropertyNode* nameNode = masterCamera->getNode("window/name");
228 setValue(cgroupNode->getNode("gui/window/name", true),
229 nameNode->getStringValue());
231 cameraGroup = CameraGroup::buildCameraGroup(viewer.get(), cgroupNode);
232 Camera* guiCamera = getGUICamera(cameraGroup);
234 Viewport* guiViewport = guiCamera->getViewport();
235 fgSetInt("/sim/startup/xsize", guiViewport->width());
236 fgSetInt("/sim/startup/ysize", guiViewport->height());
238 FGEventHandler* manipulator = globals->get_renderer()->getEventHandler();
239 WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
240 if (wsa->windows.size() != 1) {
241 manipulator->setResizable(false);
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);
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 );
264 static int status = 0;
266 void fgOSExit(int code)
268 viewer->setDone(true);
269 viewer->getDatabasePager()->cancel();
275 ref_ptr<FGEventHandler> manipulator
276 = globals->get_renderer()->getEventHandler();
277 viewer->setReleaseContextAtEndOfFrameHint(false);
278 if (!viewer->isRealized())
280 while (!viewer->done()) {
281 fgIdleHandler idleFunc = manipulator->getIdleHandler();
282 fgDrawHandler drawFunc = manipulator->getDrawHandler();
293 int fgGetKeyModifiers()
295 if (!globals->get_renderer()) { // happens during shutdown
299 return globals->get_renderer()->getEventHandler()->getCurrentModifiers();
302 void fgWarpMouse(int x, int y)
304 warpGUIPointer(CameraGroup::getDefault(), x, y);
307 void fgOSInit(int* argc, char** argv)
309 globals->get_renderer()->init();
310 WindowSystemAdapter::setWSA(new WindowSystemAdapter);
314 void fgOSFullScreen()
318 static void setMouseCursor(osg::Camera* camera, int cursor)
322 osg::GraphicsContext* gc = camera->getGraphicsContext();
325 osgViewer::GraphicsWindow* gw;
326 gw = dynamic_cast<osgViewer::GraphicsWindow*>(gc);
330 osgViewer::GraphicsWindow::MouseCursor mouseCursor;
331 mouseCursor = osgViewer::GraphicsWindow::InheritCursor;
332 if (cursor == MOUSE_CURSOR_NONE)
333 mouseCursor = osgViewer::GraphicsWindow::NoCursor;
334 else if(cursor == MOUSE_CURSOR_POINTER)
335 mouseCursor = osgViewer::GraphicsWindow::RightArrowCursor;
336 else if(cursor == MOUSE_CURSOR_WAIT)
337 mouseCursor = osgViewer::GraphicsWindow::WaitCursor;
338 else if(cursor == MOUSE_CURSOR_CROSSHAIR)
339 mouseCursor = osgViewer::GraphicsWindow::CrosshairCursor;
340 else if(cursor == MOUSE_CURSOR_LEFTRIGHT)
341 mouseCursor = osgViewer::GraphicsWindow::LeftRightCursor;
342 else if(cursor == MOUSE_CURSOR_TOPSIDE)
343 mouseCursor = osgViewer::GraphicsWindow::TopSideCursor;
344 else if(cursor == MOUSE_CURSOR_BOTTOMSIDE)
345 mouseCursor = osgViewer::GraphicsWindow::BottomSideCursor;
346 else if(cursor == MOUSE_CURSOR_LEFTSIDE)
347 mouseCursor = osgViewer::GraphicsWindow::LeftSideCursor;
348 else if(cursor == MOUSE_CURSOR_RIGHTSIDE)
349 mouseCursor = osgViewer::GraphicsWindow::RightSideCursor;
350 else if(cursor == MOUSE_CURSOR_TOPLEFT)
351 mouseCursor = osgViewer::GraphicsWindow::TopLeftCorner;
352 else if(cursor == MOUSE_CURSOR_TOPRIGHT)
353 mouseCursor = osgViewer::GraphicsWindow::TopRightCorner;
354 else if(cursor == MOUSE_CURSOR_BOTTOMLEFT)
355 mouseCursor = osgViewer::GraphicsWindow::BottomLeftCorner;
356 else if(cursor == MOUSE_CURSOR_BOTTOMRIGHT)
357 mouseCursor = osgViewer::GraphicsWindow::BottomRightCorner;
359 gw->setCursor(mouseCursor);
362 static int _cursor = -1;
364 void fgSetMouseCursor(int cursor)
367 setMouseCursor(viewer->getCamera(), cursor);
368 for (unsigned i = 0; i < viewer->getNumSlaves(); ++i)
369 setMouseCursor(viewer->getSlave(i)._camera.get(), cursor);
372 int fgGetMouseCursor()