Time/fg_time.h

   1 /**************************************************************************
   2  * fg_time.h -- data structures and routines for managing time related stuff.
   3  *
   4  * Written by Curtis Olson, started August 1997.
   5  *
   6  * Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of the
  11  * License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *
  22  * $Id$
  23  * (Log is kept at end of this file)
  24  **************************************************************************/
  25
  26
  27 #ifndef _FG_TIME_H
  28 #define _FG_TIME_H
  29
  30
  31 // #ifdef WIN32
  32 // #  include <windows.h>
  33 // #endif
  34
  35 #include <GL/glut.h>
  36 #include <time.h>
  37
  38 #include <Include/fg_types.h>
  39 #include <Flight/flight.h>
  40
  41
  42 /* Define a structure containing global time parameters */
  43 struct fgTIME {
  44     /* the date/time in various forms */
  45     time_t cur_time;     /* Unix "calendar" time in seconds */
  46     struct tm *gmt;      /* Break down of GMT time */
  47
  48     double jd;           /* Julian date */
  49     double mjd;          /* modified Julian date */
  50
  51     double gst;          /* side real time at prime meridian */
  52     double lst;          /* local side real time */
  53
  54     double gst_diff;     /* the difference between the precise
  55                             sidereal time algorithm result and the
  56                             course result.  course + diff has good
  57                             accuracy for the short term */
  58
  59     long int warp;       /* An offset in seconds from the true time.
  60                             Allows us to adjust the effective time of day. */
  61
  62     long int warp_delta; /* How much to change the value of warp each
  63                             iteration.  Allows us to make time
  64                             progress faster than normal. */
  65 };
  66
  67 extern struct fgTIME cur_time_params;
  68
  69
  70 /* Lighting is time dependent so it shows up here */
  71 /* Define a structure containing the global lighting parameters */
  72 struct fgLIGHT {
  73     /* position of the sun in various forms */
  74     double sun_lon, sun_gc_lat;         /* in geocentric coordinates */
  75     struct fgCartesianPoint fg_sunpos;  /* in cartesian coordiantes */
  76     GLfloat sun_vec[4];                 /* (in view coordinates) */
  77     GLfloat sun_vec_inv[4];             /* inverse (in view coordinates) */
  78     double sun_angle;                   /* the angle between the sun and the
  79                                            local horizontal */
  80
  81     /* Derived lighting values */
  82     GLfloat scene_ambient[3];           /* ambient component */
  83     GLfloat scene_diffuse[3];           /* diffuse component */
  84     GLfloat fog_color[4];               /* fog color */
  85     GLfloat sky_color[4];               /* clear screen color */
  86 };
  87
  88 extern struct fgLIGHT cur_light_params;
  89
  90 typedef struct fg_timestamp_t {
  91     long seconds;
  92     long millis;
  93 } fg_timestamp;
  94
  95
  96 /* Portability wrap to get current time. */
  97 void timestamp(fg_timestamp *timestamp);
  98
  99 /* Return duration in millis from first to last */
 100 long timediff(fg_timestamp *first, fg_timestamp *last);
 101
 102 /* Return new timestamp given a time stamp and an interval to add in */
 103 void timesum(fg_timestamp *res, fg_timestamp *start, long millis);
 104
 105 /* Initialize the time dependent variables */
 106 void fgTimeInit(struct fgTIME *t);
 107
 108 /* Update the time dependent variables */
 109 void fgTimeUpdate(fgFLIGHT *f, struct fgTIME *t);
 110
 111
 112 #endif /* _FG_TIME_H */
 113
 114
 115 /* $Log$
 116 /* Revision 1.17  1998/04/03 22:12:56  curt
 117 /* Converting to Gnu autoconf system.
 118 /* Centralized time handling differences.
 119 /*
 120  * Revision 1.16  1998/02/07 15:29:47  curt
 121  * Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
 122  * <chotchkiss@namg.us.anritsu.com>
 123  *
 124  * Revision 1.15  1998/01/27 00:48:06  curt
 125  * Incorporated Paul Bleisch's <bleisch@chromatic.com> new debug message
 126  * system and commandline/config file processing code.
 127  *
 128  * Revision 1.14  1998/01/22 02:59:43  curt
 129  * Changed #ifdef FILE_H to #ifdef _FILE_H
 130  *
 131  * Revision 1.13  1998/01/19 19:27:20  curt
 132  * Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 133  * This should simplify things tremendously.
 134  *
 135  * Revision 1.12  1998/01/05 18:44:37  curt
 136  * Add an option to advance/decrease time from keyboard.
 137  *
 138  * Revision 1.11  1997/12/19 23:35:07  curt
 139  * Lot's of tweaking with sky rendering and lighting.
 140  *
 141  * Revision 1.10  1997/12/15 23:55:07  curt
 142  * Add xgl wrappers for debugging.
 143  * Generate terrain normals on the fly.
 144  *
 145  * Revision 1.9  1997/12/10 22:37:55  curt
 146  * Prepended "fg" on the name of all global structures that didn't have it yet.
 147  * i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 148  *
 149  * Revision 1.8  1997/12/09 04:25:38  curt
 150  * Working on adding a global lighting params structure.
 151  *
 152  * Revision 1.7  1997/11/25 19:25:41  curt
 153  * Changes to integrate Durk's moon/sun code updates + clean up.
 154  *
 155  * Revision 1.6  1997/09/20 03:34:35  curt
 156  * Still trying to get those durned stars aligned properly.
 157  *
 158  * Revision 1.5  1997/09/16 15:50:31  curt
 159  * Working on star alignment and time issues.
 160  *
 161  * Revision 1.4  1997/09/13 02:00:08  curt
 162  * Mostly working on stars and generating sidereal time for accurate star
 163  * placement.
 164  *
 165  * Revision 1.3  1997/09/04 02:17:39  curt
 166  * Shufflin' stuff.
 167  *
 168  * Revision 1.2  1997/08/27 03:30:36  curt
 169  * Changed naming scheme of basic shared structures.
 170  *
 171  * Revision 1.1  1997/08/13 21:56:00  curt
 172  * Initial revision.
 173  *
 174  */