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