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