1 /**************************************************************************
4 * Based on gui.cxx and renamed on 2002/08/13 by Erik Hofman.
6 * Written 1998 by Durk Talsma, started Juni, 1998. For the flight gear
9 * Additional mouse supported added by David Megginson, 1999.
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation; either version 2 of the
14 * License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 **************************************************************************/
33 #include <simgear/compiler.h>
42 #include <simgear/debug/logstream.hxx>
43 #include <simgear/misc/sg_path.hxx>
44 #include <simgear/screen/screen-dump.hxx>
45 #include <simgear/structure/event_mgr.hxx>
46 #include <simgear/props/props_io.hxx>
48 #include <Cockpit/panel.hxx>
49 #include <Main/globals.hxx>
50 #include <Main/fg_props.hxx>
51 #include <Main/fg_os.hxx>
52 #include <Viewer/renderer.hxx>
53 #include <Viewer/viewmgr.hxx>
54 #include <Viewer/WindowSystemAdapter.hxx>
55 #include <Viewer/CameraGroup.hxx>
56 #include <GUI/new_gui.hxx>
60 # include <shellapi.h>
64 # include "FGCocoaMenuBar.hxx" // for cocoaOpenUrl
72 #if defined( TR_HIRES_SNAP)
73 #include <simgear/screen/tr.h>
74 extern void fgUpdateHUD( GLfloat x_start, GLfloat y_start,
75 GLfloat x_end, GLfloat y_end );
79 const __fg_gui_fn_t __fg_gui_fn[] = {
81 {"dumpHiResSnapShot", fgHiResDumpWrapper},
83 {"dumpSnapShot", fgDumpSnapShotWrapper},
87 // Structure termination
92 /* ================ General Purpose Functions ================ */
94 // General Purpose Message Box. Makes sure no more than 5 different
95 // messages are displayed at the same time, and none of them are
96 // duplicates. (5 is a *lot*, but this will hardly ever be reached
97 // and we don't want to miss any, either.)
98 void mkDialog (const char *txt)
100 NewGUI *gui = (NewGUI *)globals->get_subsystem("gui");
103 SGPropertyNode *master = gui->getDialogProperties("message");
107 const int maxdialogs = 5;
109 SGPropertyNode *msg = fgGetNode("/sim/gui/dialogs", true);
111 for (i = 0; i < maxdialogs; i++) {
112 std::ostringstream s;
113 s << "message-" << i;
116 if (!msg->getNode(name.c_str(), false))
119 if (!strcmp(txt, msg->getNode(name.c_str())->getStringValue("message"))) {
120 SG_LOG(SG_GENERAL, SG_WARN, "mkDialog(): duplicate of message " << txt);
126 msg = msg->getNode(name.c_str(), true);
127 msg->setStringValue("message", txt);
128 msg = msg->getNode("dialog", true);
129 copyProperties(master, msg);
130 msg->setStringValue("name", name.c_str());
132 gui->showDialog(name.c_str());
135 // Message Box to report an error.
136 void guiErrorMessage (const char *txt)
138 SG_LOG(SG_GENERAL, SG_ALERT, txt);
142 // Message Box to report a throwable (usually an exception).
143 void guiErrorMessage (const char *txt, const sg_throwable &throwable)
147 msg += throwable.getFormattedMessage();
148 if (!std::strlen(throwable.getOrigin()) != 0) {
149 msg += "\n (reported by ";
150 msg += throwable.getOrigin();
153 SG_LOG(SG_GENERAL, SG_ALERT, msg);
154 mkDialog(msg.c_str());
159 /* -----------------------------------------------------------------------
160 the Gui callback functions
161 ____________________________________________________________________*/
165 openBrowser( "Docs/index.html" );
168 bool openBrowser(const std::string& aAddress)
171 string address(aAddress);
173 // do not resolve addresses with given protocol, i.e. "http://...", "ftp://..."
174 if (address.find("://")==string::npos)
176 // resolve local file path
177 SGPath path(address);
178 path = globals->resolve_maybe_aircraft_path(address);
180 address = path.str();
183 mkDialog ("Sorry, file not found!");
184 SG_LOG(SG_GENERAL, SG_ALERT, "openBrowser: Cannot find requested file '"
191 if (address.find("://")==string::npos) {
192 address = "file://" + address;
195 cocoaOpenUrl(address);
198 // Look for favorite browser
199 char win32_name[1024];
201 cygwin32_conv_to_full_win32_path(address.c_str(),win32_name);
203 strncpy(win32_name,address.c_str(), 1024);
205 ShellExecute ( NULL, "open", win32_name, NULL, NULL,
208 // Linux, BSD, SGI etc
209 string command = globals->get_browser();
210 string::size_type pos;
211 if ((pos = command.find("%u", 0)) != string::npos)
212 command.replace(pos, 2, address);
214 command += " \"" + address +"\"";
217 ok = (system( command.c_str() ) == 0);
220 mkDialog("The file is shown in your web browser window.");
224 #if defined( TR_HIRES_SNAP)
229 bool menu_status = fgGetBool("/sim/menubar/visibility");
230 char *filename = new char [24];
231 static int count = 1;
233 static const SGPropertyNode *master_freeze
234 = fgGetNode("/sim/freeze/master");
236 bool freeze = master_freeze->getBoolValue();
238 fgSetBool("/sim/freeze/master", true);
241 fgSetBool("/sim/menubar/visibility", false);
242 int mouse = fgGetMouseCursor();
243 fgSetMouseCursor(MOUSE_CURSOR_NONE);
245 FGRenderer *renderer = globals->get_renderer();
247 renderer->resize( fgGetInt("/sim/startup/xsize"),
248 fgGetInt("/sim/startup/ysize") );
250 // we need two render frames here to clear the menu and cursor
251 // ... not sure why but doing an extra fgRenderFrame() shouldn't
253 //renderer->update( true );
254 //renderer->update( true );
256 // This ImageSize stuff is a temporary hack
257 // should probably use 128x128 tile size and
258 // support any image size
260 // This should be a requester to get multiplier from user
261 int multiplier = fgGetInt("/sim/startup/hires-multiplier", 3);
262 int width = fgGetInt("/sim/startup/xsize");
263 int height = fgGetInt("/sim/startup/ysize");
265 /* allocate buffer large enough to store one tile */
266 GLubyte *tile = (GLubyte *)malloc(width * height * 3 * sizeof(GLubyte));
269 printf("Malloc of tile buffer failed!\n");
273 int imageWidth = multiplier*width;
274 int imageHeight = multiplier*height;
276 /* allocate buffer to hold a row of tiles */
278 = (GLubyte *)malloc(imageWidth * height * 3 * sizeof(GLubyte));
282 printf("Malloc of tile row buffer failed!\n");
285 TRcontext *tr = trNew();
286 trTileSize(tr, width, height, 0);
287 trTileBuffer(tr, GL_RGB, GL_UNSIGNED_BYTE, tile);
288 trImageSize(tr, imageWidth, imageHeight);
289 trRowOrder(tr, TR_TOP_TO_BOTTOM);
291 // sgFrustum *frustum = ssgGetFrustum();
293 // frustum->getLeft(), frustum->getRight(),
294 // frustum->getBot(), frustum->getTop(),
295 // frustum->getNear(), frustum->getFar());
297 /* Prepare ppm output file */
298 while (count < 1000) {
299 snprintf(filename, 24, "fgfs-screen-%03d.ppm", count++);
300 if ( (f = fopen(filename, "r")) == NULL )
304 f = fopen(filename, "wb");
306 printf("Couldn't open image file: %s\n", filename);
313 fprintf(f,"# ppm-file created by %s\n", "trdemo2");
314 fprintf(f,"%i %i\n", imageWidth, imageHeight);
317 /* just to be safe... */
318 glPixelStorei(GL_PACK_ALIGNMENT, 1);
322 /* Because the HUD and Panel change the ViewPort we will
323 * need to handle some lowlevel stuff ourselves */
324 int ncols = trGet(tr, TR_COLUMNS);
325 int nrows = trGet(tr, TR_ROWS);
327 bool do_hud = fgGetBool("/sim/hud/visibility");
328 GLfloat hud_col_step = 640.0 / ncols;
329 GLfloat hud_row_step = 480.0 / nrows;
331 bool do_panel = fgPanelVisible();
332 GLfloat panel_col_step = globals->get_current_panel()->getWidth() / ncols;
333 GLfloat panel_row_step = globals->get_current_panel()->getHeight() / nrows;
335 glHint(GL_PERSPECTIVE_CORRECTION_HINT, GL_NICEST);
336 glHint(GL_POLYGON_SMOOTH_HINT, GL_NICEST);
337 glHint(GL_LINE_SMOOTH_HINT, GL_NICEST);
338 glHint(GL_POINT_SMOOTH_HINT, GL_NICEST);
339 glHint(GL_FOG_HINT, GL_NICEST);
345 int curColumn = trGet(tr, TR_CURRENT_COLUMN);
346 // int curRow = trGet(tr, TR_CURRENT_ROW);
351 // fgUpdateHUD( curColumn*hud_col_step, curRow*hud_row_step,
352 // (curColumn+1)*hud_col_step, (curRow+1)*hud_row_step );
355 // globals->get_current_panel()->update(
356 // curColumn*panel_col_step, panel_col_step,
357 // curRow*panel_row_step, panel_row_step );
358 more = trEndTile(tr);
360 /* save tile into tile row buffer*/
361 int curTileWidth = trGet(tr, TR_CURRENT_TILE_WIDTH);
362 int bytesPerImageRow = imageWidth * 3*sizeof(GLubyte);
363 int bytesPerTileRow = (width) * 3*sizeof(GLubyte);
364 int xOffset = curColumn * bytesPerTileRow;
365 int bytesPerCurrentTileRow = (curTileWidth) * 3*sizeof(GLubyte);
367 for (i=0;i<height;i++) {
368 memcpy(buffer + i*bytesPerImageRow + xOffset, /* Dest */
369 tile + i*bytesPerTileRow, /* Src */
370 bytesPerCurrentTileRow); /* Byte count*/
373 if (curColumn == trGet(tr, TR_COLUMNS)-1) {
374 /* write this buffered row of tiles to the file */
375 int curTileHeight = trGet(tr, TR_CURRENT_TILE_HEIGHT);
376 int bytesPerImageRow = imageWidth * 3*sizeof(GLubyte);
378 for (i=0;i<curTileHeight;i++) {
379 /* Remember, OpenGL images are bottom to top. Have to reverse. */
380 GLubyte *rowPtr = buffer + (curTileHeight-1-i) * bytesPerImageRow;
381 fwrite(rowPtr, 1, imageWidth*3, f);
387 renderer->resize( width, height );
391 glHint(GL_POLYGON_SMOOTH_HINT, GL_DONT_CARE);
392 glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
393 glHint(GL_POINT_SMOOTH_HINT, GL_DONT_CARE);
394 glHint(GL_PERSPECTIVE_CORRECTION_HINT, GL_DONT_CARE);
395 if ( (!strcmp(fgGetString("/sim/rendering/fog"), "disabled")) ||
396 (!fgGetBool("/sim/rendering/shading"))) {
397 // if fastest fog requested, or if flat shading force fastest
398 glHint ( GL_FOG_HINT, GL_FASTEST );
399 } else if ( !strcmp(fgGetString("/sim/rendering/fog"), "nicest") ) {
400 glHint ( GL_FOG_HINT, GL_DONT_CARE );
405 message = "Snapshot saved to \"";
408 mkDialog (message.c_str());
415 fgSetMouseCursor(mouse);
416 fgSetBool("/sim/menubar/visibility", menu_status);
419 fgSetBool("/sim/freeze/master", false);
422 #endif // #if defined( TR_HIRES_SNAP)
424 void fgDumpSnapShotWrapper () {
429 void fgHiResDumpWrapper () {
435 using namespace flightgear;
437 class GUISnapShotOperation :
438 public GraphicsContextOperation
442 // start new snap shot
445 // allow only one snapshot at a time
446 if (_snapShotOp.valid())
448 _snapShotOp = new GUISnapShotOperation();
449 /* register with graphics context so actual snap shot is done
450 * in the graphics context (thread) */
451 osg::Camera* guiCamera = getGUICamera(CameraGroup::getDefault());
452 WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
453 osg::GraphicsContext* gc = 0;
455 gc = guiCamera->getGraphicsContext();
457 gc->add(_snapShotOp.get());
459 wsa->windows[0]->gc->add(_snapShotOp.get());
465 // constructor to be executed in main loop's thread
466 GUISnapShotOperation() :
467 flightgear::GraphicsContextOperation(std::string("GUI snap shot")),
468 _master_freeze(fgGetNode("/sim/freeze/master", true)),
469 _freeze(_master_freeze->getBoolValue()),
471 _mouse(fgGetMouseCursor())
474 _master_freeze->setBoolValue(true);
476 fgSetMouseCursor(MOUSE_CURSOR_NONE);
478 string dir = fgGetString("/sim/paths/screenshot-dir");
480 dir = fgGetString("/sim/fg-current");
482 _path.set(dir + '/');
483 if (_path.create_dir( 0755 )) {
484 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot create screenshot directory '"
485 << dir << "'. Trying home directory.");
486 dir = globals->get_fg_home();
490 static int count = 1;
491 while (count < 1000) {
492 snprintf(filename, 24, "fgfs-screen-%03d.png", count++);
502 _xsize = fgGetInt("/sim/startup/xsize");
503 _ysize = fgGetInt("/sim/startup/ysize");
505 FGRenderer *renderer = globals->get_renderer();
506 renderer->resize(_xsize, _ysize);
507 globals->get_event_mgr()->addTask("SnapShotTimer",
508 this, &GUISnapShotOperation::timerExpired,
512 // to be executed in graphics context (maybe separate thread)
513 void run(osg::GraphicsContext* gc)
515 _result = sg_glDumpWindow(_path.c_str(),
520 // timer method, to be executed in main loop's thread
521 virtual void timerExpired()
525 globals->get_event_mgr()->removeTask("SnapShotTimer");
527 fgSetString("/sim/paths/screenshot-last", _path.c_str());
528 fgSetBool("/sim/signals/screenshot", _result);
530 fgSetMouseCursor(_mouse);
533 _master_freeze->setBoolValue(false);
539 static osg::ref_ptr<GUISnapShotOperation> _snapShotOp;
540 SGPropertyNode_ptr _master_freeze;
550 osg::ref_ptr<GUISnapShotOperation> GUISnapShotOperation::_snapShotOp;
552 // do a screen snap shot
553 bool fgDumpSnapShot ()
556 // start snap shot operation, while needs to be executed in
558 return GUISnapShotOperation::start();
560 // obsolete code => remove when new code is stable
561 static SGConstPropertyNode_ptr master_freeze = fgGetNode("/sim/freeze/master");
563 bool freeze = master_freeze->getBoolValue();
565 fgSetBool("/sim/freeze/master", true);
568 int mouse = fgGetMouseCursor();
569 fgSetMouseCursor(MOUSE_CURSOR_NONE);
571 fgSetBool("/sim/signals/screenshot", true);
573 FGRenderer *renderer = globals->get_renderer();
574 renderer->resize( fgGetInt("/sim/startup/xsize"),
575 fgGetInt("/sim/startup/ysize") );
577 // we need two render frames here to clear the menu and cursor
578 // ... not sure why but doing an extra fgRenderFrame() shouldn't
580 renderer->update( true );
581 renderer->update( true );
583 string dir = fgGetString("/sim/paths/screenshot-dir");
585 dir = fgGetString("/sim/fg-current");
587 SGPath path(dir + '/');
588 if (path.create_dir( 0755 )) {
589 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot create screenshot directory '"
590 << dir << "'. Trying home directory.");
591 dir = globals->get_fg_home();
595 static int count = 1;
596 while (count < 1000) {
597 snprintf(filename, 24, "fgfs-screen-%03d.png", count++);
607 bool result = sg_glDumpWindow(path.c_str(),
608 fgGetInt("/sim/startup/xsize"),
609 fgGetInt("/sim/startup/ysize"));
611 fgSetString("/sim/paths/screenshot-last", path.c_str());
612 fgSetBool("/sim/signals/screenshot", false);
614 fgSetMouseCursor(mouse);
617 fgSetBool("/sim/freeze/master", false);
623 // do an entire scenegraph dump
624 void fgDumpSceneGraph()
626 char *filename = new char [24];
628 static int count = 1;
630 static const SGPropertyNode *master_freeze
631 = fgGetNode("/sim/freeze/master");
633 bool freeze = master_freeze->getBoolValue();
635 fgSetBool("/sim/freeze/master", true);
638 while (count < 1000) {
640 snprintf(filename, 24, "fgfs-graph-%03d.osg", count++);
641 if ( (fp = fopen(filename, "r")) == NULL )
646 if ( fgDumpSceneGraphToFile(filename)) {
647 message = "Entire scene graph saved to \"";
651 message = "Failed to save to \"";
656 mkDialog (message.c_str());
661 fgSetBool("/sim/freeze/master", false);
666 // do an terrain branch dump
667 void fgDumpTerrainBranch()
669 char *filename = new char [24];
671 static int count = 1;
673 static const SGPropertyNode *master_freeze
674 = fgGetNode("/sim/freeze/master");
676 bool freeze = master_freeze->getBoolValue();
678 fgSetBool("/sim/freeze/master", true);
681 while (count < 1000) {
683 snprintf(filename, 24, "fgfs-graph-%03d.osg", count++);
684 if ( (fp = fopen(filename, "r")) == NULL )
689 if ( fgDumpTerrainBranchToFile(filename)) {
690 message = "Terrain graph saved to \"";
694 message = "Failed to save to \"";
699 mkDialog (message.c_str());
704 fgSetBool("/sim/freeze/master", false);
708 void fgPrintVisibleSceneInfoCommand()
710 static const SGPropertyNode *master_freeze
711 = fgGetNode("/sim/freeze/master");
713 bool freeze = master_freeze->getBoolValue();
715 fgSetBool("/sim/freeze/master", true);
718 flightgear::printVisibleSceneInfo(globals->get_renderer());
721 fgSetBool("/sim/freeze/master", false);