src/GUI/gui_funcs.cxx

   1 /**************************************************************************
   2  * gui_funcs.cxx
   3  *
   4  * Based on gui.cxx and renamed on 2002/08/13 by Erik Hofman.
   5  *
   6  * Written 1998 by Durk Talsma, started Juni, 1998.  For the flight gear
   7  * project.
   8  *
   9  * Additional mouse supported added by David Megginson, 1999.
  10  *
  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.
  15  *
  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.
  20  *
  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.
  24  *
  25  * $Id$
  26  **************************************************************************/
  27
  28
  29 #ifdef HAVE_CONFIG_H
  30 #  include <config.h>
  31 #endif
  32
  33 #include <simgear/compiler.h>
  34
  35 #ifdef SG_MATH_EXCEPTION_CLASH
  36 #  include <math.h>
  37 #endif
  38
  39 #ifdef HAVE_WINDOWS_H
  40 #  include <windows.h>
  41 #endif
  42
  43 #include SG_GL_H
  44
  45 #if defined(FX) && defined(XMESA)
  46 #  include <GL/xmesa.h>
  47 #endif
  48
  49 #include STL_FSTREAM
  50 #include STL_STRING
  51
  52 #include <stdlib.h>
  53 #include <string.h>
  54
  55 // for help call back
  56 #ifdef WIN32
  57 # include <shellapi.h>
  58 # ifdef __CYGWIN__
  59 #  include <sys/cygwin.h>
  60 # endif
  61 #endif
  62
  63 #include <plib/ssg.h>
  64
  65 #include <simgear/constants.h>
  66 #include <simgear/debug/logstream.hxx>
  67 #include <simgear/misc/sg_path.hxx>
  68 #include <simgear/screen/screen-dump.hxx>
  69
  70 #include <Include/general.hxx>
  71 #include <Aircraft/aircraft.hxx>
  72 #include <Aircraft/controls.hxx>
  73 #include <Airports/simple.hxx>
  74 #include <Autopilot/auto_gui.hxx>
  75 #include <Cockpit/panel.hxx>
  76 #include <FDM/flight.hxx>
  77 #include <Main/main.hxx>
  78 #include <Main/fg_init.hxx>
  79 #include <Main/fg_io.hxx>
  80 #include <Main/globals.hxx>
  81 #include <Main/fg_props.hxx>
  82 #include <Main/renderer.hxx>
  83 #include <Main/viewmgr.hxx>
  84 #include <GUI/new_gui.hxx>
  85
  86 #if defined( WIN32 ) && !defined( __CYGWIN__ ) && !defined(__MINGW32__)
  87 #  include <simgear/screen/win32-printer.h>
  88 #  include <simgear/screen/GlBitmaps.h>
  89 #endif
  90
  91 #include "gui.h"
  92 #include "gui_local.hxx"
  93 #include "preset_dlg.hxx"
  94 #include "prop_picker.hxx"
  95 #include "sgVec3Slider.hxx"
  96
  97 SG_USING_STD(string);
  98 SG_USING_STD(cout);
  99
 100 // from cockpit.cxx
 101 extern void fgLatLonFormatToggle( puObject *);
 102
 103 #if defined( TR_HIRES_SNAP)
 104 #include <simgear/screen/tr.h>
 105 extern void fgUpdateHUD( GLfloat x_start, GLfloat y_start,
 106                          GLfloat x_end, GLfloat y_end );
 107 #endif
 108
 109
 110 // TODO: remove after the last hardcoded dialog has died
 111 char *gui_msg_OK     = "OK";
 112 char *gui_msg_NO     = "NO";
 113 char *gui_msg_YES    = "YES";
 114 char *gui_msg_CANCEL = "CANCEL";
 115 char *gui_msg_RESET  = "RESET";
 116
 117
 118 const __fg_gui_fn_t __fg_gui_fn[] = {
 119
 120         // File
 121         {"reInit", reInit},
 122 #ifdef TR_HIRES_SNAP
 123         {"dumpHiResSnapShot", fgHiResDumpWrapper},
 124 #endif
 125         {"dumpSnapShot", fgDumpSnapShotWrapper},
 126 #if defined( WIN32 ) && !defined( __CYGWIN__) && !defined(__MINGW32__)
 127         {"printScreen", printScreen},
 128 #endif
 129
 130         //View
 131         {"guiTogglePanel", guiTogglePanel},
 132         {"prop_pickerView", prop_pickerView},
 133
 134         // Environment
 135         {"fgPresetAirport", fgPresetAirport},
 136         {"fgPresetRunway", fgPresetRunway},
 137         {"fgPresetOffsetDistance", fgPresetOffsetDistance},
 138         {"fgPresetAltitude", fgPresetAltitude},
 139         {"fgPresetGlideslope", fgPresetGlideslope},
 140         {"fgPresetAirspeed", fgPresetAirspeed},
 141         {"fgPresetCommit", fgPresetCommit},
 142
 143         // Autopilot
 144         {"NewAltitude", NewAltitude},
 145         {"NewHeading", NewHeading},
 146         {"AddWayPoint", AddWayPoint},
 147         {"PopWayPoint", PopWayPoint},
 148         {"ClearRoute", ClearRoute},
 149         {"fgLatLonFormatToggle", fgLatLonFormatToggle},
 150
 151         // Help
 152         {"helpCb", helpCb},
 153
 154         // Structure termination
 155         {"", NULL}
 156 };
 157
 158
 159 /* ================ General Purpose Functions ================ */
 160
 161 // General Purpose Message Box
 162 void mkDialog (const char *txt)
 163 {
 164     NewGUI *gui = (NewGUI *)globals->get_subsystem("gui");
 165     if (!gui)
 166         return;
 167     SGPropertyNode_ptr dlg = gui->getDialog("message");
 168     if (!dlg)
 169         return;
 170
 171     dlg->setStringValue("text/label", txt);
 172     dlg->setStringValue("button/legend", "OK");
 173     gui->showDialog("message");
 174 }
 175
 176 // Message Box to report an error.
 177 void guiErrorMessage (const char *txt)
 178 {
 179     SG_LOG(SG_GENERAL, SG_ALERT, txt);
 180     mkDialog(txt);
 181 }
 182
 183 // Message Box to report a throwable (usually an exception).
 184 void guiErrorMessage (const char *txt, const sg_throwable &throwable)
 185 {
 186     string msg = txt;
 187     msg += '\n';
 188     msg += throwable.getFormattedMessage();
 189     if (!throwable.getOrigin().empty()) {
 190       msg += "\n (reported by ";
 191       msg += throwable.getOrigin();
 192       msg += ')';
 193     }
 194     SG_LOG(SG_GENERAL, SG_ALERT, msg);
 195     mkDialog(msg.c_str());
 196 }
 197
 198
 199
 200 /* -----------------------------------------------------------------------
 201 the Gui callback functions
 202 ____________________________________________________________________*/
 203
 204
 205 // Hier Neu :-) This is my newly added code
 206 // Added by David Findlay <nedz@bigpond.com>
 207 // on Sunday 3rd of December
 208
 209
 210 // This is the accessor function
 211 void guiTogglePanel(puObject *cb)
 212 {
 213   if (fgGetBool("/sim/panel/visibility"))
 214     fgSetBool("/sim/panel/visibility", false);
 215   else
 216     fgSetBool("/sim/panel/visibility", true);
 217
 218   globals->get_renderer()->resize(fgGetInt("/sim/startup/xsize"),
 219                                   fgGetInt("/sim/startup/ysize"));
 220 }
 221
 222 void helpCb (puObject *)
 223 {
 224     string command;
 225
 226 #if defined(FX) && !defined(WIN32)
 227 #  if defined(XMESA_FX_FULLSCREEN) && defined(XMESA_FX_WINDOW)
 228     if ( globals->get_fullscreen() ) {
 229         globals->set_fullscreen(false);
 230         XMesaSetFXmode( XMESA_FX_WINDOW );
 231     }
 232 #  endif
 233 #endif
 234
 235     SGPath path( globals->get_fg_root() );
 236     path.append( "Docs/index.html" );
 237
 238 #if !defined(WIN32)
 239
 240     string help_app = fgGetString("/sim/startup/browser-app");
 241
 242     if ( system("xwininfo -name Netscape > /dev/null 2>&1") == 0 ) {
 243         command = help_app + " -remote \"openURL(" + path.str() + ")\"";
 244     } else {
 245         command = help_app + " " + path.str();
 246     }
 247     command += " &";
 248     system( command.c_str() );
 249
 250 #else // WIN32
 251
 252     // Look for favorite browser
 253     char Dummy[1024], ExecName[1024], browserParameter[1024];
 254     char win32_name[1024];
 255 # ifdef __CYGWIN__
 256     cygwin32_conv_to_full_win32_path(path.c_str(),win32_name);
 257 # else
 258     strncpy(win32_name,path.c_str(), 1024);
 259 # endif
 260     Dummy[0] = 0;
 261     FindExecutable(win32_name, Dummy, ExecName);
 262     snprintf(browserParameter, 1024, "file:///%s", win32_name);
 263     ShellExecute ( NULL, "open", ExecName, browserParameter, Dummy,
 264                    SW_SHOWNORMAL ) ;
 265
 266 #endif
 267
 268     mkDialog ("Help started in your web browser window.");
 269 }
 270
 271 #if defined( TR_HIRES_SNAP)
 272 void fgHiResDump()
 273 {
 274     FILE *f;
 275     string message;
 276     bool show_pu_cursor = false;
 277     bool menu_status = fgGetBool("/sim/menubar/visibility");
 278     char *filename = new char [24];
 279     static int count = 1;
 280
 281     static const SGPropertyNode *master_freeze
 282         = fgGetNode("/sim/freeze/master");
 283
 284     bool freeze = master_freeze->getBoolValue();
 285     if ( !freeze ) {
 286         fgSetBool("/sim/freeze/master", true);
 287     }
 288
 289     fgSetBool("/sim/menubar/visibility", false);
 290     TurnCursorOff();
 291     if ( !puCursorIsHidden() ) {
 292         show_pu_cursor = true;
 293         puHideCursor();
 294     }
 295
 296     FGRenderer *renderer = globals->get_renderer();
 297     renderer->init();
 298     renderer->resize( fgGetInt("/sim/startup/xsize"),
 299                       fgGetInt("/sim/startup/ysize") );
 300
 301     // we need two render frames here to clear the menu and cursor
 302     // ... not sure why but doing an extra fgRenderFrame() shouldn't
 303     // hurt anything
 304     //renderer->update( true );
 305     //renderer->update( true );
 306
 307     // This ImageSize stuff is a temporary hack
 308     // should probably use 128x128 tile size and
 309     // support any image size
 310
 311     // This should be a requester to get multiplier from user
 312     int multiplier = fgGetInt("/sim/startup/hires-multiplier", 3);
 313     int width = fgGetInt("/sim/startup/xsize");
 314     int height = fgGetInt("/sim/startup/ysize");
 315
 316     /* allocate buffer large enough to store one tile */
 317     GLubyte *tile = (GLubyte *)malloc(width * height * 3 * sizeof(GLubyte));
 318     if (!tile) {
 319         printf("Malloc of tile buffer failed!\n");
 320         return;
 321     }
 322
 323     int imageWidth  = multiplier*width;
 324     int imageHeight = multiplier*height;
 325
 326     /* allocate buffer to hold a row of tiles */
 327     GLubyte *buffer
 328         = (GLubyte *)malloc(imageWidth * height * 3 * sizeof(GLubyte));
 329     if (!buffer) {
 330         free(tile);
 331         printf("Malloc of tile row buffer failed!\n");
 332         return;
 333     }
 334     TRcontext *tr = trNew();
 335     trTileSize(tr, width, height, 0);
 336     trTileBuffer(tr, GL_RGB, GL_UNSIGNED_BYTE, tile);
 337     trImageSize(tr, imageWidth, imageHeight);
 338     trRowOrder(tr, TR_TOP_TO_BOTTOM);
 339     sgFrustum *frustum = ssgGetFrustum();
 340     trFrustum(tr,
 341               frustum->getLeft(), frustum->getRight(),
 342               frustum->getBot(),  frustum->getTop(),
 343               frustum->getNear(), frustum->getFar());
 344
 345     /* Prepare ppm output file */
 346     while (count < 1000) {
 347         snprintf(filename, 24, "fgfs-screen-%03d.ppm", count++);
 348         if ( (f = fopen(filename, "r")) == NULL )
 349             break;
 350         fclose(f);
 351     }
 352     f = fopen(filename, "wb");
 353     if (!f) {
 354         printf("Couldn't open image file: %s\n", filename);
 355         free(buffer);
 356         free(tile);
 357         return;
 358     }
 359     fprintf(f,"P6\n");
 360     fprintf(f,"# ppm-file created by %s\n", "trdemo2");
 361     fprintf(f,"%i %i\n", imageWidth, imageHeight);
 362     fprintf(f,"255\n");
 363
 364     /* just to be safe... */
 365     glPixelStorei(GL_PACK_ALIGNMENT, 1);
 366
 367     /* Because the HUD and Panel change the ViewPort we will
 368      * need to handle some lowlevel stuff ourselves */
 369     int ncols = trGet(tr, TR_COLUMNS);
 370     int nrows = trGet(tr, TR_ROWS);
 371
 372     bool do_hud = fgGetBool("/sim/hud/visibility");
 373     GLfloat hud_col_step = 640.0 / ncols;
 374     GLfloat hud_row_step = 480.0 / nrows;
 375
 376     bool do_panel = fgPanelVisible();
 377     GLfloat panel_col_step = globals->get_current_panel()->getWidth() / ncols;
 378     GLfloat panel_row_step = globals->get_current_panel()->getHeight() / nrows;
 379
 380     glHint(GL_PERSPECTIVE_CORRECTION_HINT, GL_NICEST);
 381     glHint(GL_POLYGON_SMOOTH_HINT, GL_NICEST);
 382     glHint(GL_LINE_SMOOTH_HINT, GL_NICEST);
 383     glHint(GL_POINT_SMOOTH_HINT, GL_NICEST);
 384     glHint(GL_FOG_HINT, GL_NICEST);
 385
 386     /* Draw tiles */
 387     int more = 1;
 388     while (more) {
 389         trBeginTile(tr);
 390         int curColumn = trGet(tr, TR_CURRENT_COLUMN);
 391         int curRow =  trGet(tr, TR_CURRENT_ROW);
 392
 393         renderer->update( false );
 394         if ( do_hud )
 395             fgUpdateHUD( curColumn*hud_col_step,      curRow*hud_row_step,
 396                          (curColumn+1)*hud_col_step, (curRow+1)*hud_row_step );
 397         if (do_panel)
 398             globals->get_current_panel()->update(
 399                                    curColumn*panel_col_step, panel_col_step,
 400                                    curRow*panel_row_step,    panel_row_step );
 401         more = trEndTile(tr);
 402
 403         /* save tile into tile row buffer*/
 404         int curTileWidth = trGet(tr, TR_CURRENT_TILE_WIDTH);
 405         int bytesPerImageRow = imageWidth * 3*sizeof(GLubyte);
 406         int bytesPerTileRow = (width) * 3*sizeof(GLubyte);
 407         int xOffset = curColumn * bytesPerTileRow;
 408         int bytesPerCurrentTileRow = (curTileWidth) * 3*sizeof(GLubyte);
 409         int i;
 410         for (i=0;i<height;i++) {
 411             memcpy(buffer + i*bytesPerImageRow + xOffset, /* Dest */
 412                    tile + i*bytesPerTileRow,              /* Src */
 413                    bytesPerCurrentTileRow);               /* Byte count*/
 414         }
 415
 416         if (curColumn == trGet(tr, TR_COLUMNS)-1) {
 417             /* write this buffered row of tiles to the file */
 418             int curTileHeight = trGet(tr, TR_CURRENT_TILE_HEIGHT);
 419             int bytesPerImageRow = imageWidth * 3*sizeof(GLubyte);
 420             int i;
 421             for (i=0;i<curTileHeight;i++) {
 422                 /* Remember, OpenGL images are bottom to top.  Have to reverse. */
 423                 GLubyte *rowPtr = buffer + (curTileHeight-1-i) * bytesPerImageRow;
 424                 fwrite(rowPtr, 1, imageWidth*3, f);
 425             }
 426         }
 427
 428     }
 429
 430     renderer->resize( width, height );
 431
 432     trDelete(tr);
 433
 434     glHint(GL_POLYGON_SMOOTH_HINT, GL_DONT_CARE);
 435     glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
 436     glHint(GL_POINT_SMOOTH_HINT, GL_DONT_CARE);
 437     glHint(GL_PERSPECTIVE_CORRECTION_HINT, GL_DONT_CARE);
 438     if ( (!strcmp(fgGetString("/sim/rendering/fog"), "disabled")) ||
 439          (!fgGetBool("/sim/rendering/shading"))) {
 440         // if fastest fog requested, or if flat shading force fastest
 441         glHint ( GL_FOG_HINT, GL_FASTEST );
 442     } else if ( !strcmp(fgGetString("/sim/rendering/fog"), "nicest") ) {
 443         glHint ( GL_FOG_HINT, GL_DONT_CARE );
 444     }
 445
 446     fclose(f);
 447
 448     message = "Snapshot saved to \"";
 449     message += filename;
 450     message += "\".";
 451     mkDialog (message.c_str());
 452
 453     free(tile);
 454     free(buffer);
 455
 456     delete [] filename;
 457
 458     if ( show_pu_cursor ) {
 459         puShowCursor();
 460     }
 461
 462     TurnCursorOn();
 463     fgSetBool("/sim/menubar/visibility", menu_status);
 464
 465     if ( !freeze ) {
 466         fgSetBool("/sim/freeze/master", false);
 467     }
 468 }
 469 #endif // #if defined( TR_HIRES_SNAP)
 470
 471
 472 #if defined( WIN32 ) && !defined( __CYGWIN__) && !defined(__MINGW32__)
 473
 474 void rotateView( double roll, double pitch, double yaw )
 475 {
 476         // rotate view
 477 }
 478
 479 GlBitmap *b1 = NULL;
 480 GLubyte *hiResScreenCapture( int multiplier )
 481 {
 482     float oldfov = fgGetDouble("/sim/current-view/field-of-view");
 483     float fov = oldfov / multiplier;
 484     FGViewer *v = globals->get_current_view();
 485     fgSetDouble("/sim/current-view/field-of-view", fov);
 486     globals->get_renderer()->init();
 487     int cur_width = fgGetInt("/sim/startup/xsize");
 488     int cur_height = fgGetInt("/sim/startup/ysize");
 489     delete( b1 );
 490     // New empty (mostly) bitmap
 491     b1 = new GlBitmap( GL_RGB, 1, 1, (unsigned char *)"123" );
 492     int x,y;
 493     for ( y = 0; y < multiplier; y++ ) {
 494         for ( x = 0; x < multiplier; x++ ) {
 495             globals->get_renderer()->resize( cur_width, cur_height );
 496             // pan to tile
 497             rotateView( 0, (y*fov)-((multiplier-1)*fov/2), (x*fov)-((multiplier-1)*fov/2) );
 498             globals->get_renderer()->update( false );
 499             // restore view
 500             GlBitmap b2;
 501             b1->copyBitmap( &b2, cur_width*x, cur_height*y );
 502         }
 503     }
 504     fgSetDouble("/sim/current-view/field-of-view", oldfov);
 505     return b1->getBitmap();
 506 }
 507 #endif
 508
 509 #if defined( WIN32 ) && !defined( __CYGWIN__) && !defined(__MINGW32__)
 510 // win32 print screen function
 511 void printScreen ( puObject *obj ) {
 512     bool show_pu_cursor = false;
 513     TurnCursorOff();
 514     if ( !puCursorIsHidden() ) {
 515         show_pu_cursor = true;
 516         puHideCursor();
 517     }
 518     // BusyCursor( 0 );
 519
 520     CGlPrinter p( CGlPrinter::PRINT_BITMAP );
 521     int cur_width = fgGetInt("/sim/startup/xsize");
 522     int cur_height = fgGetInt("/sim/startup/ysize");
 523     p.Begin( "FlightGear", cur_width*3, cur_height*3 );
 524     p.End( hiResScreenCapture(3) );
 525
 526     // BusyCursor(1);
 527     if ( show_pu_cursor ) {
 528         puShowCursor();
 529     }
 530     TurnCursorOn();
 531 }
 532 #endif // #ifdef WIN32
 533
 534
 535 void fgDumpSnapShotWrapper ( puObject *obj ) {
 536     fgDumpSnapShot();
 537 }
 538
 539
 540 void fgHiResDumpWrapper ( puObject *obj ) {
 541     fgHiResDump();
 542 }
 543
 544
 545 // do a screen snap shot
 546 void fgDumpSnapShot () {
 547     bool show_pu_cursor = false;
 548     char *filename = new char [24];
 549     string message;
 550     static int count = 1;
 551
 552     static const SGPropertyNode *master_freeze
 553         = fgGetNode("/sim/freeze/master");
 554
 555     bool freeze = master_freeze->getBoolValue();
 556     if ( !freeze ) {
 557         fgSetBool("/sim/freeze/master", true);
 558     }
 559
 560     TurnCursorOff();
 561     if ( !puCursorIsHidden() ) {
 562         show_pu_cursor = true;
 563         puHideCursor();
 564     }
 565
 566     FGRenderer *renderer = globals->get_renderer();
 567     renderer->init();
 568     renderer->resize( fgGetInt("/sim/startup/xsize"),
 569                         fgGetInt("/sim/startup/ysize") );
 570
 571     // we need two render frames here to clear the menu and cursor
 572     // ... not sure why but doing an extra fgRenderFrame() shouldn't
 573     // hurt anything
 574     renderer->update( true );
 575     renderer->update( true );
 576
 577     while (count < 1000) {
 578         FILE *fp;
 579         snprintf(filename, 24, "fgfs-screen-%03d.ppm", count++);
 580         if ( (fp = fopen(filename, "r")) == NULL )
 581             break;
 582         fclose(fp);
 583     }
 584
 585     if ( sg_glDumpWindow( filename,
 586                           fgGetInt("/sim/startup/xsize"),
 587                           fgGetInt("/sim/startup/ysize")) ) {
 588         message = "Snapshot saved to \"";
 589         message += filename;
 590         message += "\".";
 591     } else {
 592         message = "Failed to save to \"";
 593         message += filename;
 594         message += "\".";
 595     }
 596
 597     mkDialog (message.c_str());
 598
 599     delete [] filename;
 600
 601     if ( show_pu_cursor ) {
 602         puShowCursor();
 603     }
 604
 605     TurnCursorOn();
 606
 607     if ( !freeze ) {
 608         fgSetBool("/sim/freeze/master", false);
 609     }
 610 }
 611