src/Time/light.hxx

   1 // light.hxx -- lighting routines
   2 //
   3 // Written by Curtis Olson, started April 1998.
   4 //
   5 // Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _LIGHT_HXX
  25 #define _LIGHT_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32
  33 #ifdef HAVE_CONFIG_H
  34 #  include <config.h>
  35 #endif
  36
  37 #ifdef HAVE_WINDOWS_H
  38 #  include <windows.h>
  39 #endif
  40
  41 #include <simgear/compiler.h>
  42
  43 #include <simgear/structure/subsystem_mgr.hxx>
  44 #include <simgear/math/interpolater.hxx>
  45 #include <simgear/math/point3d.hxx>
  46
  47
  48 // Define a structure containing the global lighting parameters
  49 class FGLight : public SGSubsystem
  50 {
  51
  52 private:
  53
  54     /*
  55      * Lighting look up tables (based on sun angle with local horizon)
  56      */
  57     SGInterpTable *_ambient_tbl, *_diffuse_tbl, *_specular_tbl;
  58     SGInterpTable *_sky_tbl;
  59
  60     /**
  61      * position of the sun and moon in various forms
  62      */
  63
  64     // in geocentric coordinates
  65     double _sun_lon, _sun_lat;
  66     double _moon_lon, _moon_gc_lat;
  67
  68     // in cartesian coordiantes
  69     SGVec3d _sunpos, _moonpos;
  70
  71     // (in view coordinates)
  72     SGVec4f _sun_vec, _moon_vec;
  73
  74     // inverse (in view coordinates)
  75     SGVec4f _sun_vec_inv, _moon_vec_inv;
  76
  77     // the angle between the celestial object and the local horizontal
  78     // (in radians)
  79     double _sun_angle, _moon_angle;
  80     double _prev_sun_angle;
  81
  82     // the rotation around our vertical axis of the sun (relative to
  83     // due south with positive numbers going in the counter clockwise
  84     // direction.)  This is the direction we'd need to face if we
  85     // wanted to travel towards celestial object.
  86     double _sun_rotation, _moon_rotation;
  87
  88     /**
  89      * Derived lighting values
  90      */
  91
  92     // ambient, diffuse and specular component
  93     SGVec4f _scene_ambient;
  94     SGVec4f _scene_diffuse;
  95     SGVec4f _scene_specular;
  96
  97     // clear sky, fog and cloud color
  98     SGVec4f _sky_color;
  99     SGVec4f _fog_color;
 100     SGVec4f _cloud_color;
 101
 102     // clear sky and fog color adjusted for sunset effects
 103     SGVec4f _adj_fog_color;
 104     SGVec4f _adj_sky_color;
 105
 106     double _dt_total;
 107
 108     void update_sky_color ();
 109     void update_adj_fog_color ();
 110
 111 public:
 112
 113     FGLight ();
 114     virtual ~FGLight ();
 115
 116     virtual void init ();
 117     virtual void reinit ();
 118     virtual void bind ();
 119     virtual void unbind ();
 120     virtual void update ( double dt );
 121
 122
 123     // Color related functions
 124
 125     inline const SGVec4f& scene_ambient () const { return _scene_ambient; }
 126     inline const SGVec4f& scene_diffuse () const { return _scene_diffuse; }
 127     inline const SGVec4f& scene_specular () const { return _scene_specular; }
 128
 129     inline const SGVec4f& sky_color () const { return _sky_color; }
 130     inline const SGVec4f& cloud_color () const { return _cloud_color; }
 131     inline const SGVec4f& adj_fog_color () const { return _adj_fog_color; }
 132
 133
 134     // Sun related functions
 135
 136     inline double get_sun_angle () const { return _sun_angle; }
 137     inline void set_sun_angle (double a) { _sun_angle = a; }
 138
 139     inline double get_sun_rotation () const { return _sun_rotation; }
 140     inline void set_sun_rotation (double r) { _sun_rotation = r; }
 141
 142     inline double get_sun_lon () const { return _sun_lon; }
 143     inline void set_sun_lon (double l) { _sun_lon = l; }
 144
 145     inline double get_sun_lat () const { return _sun_lat; }
 146     inline void set_sun_lat (double l) { _sun_lat = l; }
 147
 148     inline const SGVec3d& get_sunpos () const { return _sunpos; }
 149     inline void set_sunpos (const SGVec3d& p) { _sunpos = p; }
 150
 151     inline SGVec4f& sun_vec () { return _sun_vec; }
 152     inline SGVec4f& sun_vec_inv () { return _sun_vec_inv; }
 153
 154
 155     // Moon related functions
 156
 157     inline double get_moon_angle () const { return _moon_angle; }
 158     inline void set_moon_angle (double a) { _moon_angle = a; }
 159
 160     inline double get_moon_rotation () const { return _moon_rotation; }
 161     inline void set_moon_rotation (double r) { _moon_rotation = r; }
 162
 163     inline double get_moon_lon () const { return _moon_lon; }
 164     inline void set_moon_lon (double l) { _moon_lon = l; }
 165
 166     inline double get_moon_gc_lat () const { return _moon_gc_lat; }
 167     inline void set_moon_gc_lat (double l) { _moon_gc_lat = l; }
 168
 169     inline const SGVec3d& get_moonpos () const { return _moonpos; }
 170     inline void set_moonpos (const SGVec3d& p) { _moonpos = p; }
 171
 172     inline const SGVec4f& moon_vec () const { return _moon_vec; }
 173     inline const SGVec4f& moon_vec_inv () const { return _moon_vec_inv; }
 174 };
 175
 176 #endif // _LIGHT_HXX
 177