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 #include <simgear/compiler.h>
  30
  31 #include <cmath>
  32
  33 #include <simgear/constants.h>
  34 #include <simgear/debug/logstream.hxx>
  35 #include <simgear/math/interpolater.hxx>
  36 #include <simgear/misc/sg_path.hxx>
  37 #include <simgear/scene/sky/sky.hxx>
  38 #include <simgear/screen/colors.hxx>
  39 #include <simgear/timing/sg_time.hxx>
  40 #include <simgear/structure/event_mgr.hxx>
  41
  42 #include <Main/main.hxx>
  43 #include <Main/globals.hxx>
  44 #include <Main/fg_props.hxx>
  45 #include <Main/renderer.hxx>
  46 #include <Main/viewer.hxx>
  47
  48 #include "light.hxx"
  49 #include "sunsolver.hxx"
  50
  51 /**
  52  * Map i.e. project a vector onto a plane.
  53  * @param normal (in) normal vector for the plane
  54  * @param v0 (in) a point on the plane
  55  * @param vec (in) the vector to map onto the plane
  56  */
  57 static SGVec3f map_vec_onto_cur_surface_plane(const SGVec3f& normal,
  58                                               const SGVec3f& v0,
  59                                               const SGVec3f& vec)
  60 {
  61     // calculate a vector "u1" representing the shortest distance from
  62     // the plane specified by normal and v0 to a point specified by
  63     // "vec".  "u1" represents both the direction and magnitude of
  64     // this desired distance.
  65
  66     // u1 = ( (normal <dot> vec) / (normal <dot> normal) ) * normal
  67     SGVec3f u1 = (dot(normal, vec) / dot(normal, normal)) * normal;
  68
  69     // calculate the vector "v" which is the vector "vec" mapped onto
  70     // the plane specified by "normal" and "v0".
  71
  72     // v = v0 + vec - u1
  73     SGVec3f v = v0 + vec - u1;
  74
  75     // Calculate the vector "result" which is "v" - "v0" which is a
  76     // directional vector pointing from v0 towards v
  77
  78     // result = v - v0
  79     return v - v0;
  80 }
  81
  82
  83 // Constructor
  84 FGLight::FGLight ()
  85     : _ambient_tbl( NULL ),
  86       _diffuse_tbl( NULL ),
  87       _specular_tbl( NULL ),
  88       _sky_tbl( NULL ),
  89       _sun_lon(0),
  90       _sun_lat(0),
  91       _moon_lon(0),
  92       _moon_gc_lat(0),
  93       _sun_vec(0, 0, 0, 0),
  94       _moon_vec(0, 0, 0, 0),
  95       _sun_vec_inv(0, 0, 0, 0),
  96       _moon_vec_inv(0, 0, 0, 0),
  97       _sun_angle(0),
  98       _moon_angle(0),
  99       _prev_sun_angle(0),
 100       _sun_rotation(0),
 101       _moon_rotation(0),
 102       _scene_ambient(0, 0, 0, 0),
 103       _scene_diffuse(0, 0, 0, 0),
 104       _scene_specular(0, 0, 0, 0),
 105       _scene_chrome(0, 0, 0, 0),
 106       _sky_color(0, 0, 0, 0),
 107       _fog_color(0, 0, 0, 0),
 108       _cloud_color(0, 0, 0, 0),
 109       _adj_fog_color(0, 0, 0, 0),
 110       _adj_sky_color(0, 0, 0, 0),
 111       _saturation(1.0),
 112       _dt_total(0)
 113 {
 114 }
 115
 116 // Destructor
 117 FGLight::~FGLight ()
 118 {
 119     delete _ambient_tbl;
 120     delete _diffuse_tbl;
 121     delete _specular_tbl;
 122     delete _sky_tbl;
 123 }
 124
 125
 126 // initialize lighting tables
 127 void FGLight::init () {
 128     SG_LOG( SG_EVENT, SG_INFO,
 129             "Initializing Lighting interpolation tables." );
 130
 131     // build the path names of the lookup tables
 132     SGPath path( globals->get_fg_root() );
 133
 134     // initialize ambient, diffuse and specular tables
 135     SGPath ambient_path = path;
 136     ambient_path.append( "Lighting/ambient" );
 137     _ambient_tbl = new SGInterpTable( ambient_path.str() );
 138
 139     SGPath diffuse_path = path;
 140     diffuse_path.append( "Lighting/diffuse" );
 141     _diffuse_tbl = new SGInterpTable( diffuse_path.str() );
 142
 143     SGPath specular_path = path;
 144     specular_path.append( "Lighting/specular" );
 145     _specular_tbl = new SGInterpTable( specular_path.str() );
 146
 147     // initialize sky table
 148     SGPath sky_path = path;
 149     sky_path.append( "Lighting/sky" );
 150     _sky_tbl = new SGInterpTable( sky_path.str() );
 151
 152     globals->get_event_mgr()->addTask("updateSunPos", this,
 153                             &FGLight::updateSunPos, 0.5 );
 154 }
 155
 156
 157 void FGLight::reinit () {
 158     _prev_sun_angle = -9999.0;
 159     _dt_total = 0;
 160
 161     delete _ambient_tbl;
 162     delete _diffuse_tbl;
 163     delete _specular_tbl;
 164     delete _sky_tbl;
 165
 166     init();
 167
 168     updateSunPos();
 169     update_sky_color();
 170     update_adj_fog_color();
 171 }
 172
 173 void FGLight::bind () {
 174     SGPropertyNode *prop = globals->get_props();
 175     prop->tie("/sim/time/sun-angle-rad",SGRawValuePointer<double>(&_sun_angle));
 176     prop->tie("/rendering/scene/saturation",SGRawValuePointer<float>(&_saturation));
 177     prop->tie("/rendering/scene/ambient/red",SGRawValuePointer<float>(&_scene_ambient[0]));
 178     prop->tie("/rendering/scene/ambient/green",SGRawValuePointer<float>(&_scene_ambient[1]));
 179     prop->tie("/rendering/scene/ambient/blue",SGRawValuePointer<float>(&_scene_ambient[2]));
 180     prop->tie("/rendering/scene/diffuse/red",SGRawValuePointer<float>(&_scene_diffuse[0]));
 181     prop->tie("/rendering/scene/diffuse/green",SGRawValuePointer<float>(&_scene_diffuse[1]));
 182     prop->tie("/rendering/scene/diffuse/blue",SGRawValuePointer<float>(&_scene_diffuse[2]));
 183     prop->tie("/rendering/scene/specular/red",SGRawValuePointer<float>(&_scene_specular[0]));
 184     prop->tie("/rendering/scene/specular/green",SGRawValuePointer<float>(&_scene_specular[1]));
 185     prop->tie("/rendering/scene/specular/blue",SGRawValuePointer<float>(&_scene_specular[2]));
 186     prop->tie("/rendering/dome/sky/red",SGRawValuePointer<float>(&_sky_color[0]));
 187     prop->tie("/rendering/dome/sky/green",SGRawValuePointer<float>(&_sky_color[1]));
 188     prop->tie("/rendering/dome/sky/blue",SGRawValuePointer<float>(&_sky_color[2]));
 189     prop->tie("/rendering/dome/fog/red",SGRawValuePointer<float>(&_fog_color[0]));
 190     prop->tie("/rendering/dome/fog/green",SGRawValuePointer<float>(&_fog_color[1]));
 191     prop->tie("/rendering/dome/fog/blue",SGRawValuePointer<float>(&_fog_color[2]));
 192     // Properties used directly by effects
 193     _chromeProps[0] = prop->getNode("/rendering/scene/chrome-light/red", true);
 194     _chromeProps[1] = prop->getNode("/rendering/scene/chrome-light/green",
 195                                     true);
 196     _chromeProps[2] = prop->getNode("/rendering/scene/chrome-light/blue", true);
 197     _chromeProps[3] = prop->getNode("/rendering/scene/chrome-light/alpha",
 198                                     true);
 199     for (int i = 0; i < 4; ++i)
 200         _chromeProps[i]->setValue(0.0);
 201 }
 202
 203 void FGLight::unbind () {
 204     SGPropertyNode *prop = globals->get_props();
 205     prop->untie("/sim/time/sun-angle-rad");
 206     prop->untie("/rendering/scene/saturation");
 207     prop->untie("/rendering/scene/ambient/red");
 208     prop->untie("/rendering/scene/ambient/green");
 209     prop->untie("/rendering/scene/ambient/blue");
 210     prop->untie("/rendering/scene/diffuse/red");
 211     prop->untie("/rendering/scene/diffuse/green");
 212     prop->untie("/rendering/scene/diffuse/blue");
 213     prop->untie("/rendering/scene/specular/red");
 214     prop->untie("/rendering/scene/specular/green");
 215     prop->untie("/rendering/scene/specular/blue");
 216     prop->untie("/rendering/dome/sun/red");
 217     prop->untie("/rendering/dome/sun/green");
 218     prop->untie("/rendering/dome/sun/blue");
 219     prop->untie("/rendering/dome/sky/red");
 220     prop->untie("/rendering/dome/sky/green");
 221     prop->untie("/rendering/dome/sky/blue");
 222     prop->untie("/rendering/dome/fog/red");
 223     prop->untie("/rendering/dome/fog/green");
 224     prop->untie("/rendering/dome/fog/blue");
 225 }
 226
 227
 228 // update lighting parameters based on current sun position
 229 void FGLight::update( double dt )
 230 {
 231     update_adj_fog_color();
 232
 233     if (_prev_sun_angle != _sun_angle) {
 234         _prev_sun_angle = _sun_angle;
 235         update_sky_color();
 236     }
 237 }
 238
 239 void FGLight::update_sky_color () {
 240     // if the 4th field is 0.0, this specifies a direction ...
 241     // const GLfloat white[4]          = { 1.0,  1.0,  1.0,  1.0 };
 242     const GLfloat base_sky_color[4] = { 0.31, 0.43, 0.69, 1.0 };
 243     const GLfloat base_fog_color[4] = { 0.63, 0.72, 0.88,  1.0 };
 244
 245     SG_LOG( SG_EVENT, SG_DEBUG, "Updating light parameters." );
 246
 247     // calculate lighting parameters based on sun's relative angle to
 248     // local up
 249     static SGConstPropertyNode_ptr humidity = fgGetNode("/environment/relative-humidity");
 250     float av = humidity->getFloatValue() * 45;
 251     float visibility_log = log(av)/11.0;
 252     float visibility_inv = (45000.0 - av)/45000.0;
 253
 254     float deg = _sun_angle * SGD_RADIANS_TO_DEGREES;
 255     SG_LOG( SG_EVENT, SG_DEBUG, "  Sun angle = " << deg );
 256
 257     if (_saturation < 0.0) _saturation = 0.0;
 258     else if (_saturation > 1.0) _saturation = 1.0;
 259
 260     float ambient = _ambient_tbl->interpolate( deg ) + visibility_inv/10;
 261     float diffuse = _diffuse_tbl->interpolate( deg );
 262     float specular = _specular_tbl->interpolate( deg ) * visibility_log;
 263     float sky_brightness = _sky_tbl->interpolate( deg );
 264
 265     ambient *= _saturation;
 266     diffuse *= _saturation;
 267     specular *= _saturation;
 268     sky_brightness *= _saturation;
 269
 270     SG_LOG( SG_EVENT, SG_DEBUG,
 271             "  ambient = " << ambient << "  diffuse = " << diffuse
 272             << "  specular = " << specular << "  sky = " << sky_brightness );
 273
 274     // sky_brightness = 0.15;  // used to force a dark sky (when testing)
 275
 276     // set fog and cloud color
 277     float sqrt_sky_brightness = 1.0 - sqrt(1.0 - sky_brightness);
 278     _fog_color[0] = base_fog_color[0] * sqrt_sky_brightness;
 279     _fog_color[1] = base_fog_color[1] * sqrt_sky_brightness;
 280     _fog_color[2] = base_fog_color[2] * sqrt_sky_brightness;
 281     _fog_color[3] = base_fog_color[3];
 282     gamma_correct_rgb( _fog_color.data() );
 283
 284     // set sky color
 285     _sky_color[0] = base_sky_color[0] * sky_brightness;
 286     _sky_color[1] = base_sky_color[1] * sky_brightness;
 287     _sky_color[2] = base_sky_color[2] * sky_brightness;
 288     _sky_color[3] = base_sky_color[3];
 289     gamma_correct_rgb( _sky_color.data() );
 290
 291     _cloud_color[0] = base_fog_color[0] * sky_brightness;
 292     _cloud_color[1] = base_fog_color[1] * sky_brightness;
 293     _cloud_color[2] = base_fog_color[2] * sky_brightness;
 294     _cloud_color[3] = base_fog_color[3];
 295
 296     // adjust the cloud colors for sunrise/sunset effects (darken them)
 297     if (_sun_angle > 1.0) {
 298        float sun2 = sqrt(_sun_angle);
 299        _cloud_color[0] /= sun2;
 300        _cloud_color[1] /= sun2;
 301        _cloud_color[2] /= sun2;
 302     }
 303     gamma_correct_rgb( _cloud_color.data() );
 304
 305     _scene_ambient[0] = _fog_color[0] * ambient;
 306     _scene_ambient[1] = _fog_color[1] * ambient;
 307     _scene_ambient[2] = _fog_color[2] * ambient;
 308     _scene_ambient[3] = 1.0;
 309     gamma_correct_rgb( _scene_ambient.data() );
 310
 311     SGVec4f color = thesky->get_scene_color();
 312     _scene_diffuse[0] = color[0] * diffuse;
 313     _scene_diffuse[1] = color[1] * diffuse;
 314     _scene_diffuse[2] = color[2] * diffuse;
 315     _scene_diffuse[3] = 1.0;
 316     gamma_correct_rgb( _scene_diffuse.data() );
 317
 318     SGVec4f chrome = _scene_ambient * .4f + _scene_diffuse;
 319     chrome[3] = 1.0f;
 320     if (chrome != _scene_chrome) {
 321         _scene_chrome = chrome;
 322         for (int i = 0; i < 4; ++i)
 323             _chromeProps[i]->setValue(static_cast<double>(_scene_chrome[i]));
 324     }
 325
 326     color = thesky->get_sun_color();
 327     _scene_specular[0] = color[0] * specular;
 328     _scene_specular[1] = color[1] * specular;
 329     _scene_specular[2] = color[2] * specular;
 330     _scene_specular[3] = 1.0;
 331     gamma_correct_rgb( _scene_specular.data() );
 332 }
 333
 334
 335 // calculate fog color adjusted for sunrise/sunset effects
 336 void FGLight::update_adj_fog_color () {
 337
 338     double pitch = globals->get_current_view()->getPitch_deg()
 339                      * SGD_DEGREES_TO_RADIANS;
 340     double pitch_offset = globals->get_current_view()-> getPitchOffset_deg()
 341                      * SGD_DEGREES_TO_RADIANS;
 342     double heading = globals->get_current_view()->getHeading_deg()
 343                      * SGD_DEGREES_TO_RADIANS;
 344     double heading_offset = globals->get_current_view()->getHeadingOffset_deg()
 345                             * SGD_DEGREES_TO_RADIANS;
 346
 347     SG_LOG( SG_EVENT, SG_DEBUG, "Updating adjusted fog parameters." );
 348
 349     // set fog color (we'll try to match the sunset color in the
 350     // direction we are looking
 351
 352     // Do some sanity checking ...
 353     if ( _sun_rotation < -2.0 * SGD_2PI || _sun_rotation > 2.0 * SGD_2PI ) {
 354         SG_LOG( SG_EVENT, SG_ALERT, "Sun rotation bad = " << _sun_rotation );
 355         return;
 356     }
 357
 358     if ( heading < -2.0 * SGD_2PI || heading > 2.0 * SGD_2PI ) {
 359         SG_LOG( SG_EVENT, SG_ALERT, "Heading rotation bad = " << heading );
 360         return;
 361     }
 362
 363     if ( heading_offset < -2.0 * SGD_2PI || heading_offset > 2.0 * SGD_2PI ) {
 364         SG_LOG( SG_EVENT, SG_ALERT, "Heading offset bad = " << heading_offset );
 365         return;
 366     }
 367
 368     double hor_rotation, vert_rotation;
 369     static float gamma = system_gamma;
 370
 371     // first determine the difference between our view angle and local
 372     // direction to the sun
 373     vert_rotation = pitch + pitch_offset;
 374     hor_rotation = -(_sun_rotation + SGD_PI) - heading + heading_offset;
 375     if (hor_rotation < 0 )
 376        hor_rotation = fmod(hor_rotation, SGD_2PI) + SGD_2PI;
 377     else
 378        hor_rotation = fmod(hor_rotation, SGD_2PI);
 379
 380     // revert to unmodified values before usign them.
 381     //
 382     SGVec4f color = thesky->get_scene_color();
 383
 384     gamma_restore_rgb( _fog_color.data(), gamma );
 385     gamma_restore_rgb( _sky_color.data(), gamma );
 386
 387     // Calculate the fog color in the direction of the sun for
 388     // sunrise/sunset effects.
 389     //
 390     float s_red =   color[0]*color[0]*color[0];
 391     float s_green = color[1]*color[1]*color[1];
 392     float s_blue =  color[2]*color[2];
 393
 394     // interpolate beween the sunrise/sunset color and the color
 395     // at the opposite direction of this effect. Take in account
 396     // the current visibility.
 397     //
 398     float av = thesky->get_visibility();
 399     if (av > 45000) av = 45000;
 400
 401     float avf = 0.87 - (45000 - av) / 83333.33;
 402     float sif = 0.5 - cos(_sun_angle*2)/2;
 403
 404     if (sif < 1e-4)
 405        sif = 1e-4;
 406
 407     float rf1 = fabs((hor_rotation - SGD_PI) / SGD_PI);         // 0.0 .. 1.0
 408     float rf2 = avf * pow(rf1*rf1, 1/sif) * 1.0639 * _saturation;
 409     float rf3 = 1.0 - rf2;
 410
 411     gamma = system_gamma * (0.9 - sif*avf);
 412
 413     _adj_fog_color[0] = rf3 * _fog_color[0] + rf2 * s_red;
 414     _adj_fog_color[1] = rf3 * _fog_color[1] + rf2 * s_green;
 415     _adj_fog_color[2] = rf3 * _fog_color[2] + rf2 * s_blue;
 416     gamma_correct_rgb( _adj_fog_color.data(), gamma);
 417
 418     // make sure the colors have their original value before they are being
 419     // used by the rest of the program.
 420     //
 421     gamma_correct_rgb( _fog_color.data(), gamma );
 422     gamma_correct_rgb( _sky_color.data(), gamma );
 423 }
 424
 425 // update the cur_time_params structure with the current sun position
 426 void FGLight::updateSunPos()
 427 {
 428     SGTime *t = globals->get_time_params();
 429     FGViewer *v = globals->get_current_view();
 430
 431     SG_LOG( SG_EVENT, SG_DEBUG, "  Updating Sun position" );
 432     SG_LOG( SG_EVENT, SG_DEBUG, "  Gst = " << t->getGst() );
 433
 434     double sun_l;
 435     double sun_gd_lat;
 436     fgSunPositionGST(t->getGst(), &sun_l, &sun_gd_lat);
 437     set_sun_lon(sun_l);
 438     set_sun_lat(sun_gd_lat);
 439     SGVec3d sunpos(SGVec3d::fromGeod(SGGeod::fromRad(sun_l, sun_gd_lat)));
 440
 441     SG_LOG( SG_EVENT, SG_DEBUG, "    t->cur_time = " << t->get_cur_time() );
 442     SG_LOG( SG_EVENT, SG_DEBUG,
 443             "    Sun Geodetic lat = " << sun_gd_lat
 444             << " Geodetic lat = " << sun_gd_lat );
 445
 446     // update the sun light vector
 447     sun_vec() = SGVec4f(toVec3f(normalize(sunpos)), 0);
 448     sun_vec_inv() = - sun_vec();
 449
 450     // calculate the sun's relative angle to local up
 451     SGVec3d viewPos = v->get_view_pos();
 452     SGQuatd hlOr = SGQuatd::fromLonLat(SGGeod::fromCart(viewPos));
 453     SGVec3f world_up = toVec3f(hlOr.backTransform(-SGVec3d::e3()));
 454     SGVec3f nsun = toVec3f(normalize(sunpos));
 455     // cout << "nup = " << nup[0] << "," << nup[1] << ","
 456     //      << nup[2] << endl;
 457     // cout << "nsun = " << nsun[0] << "," << nsun[1] << ","
 458     //      << nsun[2] << endl;
 459
 460     set_sun_angle( acos( dot ( world_up, nsun ) ) );
 461     SG_LOG( SG_EVENT, SG_DEBUG, "sun angle relative to current location = "
 462             << get_sun_angle() );
 463
 464     // calculate vector to sun's position on the earth's surface
 465     SGVec3d rel_sunpos = sunpos - v->get_view_pos();
 466     // vector in cartesian coordinates from current position to the
 467     // postion on the earth's surface the sun is directly over
 468     SGVec3f to_sun = toVec3f(rel_sunpos);
 469     // printf( "Vector to sun = %.2f %.2f %.2f\n",
 470     //         v->to_sun[0], v->to_sun[1], v->to_sun[2]);
 471
 472     // Given a vector from the view position to the point on the
 473     // earth's surface the sun is directly over, map into onto the
 474     // local plane representing "horizontal".
 475
 476     // surface direction to go to head towards sun
 477     SGVec3f surface_to_sun;
 478     SGVec3f view_pos = toVec3f(v->get_view_pos());
 479     surface_to_sun = map_vec_onto_cur_surface_plane(world_up, view_pos, to_sun);
 480     surface_to_sun = normalize(surface_to_sun);
 481     // cout << "(sg) Surface direction to sun is "
 482     //   << surface_to_sun[0] << ","
 483     //   << surface_to_sun[1] << ","
 484     //   << surface_to_sun[2] << endl;
 485     // cout << "Should be close to zero = "
 486     //   << sgScalarProductVec3(nup, surface_to_sun) << endl;
 487
 488     // calculate the angle between surface_to_sun and
 489     // v->get_surface_east().  We do this so we can sort out the
 490     // acos() ambiguity.  I wish I could think of a more efficient
 491     // way. :-(
 492     SGVec3f surface_east(toVec3f(hlOr.backTransform(SGVec3d::e2())));
 493     float east_dot = dot( surface_to_sun, surface_east );
 494     // cout << "  East dot product = " << east_dot << endl;
 495
 496     // calculate the angle between v->surface_to_sun and
 497     // v->surface_south.  this is how much we have to rotate the sky
 498     // for it to align with the sun
 499     SGVec3f surface_south(toVec3f(hlOr.backTransform(-SGVec3d::e1())));
 500     float dot_ = dot( surface_to_sun, surface_south );
 501     // cout << "  Dot product = " << dot << endl;
 502
 503     if (dot_ > 1.0) {
 504         SG_LOG( SG_ASTRO, SG_INFO,
 505                 "Dot product  = " << dot_ << " is greater than 1.0" );
 506         dot_ = 1.0;
 507     }
 508     else if (dot_ < -1.0) {
 509          SG_LOG( SG_ASTRO, SG_INFO,
 510                  "Dot product  = " << dot_ << " is less than -1.0" );
 511          dot_ = -1.0;
 512      }
 513
 514     if ( east_dot >= 0 ) {
 515         set_sun_rotation( acos(dot_) );
 516     } else {
 517         set_sun_rotation( -acos(dot_) );
 518     }
 519     // cout << "  Sky needs to rotate = " << angle << " rads = "
 520     //      << angle * SGD_RADIANS_TO_DEGREES << " degrees." << endl;
 521
 522 }