Time/fg_time.hxx

   1 //
   2 // fg_time.hxx -- 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 #ifndef _FG_TIME_HXX
  27 #define _FG_TIME_HXX
  28
  29
  30 #ifndef __cplusplus
  31 # error This library requires C++
  32 #endif
  33
  34
  35 #ifdef HAVE_CONFIG_H
  36 #  include <config.h>
  37 #endif
  38
  39 #ifdef HAVE_WINDOWS_H
  40 #  include <windows.h>
  41 #endif
  42
  43 #include <GL/glut.h>
  44 #include <time.h>
  45
  46 #include <Flight/flight.hxx>
  47
  48
  49 // Define a structure containing global time parameters
  50 typedef struct {
  51     // the date/time in various forms
  52     // Unix "calendar" time in seconds
  53     time_t cur_time;
  54
  55     // Break down of GMT time
  56     struct tm *gmt;
  57
  58     // Julian date
  59     double jd;
  60
  61     // modified Julian date
  62     double mjd;
  63
  64     // side real time at prime meridian
  65     double gst;
  66
  67     // local side real time
  68     double lst;
  69
  70     // the difference between the precise sidereal time algorithm
  71     // result and the course result.
  72     // course + diff has good accuracy for the short term
  73     double gst_diff;
  74
  75     // An offset in seconds from the true time.  Allows us to adjust
  76     // the effective time of day.
  77     long int warp;
  78
  79     // How much to change the value of warp each iteration.  Allows us
  80     // to make time progress faster than normal.
  81     long int warp_delta;
  82
  83     // Paused (0 = no, 1 = yes)
  84     int pause;
  85 } fgTIME;
  86
  87 extern fgTIME cur_time_params;
  88
  89
  90 typedef struct {
  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
 100 // Return duration in millis from first to last
 101 long timediff(fg_timestamp *first, fg_timestamp *last);
 102
 103
 104 // Return new timestamp given a time stamp and an interval to add in
 105 void timesum(fg_timestamp *res, fg_timestamp *start, long millis);
 106
 107
 108 // Update time variables such as gmt, julian date, and sidereal time
 109 void fgTimeInit(fgTIME *t);
 110
 111
 112 // Update the time dependent variables
 113 void fgTimeUpdate(fgFLIGHT *f, fgTIME *t);
 114
 115
 116 #endif // _FG_TIME_HXX
 117
 118
 119 // $Log$
 120 // Revision 1.8  1998/10/16 23:28:00  curt
 121 // C++-ifying.
 122 //
 123 // Revision 1.7  1998/10/16 00:56:09  curt
 124 // Converted to Point3D class.
 125 //
 126 // Revision 1.6  1998/07/27 18:42:22  curt
 127 // Added a pause option.
 128 //
 129 // Revision 1.5  1998/05/22 21:14:54  curt
 130 // Rewrote event.cxx in C++ as a class using STL for the internal event list
 131 // and run queue this removes the arbitrary list sizes and makes things much
 132 // more dynamic.  Because this is C++-classified we can now have multiple
 133 // event_tables if we'd ever want them.
 134 //
 135 // Revision 1.4  1998/04/28 01:22:17  curt
 136 // Type-ified fgTIME and fgVIEW.
 137 //
 138 // Revision 1.3  1998/04/25 22:06:34  curt
 139 // Edited cvs log messages in source files ... bad bad bad!
 140 //
 141 // Revision 1.2  1998/04/25 20:24:03  curt
 142 // Cleaned up initialization sequence to eliminate interdependencies
 143 // between sun position, lighting, and view position.  This creates a
 144 // valid single pass initialization path.
 145 //
 146 // Revision 1.1  1998/04/24 00:52:28  curt
 147 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
 148 // Fog color fixes.
 149 // Separated out lighting calcs into their own file.
 150 //
 151 // Revision 1.20  1998/04/22 13:24:05  curt
 152 // C++ - ifiing the code a bit.
 153 // Starting to reorginize some of the lighting calcs to use a table lookup.
 154 //
 155 // Revision 1.19  1998/04/21 17:01:44  curt
 156 // Fixed a problems where a pointer to a function was being passed around.  In
 157 // one place this functions arguments were defined as ( void ) while in another
 158 // place they were defined as ( int ).  The correct answer was ( int ).
 159 //
 160 // Prepairing for C++ integration.
 161 //
 162 // Revision 1.18  1998/04/08 23:35:40  curt
 163 // Tweaks to Gnu automake/autoconf system.
 164 //
 165 // Revision 1.17  1998/04/03 22:12:56  curt
 166 // Converting to Gnu autoconf system.
 167 // Centralized time handling differences.
 168 //
 169 // Revision 1.16  1998/02/07 15:29:47  curt
 170 // Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
 171 // <chotchkiss@namg.us.anritsu.com>
 172 //
 173 // Revision 1.15  1998/01/27 00:48:06  curt
 174 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
 175 // system and commandline/config file processing code.
 176 //
 177 // Revision 1.14  1998/01/22 02:59:43  curt
 178 // Changed #ifdef FILE_H to #ifdef _FILE_H
 179 //
 180 // Revision 1.13  1998/01/19 19:27:20  curt
 181 // Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 182 // This should simplify things tremendously.
 183 //
 184 // Revision 1.12  1998/01/05 18:44:37  curt
 185 // Add an option to advance/decrease time from keyboard.
 186 //
 187 // Revision 1.11  1997/12/19 23:35:07  curt
 188 // Lot's of tweaking with sky rendering and lighting.
 189 //
 190 // Revision 1.10  1997/12/15 23:55:07  curt
 191 // Add xgl wrappers for debugging.
 192 // Generate terrain normals on the fly.
 193 //
 194 // Revision 1.9  1997/12/10 22:37:55  curt
 195 // Prepended "fg" on the name of all global structures that didn't have it yet.
 196 // i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 197 //
 198 // Revision 1.8  1997/12/09 04:25:38  curt
 199 // Working on adding a global lighting params structure.
 200 //
 201 // Revision 1.7  1997/11/25 19:25:41  curt
 202 // Changes to integrate Durk's moon/sun code updates + clean up.
 203 //
 204 // Revision 1.6  1997/09/20 03:34:35  curt
 205 // Still trying to get those durned stars aligned properly.
 206 //
 207 // Revision 1.5  1997/09/16 15:50:31  curt
 208 // Working on star alignment and time issues.
 209 //
 210 // Revision 1.4  1997/09/13 02:00:08  curt
 211 // Mostly working on stars and generating sidereal time for accurate star
 212 // placement.
 213 //
 214 // Revision 1.3  1997/09/04 02:17:39  curt
 215 // Shufflin' stuff.
 216 //
 217 // Revision 1.2  1997/08/27 03:30:36  curt
 218 // Changed naming scheme of basic shared structures.
 219 //
 220 // Revision 1.1  1997/08/13 21:56:00  curt
 221 // Initial revision.
 222 //