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