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 #include <simgear/compiler.h>
  38
  39 #include <simgear/props/props.hxx>
  40 #include <simgear/structure/subsystem_mgr.hxx>
  41 #include <simgear/math/interpolater.hxx>
  42
  43
  44 // Define a structure containing the global lighting parameters
  45 class FGLight : public SGSubsystem
  46 {
  47
  48 private:
  49
  50     /*
  51      * Lighting look up tables (based on sun angle with local horizon)
  52      */
  53     SGInterpTable *_ambient_tbl, *_diffuse_tbl, *_specular_tbl;
  54     SGInterpTable *_sky_tbl;
  55
  56     /**
  57      * position of the sun and moon in various forms
  58      */
  59
  60     // in geocentric coordinates
  61     double _sun_lon, _sun_lat;
  62     double _moon_lon, _moon_gc_lat;
  63
  64     // (in view coordinates)
  65     SGVec4f _sun_vec, _moon_vec;
  66
  67     // inverse (in view coordinates)
  68     SGVec4f _sun_vec_inv, _moon_vec_inv;
  69
  70     // the angle between the celestial object and the local horizontal
  71     // (in radians)
  72     double _sun_angle, _moon_angle;
  73     double _prev_sun_angle;
  74
  75     // the rotation around our vertical axis of the sun (relative to
  76     // due south with positive numbers going in the counter clockwise
  77     // direction.)  This is the direction we'd need to face if we
  78     // wanted to travel towards celestial object.
  79     double _sun_rotation, _moon_rotation;
  80
  81     /**
  82      * Derived lighting values
  83      */
  84
  85     // ambient, diffuse and specular component
  86     SGVec4f _scene_ambient;
  87     SGVec4f _scene_diffuse;
  88     SGVec4f _scene_specular;
  89     SGVec4f _scene_chrome;
  90
  91     // clear sky, fog and cloud color
  92     SGVec4f _sky_color;
  93     SGVec4f _fog_color;
  94     SGVec4f _cloud_color;
  95
  96     // clear sky and fog color adjusted for sunset effects
  97     SGVec4f _adj_fog_color;
  98     SGVec4f _adj_sky_color;
  99
 100     double _dt_total;
 101
 102     void update_sky_color ();
 103     void update_adj_fog_color ();
 104
 105     // properties for chrome light; not a tie because I want to fire
 106     // property listeners when the values change.
 107     SGPropertyNode_ptr _chromeProps[4];
 108 public:
 109
 110     FGLight ();
 111     virtual ~FGLight ();
 112
 113     virtual void init ();
 114     virtual void reinit ();
 115     virtual void bind ();
 116     virtual void unbind ();
 117     virtual void update ( double dt );
 118
 119
 120     // Color related functions
 121
 122     inline const SGVec4f& scene_ambient () const { return _scene_ambient; }
 123     inline const SGVec4f& scene_diffuse () const { return _scene_diffuse; }
 124     inline const SGVec4f& scene_specular () const { return _scene_specular; }
 125     inline const SGVec4f& scene_chrome () const { return _scene_chrome; }
 126
 127     inline const SGVec4f& sky_color () const { return _sky_color; }
 128     inline const SGVec4f& cloud_color () const { return _cloud_color; }
 129     inline const SGVec4f& adj_fog_color () const { return _adj_fog_color; }
 130     inline const SGVec4f& adj_sky_color () const { return _adj_sky_color; }
 131
 132
 133     // Sun related functions
 134
 135     inline double get_sun_angle () const { return _sun_angle; }
 136     inline void set_sun_angle (double a) { _sun_angle = a; }
 137
 138     inline double get_sun_rotation () const { return _sun_rotation; }
 139     inline void set_sun_rotation (double r) { _sun_rotation = r; }
 140
 141     inline double get_sun_lon () const { return _sun_lon; }
 142     inline void set_sun_lon (double l) { _sun_lon = l; }
 143
 144     inline double get_sun_lat () const { return _sun_lat; }
 145     inline void set_sun_lat (double l) { _sun_lat = l; }
 146
 147     inline SGVec4f& sun_vec () { return _sun_vec; }
 148     inline SGVec4f& sun_vec_inv () { return _sun_vec_inv; }
 149
 150
 151     // Moon related functions
 152
 153     inline double get_moon_angle () const { return _moon_angle; }
 154     inline void set_moon_angle (double a) { _moon_angle = a; }
 155
 156     inline double get_moon_rotation () const { return _moon_rotation; }
 157     inline void set_moon_rotation (double r) { _moon_rotation = r; }
 158
 159     inline double get_moon_lon () const { return _moon_lon; }
 160     inline void set_moon_lon (double l) { _moon_lon = l; }
 161
 162     inline double get_moon_gc_lat () const { return _moon_gc_lat; }
 163     inline void set_moon_gc_lat (double l) { _moon_gc_lat = l; }
 164
 165     inline const SGVec4f& moon_vec () const { return _moon_vec; }
 166     inline const SGVec4f& moon_vec_inv () const { return _moon_vec_inv; }
 167 };
 168
 169 #endif // _LIGHT_HXX
 170