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 **************************************************************************/
37 #include <simgear/compiler.h>
46 #include <simgear/debug/logstream.hxx>
47 #include <simgear/misc/sg_path.hxx>
48 #include <simgear/screen/screen-dump.hxx>
49 #include <simgear/structure/event_mgr.hxx>
50 #include <simgear/props/props_io.hxx>
52 #include <Cockpit/panel.hxx>
53 #include <Main/globals.hxx>
54 #include <Main/fg_props.hxx>
55 #include <Main/fg_os.hxx>
56 #include <Viewer/renderer.hxx>
57 #include <Viewer/viewmgr.hxx>
58 #include <Viewer/WindowSystemAdapter.hxx>
59 #include <Viewer/CameraGroup.hxx>
60 #include <GUI/new_gui.hxx>
64 # include <shellapi.h>
68 # include <GUI/CocoaHelpers.h> // for cocoaOpenUrl
76 #if defined( TR_HIRES_SNAP)
77 #include <simgear/screen/tr.h>
78 extern void fgUpdateHUD( GLfloat x_start, GLfloat y_start,
79 GLfloat x_end, GLfloat y_end );
83 const __fg_gui_fn_t __fg_gui_fn[] = {
85 {"dumpHiResSnapShot", fgHiResDumpWrapper},
87 {"dumpSnapShot", fgDumpSnapShotWrapper},
91 // Structure termination
96 /* ================ General Purpose Functions ================ */
98 // General Purpose Message Box. Makes sure no more than 5 different
99 // messages are displayed at the same time, and none of them are
100 // duplicates. (5 is a *lot*, but this will hardly ever be reached
101 // and we don't want to miss any, either.)
102 void mkDialog (const char *txt)
104 NewGUI *gui = (NewGUI *)globals->get_subsystem("gui");
107 SGPropertyNode *master = gui->getDialogProperties("message");
111 const int maxdialogs = 5;
113 SGPropertyNode *msg = fgGetNode("/sim/gui/dialogs", true);
115 for (i = 0; i < maxdialogs; i++) {
116 std::ostringstream s;
117 s << "message-" << i;
120 if (!msg->getNode(name.c_str(), false))
123 if (!strcmp(txt, msg->getNode(name.c_str())->getStringValue("message"))) {
124 SG_LOG(SG_GENERAL, SG_WARN, "mkDialog(): duplicate of message " << txt);
130 msg = msg->getNode(name.c_str(), true);
131 msg->setStringValue("message", txt);
132 msg = msg->getNode("dialog", true);
133 copyProperties(master, msg);
134 msg->setStringValue("name", name.c_str());
136 gui->showDialog(name.c_str());
139 // Message Box to report an error.
140 void guiErrorMessage (const char *txt)
142 SG_LOG(SG_GENERAL, SG_ALERT, txt);
146 // Message Box to report a throwable (usually an exception).
147 void guiErrorMessage (const char *txt, const sg_throwable &throwable)
151 msg += throwable.getFormattedMessage();
152 if (!std::strlen(throwable.getOrigin()) != 0) {
153 msg += "\n (reported by ";
154 msg += throwable.getOrigin();
157 SG_LOG(SG_GENERAL, SG_ALERT, msg);
158 mkDialog(msg.c_str());
163 /* -----------------------------------------------------------------------
164 the Gui callback functions
165 ____________________________________________________________________*/
169 openBrowser( "Docs/index.html" );
172 bool openBrowser(const std::string& aAddress)
175 string address(aAddress);
177 // do not resolve addresses with given protocol, i.e. "http://...", "ftp://..."
178 if (address.find("://")==string::npos)
180 // resolve local file path
181 SGPath path(address);
182 path = globals->resolve_maybe_aircraft_path(address);
184 address = path.str();
187 mkDialog ("Sorry, file not found!");
188 SG_LOG(SG_GENERAL, SG_ALERT, "openBrowser: Cannot find requested file '"
195 if (address.find("://")==string::npos) {
196 address = "file://" + address;
199 cocoaOpenUrl(address);
202 // Look for favorite browser
203 char win32_name[1024];
205 cygwin32_conv_to_full_win32_path(address.c_str(),win32_name);
207 strncpy(win32_name,address.c_str(), 1024);
209 ShellExecute ( NULL, "open", win32_name, NULL, NULL,
212 // Linux, BSD, SGI etc
213 string command = globals->get_browser();
214 string::size_type pos;
215 if ((pos = command.find("%u", 0)) != string::npos)
216 command.replace(pos, 2, address);
218 command += " \"" + address +"\"";
221 ok = (system( command.c_str() ) == 0);
224 mkDialog("The file is shown in your web browser window.");
228 #if defined( TR_HIRES_SNAP)
233 bool menu_status = fgGetBool("/sim/menubar/visibility");
234 char *filename = new char [24];
235 static int count = 1;
237 SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
239 bool freeze = master_freeze->getBoolValue();
241 master_freeze->setBoolValue(true);
244 fgSetBool("/sim/menubar/visibility", false);
245 int mouse = fgGetMouseCursor();
246 fgSetMouseCursor(MOUSE_CURSOR_NONE);
248 FGRenderer *renderer = globals->get_renderer();
250 renderer->resize( fgGetInt("/sim/startup/xsize"),
251 fgGetInt("/sim/startup/ysize") );
253 // we need two render frames here to clear the menu and cursor
254 // ... not sure why but doing an extra fgRenderFrame() shouldn't
256 //renderer->update( true );
257 //renderer->update( true );
259 // This ImageSize stuff is a temporary hack
260 // should probably use 128x128 tile size and
261 // support any image size
263 // This should be a requester to get multiplier from user
264 int multiplier = fgGetInt("/sim/startup/hires-multiplier", 3);
265 int width = fgGetInt("/sim/startup/xsize");
266 int height = fgGetInt("/sim/startup/ysize");
268 /* allocate buffer large enough to store one tile */
269 GLubyte *tile = (GLubyte *)malloc(width * height * 3 * sizeof(GLubyte));
272 printf("Malloc of tile buffer failed!\n");
276 int imageWidth = multiplier*width;
277 int imageHeight = multiplier*height;
279 /* allocate buffer to hold a row of tiles */
281 = (GLubyte *)malloc(imageWidth * height * 3 * sizeof(GLubyte));
285 printf("Malloc of tile row buffer failed!\n");
288 TRcontext *tr = trNew();
289 trTileSize(tr, width, height, 0);
290 trTileBuffer(tr, GL_RGB, GL_UNSIGNED_BYTE, tile);
291 trImageSize(tr, imageWidth, imageHeight);
292 trRowOrder(tr, TR_TOP_TO_BOTTOM);
294 // sgFrustum *frustum = ssgGetFrustum();
296 // frustum->getLeft(), frustum->getRight(),
297 // frustum->getBot(), frustum->getTop(),
298 // frustum->getNear(), frustum->getFar());
300 /* Prepare ppm output file */
301 while (count < 1000) {
302 snprintf(filename, 24, "fgfs-screen-%03d.ppm", count++);
303 if ( (f = fopen(filename, "r")) == NULL )
307 f = fopen(filename, "wb");
309 printf("Couldn't open image file: %s\n", filename);
316 fprintf(f,"# ppm-file created by %s\n", "trdemo2");
317 fprintf(f,"%i %i\n", imageWidth, imageHeight);
320 /* just to be safe... */
321 glPixelStorei(GL_PACK_ALIGNMENT, 1);
325 /* Because the HUD and Panel change the ViewPort we will
326 * need to handle some lowlevel stuff ourselves */
327 int ncols = trGet(tr, TR_COLUMNS);
328 int nrows = trGet(tr, TR_ROWS);
330 bool do_hud = fgGetBool("/sim/hud/visibility");
331 GLfloat hud_col_step = 640.0 / ncols;
332 GLfloat hud_row_step = 480.0 / nrows;
334 bool do_panel = fgPanelVisible();
335 GLfloat panel_col_step = globals->get_current_panel()->getWidth() / ncols;
336 GLfloat panel_row_step = globals->get_current_panel()->getHeight() / nrows;
338 glHint(GL_PERSPECTIVE_CORRECTION_HINT, GL_NICEST);
339 glHint(GL_POLYGON_SMOOTH_HINT, GL_NICEST);
340 glHint(GL_LINE_SMOOTH_HINT, GL_NICEST);
341 glHint(GL_POINT_SMOOTH_HINT, GL_NICEST);
342 glHint(GL_FOG_HINT, GL_NICEST);
348 int curColumn = trGet(tr, TR_CURRENT_COLUMN);
349 // int curRow = trGet(tr, TR_CURRENT_ROW);
354 // fgUpdateHUD( curColumn*hud_col_step, curRow*hud_row_step,
355 // (curColumn+1)*hud_col_step, (curRow+1)*hud_row_step );
358 // globals->get_current_panel()->update(
359 // curColumn*panel_col_step, panel_col_step,
360 // curRow*panel_row_step, panel_row_step );
361 more = trEndTile(tr);
363 /* save tile into tile row buffer*/
364 int curTileWidth = trGet(tr, TR_CURRENT_TILE_WIDTH);
365 int bytesPerImageRow = imageWidth * 3*sizeof(GLubyte);
366 int bytesPerTileRow = (width) * 3*sizeof(GLubyte);
367 int xOffset = curColumn * bytesPerTileRow;
368 int bytesPerCurrentTileRow = (curTileWidth) * 3*sizeof(GLubyte);
370 for (i=0;i<height;i++) {
371 memcpy(buffer + i*bytesPerImageRow + xOffset, /* Dest */
372 tile + i*bytesPerTileRow, /* Src */
373 bytesPerCurrentTileRow); /* Byte count*/
376 if (curColumn == trGet(tr, TR_COLUMNS)-1) {
377 /* write this buffered row of tiles to the file */
378 int curTileHeight = trGet(tr, TR_CURRENT_TILE_HEIGHT);
379 int bytesPerImageRow = imageWidth * 3*sizeof(GLubyte);
381 for (i=0;i<curTileHeight;i++) {
382 /* Remember, OpenGL images are bottom to top. Have to reverse. */
383 GLubyte *rowPtr = buffer + (curTileHeight-1-i) * bytesPerImageRow;
384 fwrite(rowPtr, 1, imageWidth*3, f);
390 renderer->resize( width, height );
394 glHint(GL_POLYGON_SMOOTH_HINT, GL_DONT_CARE);
395 glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
396 glHint(GL_POINT_SMOOTH_HINT, GL_DONT_CARE);
397 glHint(GL_PERSPECTIVE_CORRECTION_HINT, GL_DONT_CARE);
398 if ( (!strcmp(fgGetString("/sim/rendering/fog"), "disabled")) ||
399 (!fgGetBool("/sim/rendering/shading"))) {
400 // if fastest fog requested, or if flat shading force fastest
401 glHint ( GL_FOG_HINT, GL_FASTEST );
402 } else if ( !strcmp(fgGetString("/sim/rendering/fog"), "nicest") ) {
403 glHint ( GL_FOG_HINT, GL_DONT_CARE );
408 message = "Snapshot saved to \"";
411 mkDialog (message.c_str());
418 fgSetMouseCursor(mouse);
419 fgSetBool("/sim/menubar/visibility", menu_status);
422 master_freeze->setBoolValue(false);
425 #endif // #if defined( TR_HIRES_SNAP)
427 void fgDumpSnapShotWrapper () {
432 void fgHiResDumpWrapper () {
438 using namespace flightgear;
440 class GUISnapShotOperation :
441 public GraphicsContextOperation
445 // start new snap shot
448 // allow only one snapshot at a time
449 if (_snapShotOp.valid())
451 _snapShotOp = new GUISnapShotOperation();
452 /* register with graphics context so actual snap shot is done
453 * in the graphics context (thread) */
454 osg::Camera* guiCamera = getGUICamera(CameraGroup::getDefault());
455 WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
456 osg::GraphicsContext* gc = 0;
458 gc = guiCamera->getGraphicsContext();
460 gc->add(_snapShotOp.get());
462 wsa->windows[0]->gc->add(_snapShotOp.get());
468 // constructor to be executed in main loop's thread
469 GUISnapShotOperation() :
470 flightgear::GraphicsContextOperation(std::string("GUI snap shot")),
471 _master_freeze(fgGetNode("/sim/freeze/master", true)),
472 _freeze(_master_freeze->getBoolValue()),
474 _mouse(fgGetMouseCursor())
477 _master_freeze->setBoolValue(true);
479 fgSetMouseCursor(MOUSE_CURSOR_NONE);
481 string dir = fgGetString("/sim/paths/screenshot-dir");
483 dir = SGPath::desktop().str();
485 _path.set(dir + '/');
486 if (_path.create_dir( 0755 )) {
487 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot create screenshot directory '"
488 << dir << "'. Trying home directory.");
489 dir = globals->get_fg_home();
493 static int count = 1;
494 while (count < 1000) {
495 snprintf(filename, 24, "fgfs-screen-%03d.png", count++);
505 _xsize = fgGetInt("/sim/startup/xsize");
506 _ysize = fgGetInt("/sim/startup/ysize");
508 FGRenderer *renderer = globals->get_renderer();
509 renderer->resize(_xsize, _ysize);
510 globals->get_event_mgr()->addTask("SnapShotTimer",
511 this, &GUISnapShotOperation::timerExpired,
515 // to be executed in graphics context (maybe separate thread)
516 void run(osg::GraphicsContext* gc)
518 _result = sg_glDumpWindow(_path.c_str(),
523 // timer method, to be executed in main loop's thread
524 virtual void timerExpired()
528 globals->get_event_mgr()->removeTask("SnapShotTimer");
530 fgSetString("/sim/paths/screenshot-last", _path.c_str());
531 fgSetBool("/sim/signals/screenshot", _result);
533 fgSetMouseCursor(_mouse);
536 _master_freeze->setBoolValue(false);
542 static osg::ref_ptr<GUISnapShotOperation> _snapShotOp;
543 SGPropertyNode_ptr _master_freeze;
551 } // of anonymous namespace
553 osg::ref_ptr<GUISnapShotOperation> GUISnapShotOperation::_snapShotOp;
555 // do a screen snap shot
556 bool fgDumpSnapShot ()
558 // start snap shot operation, while needs to be executed in
560 return GUISnapShotOperation::start();
563 // do an entire scenegraph dump
564 void fgDumpSceneGraph()
566 char *filename = new char [24];
568 static int count = 1;
570 SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
572 bool freeze = master_freeze->getBoolValue();
574 master_freeze->setBoolValue(true);
577 while (count < 1000) {
579 snprintf(filename, 24, "fgfs-graph-%03d.osg", count++);
580 if ( (fp = fopen(filename, "r")) == NULL )
585 if ( fgDumpSceneGraphToFile(filename)) {
586 message = "Entire scene graph saved to \"";
590 message = "Failed to save to \"";
595 mkDialog (message.c_str());
600 master_freeze->setBoolValue(false);
605 // do an terrain branch dump
606 void fgDumpTerrainBranch()
608 char *filename = new char [24];
610 static int count = 1;
612 SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
614 bool freeze = master_freeze->getBoolValue();
616 master_freeze->setBoolValue(true);
619 while (count < 1000) {
621 snprintf(filename, 24, "fgfs-graph-%03d.osg", count++);
622 if ( (fp = fopen(filename, "r")) == NULL )
627 if ( fgDumpTerrainBranchToFile(filename)) {
628 message = "Terrain graph saved to \"";
632 message = "Failed to save to \"";
637 mkDialog (message.c_str());
642 master_freeze->setBoolValue(false);
646 void fgPrintVisibleSceneInfoCommand()
648 SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
650 bool freeze = master_freeze->getBoolValue();
652 master_freeze->setBoolValue(true);
655 flightgear::printVisibleSceneInfo(globals->get_renderer());
658 master_freeze->setBoolValue(false);