Weather/weather.h

   1 /**************************************************************************
   2  * weather.h -- routines to model weather
   3  *
   4  * Written by Curtis Olson, started July 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 _WEATHER_H
  28 #define _WEATHER_H
  29
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35
  36 /* holds the current weather values */
  37 struct fgWEATHER {
  38     float visibility;
  39     float fog_density;
  40 };
  41
  42 extern struct fgWEATHER current_weather;
  43
  44
  45 /* Initialize the weather modeling subsystem */
  46 void fgWeatherInit( void );
  47
  48
  49 /* Update the weather parameters for the current position */
  50 void fgWeatherUpdate( void );
  51
  52
  53 /* Get the current visibility */
  54 float fgWeatherGetVisibility( void );
  55
  56
  57 /* Set the visibility and update fog parameters */
  58 void fgWeatherSetVisibility( float visibility );
  59
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif
  64
  65
  66 #endif /* _WEATHER_H */
  67
  68
  69 /* $Log$
  70 /* Revision 1.10  1998/06/12 01:01:00  curt
  71 /* Build only static libraries.
  72 /* Declare memmove/memset for Sloaris.
  73 /* Added support for exponetial fog, which solves for the proper density to
  74 /* achieve the desired visibility range.
  75 /*
  76  * Revision 1.9  1998/04/21 17:02:46  curt
  77  * Prepairing for C++ integration.
  78  *
  79  * Revision 1.8  1998/01/22 02:59:44  curt
  80  * Changed #ifdef FILE_H to #ifdef _FILE_H
  81  *
  82  * Revision 1.7  1998/01/19 18:40:41  curt
  83  * Tons of little changes to clean up the code and to remove fatal errors
  84  * when building with the c++ compiler.
  85  *
  86  * Revision 1.6  1997/12/30 22:22:47  curt
  87  * Further integration of event manager.
  88  *
  89  * Revision 1.5  1997/12/10 22:37:56  curt
  90  * Prepended "fg" on the name of all global structures that didn't have it yet.
  91  * i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
  92  *
  93  * Revision 1.4  1997/08/27 03:30:39  curt
  94  * Changed naming scheme of basic shared structures.
  95  *
  96  * Revision 1.3  1997/08/22 21:34:43  curt
  97  * Doing a bit of reorganizing and house cleaning.
  98  *
  99  * Revision 1.2  1997/07/23 21:52:30  curt
 100  * Put comments around the text after an #endif for increased portability.
 101  *
 102  * Revision 1.1  1997/07/19 23:03:58  curt
 103  * Initial revision.
 104  *
 105  */