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 // Constructor
  52 FGLight::FGLight ()
  53     : _ambient_tbl( NULL ),
  54       _diffuse_tbl( NULL ),
  55       _specular_tbl( NULL ),
  56       _sky_tbl( NULL ),
  57       _sun_lon(0),
  58       _sun_lat(0),
  59       _moon_lon(0),
  60       _moon_gc_lat(0),
  61       _sun_vec(0, 0, 0, 0),
  62       _moon_vec(0, 0, 0, 0),
  63       _sun_vec_inv(0, 0, 0, 0),
  64       _moon_vec_inv(0, 0, 0, 0),
  65       _sun_angle(0),
  66       _moon_angle(0),
  67       _prev_sun_angle(0),
  68       _sun_rotation(0),
  69       _moon_rotation(0),
  70       _scene_ambient(0, 0, 0, 0),
  71       _scene_diffuse(0, 0, 0, 0),
  72       _scene_specular(0, 0, 0, 0),
  73       _scene_chrome(0, 0, 0, 0),
  74       _sky_color(0, 0, 0, 0),
  75       _fog_color(0, 0, 0, 0),
  76       _cloud_color(0, 0, 0, 0),
  77       _adj_fog_color(0, 0, 0, 0),
  78       _adj_sky_color(0, 0, 0, 0),
  79       _saturation(1.0),
  80       _scattering(0.8),
  81       _overcast(0.0),
  82       _dt_total(0)
  83 {
  84 }
  85
  86 // Destructor
  87 FGLight::~FGLight ()
  88 {
  89     delete _ambient_tbl;
  90     delete _diffuse_tbl;
  91     delete _specular_tbl;
  92     delete _sky_tbl;
  93 }
  94
  95
  96 // initialize lighting tables
  97 void FGLight::init () {
  98     SG_LOG( SG_EVENT, SG_INFO,
  99             "Initializing Lighting interpolation tables." );
 100
 101     // build the path names of the lookup tables
 102     SGPath path( globals->get_fg_root() );
 103
 104     // initialize ambient, diffuse and specular tables
 105     SGPath ambient_path = path;
 106     ambient_path.append( "Lighting/ambient" );
 107     _ambient_tbl = new SGInterpTable( ambient_path.str() );
 108
 109     SGPath diffuse_path = path;
 110     diffuse_path.append( "Lighting/diffuse" );
 111     _diffuse_tbl = new SGInterpTable( diffuse_path.str() );
 112
 113     SGPath specular_path = path;
 114     specular_path.append( "Lighting/specular" );
 115     _specular_tbl = new SGInterpTable( specular_path.str() );
 116
 117     // initialize sky table
 118     SGPath sky_path = path;
 119     sky_path.append( "Lighting/sky" );
 120     _sky_tbl = new SGInterpTable( sky_path.str() );
 121
 122     globals->get_event_mgr()->addTask("updateSunPos", this,
 123                             &FGLight::updateSunPos, 0.5 );
 124 }
 125
 126
 127 void FGLight::reinit () {
 128     _prev_sun_angle = -9999.0;
 129     _dt_total = 0;
 130
 131     delete _ambient_tbl;
 132     delete _diffuse_tbl;
 133     delete _specular_tbl;
 134     delete _sky_tbl;
 135
 136     init();
 137
 138     updateSunPos();
 139     update_sky_color();
 140     update_adj_fog_color();
 141 }
 142
 143 void FGLight::bind () {
 144     SGPropertyNode *prop = globals->get_props();
 145
 146     // Write Only
 147     prop->tie("/rendering/scene/saturation",SGRawValuePointer<float>(&_saturation));
 148     prop->tie("/rendering/scene/scattering",SGRawValuePointer<float>(&_scattering));
 149     prop->tie("/rendering/scene/overcast",SGRawValuePointer<float>(&_overcast));
 150
 151     _sunAngleRad = prop->getNode("/sim/time/sun-angle-rad", true);
 152     _sunAngleRad->setDoubleValue(_sun_angle);
 153
 154     // Read Only
 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     prop->tie("/rendering/dome/sky/red",SGRawValuePointer<float>(&_sky_color[0]));
 165     prop->tie("/rendering/dome/sky/green",SGRawValuePointer<float>(&_sky_color[1]));
 166     prop->tie("/rendering/dome/sky/blue",SGRawValuePointer<float>(&_sky_color[2]));
 167     prop->tie("/rendering/dome/cloud/red",SGRawValuePointer<float>(&_cloud_color[0]));
 168     prop->tie("/rendering/dome/cloud/green",SGRawValuePointer<float>(&_cloud_color[1]));
 169     prop->tie("/rendering/dome/cloud/blue",SGRawValuePointer<float>(&_cloud_color[2]));
 170     prop->tie("/rendering/dome/fog/red",SGRawValuePointer<float>(&_fog_color[0]));
 171     prop->tie("/rendering/dome/fog/green",SGRawValuePointer<float>(&_fog_color[1]));
 172     prop->tie("/rendering/dome/fog/blue",SGRawValuePointer<float>(&_fog_color[2]));
 173     // Properties used directly by effects
 174     _chromeProps[0] = prop->getNode("/rendering/scene/chrome-light/red", true);
 175     _chromeProps[1] = prop->getNode("/rendering/scene/chrome-light/green",
 176                                     true);
 177     _chromeProps[2] = prop->getNode("/rendering/scene/chrome-light/blue", true);
 178     _chromeProps[3] = prop->getNode("/rendering/scene/chrome-light/alpha",
 179                                     true);
 180     for (int i = 0; i < 4; ++i)
 181         _chromeProps[i]->setValue(0.0);
 182 }
 183
 184 void FGLight::unbind () {
 185     SGPropertyNode *prop = globals->get_props();
 186     prop->untie("/rendering/scene/saturation");
 187     prop->untie("/rendering/scene/scattering");
 188     prop->untie("/rendering/scene/overcast");
 189     prop->untie("/rendering/scene/ambient/red");
 190     prop->untie("/rendering/scene/ambient/green");
 191     prop->untie("/rendering/scene/ambient/blue");
 192     prop->untie("/rendering/scene/diffuse/red");
 193     prop->untie("/rendering/scene/diffuse/green");
 194     prop->untie("/rendering/scene/diffuse/blue");
 195     prop->untie("/rendering/scene/specular/red");
 196     prop->untie("/rendering/scene/specular/green");
 197     prop->untie("/rendering/scene/specular/blue");
 198     prop->untie("/rendering/dome/sun/red");
 199     prop->untie("/rendering/dome/sun/green");
 200     prop->untie("/rendering/dome/sun/blue");
 201     prop->untie("/rendering/dome/sky/red");
 202     prop->untie("/rendering/dome/sky/green");
 203     prop->untie("/rendering/dome/sky/blue");
 204     prop->untie("/rendering/dome/cloud/red");
 205     prop->untie("/rendering/dome/cloud/green");
 206     prop->untie("/rendering/dome/cloud/blue");
 207     prop->untie("/rendering/dome/fog/red");
 208     prop->untie("/rendering/dome/fog/green");
 209     prop->untie("/rendering/dome/fog/blue");
 210 }
 211
 212
 213 // update lighting parameters based on current sun position
 214 void FGLight::update( double dt )
 215 {
 216     update_adj_fog_color();
 217
 218     if (_prev_sun_angle != _sun_angle) {
 219         _prev_sun_angle = _sun_angle;
 220         update_sky_color();
 221     }
 222 }
 223
 224 void FGLight::update_sky_color () {
 225     // if the 4th field is 0.0, this specifies a direction ...
 226     // const GLfloat white[4]          = { 1.0,  1.0,  1.0,  1.0 };
 227     const GLfloat base_sky_color[4] = { 0.31, 0.43, 0.69, 1.0 };
 228     const GLfloat base_fog_color[4] = { 0.63, 0.72, 0.88,  1.0 };
 229
 230     SG_LOG( SG_EVENT, SG_DEBUG, "Updating light parameters." );
 231
 232     // calculate lighting parameters based on sun's relative angle to
 233     // local up
 234     static SGConstPropertyNode_ptr humidity = fgGetNode("/environment/relative-humidity");
 235     float av = humidity->getFloatValue() * 45;
 236     float visibility_log = log(av)/11.0;
 237     float visibility_inv = (45000.0 - av)/45000.0;
 238
 239     float deg = _sun_angle * SGD_RADIANS_TO_DEGREES;
 240     SG_LOG( SG_EVENT, SG_DEBUG, "  Sun angle = " << deg );
 241
 242     if (_saturation < 0.0) _saturation = 0.0;
 243     else if (_saturation > 1.0) _saturation = 1.0;
 244     if (_scattering < 0.0) _scattering = 0.0;
 245     else if (_scattering > 1.0) _scattering = 1.0;
 246     if (_overcast < 0.0) _overcast = 0.0;
 247     else if (_overcast > 1.0) _overcast = 1.0;
 248
 249     float ambient = _ambient_tbl->interpolate( deg ) + visibility_inv/10;
 250     float diffuse = _diffuse_tbl->interpolate( deg );
 251     float specular = _specular_tbl->interpolate( deg ) * visibility_log;
 252     float sky_brightness = _sky_tbl->interpolate( deg );
 253
 254     ambient *= _saturation;
 255     diffuse *= _saturation;
 256     specular *= _saturation;
 257     sky_brightness *= _saturation;
 258
 259     SG_LOG( SG_EVENT, SG_DEBUG,
 260             "  ambient = " << ambient << "  diffuse = " << diffuse
 261             << "  specular = " << specular << "  sky = " << sky_brightness );
 262
 263     // sky_brightness = 0.15;  // used to force a dark sky (when testing)
 264
 265     // set fog and cloud color
 266     float sqrt_sky_brightness = (1.0 - sqrt(1.0 - sky_brightness))*_scattering;
 267     _fog_color[0] = base_fog_color[0] * sqrt_sky_brightness;
 268     _fog_color[1] = base_fog_color[1] * sqrt_sky_brightness;
 269     _fog_color[2] = base_fog_color[2] * sqrt_sky_brightness;
 270     _fog_color[3] = base_fog_color[3];
 271     gamma_correct_rgb( _fog_color.data() );
 272
 273     // set sky color
 274     _sky_color[0] = (base_sky_color[0] + (1.0f-base_sky_color[0]) * _overcast) * sky_brightness;
 275     _sky_color[1] = (base_sky_color[1] + (1.0f-base_sky_color[1]) * _overcast)  * sky_brightness;
 276     _sky_color[2] = (base_sky_color[2] + (1.0f-base_sky_color[2]) * _overcast)  * sky_brightness;
 277     _sky_color[3] = base_sky_color[3];
 278     gamma_correct_rgb( _sky_color.data() );
 279
 280     sqrt_sky_brightness /= _scattering;
 281     _cloud_color[0] = base_fog_color[0] * sky_brightness;
 282     _cloud_color[1] = base_fog_color[1] * sky_brightness;
 283     _cloud_color[2] = base_fog_color[2] * sky_brightness;
 284     _cloud_color[3] = base_fog_color[3];
 285
 286     // adjust the cloud colors for sunrise/sunset effects (darken them)
 287     if (_sun_angle > 1.0) {
 288        float sun2 = sqrt(_sun_angle);
 289        _cloud_color[0] /= sun2;
 290        _cloud_color[1] /= sun2;
 291        _cloud_color[2] /= sun2;
 292     }
 293     gamma_correct_rgb( _cloud_color.data() );
 294
 295     _scene_ambient[0] = _fog_color[0] * ambient;
 296     _scene_ambient[1] = _fog_color[1] * ambient;
 297     _scene_ambient[2] = _fog_color[2] * ambient;
 298     _scene_ambient[3] = 1.0;
 299     gamma_correct_rgb( _scene_ambient.data() );
 300
 301     SGSky* thesky = globals->get_renderer()->getSky();
 302
 303     SGVec4f color = thesky->get_scene_color();
 304     _scene_diffuse[0] = color[0] * diffuse;
 305     _scene_diffuse[1] = color[1] * diffuse;
 306     _scene_diffuse[2] = color[2] * diffuse;
 307     _scene_diffuse[3] = 1.0;
 308     gamma_correct_rgb( _scene_diffuse.data() );
 309
 310     SGVec4f chrome = _scene_ambient * .4f + _scene_diffuse;
 311     chrome[3] = 1.0f;
 312     if (chrome != _scene_chrome) {
 313         _scene_chrome = chrome;
 314         for (int i = 0; i < 4; ++i)
 315             _chromeProps[i]->setValue(static_cast<double>(_scene_chrome[i]));
 316     }
 317
 318     color = thesky->get_sun_color();
 319     _scene_specular[0] = color[0] * specular;
 320     _scene_specular[1] = color[1] * specular;
 321     _scene_specular[2] = color[2] * specular;
 322     _scene_specular[3] = 1.0;
 323     gamma_correct_rgb( _scene_specular.data() );
 324 }
 325
 326
 327 // calculate fog color adjusted for sunrise/sunset effects
 328 void FGLight::update_adj_fog_color () {
 329
 330     double pitch = globals->get_current_view()->getPitch_deg()
 331                      * SGD_DEGREES_TO_RADIANS;
 332     double pitch_offset = globals->get_current_view()-> getPitchOffset_deg()
 333                      * SGD_DEGREES_TO_RADIANS;
 334     double heading = globals->get_current_view()->getHeading_deg()
 335                      * SGD_DEGREES_TO_RADIANS;
 336     double heading_offset = globals->get_current_view()->getHeadingOffset_deg()
 337                             * SGD_DEGREES_TO_RADIANS;
 338
 339     SG_LOG( SG_EVENT, SG_DEBUG, "Updating adjusted fog parameters." );
 340
 341     // set fog color (we'll try to match the sunset color in the
 342     // direction we are looking
 343
 344     // Do some sanity checking ...
 345     if ( _sun_rotation < -2.0 * SGD_2PI || _sun_rotation > 2.0 * SGD_2PI ) {
 346         SG_LOG( SG_EVENT, SG_ALERT, "Sun rotation bad = " << _sun_rotation );
 347         return;
 348     }
 349
 350     if ( heading < -2.0 * SGD_2PI || heading > 2.0 * SGD_2PI ) {
 351         SG_LOG( SG_EVENT, SG_ALERT, "Heading rotation bad = " << heading );
 352         return;
 353     }
 354
 355     if ( heading_offset < -2.0 * SGD_2PI || heading_offset > 2.0 * SGD_2PI ) {
 356         SG_LOG( SG_EVENT, SG_ALERT, "Heading offset bad = " << heading_offset );
 357         return;
 358     }
 359
 360     double hor_rotation, vert_rotation;
 361     static float gamma = system_gamma;
 362
 363     // first determine the difference between our view angle and local
 364     // direction to the sun
 365     vert_rotation = pitch + pitch_offset;
 366     hor_rotation = -(_sun_rotation + SGD_PI) - heading + heading_offset;
 367     if (hor_rotation < 0 )
 368        hor_rotation = fmod(hor_rotation, SGD_2PI) + SGD_2PI;
 369     else
 370        hor_rotation = fmod(hor_rotation, SGD_2PI);
 371
 372     // revert to unmodified values before using them.
 373     //
 374     SGSky* thesky = globals->get_renderer()->getSky();
 375     SGVec4f color = thesky->get_scene_color();
 376
 377     gamma_restore_rgb( _fog_color.data(), gamma );
 378     gamma_restore_rgb( _sky_color.data(), gamma );
 379
 380     // Calculate the fog color in the direction of the sun for
 381     // sunrise/sunset effects.
 382     //
 383     float s_red =   color[0]*color[0]*color[0];
 384     float s_green = color[1]*color[1]*color[1];
 385     float s_blue =  color[2]*color[2];
 386
 387     // interpolate between the sunrise/sunset color and the color
 388     // at the opposite direction of this effect. Take in account
 389     // the current visibility.
 390     //
 391     float av = thesky->get_visibility();
 392     if (av > 45000) av = 45000;
 393
 394     float avf = 0.87 - (45000 - av) / 83333.33;
 395     float sif = 0.5 - cos(_sun_angle*2)/2;
 396
 397     if (sif < 1e-4)
 398        sif = 1e-4;
 399
 400     float rf1 = fabs((hor_rotation - SGD_PI) / SGD_PI);         // 0.0 .. 1.0
 401     float rf2 = avf * pow(rf1*rf1, 1/sif) * 1.0639 * _saturation * _scattering;
 402     float rf3 = 1.0 - rf2;
 403
 404     gamma = system_gamma * (0.9 - sif*avf);
 405     _adj_fog_color[0] = rf3 * _fog_color[0] + rf2 * s_red;
 406     _adj_fog_color[1] = rf3 * _fog_color[1] + rf2 * s_green;
 407     _adj_fog_color[2] = rf3 * _fog_color[2] + rf2 * s_blue;
 408     gamma_correct_rgb( _adj_fog_color.data(), gamma);
 409
 410     // make sure the colors have their original value before they are being
 411     // used by the rest of the program.
 412     //
 413     gamma_correct_rgb( _fog_color.data(), gamma );
 414     gamma_correct_rgb( _sky_color.data(), gamma );
 415 }
 416
 417 // update the cur_time_params structure with the current sun position
 418 void FGLight::updateSunPos()
 419 {
 420     SGTime *t = globals->get_time_params();
 421     FGViewer *v = globals->get_current_view();
 422
 423     SG_LOG( SG_EVENT, SG_DEBUG, "  Updating Sun position" );
 424     SG_LOG( SG_EVENT, SG_DEBUG, "  Gst = " << t->getGst() );
 425
 426     fgSunPositionGST(t->getGst(), &_sun_lon, &_sun_lat);
 427     // It might seem that sun_gc_lat needs to be converted to geodetic
 428     // latitude here, but it doesn't. The sun latitude is the latitude
 429     // of the point on the earth where the up vector has the same
 430     // angle from geocentric Z as the sun direction. But geodetic
 431     // latitude is defined as 90 - angle of up vector from Z!
 432     SGVec3d sunpos(SGVec3d::fromGeoc(SGGeoc::fromRadM(_sun_lon, _sun_lat,
 433                                                       SGGeodesy::EQURAD)));
 434
 435     SG_LOG( SG_EVENT, SG_DEBUG, "    t->cur_time = " << t->get_cur_time() );
 436     SG_LOG( SG_EVENT, SG_DEBUG,
 437             "    Sun Geocentric lat = " << _sun_lat
 438             << " Geodcentric lat = " << _sun_lat );
 439
 440     // update the sun light vector
 441     sun_vec() = SGVec4f(toVec3f(normalize(sunpos)), 0);
 442     sun_vec_inv() = - sun_vec();
 443
 444     // calculate the sun's relative angle to local up
 445     SGVec3d viewPos = v->get_view_pos();
 446     SGQuatd hlOr = SGQuatd::fromLonLat(SGGeod::fromCart(viewPos));
 447     SGVec3d world_up = hlOr.backTransform(-SGVec3d::e3());
 448     SGVec3d nsun = normalize(sunpos);
 449     // cout << "nup = " << nup[0] << "," << nup[1] << ","
 450     //      << nup[2] << endl;
 451     // cout << "nsun = " << nsun[0] << "," << nsun[1] << ","
 452     //      << nsun[2] << endl;
 453
 454     _sun_angle = acos( dot ( world_up, nsun ) );
 455     SG_LOG( SG_EVENT, SG_DEBUG, "sun angle relative to current location = "
 456             << get_sun_angle() );
 457
 458     // Get direction to the sun in the local frame.
 459     SGVec3d local_sun_vec = hlOr.transform(nsun);
 460
 461     // Angle from south. XXX Is this correct in the southern hemisphere?
 462     _sun_rotation = atan2(local_sun_vec.x(), -local_sun_vec.y());
 463
 464     // cout << "  Sky needs to rotate = " << _sun_rotation << " rads = "
 465     //      << _sun_rotation * SGD_RADIANS_TO_DEGREES << " degrees." << endl;
 466
 467     _sunAngleRad->setDoubleValue(_sun_angle);
 468 }