src/Time/light.cxx

   1 //
   2 // light.cxx -- lighting routines
   3 //
   4 // Written by Curtis Olson, started April 1998.
   5 //
   6 // Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
   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
  24
  25 #ifdef HAVE_CONFIG_H
  26 #  include <config.h>
  27 #endif
  28
  29 #ifdef HAVE_WINDOWS_H
  30 #  include <windows.h>
  31 #endif
  32
  33 #include <simgear/compiler.h>
  34
  35 #include SG_GL_H
  36
  37 #ifdef SG_MATH_EXCEPTION_CLASH
  38 #  define exception c_exception
  39 #endif
  40
  41 #ifdef SG_HAVE_STD_INCLUDES
  42 #  include <cmath>
  43 #else
  44 #  include <math.h>
  45 #endif
  46
  47 #include <string>
  48 SG_USING_STD(string);
  49
  50 #include <simgear/constants.h>
  51 #include <simgear/debug/logstream.hxx>
  52 #include <simgear/math/interpolater.hxx>
  53 #include <simgear/math/polar3d.hxx>
  54 #include <simgear/misc/sg_path.hxx>
  55 #include <simgear/scene/sky/sky.hxx>
  56 #include <simgear/screen/colors.hxx>
  57
  58 #include <Main/main.hxx>
  59 #include <Main/globals.hxx>
  60 #include <Main/fg_props.hxx>
  61 #include <Main/renderer.hxx>
  62 #include <Main/viewer.hxx>
  63
  64 #include "light.hxx"
  65 #include "sunpos.hxx"
  66
  67
  68 // Constructor
  69 FGLight::FGLight ()
  70     : _ambient_tbl( NULL ),
  71       _diffuse_tbl( NULL ),
  72       _specular_tbl( NULL ),
  73       _sky_tbl( NULL ),
  74       _prev_sun_angle(-9999.0),
  75       _sun_rotation( 0.0 ),
  76       _dt_total( 0.0 )
  77 {
  78 }
  79
  80 // Destructor
  81 FGLight::~FGLight ()
  82 {
  83     delete _ambient_tbl;
  84     delete _diffuse_tbl;
  85     delete _specular_tbl;
  86     delete _sky_tbl;
  87 }
  88
  89
  90 // initialize lighting tables
  91 void FGLight::init () {
  92     SG_LOG( SG_EVENT, SG_INFO,
  93             "Initializing Lighting interpolation tables." );
  94
  95     // build the path names of the lookup tables
  96     SGPath path( globals->get_fg_root() );
  97
  98     // initialize ambient, diffuse and specular tables
  99     SGPath ambient_path = path;
 100     ambient_path.append( "Lighting/ambient" );
 101     _ambient_tbl = new SGInterpTable( ambient_path.str() );
 102
 103     SGPath diffuse_path = path;
 104     diffuse_path.append( "Lighting/diffuse" );
 105     _diffuse_tbl = new SGInterpTable( diffuse_path.str() );
 106
 107     SGPath specular_path = path;
 108     specular_path.append( "Lighting/specular" );
 109     _specular_tbl = new SGInterpTable( specular_path.str() );
 110
 111     // initialize sky table
 112     SGPath sky_path = path;
 113     sky_path.append( "Lighting/sky" );
 114     _sky_tbl = new SGInterpTable( sky_path.str() );
 115 }
 116
 117
 118 void FGLight::reinit () {
 119     _prev_sun_angle = -9999.0;
 120     _dt_total = 0;
 121
 122     delete _ambient_tbl;
 123     delete _diffuse_tbl;
 124     delete _specular_tbl;
 125     delete _sky_tbl;
 126
 127     init();
 128
 129     fgUpdateSunPos();
 130
 131     update_sky_color();
 132     update_adj_fog_color();
 133 }
 134
 135 void FGLight::bind () {
 136     SGPropertyNode *prop = globals->get_props();
 137     prop->tie("/sim/time/sun-angle-rad",SGRawValuePointer<double>(&_sun_angle));
 138 }
 139
 140 void FGLight::unbind () {
 141     SGPropertyNode *prop = globals->get_props();
 142     prop->untie("/sim/time/sun-angle-rad");
 143 }
 144
 145
 146 // update lighting parameters based on current sun position
 147 void FGLight::update( double dt ) {
 148
 149     _dt_total += dt;
 150     if (_dt_total >= 0.5) {
 151         _dt_total -= 0.5;
 152         fgUpdateSunPos();
 153     }
 154
 155     update_adj_fog_color();
 156
 157     if (_prev_sun_angle != _sun_angle) {
 158         _prev_sun_angle = _sun_angle;
 159         update_sky_color();
 160     }
 161 }
 162
 163 void FGLight::update_sky_color () {
 164     // if the 4th field is 0.0, this specifies a direction ...
 165     // const GLfloat white[4]          = { 1.0,  1.0,  1.0,  1.0 };
 166     const GLfloat base_sky_color[4] = { 0.31, 0.43, 0.69, 1.0 };
 167     const GLfloat base_fog_color[4] = { 0.84, 0.87, 1.0,  1.0 };
 168
 169     SG_LOG( SG_EVENT, SG_INFO, "Updating light parameters." );
 170
 171     // calculate lighting parameters based on sun's relative angle to
 172     // local up
 173
 174     float deg = _sun_angle * SGD_RADIANS_TO_DEGREES;
 175     SG_LOG( SG_EVENT, SG_INFO, "  Sun angle = " << deg );
 176
 177     float ambient = _ambient_tbl->interpolate( deg );
 178     float diffuse = _diffuse_tbl->interpolate( deg );
 179     float specular = _specular_tbl->interpolate( deg );
 180     float sky_brightness = _sky_tbl->interpolate( deg );
 181
 182     SG_LOG( SG_EVENT, SG_INFO,
 183             "  ambient = " << ambient << "  diffuse = " << diffuse
 184             << "  specular = " << specular << "  sky = " << sky_brightness );
 185
 186     // sky_brightness = 0.15;  // used to force a dark sky (when testing)
 187
 188     // if ( ambient < 0.02 ) { ambient = 0.02; }
 189     // if ( diffuse < 0.0 ) { diffuse = 0.0; }
 190     // if ( sky_brightness < 0.1 ) { sky_brightness = 0.1; }
 191
 192     // set sky color
 193     _sky_color[0] = base_sky_color[0] * sky_brightness;
 194     _sky_color[1] = base_sky_color[1] * sky_brightness;
 195     _sky_color[2] = base_sky_color[2] * sky_brightness;
 196     _sky_color[3] = base_sky_color[3];
 197     gamma_correct_rgb( _sky_color );
 198
 199     // set cloud and fog color
 200     _cloud_color[0] = _fog_color[0] = base_fog_color[0] * sky_brightness;
 201     _cloud_color[1] = _fog_color[1] = base_fog_color[1] * sky_brightness;
 202     _cloud_color[2] = _fog_color[2] = base_fog_color[2] * sky_brightness;
 203     _cloud_color[3] = _fog_color[3] = base_fog_color[3];
 204     gamma_correct_rgb( _fog_color );
 205
 206     // adjust the cloud colors for sunrise/sunset effects (darken them)
 207     if (_sun_angle > 1.0) {
 208        float sun2 = sqrt(_sun_angle);
 209        _cloud_color[0] /= sun2;
 210        _cloud_color[1] /= sun2;
 211        _cloud_color[2] /= sun2;
 212     }
 213     gamma_correct_rgb( _cloud_color );
 214
 215     float *sun_color = thesky->get_sun_color();
 216
 217     _scene_ambient[0] = ((sun_color[0]*0.25 + _cloud_color[0]*0.75) + ambient) / 2;
 218     _scene_ambient[1] = ((sun_color[1]*0.25 + _cloud_color[1]*0.75) + ambient) / 2;
 219     _scene_ambient[2] = ((sun_color[2]*0.25 + _cloud_color[2]*0.75) + ambient) / 2;
 220     _scene_ambient[3] = 1.0;
 221
 222     _scene_diffuse[0] = (sun_color[0]*0.25 + _fog_color[0]*0.75) * diffuse;
 223     _scene_diffuse[1] = (sun_color[1]*0.25 + _fog_color[1]*0.75) * diffuse;
 224     _scene_diffuse[2] = (sun_color[2]*0.25 + _fog_color[2]*0.75) * diffuse;
 225     _scene_diffuse[3] = 1.0;
 226
 227     _scene_specular[0] = sun_color[0] * specular;
 228     _scene_specular[1] = sun_color[1] * specular;
 229     _scene_specular[2] = sun_color[2] * specular;
 230     _scene_specular[3] = 1.0;
 231 }
 232
 233
 234 // calculate fog color adjusted for sunrise/sunset effects
 235 void FGLight::update_adj_fog_color () {
 236
 237     double heading = globals->get_current_view()->getHeading_deg()
 238                      * SGD_DEGREES_TO_RADIANS;
 239     double heading_offset = globals->get_current_view()->getHeadingOffset_deg()
 240                             * SGD_DEGREES_TO_RADIANS;
 241
 242     SG_LOG( SG_EVENT, SG_DEBUG, "Updating adjusted fog parameters." );
 243
 244     // set fog color (we'll try to match the sunset color in the
 245     // direction we are looking
 246
 247     // Do some sanity checking ...
 248     if ( _sun_rotation < -2.0 * SGD_2PI || _sun_rotation > 2.0 * SGD_2PI ) {
 249         SG_LOG( SG_EVENT, SG_ALERT, "Sun rotation bad = " << _sun_rotation );
 250         return;
 251     }
 252
 253     if ( heading < -2.0 * SGD_2PI || heading > 2.0 * SGD_2PI ) {
 254         SG_LOG( SG_EVENT, SG_ALERT, "Heading rotation bad = " << heading );
 255         return;
 256     }
 257
 258     if ( heading_offset < -2.0 * SGD_2PI || heading_offset > 2.0 * SGD_2PI ) {
 259         SG_LOG( SG_EVENT, SG_ALERT, "Heading offset bad = " << heading_offset );
 260         return;
 261     }
 262
 263     double rotation;
 264
 265     // first determine the difference between our view angle and local
 266     // direction to the sun
 267     rotation = -(_sun_rotation + SGD_PI) - heading + heading_offset;
 268     while ( rotation < 0 ) {
 269         rotation += SGD_2PI;
 270     }
 271     while ( rotation > SGD_2PI ) {
 272         rotation -= SGD_2PI;
 273     }
 274
 275     // revert to unmodified values before usign them.
 276     //
 277     float *sun_color = thesky->get_sun_color();
 278
 279     gamma_restore_rgb( _fog_color );
 280
 281     // Calculate the fog color in the direction of the sun for
 282     // sunrise/sunset effects.
 283     //
 284     float s_red =   (_fog_color[0] + 2 * sun_color[0]*sun_color[0]) / 3;
 285     float s_green = (_fog_color[1] + 2 * sun_color[1]*sun_color[1]) / 3;
 286     float s_blue =  (_fog_color[2] + 2 * sun_color[2]) / 3;
 287
 288     // interpolate beween the sunrise/sunset color and the color
 289     // at the opposite direction of this effect. Take in account
 290     // the current visibility.
 291     //
 292     float av = thesky->get_visibility();
 293     if (av > 45000)
 294        av = 45000;
 295
 296     float avf = 0.87 - (45000 - av) / 83333.33;
 297     float sif = 0.5 - cos(_sun_angle*2)/2;
 298
 299     if (sif < 1e-4)
 300        sif = 1e-4;
 301
 302     float rf1 = fabs((rotation - SGD_PI) / SGD_PI);             // 0.0 .. 1.0
 303     float rf2 = avf * pow(rf1 * rf1, 1/sif);
 304     float rf3 = 0.94 - rf2;
 305
 306     _adj_fog_color[0] = rf3 * _fog_color[0] + rf2 * s_red;
 307     _adj_fog_color[1] = rf3 * _fog_color[1] + rf2 * s_green;
 308     _adj_fog_color[2] = rf3 * _fog_color[2] + rf2 * s_blue;
 309     gamma_correct_rgb( _adj_fog_color );
 310
 311     // make sure the colors have their original value before they are being
 312     // used by the rest of the program.
 313     //
 314     gamma_correct_rgb( _fog_color );
 315 }
 316