Astro/stars.cxx

   1 // stars.cxx -- data structures and routines for managing and rendering stars.
   2 //
   3 // Written by Curtis Olson, started August 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@me.umn.edu
   6 //
   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.
  11 //
  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.
  16 //
  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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22 // (Log is kept at end of this file)
  23 //*************************************************************************/
  24
  25
  26 #ifdef HAVE_CONFIG_H
  27 #  include <config.h>
  28 #endif
  29
  30 #ifdef HAVE_WINDOWS_H
  31 #  include <windows.h>
  32 #endif
  33
  34 #include <math.h>
  35 #include <stdio.h>
  36 #include <string.h>
  37 #include <string>
  38 #include <time.h>
  39
  40 #include <GL/glut.h>
  41 #include <XGL/xgl.h>
  42
  43 #include <Aircraft/aircraft.hxx>
  44 #include <Debug/logstream.hxx>
  45 #include <Include/fg_constants.h>
  46 #include <Misc/fgstream.hxx>
  47 #include <Main/options.hxx>
  48 #include <Main/views.hxx>
  49 #include <Misc/stopwatch.hxx>
  50 #include <Time/fg_time.hxx>
  51
  52 #include "stars.hxx"
  53
  54
  55 #define EpochStart           (631065600)
  56 #define DaysSinceEpoch(secs) (((secs)-EpochStart)*(1.0/(24*3600)))
  57 #define FG_MAX_STARS 3500
  58
  59 // Define four structures, each with varying amounts of stars
  60 static GLint stars[FG_STAR_LEVELS];
  61
  62
  63 // Initialize the Star Management Subsystem
  64 int fgStarsInit( void ) {
  65     Point3D starlist[FG_MAX_STARS];
  66     // struct CelestialCoord pltPos;
  67     double right_ascension, declination, magnitude;
  68     double min_magnitude[FG_STAR_LEVELS];
  69     // double ra_save, decl_save;
  70     // double ra_save1, decl_save1;
  71     int i, j, starcount, count;
  72
  73     FG_LOG( FG_ASTRO, FG_INFO, "Initializing stars" );
  74
  75     if ( FG_STAR_LEVELS < 4 ) {
  76         FG_LOG( FG_ASTRO, FG_ALERT, "Big whups in stars.cxx" );
  77         exit(-1);
  78     }
  79
  80     // build the full path name to the stars data base file
  81     string path = current_options.get_fg_root() + "/Astro/stars" + ".gz";
  82
  83     FG_LOG( FG_ASTRO, FG_INFO, "  Loading stars from " << path );
  84
  85     fg_gzifstream in( path );
  86     if ( ! in ) {
  87         FG_LOG( FG_ASTRO, FG_ALERT, "Cannot open star file: " << path );
  88         exit(-1);
  89     }
  90
  91     starcount = 0;
  92
  93     StopWatch timer;
  94     timer.start();
  95
  96     // read in each line of the file
  97     while ( ! in.eof() && starcount < FG_MAX_STARS )
  98     {
  99         in >> skipcomment;
 100         string name;
 101         getline( in, name, ',' );
 102         in >> starlist[starcount];
 103         ++starcount;
 104     }
 105
 106     timer.stop();
 107     cerr << "Loaded " << starcount << " stars in "
 108          << timer.elapsedSeconds() << " seconds" << endl;
 109
 110     min_magnitude[0] = 4.2;
 111     min_magnitude[1] = 3.6;
 112     min_magnitude[2] = 3.0;
 113     min_magnitude[3] = 2.4;
 114     min_magnitude[4] = 1.8;
 115     min_magnitude[5] = 1.2;
 116     min_magnitude[6] = 0.6;
 117     min_magnitude[7] = 0.0;
 118
 119     // build the various star display lists
 120     for ( i = 0; i < FG_STAR_LEVELS; i++ ) {
 121
 122         stars[i] = xglGenLists(1);
 123         xglNewList( stars[i], GL_COMPILE );
 124         xglBegin( GL_POINTS );
 125
 126         count = 0;
 127
 128         for ( j = 0; j < starcount; j++ ) {
 129             magnitude = starlist[j].z();
 130             // printf("magnitude = %.2f\n", magnitude);
 131
 132             if ( magnitude < min_magnitude[i] ) {
 133                 right_ascension = starlist[j].x();
 134                 declination = starlist[j].y();
 135
 136                 count++;
 137
 138                 // scale magnitudes to (0.0 - 1.0)
 139                 magnitude = (0.0 - magnitude) / 5.0 + 1.0;
 140
 141                 // scale magnitudes again so they look ok
 142                 if ( magnitude > 1.0 ) { magnitude = 1.0; }
 143                 if ( magnitude < 0.0 ) { magnitude = 0.0; }
 144                 // magnitude =
 145                 //     magnitude * 0.7 + (((FG_STAR_LEVELS - 1) - i) * 0.042);
 146
 147                 magnitude = magnitude * 0.9 +
 148                     (((FG_STAR_LEVELS - 1) - i) * 0.014);
 149                 // printf("  Found star: %d %s, %.3f %.3f %.3f\n", count,
 150                 //        name, right_ascension, declination, magnitude);
 151
 152                 xglColor3f( magnitude, magnitude, magnitude );
 153                 //xglColor3f(0,0,0);*/
 154                 xglVertex3f( 50000.0*cos(right_ascension)*cos(declination),
 155                              50000.0*sin(right_ascension)*cos(declination),
 156                              50000.0*sin(declination) );
 157             }
 158         } // while
 159
 160         xglEnd();
 161
 162         /*
 163         xglBegin(GL_LINE_LOOP);
 164         xglColor3f(1.0, 0.0, 0.0);
 165         xglVertex3f( 50000.0 * cos(ra_save-0.2) * cos(decl_save-0.2),
 166                     50000.0 * sin(ra_save-0.2) * cos(decl_save-0.2),
 167                     50000.0 * sin(decl_save-0.2) );
 168         xglVertex3f( 50000.0 * cos(ra_save+0.2) * cos(decl_save-0.2),
 169                     50000.0 * sin(ra_save+0.2) * cos(decl_save-0.2),
 170                     50000.0 * sin(decl_save-0.2) );
 171         xglVertex3f( 50000.0 * cos(ra_save+0.2) * cos(decl_save+0.2),
 172                     50000.0 * sin(ra_save+0.2) * cos(decl_save+0.2),
 173                     50000.0 * sin(decl_save+0.2) );
 174         xglVertex3f( 50000.0 * cos(ra_save-0.2) * cos(decl_save+0.2),
 175                     50000.0 * sin(ra_save-0.2) * cos(decl_save+0.2),
 176                     50000.0 * sin(decl_save+0.2) );
 177         xglEnd();
 178         */
 179
 180         /*
 181         xglBegin(GL_LINE_LOOP);
 182         xglColor3f(0.0, 1.0, 0.0);
 183         xglVertex3f( 50000.0 * cos(ra_save1-0.2) * cos(decl_save1-0.2),
 184                     50000.0 * sin(ra_save1-0.2) * cos(decl_save1-0.2),
 185                     50000.0 * sin(decl_save1-0.2) );
 186         xglVertex3f( 50000.0 * cos(ra_save1+0.2) * cos(decl_save1-0.2),
 187                     50000.0 * sin(ra_save1+0.2) * cos(decl_save1-0.2),
 188                     50000.0 * sin(decl_save1-0.2) );
 189         xglVertex3f( 50000.0 * cos(ra_save1+0.2) * cos(decl_save1+0.2),
 190                     50000.0 * sin(ra_save1+0.2) * cos(decl_save1+0.2),
 191                     50000.0 * sin(decl_save1+0.2) );
 192         xglVertex3f( 50000.0 * cos(ra_save1-0.2) * cos(decl_save1+0.2),
 193                     50000.0 * sin(ra_save1-0.2) * cos(decl_save1+0.2),
 194                     50000.0 * sin(decl_save1+0.2) );
 195         xglEnd();
 196         */
 197
 198         xglEndList();
 199
 200         FG_LOG( FG_ASTRO, FG_INFO,
 201                 "  Loading " << count << " stars brighter than "
 202                 << min_magnitude[i] );
 203     }
 204
 205     return 1;  // OK, we got here because initialization worked.
 206 }
 207
 208
 209 // Draw the Stars
 210 void fgStarsRender( void ) {
 211     fgFLIGHT *f;
 212     fgVIEW *v;
 213     fgLIGHT *l;
 214     fgTIME *t;
 215     int i;
 216
 217     f = current_aircraft.flight;
 218     l = &cur_light_params;
 219     t = &cur_time_params;
 220     v = &current_view;
 221
 222     // FG_PI_2 + 0.1 is about 6 degrees after sundown and before sunrise
 223
 224     // t->sun_angle = 3.0; // to force stars to be drawn (for testing)
 225
 226     // render the stars
 227     if ( l->sun_angle > (FG_PI_2 + 5 * DEG_TO_RAD ) ) {
 228         // determine which star structure to draw
 229         if ( l->sun_angle > (FG_PI_2 + 10.0 * DEG_TO_RAD ) ) {
 230             i = 0;
 231         } else if ( l->sun_angle > (FG_PI_2 + 8.8 * DEG_TO_RAD ) ) {
 232             i = 1;
 233         } else if ( l->sun_angle > (FG_PI_2 + 7.5 * DEG_TO_RAD ) ) {
 234             i = 2;
 235         } else if ( l->sun_angle > (FG_PI_2 + 7.0 * DEG_TO_RAD ) ) {
 236             i = 3;
 237         } else if ( l->sun_angle > (FG_PI_2 + 6.5 * DEG_TO_RAD ) ) {
 238             i = 4;
 239         } else if ( l->sun_angle > (FG_PI_2 + 6.0 * DEG_TO_RAD ) ) {
 240             i = 5;
 241         } else if ( l->sun_angle > (FG_PI_2 + 5.5 * DEG_TO_RAD ) ) {
 242             i = 6;
 243         } else {
 244             i = 7;
 245         }
 246
 247         // printf("RENDERING STARS = %d (night)\n", i);
 248
 249         xglCallList(stars[i]);
 250     } else {
 251         // printf("not RENDERING STARS (day)\n");
 252     }
 253 }
 254
 255
 256 // $Log$
 257 // Revision 1.21  1998/11/06 21:17:42  curt
 258 // Converted to new logstream debugging facility.  This allows release
 259 // builds with no messages at all (and no performance impact) by using
 260 // the -DFG_NDEBUG flag.
 261 //
 262 // Revision 1.20  1998/11/06 14:47:02  curt
 263 // Changes to track Bernie's updates to fgstream.
 264 //
 265 // Revision 1.19  1998/10/16 23:27:21  curt
 266 // C++-ifying.
 267 //
 268 // Revision 1.18  1998/10/16 00:52:20  curt
 269 // Converted to Point3D class.
 270 //
 271 // Revision 1.17  1998/09/24 15:36:19  curt
 272 // Converted to c++ style comments.
 273 //
 274 // Revision 1.16  1998/09/24 15:25:24  curt
 275 // Miscellaneous tweaks.
 276 //
 277 //
 278 // Revision 1.15  1998/09/17 18:25:12  curt
 279 // Fixed output message.
 280 //
 281 // Revision 1.14  1998/09/15 04:26:22  curt
 282 // New textured moon and rewritten/restructured Astro code contributed by Durk
 283 // Talsma.
 284 //
 285 // Revision 1.13  1998/09/01 19:03:04  curt
 286 // Changes contributed by Bernie Bright <bbright@c031.aone.net.au>
 287 //  - The new classes in libmisc.tgz define a stream interface into zlib.
 288 //    I've put these in a new directory, Lib/Misc.  Feel free to rename it
 289 //    to something more appropriate.  However you'll have to change the
 290 //    include directives in all the other files.  Additionally you'll have
 291 //    add the library to Lib/Makefile.am and Simulator/Main/Makefile.am.
 292 //
 293 //    The StopWatch class in Lib/Misc requires a HAVE_GETRUSAGE autoconf
 294 //    test so I've included the required changes in config.tgz.
 295 //
 296 //    There are a fair few changes to Simulator/Objects as I've moved
 297 //    things around.  Loading tiles is quicker but thats not where the delay
 298 //    is.  Tile loading takes a few tenths of a second per file on a P200
 299 //    but it seems to be the post-processing that leads to a noticeable
 300 //    blip in framerate.  I suppose its time to start profiling to see where
 301 //    the delays are.
 302 //
 303 //    I've included a brief description of each archives contents.
 304 //
 305 // Lib/Misc/
 306 //   zfstream.cxx
 307 //   zfstream.hxx
 308 //     C++ stream interface into zlib.
 309 //     Taken from zlib-1.1.3/contrib/iostream/.
 310 //     Minor mods for STL compatibility.
 311 //     There's no copyright associated with these so I assume they're
 312 //     covered by zlib's.
 313 //
 314 //   fgstream.cxx
 315 //   fgstream.hxx
 316 //     FlightGear input stream using gz_ifstream.  Tries to open the
 317 //     given filename.  If that fails then filename is examined and a
 318 //     ".gz" suffix is removed or appended and that file is opened.
 319 //
 320 //   stopwatch.hxx
 321 //     A simple timer for benchmarking.  Not used in production code.
 322 //     Taken from the Blitz++ project.  Covered by GPL.
 323 //
 324 //   strutils.cxx
 325 //   strutils.hxx
 326 //     Some simple string manipulation routines.
 327 //
 328 // Simulator/Airports/
 329 //   Load airports database using fgstream.
 330 //   Changed fgAIRPORTS to use set<> instead of map<>.
 331 //   Added bool fgAIRPORTS::search() as a neater way doing the lookup.
 332 //   Returns true if found.
 333 //
 334 // Simulator/Astro/
 335 //   Modified fgStarsInit() to load stars database using fgstream.
 336 //
 337 // Simulator/Objects/
 338 //   Modified fgObjLoad() to use fgstream.
 339 //   Modified fgMATERIAL_MGR::load_lib() to use fgstream.
 340 //   Many changes to fgMATERIAL.
 341 //   Some changes to fgFRAGMENT but I forget what!
 342 //
 343 // Revision 1.12  1998/08/27 17:02:01  curt
 344 // Contributions from Bernie Bright <bbright@c031.aone.net.au>
 345 // - use strings for fg_root and airport_id and added methods to return
 346 //   them as strings,
 347 // - inlined all access methods,
 348 // - made the parsing functions private methods,
 349 // - deleted some unused functions.
 350 // - propogated some of these changes out a bit further.
 351 //
 352 // Revision 1.11  1998/08/25 20:53:29  curt
 353 // Shuffled $FG_ROOT file layout.
 354 //
 355 // Revision 1.10  1998/08/10 20:33:09  curt
 356 // Rewrote star loading and rendering to:
 357 //   1. significantly improve load speed
 358 //   2. transition from no stars to stars through eight stages.
 359 //
 360 // Revision 1.9  1998/08/06 12:45:20  curt
 361 // Modified to bring in stars in 8 increments based on magnitude, not number
 362 // of stars.
 363 //
 364 // Revision 1.8  1998/07/13 21:00:10  curt
 365 // Wrote access functions for current fgOPTIONS.
 366 //
 367 // Revision 1.7  1998/05/29 20:35:42  curt
 368 // Added zlib support for reading in compressed data files.
 369 //
 370 // Revision 1.6  1998/05/13 18:25:35  curt
 371 // Root path info moved to fgOPTIONS.
 372 //
 373 // Revision 1.5  1998/04/28 01:19:03  curt
 374 // Type-ified fgTIME and fgVIEW
 375 //
 376 // Revision 1.4  1998/04/26 05:10:02  curt
 377 // "struct fgLIGHT" -> "fgLIGHT" because fgLIGHT is typedef'd.
 378 //
 379 // Revision 1.3  1998/04/25 22:06:26  curt
 380 // Edited cvs log messages in source files ... bad bad bad!
 381 //
 382 // Revision 1.2  1998/04/24 00:45:03  curt
 383 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
 384 // Fixed a bug when generating sky colors.
 385 //
 386 // Revision 1.1  1998/04/22 13:21:34  curt
 387 // C++ - ifing the code a bit.
 388 //
 389 // Revision 1.11  1998/04/18 04:13:58  curt
 390 // Moved fg_debug.c to it's own library.
 391 //
 392 // Revision 1.10  1998/04/03 21:52:51  curt
 393 // Converting to Gnu autoconf system.
 394 //
 395 // Revision 1.9  1998/03/14 00:27:12  curt
 396 // Updated fgGENERAL to a "type" of struct.
 397 //
 398 // Revision 1.8  1998/02/12 21:59:38  curt
 399 // Incorporated code changes contributed by Charlie Hotchkiss
 400 // <chotchkiss@namg.us.anritsu.com>
 401 //
 402 // Revision 1.7  1998/02/09 15:07:48  curt
 403 // Minor tweaks.
 404 //
 405 // Revision 1.6  1998/02/02 20:53:23  curt
 406 // To version 0.29
 407 //
 408 // Revision 1.5  1998/01/27 18:35:53  curt
 409 // Minor tweaks.
 410 //
 411 // Revision 1.4  1998/01/27 00:47:49  curt
 412 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
 413 // system and commandline/config file processing code.
 414 //
 415 // Revision 1.3  1998/01/19 19:26:59  curt
 416 // Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 417 // This should simplify things tremendously.
 418 //
 419 // Revision 1.2  1998/01/19 18:40:18  curt
 420 // Tons of little changes to clean up the code and to remove fatal errors
 421 // when building with the c++ compiler.
 422 //
 423 // Revision 1.1  1998/01/07 03:16:20  curt
 424 // Moved from .../Src/Scenery/ to .../Src/Astro/
 425 //
 426 // Revision 1.24  1997/12/30 22:22:39  curt
 427 // Further integration of event manager.
 428 //
 429 // Revision 1.23  1997/12/30 20:47:53  curt
 430 // Integrated new event manager with subsystem initializations.
 431 //
 432 // Revision 1.22  1997/12/30 16:36:53  curt
 433 // Merged in Durk's changes ...
 434 //
 435 // Revision 1.21  1997/12/19 23:35:00  curt
 436 // Lot's of tweaking with sky rendering and lighting.
 437 //
 438 // Revision 1.20  1997/12/15 23:55:03  curt
 439 // Add xgl wrappers for debugging.
 440 // Generate terrain normals on the fly.
 441 //
 442 // Revision 1.19  1997/12/12  19:53:00  curt
 443 // Working on lightling and material properties.
 444 //
 445 // Revision 1.18  1997/12/10 22:37:52  curt
 446 // Prepended "fg" on the name of all global structures that didn't have it yet.
 447 // i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 448 //
 449 // Revision 1.17  1997/12/09 04:25:33  curt
 450 // Working on adding a global lighting params structure.
 451 //
 452 // Revision 1.16  1997/11/25 19:25:38  curt
 453 // Changes to integrate Durk's moon/sun code updates + clean up.
 454 //
 455 // Revision 1.15  1997/10/30 12:38:45  curt
 456 // Working on new scenery subsystem.
 457 //
 458 // Revision 1.14  1997/10/28 21:00:22  curt
 459 // Changing to new terrain format.
 460 //
 461 // Revision 1.13  1997/10/25 03:18:28  curt
 462 // Incorporated sun, moon, and planet position and rendering code contributed
 463 // by Durk Talsma.
 464 //
 465 // Revision 1.12  1997/09/23 00:29:43  curt
 466 // Tweaks to get things to compile with gcc-win32.
 467 //
 468 // Revision 1.11  1997/09/22 14:44:21  curt
 469 // Continuing to try to align stars correctly.
 470 //
 471 // Revision 1.10  1997/09/20 03:34:32  curt
 472 // Still trying to get those durned stars aligned properly.
 473 //
 474 // Revision 1.9  1997/09/18 16:20:09  curt
 475 // At dusk/dawn add/remove stars in stages.
 476 //
 477 // Revision 1.8  1997/09/16 22:14:52  curt
 478 // Tweaked time of day lighting equations.  Don't draw stars during the day.
 479 //
 480 // Revision 1.7  1997/09/16 15:50:31  curt
 481 // Working on star alignment and time issues.
 482 //
 483 // Revision 1.6  1997/09/05 14:17:31  curt
 484 // More tweaking with stars.
 485 //
 486 // Revision 1.5  1997/09/05 01:35:59  curt
 487 // Working on getting stars right.
 488 //
 489 // Revision 1.4  1997/09/04 02:17:38  curt
 490 // Shufflin' stuff.
 491 //
 492 // Revision 1.3  1997/08/29 17:55:28  curt
 493 // Worked on properly aligning the stars.
 494 //
 495 // Revision 1.2  1997/08/27 21:32:30  curt
 496 // Restructured view calculation code.  Added stars.
 497 //
 498 // Revision 1.1  1997/08/27 03:34:48  curt
 499 // Initial revision.
 500
 501