Main/fg_init.c

   1 /* -*- Mode: C++ -*-
   2  *
   3  * fg_init.c -- Flight Gear top level initialization routines
   4  *
   5  * Written by Curtis Olson, started August 1997.
   6  *
   7  * Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of the
  12  * License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *
  23  *
  24  * $Id$
  25  * (Log is kept at end of this file)
  26  **************************************************************************/
  27
  28
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31
  32 #include <Main/fg_init.h>
  33 #include <Main/views.h>
  34
  35 #include <Include/cmdargs.h>
  36 #include <Include/fg_constants.h>
  37 #include <Include/general.h>
  38
  39 #include <Aircraft/aircraft.h>
  40 #include <Astro/moon.h>
  41 #include <Astro/planets.h>
  42 #include <Astro/sky.h>
  43 #include <Astro/stars.h>
  44 #include <Astro/sun.h>
  45 #include <Cockpit/cockpit.h>
  46 #include <Joystick/joystick.h>
  47 #include <Math/fg_random.h>
  48 #include <Scenery/scenery.h>
  49 #include <Scenery/tilemgr.h>
  50 #include <Time/event.h>
  51 #include <Time/fg_time.h>
  52 #include <Time/sunpos.h>
  53 #include <Weather/weather.h>
  54 #include <Main/fg_debug.h>
  55
  56 extern int show_hud;             /* HUD state */
  57 extern int displayInstruments;
  58 extern const char *default_root;
  59
  60 /* General house keeping initializations */
  61
  62 int fgInitGeneral( void ) {
  63     struct fgGENERAL *g;
  64
  65     g = &general;
  66
  67     fgInitDebug();
  68
  69     fgPrintf( FG_GENERAL, FG_INFO, "General Initialization\n" );
  70     fgPrintf( FG_GENERAL, FG_INFO, "======= ==============\n" );
  71
  72     /* seed the random number generater */
  73     fg_srandom();
  74
  75     // determine the fg root path. The command line parser getargs() will
  76     // fill in a root directory if the option was used.
  77
  78     if( !(g->root_dir) ) {
  79         // If not set by command line test for environmental var..
  80         g->root_dir = getenv("FG_ROOT");
  81         if ( !g->root_dir ) {
  82             // No root path set? Then assume, we will exit if this is
  83             // wrong when looking for support files.
  84             g->root_dir = (char *)DefaultRootDir;
  85         }
  86     }
  87     fgPrintf( FG_GENERAL, FG_INFO, "FG_ROOT = %s\n\n", g->root_dir);
  88
  89     // Dummy value can be changed if future initializations
  90     // fail a critical task.
  91     return ( 0 /* FALSE */ );
  92 }
  93
  94
  95 // This is the top level init routine which calls all the other
  96 // initialization routines.  If you are adding a subsystem to flight
  97 // gear, its initialization call should located in this routine.
  98 // Returns non-zero if a problem encountered.
  99
 100 int fgInitSubsystems( void ) {
 101     double cur_elev;
 102
 103     // Ok will be flagged only if we get EVERYTHING done.
 104     int ret_val = 1 /* TRUE */;
 105
 106     fgFLIGHT *f;
 107     struct fgLIGHT *l;
 108     struct fgTIME *t;
 109     struct fgVIEW *v;
 110
 111     l = &cur_light_params;
 112     t = &cur_time_params;
 113     v = &current_view;
 114
 115     fgPrintf( FG_GENERAL, FG_INFO, "Initialize Subsystems\n");
 116     fgPrintf( FG_GENERAL, FG_INFO, "========== ==========\n");
 117
 118     /****************************************************************
 119      * The following section sets up the flight model EOM parameters and
 120      * should really be read in from one or more files.
 121      ****************************************************************/
 122
 123     /* Must happen before any of the flight model or control
 124      * parameters are set */
 125
 126     fgAircraftInit();   // In the future this might not be the case.
 127     f = current_aircraft.flight;
 128
 129     /* Globe Aiport, AZ */
 130     FG_Runway_longitude = -398391.28;
 131     FG_Runway_latitude = 120070.41;
 132     FG_Runway_altitude = 3234.5;
 133     FG_Runway_heading = 102.0 * DEG_TO_RAD;
 134
 135     /* Initial Position at (P13) Globe, AZ */
 136     FG_Longitude = ( -398391.28 / 3600.0 ) * DEG_TO_RAD;
 137     FG_Latitude  = (  120070.41 / 3600.0 ) * DEG_TO_RAD;
 138     FG_Runway_altitude = (3234.5 + 300);
 139     FG_Altitude = FG_Runway_altitude + 3.758099;
 140
 141     // Initial Position at (E81) Superior, AZ
 142     // FG_Longitude = ( -111.1270650 ) * DEG_TO_RAD;
 143     // FG_Latitude  = (  33.2778339 ) * DEG_TO_RAD;
 144     // FG_Runway_altitude = (2646 + 1000);
 145     // FG_Altitude = FG_Runway_altitude + 3.758099;
 146
 147     // Initial Position at (TUS) Tucson, AZ
 148     // FG_Longitude = ( -110.9412597 ) * DEG_TO_RAD;
 149     // FG_Latitude  = (  32.1162439 ) * DEG_TO_RAD;
 150     // FG_Runway_altitude = (2641 + 0);
 151     // FG_Altitude = FG_Runway_altitude + 3.758099;
 152
 153     /* Initial Position at near Anchoraze, AK */
 154     /* FG_Longitude = ( -150.00 ) * DEG_TO_RAD; */
 155     /* FG_Latitude  = (  61.17 ) * DEG_TO_RAD; */
 156     /* FG_Runway_altitude = (2641 + 07777); */
 157     /* FG_Altitude = FG_Runway_altitude + 3.758099; */
 158
 159     /* Initial Position at (SEZ) SEDONA airport */
 160     /* FG_Longitude = (-111.7884614 + 0.02) * DEG_TO_RAD; */
 161     /* FG_Latitude  = (  34.8486289 - 0.04) * DEG_TO_RAD; */
 162     /* FG_Runway_altitude = (4827 + 800); */
 163     /* FG_Altitude = FG_Runway_altitude + 3.758099; */
 164
 165     /* Initial Position at (HSP) Hot Springs, VA */
 166     /* FG_Longitude = (-79.8338964 + 0.02) * DEG_TO_RAD; */
 167     /* FG_Latitude  = ( 37.9514564 + 0.05) * DEG_TO_RAD; */
 168     /* FG_Runway_altitude = (792 + 1500); */
 169     /* FG_Altitude = FG_Runway_altitude + 3.758099; */
 170
 171     /* Initial Position at (ANE) Anoka County airport */
 172     /* FG_Longitude = -93.2113889 * DEG_TO_RAD; */
 173     /* FG_Latitude  = 45.145 * DEG_TO_RAD; */
 174     /* FG_Runway_altitude = 912; */
 175     /* FG_Altitude = FG_Runway_altitude + 3.758099; */
 176
 177     /* Initial Position north of the city of Globe */
 178     /* FG_Longitude = ( -398673.28 / 3600.0 ) * DEG_TO_RAD; */
 179     /* FG_Latitude  = (  120625.64 / 3600.0 ) * DEG_TO_RAD; */
 180     /* FG_Longitude = ( -397867.44 / 3600.0 ) * DEG_TO_RAD; */
 181     /* FG_Latitude  = (  119548.21 / 3600.0 ) * DEG_TO_RAD; */
 182     /* FG_Altitude = 0.0 + 3.758099; */
 183
 184     /* Initial Posisition near where I used to live in Globe, AZ */
 185     /* FG_Longitude = ( -398757.6 / 3600.0 ) * DEG_TO_RAD; */
 186     /* FG_Latitude  = (  120160.0 / 3600.0 ) * DEG_TO_RAD;  */
 187     /* FG_Runway_altitude = 5000.0; */
 188     /* FG_Altitude = FG_Runway_altitude + 3.758099; */
 189
 190     // Initial Position: 10125 Jewell St. NE
 191     // FG_Longitude = ( -93.15 ) * DEG_TO_RAD;
 192     // FG_Latitude  = (  45.15 ) * DEG_TO_RAD;
 193     // FG_Runway_altitude = 950.0;
 194     // FG_Altitude = FG_Runway_altitude + 3.758099;
 195
 196     // Initial Position: Somewhere near the Grand Canyon
 197     // FG_Longitude = ( -112.5 ) * DEG_TO_RAD;
 198     // FG_Latitude  = (  36.5 ) * DEG_TO_RAD;
 199     // FG_Runway_altitude = 5000.0;
 200     // FG_Altitude = FG_Runway_altitude + 3.758099;
 201
 202     // Initial Position: (GCN) Grand Canyon Airport, AZ
 203     // FG_Longitude = ( -112.1469647 ) * DEG_TO_RAD;
 204     // FG_Latitude  = (   35.9523539 ) * DEG_TO_RAD;
 205     // FG_Runway_altitude = 6606.0;
 206     // FG_Altitude = FG_Runway_altitude + 3.758099;
 207
 208     // Initial Position: Jim Brennon's Kingmont Observatory
 209     // FG_Longitude = ( -121.1131666 ) * DEG_TO_RAD;
 210     // FG_Latitude  = (   38.8293916 ) * DEG_TO_RAD;
 211     // FG_Runway_altitude = 920.0 + 100;
 212     // FG_Altitude = FG_Runway_altitude + 3.758099;
 213
 214     // Test Position
 215     // FG_Longitude = ( -111.18 ) * DEG_TO_RAD;
 216     // FG_Latitude  = (   33.70 ) * DEG_TO_RAD;
 217     // FG_Runway_altitude = 5000.0;
 218     // FG_Altitude = FG_Runway_altitude + 3.758099;
 219
 220     // A random test position
 221     // FG_Longitude = ( 88128.00 / 3600.0 ) * DEG_TO_RAD;
 222     // FG_Latitude  = ( 93312.00 / 3600.0 ) * DEG_TO_RAD;
 223
 224     fgPrintf( FG_GENERAL, FG_INFO,
 225               "Initial position is: (%.4f, %.4f, %.2f)\n",
 226               FG_Longitude * RAD_TO_DEG, FG_Latitude * RAD_TO_DEG,
 227               FG_Altitude * FEET_TO_METER);
 228
 229     /* Initial Velocity */
 230     FG_V_north = 0.0 /*  7.287719E+00 */;
 231     FG_V_east  = 0.0 /*  1.521770E+03 */;
 232     FG_V_down  = 0.0 /* -1.265722E-05 */;
 233
 234     /* Initial Orientation */
 235     FG_Phi   = -2.658474E-06;
 236     FG_Theta =  7.401790E-03;
 237     FG_Psi   =  270.0 * DEG_TO_RAD;
 238
 239     /* Initial Angular B rates */
 240     FG_P_body = 7.206685E-05;
 241     FG_Q_body = 0.000000E+00;
 242     FG_R_body = 9.492658E-05;
 243
 244     FG_Earth_position_angle = 0.000000E+00;
 245
 246     /* Mass properties and geometry values */
 247     FG_Mass = 8.547270E+01;
 248     FG_I_xx = 1.048000E+03;
 249     FG_I_yy = 3.000000E+03;
 250     FG_I_zz = 3.530000E+03;
 251     FG_I_xz = 0.000000E+00;
 252
 253     /* CG position w.r.t. ref. point */
 254     FG_Dx_cg = 0.000000E+00;
 255     FG_Dy_cg = 0.000000E+00;
 256     FG_Dz_cg = 0.000000E+00;
 257
 258     /* Set initial position and slew parameters */
 259     /* fgSlewInit(-398391.3, 120070.41, 244, 3.1415); */ /* GLOBE Airport */
 260     /* fgSlewInit(-335340,162540, 15, 4.38); */
 261     /* fgSlewInit(-398673.28,120625.64, 53, 4.38); */
 262
 263     /* Initialize the event manager */
 264     fgEventInit();
 265
 266     /* Dump event stats every 60 seconds */
 267     fgEventRegister( "fgEventPrintStats()", fgEventPrintStats,
 268                      FG_EVENT_READY, 60000 );
 269
 270     /* Initialize "time" */
 271     fgTimeInit(t);
 272     fgTimeUpdate(f, t);
 273
 274     /* fgViewUpdate() needs the sun in the right place, while
 275      * fgUpdateSunPos() needs to know the view position.  I'll get
 276      * around this interdependency for now by calling fgUpdateSunPos()
 277      * once, then moving on with normal initialization. */
 278     fgUpdateSunPos();
 279
 280     /* Initialize view parameters */
 281     fgViewInit(v);
 282     fgViewUpdate(f, v, l);
 283
 284     /* Initialize shared sun position and sun_vec */
 285     fgEventRegister( "fgUpdateSunPos()", fgUpdateSunPos, FG_EVENT_READY, 1000 );
 286
 287     /* Initialize the weather modeling subsystem */
 288     fgWeatherInit();
 289
 290     /* update the weather for our current position */
 291     fgEventRegister( "fgWeatherUpdate()", fgWeatherUpdate,
 292                      FG_EVENT_READY, 120000 );
 293
 294     /* Initialize the Cockpit subsystem */
 295     if( fgCockpitInit( &current_aircraft )) {
 296         // Cockpit initialized ok.
 297     } else {
 298         fgPrintf( FG_GENERAL, FG_EXIT, "Error in Cockpit initialization!\n" );
 299     }
 300
 301     // Initialize the orbital elements of sun, moon and mayor planets
 302     fgSolarSystemInit(*t);
 303
 304     // Initialize the Stars subsystem
 305     if( fgStarsInit() ) {
 306         // Stars initialized ok.
 307     } else {
 308         fgPrintf( FG_GENERAL, FG_EXIT, "Error in Stars initialization!\n" );
 309     }
 310
 311     // Initialize the planetary subsystem
 312     fgEventRegister("fgPlanetsInit()", fgPlanetsInit, FG_EVENT_READY, 600000);
 313
 314     // Initialize the sun's position
 315     fgEventRegister("fgSunInit()", fgSunInit, FG_EVENT_READY, 60000 );
 316
 317     // Intialize the moon's position
 318     fgEventRegister( "fgMoonInit()", fgMoonInit, FG_EVENT_READY, 600000 );
 319
 320     // Initialize the "sky"
 321     fgSkyInit();
 322
 323     // Initialize the Scenery Management subsystem
 324     if( fgTileMgrInit() ) {
 325         // Load the local scenery data
 326         fgTileMgrUpdate();
 327     } else {
 328         fgPrintf( FG_GENERAL, FG_EXIT,
 329                   "Error in Tile Manager initialization!\n" );
 330     }
 331
 332     // I'm just sticking this here for now, it should probably move
 333     // eventually
 334     // cur_elev = mesh_altitude(FG_Longitude * RAD_TO_DEG * 3600.0,
 335     //           FG_Latitude  * RAD_TO_DEG * 3600.0); */
 336     // fgPrintf( FG_GENERAL, FG_INFO,
 337     //   "True ground elevation is %.2f meters here.\n",
 338     //   cur_elev); */
 339
 340     cur_elev = FG_Runway_altitude * FEET_TO_METER;
 341     if ( cur_elev > -9990.0 ) {
 342         FG_Runway_altitude = cur_elev * METER_TO_FEET;
 343     }
 344
 345     if ( FG_Altitude < FG_Runway_altitude ) {
 346         FG_Altitude = FG_Runway_altitude + 3.758099;
 347     }
 348
 349     fgPrintf(FG_GENERAL, FG_INFO,
 350              "Updated position (after elevation adj): (%.4f, %.4f, %.2f)\n",
 351              FG_Latitude * RAD_TO_DEG, FG_Longitude * RAD_TO_DEG,
 352              FG_Altitude * FEET_TO_METER);
 353
 354     /* end of thing that I just stuck in that I should probably move */
 355
 356     /* Initialize the flight model subsystem data structures base on
 357      * above values */
 358
 359     fgFlightModelInit( FG_LARCSIM, f, 1.0 / DEFAULT_MODEL_HZ );
 360
 361     // To HUD or not to HUD  - Now a command line issue
 362     //              show_hud = 0;
 363
 364     // Let's not show the instrument panel
 365     displayInstruments = 0;
 366
 367     // Joystick support
 368     if (fgJoystickInit(0) ) {
 369         // Joystick initialized ok.
 370     } else {
 371         fgPrintf( FG_GENERAL, FG_EXIT, "Error in Joystick initialization!\n" );
 372     }
 373
 374     // One more try here to get the sky synced up
 375     fgSkyColorsInit();
 376     ret_val = 0;
 377
 378     fgPrintf(FG_GENERAL, FG_INFO,"\n");
 379     return ret_val;
 380 }
 381
 382
 383 /* $Log$
 384 /* Revision 1.48  1998/02/21 14:53:15  curt
 385 /* Added Charlie's HUD changes.
 386 /*
 387  * Revision 1.47  1998/02/19 13:05:53  curt
 388  * Incorporated some HUD tweaks from Michelle America.
 389  * Tweaked the sky's sunset/rise colors.
 390  * Other misc. tweaks.
 391  *
 392  * Revision 1.46  1998/02/18 15:07:06  curt
 393  * Tweaks to build with SGI OpenGL (and therefor hopefully other accelerated
 394  * drivers will work.)
 395  *
 396  * Revision 1.45  1998/02/16 13:39:43  curt
 397  * Miscellaneous weekend tweaks.  Fixed? a cache problem that caused whole
 398  * tiles to occasionally be missing.
 399  *
 400  * Revision 1.44  1998/02/12 21:59:50  curt
 401  * Incorporated code changes contributed by Charlie Hotchkiss
 402  * <chotchkiss@namg.us.anritsu.com>
 403  *
 404  * Revision 1.43  1998/02/11 02:50:40  curt
 405  * Minor changes.
 406  *
 407  * Revision 1.42  1998/02/09 22:56:58  curt
 408  * Removed "depend" files from cvs control.  Other minor make tweaks.
 409  *
 410  * Revision 1.41  1998/02/09 15:07:50  curt
 411  * Minor tweaks.
 412  *
 413  * Revision 1.40  1998/02/07 15:29:44  curt
 414  * Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
 415  * <chotchkiss@namg.us.anritsu.com>
 416  *
 417  * Revision 1.39  1998/02/03 23:20:25  curt
 418  * Lots of little tweaks to fix various consistency problems discovered by
 419  * Solaris' CC.  Fixed a bug in fg_debug.c with how the fgPrintf() wrapper
 420  * passed arguments along to the real printf().  Also incorporated HUD changes
 421  * by Michele America.
 422  *
 423  * Revision 1.38  1998/02/02 20:53:58  curt
 424  * Incorporated Durk's changes.
 425  *
 426  * Revision 1.37  1998/02/01 03:39:54  curt
 427  * Minor tweaks.
 428  *
 429  * Revision 1.36  1998/01/31 00:43:13  curt
 430  * Added MetroWorks patches from Carmen Volpe.
 431  *
 432  * Revision 1.35  1998/01/27 00:47:57  curt
 433  * Incorporated Paul Bleisch's <bleisch@chromatic.com> new debug message
 434  * system and commandline/config file processing code.
 435  *
 436  * Revision 1.34  1998/01/22 02:59:37  curt
 437  * Changed #ifdef FILE_H to #ifdef _FILE_H
 438  *
 439  * Revision 1.33  1998/01/21 21:11:34  curt
 440  * Misc. tweaks.
 441  *
 442  * Revision 1.32  1998/01/19 19:27:08  curt
 443  * Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 444  * This should simplify things tremendously.
 445  *
 446  * Revision 1.31  1998/01/19 18:40:32  curt
 447  * Tons of little changes to clean up the code and to remove fatal errors
 448  * when building with the c++ compiler.
 449  *
 450  * Revision 1.30  1998/01/13 00:23:09  curt
 451  * Initial changes to support loading and management of scenery tiles.  Note,
 452  * there's still a fair amount of work left to be done.
 453  *
 454  * Revision 1.29  1998/01/08 02:22:08  curt
 455  * Beginning to integrate Tile management subsystem.
 456  *
 457  * Revision 1.28  1998/01/07 03:18:58  curt
 458  * Moved astronomical stuff from .../Src/Scenery to .../Src/Astro/
 459  *
 460  * Revision 1.27  1998/01/05 18:44:35  curt
 461  * Add an option to advance/decrease time from keyboard.
 462  *
 463  * Revision 1.26  1997/12/30 23:09:04  curt
 464  * Tweaking initialization sequences.
 465  *
 466  * Revision 1.25  1997/12/30 22:22:33  curt
 467  * Further integration of event manager.
 468  *
 469  * Revision 1.24  1997/12/30 20:47:44  curt
 470  * Integrated new event manager with subsystem initializations.
 471  *
 472  * Revision 1.23  1997/12/30 16:36:50  curt
 473  * Merged in Durk's changes ...
 474  *
 475  * Revision 1.22  1997/12/19 23:34:05  curt
 476  * Lot's of tweaking with sky rendering and lighting.
 477  *
 478  * Revision 1.21  1997/12/19 16:45:00  curt
 479  * Working on scene rendering order and options.
 480  *
 481  * Revision 1.20  1997/12/18 23:32:33  curt
 482  * First stab at sky dome actually starting to look reasonable. :-)
 483  *
 484  * Revision 1.19  1997/12/17 23:13:36  curt
 485  * Began working on rendering a sky.
 486  *
 487  * Revision 1.18  1997/12/15 23:54:49  curt
 488  * Add xgl wrappers for debugging.
 489  * Generate terrain normals on the fly.
 490  *
 491  * Revision 1.17  1997/12/15 20:59:09  curt
 492  * Misc. tweaks.
 493  *
 494  * Revision 1.16  1997/12/12 19:52:48  curt
 495  * Working on lightling and material properties.
 496  *
 497  * Revision 1.15  1997/12/11 04:43:55  curt
 498  * Fixed sun vector and lighting problems.  I thing the moon is now lit
 499  * correctly.
 500  *
 501  * Revision 1.14  1997/12/10 22:37:47  curt
 502  * Prepended "fg" on the name of all global structures that didn't have it yet.
 503  * i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 504  *
 505  * Revision 1.13  1997/11/25 19:25:32  curt
 506  * Changes to integrate Durk's moon/sun code updates + clean up.
 507  *
 508  * Revision 1.12  1997/11/15 18:16:35  curt
 509  * minor tweaks.
 510  *
 511  * Revision 1.11  1997/10/30 12:38:42  curt
 512  * Working on new scenery subsystem.
 513  *
 514  * Revision 1.10  1997/10/25 03:24:23  curt
 515  * Incorporated sun, moon, and star positioning code contributed by Durk Talsma.
 516  *
 517  * Revision 1.9  1997/09/23 00:29:39  curt
 518  * Tweaks to get things to compile with gcc-win32.
 519  *
 520  * Revision 1.8  1997/09/22 14:44:20  curt
 521  * Continuing to try to align stars correctly.
 522  *
 523  * Revision 1.7  1997/09/16 15:50:30  curt
 524  * Working on star alignment and time issues.
 525  *
 526  * Revision 1.6  1997/09/05 14:17:30  curt
 527  * More tweaking with stars.
 528  *
 529  * Revision 1.5  1997/09/04 02:17:36  curt
 530  * Shufflin' stuff.
 531  *
 532  * Revision 1.4  1997/08/27 21:32:26  curt
 533  * Restructured view calculation code.  Added stars.
 534  *
 535  * Revision 1.3  1997/08/27 03:30:19  curt
 536  * Changed naming scheme of basic shared structures.
 537  *
 538  * Revision 1.2  1997/08/25 20:27:23  curt
 539  * Merged in initial HUD and Joystick code.
 540  *
 541  * Revision 1.1  1997/08/23 01:46:20  curt
 542  * Initial revision.
 543  *
 544  */