2 // light.cxx -- lighting routines
4 // Written by Curtis Olson, started April 1998.
6 // Copyright (C) 1998 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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.
29 #include <simgear/compiler.h>
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>
42 #include <Main/main.hxx>
43 #include <Main/globals.hxx>
44 #include <Main/fg_props.hxx>
45 #include <Viewer/renderer.hxx>
46 #include <Viewer/viewer.hxx>
49 #include "sunsolver.hxx"
53 : _ambient_tbl( NULL ),
55 _specular_tbl( NULL ),
62 _moon_vec(0, 0, 0, 0),
63 _sun_vec_inv(0, 0, 0, 0),
64 _moon_vec_inv(0, 0, 0, 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 _sun_color(1, 1, 1, 0),
75 _sky_color(0, 0, 0, 0),
76 _fog_color(0, 0, 0, 0),
77 _cloud_color(0, 0, 0, 0),
78 _adj_fog_color(0, 0, 0, 0),
79 _adj_sky_color(0, 0, 0, 0),
97 // initialize lighting tables
98 void FGLight::init () {
99 SG_LOG( SG_EVENT, SG_INFO,
100 "Initializing Lighting interpolation tables." );
102 // build the path names of the lookup tables
103 SGPath path( globals->get_fg_root() );
105 // initialize ambient, diffuse and specular tables
106 SGPath ambient_path = path;
107 ambient_path.append( "Lighting/ambient" );
108 _ambient_tbl = new SGInterpTable( ambient_path.str() );
110 SGPath diffuse_path = path;
111 diffuse_path.append( "Lighting/diffuse" );
112 _diffuse_tbl = new SGInterpTable( diffuse_path.str() );
114 SGPath specular_path = path;
115 specular_path.append( "Lighting/specular" );
116 _specular_tbl = new SGInterpTable( specular_path.str() );
118 // initialize sky table
119 SGPath sky_path = path;
120 sky_path.append( "Lighting/sky" );
121 _sky_tbl = new SGInterpTable( sky_path.str() );
123 globals->get_event_mgr()->addTask("updateSunPos", this,
124 &FGLight::updateSunPos, 0.5 );
128 void FGLight::reinit () {
129 _prev_sun_angle = -9999.0;
134 delete _specular_tbl;
141 update_adj_fog_color();
144 void FGLight::bind () {
145 SGPropertyNode *prop = globals->get_props();
148 tie(prop,"/rendering/scene/saturation", SGRawValuePointer<float>(&_saturation));
149 tie(prop,"/rendering/scene/scattering", SGRawValuePointer<float>(&_scattering));
150 tie(prop,"/rendering/scene/overcast", SGRawValuePointer<float>(&_overcast));
152 _sunAngleRad = prop->getNode("/sim/time/sun-angle-rad", true);
153 _sunAngleRad->setDoubleValue(_sun_angle);
154 _humidity = fgGetNode("/environment/relative-humidity", true);
157 tie(prop,"/rendering/scene/ambient/red", SGRawValuePointer<float>(&_scene_ambient[0]));
158 tie(prop,"/rendering/scene/ambient/green", SGRawValuePointer<float>(&_scene_ambient[1]));
159 tie(prop,"/rendering/scene/ambient/blue", SGRawValuePointer<float>(&_scene_ambient[2]));
160 tie(prop,"/rendering/scene/diffuse/red", SGRawValuePointer<float>(&_scene_diffuse[0]));
161 tie(prop,"/rendering/scene/diffuse/green", SGRawValuePointer<float>(&_scene_diffuse[1]));
162 tie(prop,"/rendering/scene/diffuse/blue", SGRawValuePointer<float>(&_scene_diffuse[2]));
163 tie(prop,"/rendering/scene/specular/red", SGRawValuePointer<float>(&_scene_specular[0]));
164 tie(prop,"/rendering/scene/specular/green", SGRawValuePointer<float>(&_scene_specular[1]));
165 tie(prop,"/rendering/scene/specular/blue", SGRawValuePointer<float>(&_scene_specular[2]));
166 tie(prop,"/rendering/dome/sun/red", SGRawValuePointer<float>(&_sun_color[0]));
167 tie(prop,"/rendering/dome/sun/green", SGRawValuePointer<float>(&_sun_color[1]));
168 tie(prop,"/rendering/dome/sun/blue", SGRawValuePointer<float>(&_sun_color[2]));
169 tie(prop,"/rendering/dome/sky/red", SGRawValuePointer<float>(&_sky_color[0]));
170 tie(prop,"/rendering/dome/sky/green", SGRawValuePointer<float>(&_sky_color[1]));
171 tie(prop,"/rendering/dome/sky/blue", SGRawValuePointer<float>(&_sky_color[2]));
172 tie(prop,"/rendering/dome/cloud/red", SGRawValuePointer<float>(&_cloud_color[0]));
173 tie(prop,"/rendering/dome/cloud/green", SGRawValuePointer<float>(&_cloud_color[1]));
174 tie(prop,"/rendering/dome/cloud/blue", SGRawValuePointer<float>(&_cloud_color[2]));
175 tie(prop,"/rendering/dome/fog/red", SGRawValuePointer<float>(&_fog_color[0]));
176 tie(prop,"/rendering/dome/fog/green", SGRawValuePointer<float>(&_fog_color[1]));
177 tie(prop,"/rendering/dome/fog/blue", SGRawValuePointer<float>(&_fog_color[2]));
179 // Properties used directly by effects
180 _chromeProps[0] = prop->getNode("/rendering/scene/chrome-light/red", true);
181 _chromeProps[1] = prop->getNode("/rendering/scene/chrome-light/green",
183 _chromeProps[2] = prop->getNode("/rendering/scene/chrome-light/blue", true);
184 _chromeProps[3] = prop->getNode("/rendering/scene/chrome-light/alpha",
186 for (int i = 0; i < 4; ++i)
187 _chromeProps[i]->setValue(0.0);
190 void FGLight::unbind () {
191 _tiedProperties.Untie();
193 for (int i = 0; i < 4; ++i)
194 _chromeProps[i] = SGPropertyNode_ptr();
195 _sunAngleRad = SGPropertyNode_ptr();
196 _humidity = SGPropertyNode_ptr();
200 // update lighting parameters based on current sun position
201 void FGLight::update( double dt )
203 update_adj_fog_color();
205 if (_prev_sun_angle != _sun_angle) {
206 _prev_sun_angle = _sun_angle;
211 void FGLight::update_sky_color () {
212 const SGVec4f base_sky_color( 0.31, 0.43, 0.69, 1.0 );
213 const SGVec4f base_fog_color( 0.63, 0.72, 0.88, 1.0 );
215 SG_LOG( SG_EVENT, SG_DEBUG, "Updating light parameters." );
217 // calculate lighting parameters based on sun's relative angle to
219 float av = _humidity->getFloatValue() * 45;
220 float visibility_log = log(av)/11.0;
221 float visibility_inv = (45000.0 - av)/45000.0;
223 float deg = _sun_angle * SGD_RADIANS_TO_DEGREES;
224 SG_LOG( SG_EVENT, SG_DEBUG, " Sun angle = " << deg );
226 if (_saturation < 0.0) _saturation = 0.0;
227 else if (_saturation > 1.0) _saturation = 1.0;
228 if (_scattering < 0.0) _scattering = 0.0;
229 else if (_scattering > 1.0) _scattering = 1.0;
230 if (_overcast < 0.0) _overcast = 0.0;
231 else if (_overcast > 1.0) _overcast = 1.0;
233 float ambient = _ambient_tbl->interpolate( deg ) + visibility_inv/10;
234 float diffuse = _diffuse_tbl->interpolate( deg );
235 float specular = _specular_tbl->interpolate( deg ) * visibility_log;
236 float sky_brightness = _sky_tbl->interpolate( deg );
238 ambient *= _saturation;
239 diffuse *= _saturation;
240 specular *= _saturation;
241 sky_brightness *= _saturation;
243 SG_LOG( SG_EVENT, SG_DEBUG,
244 " ambient = " << ambient << " diffuse = " << diffuse
245 << " specular = " << specular << " sky = " << sky_brightness );
247 // sky_brightness = 0.15; // used to force a dark sky (when testing)
250 float sqr_sky_brightness = sky_brightness * sky_brightness * _scattering;
251 _fog_color = base_fog_color * sqr_sky_brightness;
252 _fog_color[3] = base_fog_color[3];
253 gamma_correct_rgb( _fog_color.data() );
256 static const SGVec4f one_vec( 1.0f, 1.0f, 1.0f, 1.0f);
257 SGVec4f overcast_color = (one_vec - base_sky_color) * _overcast;
258 _sky_color = (base_sky_color + overcast_color) * sky_brightness;
259 _sky_color[3] = base_sky_color[3];
260 gamma_correct_rgb( _sky_color.data() );
263 _cloud_color = base_fog_color * sky_brightness;
265 /** adjust the cloud colors for sunrise/sunset effects (darken them) */
266 if (_sun_angle > 1.0) {
267 float sun2 = 1.0 / sqrt(_sun_angle);
268 _cloud_color *= sun2;
270 _cloud_color[3] = base_fog_color[3];
271 gamma_correct_rgb( _cloud_color.data() );
274 _scene_ambient = _fog_color * ambient;
275 _scene_ambient[3] = _fog_color[3];
276 gamma_correct_rgb( _scene_ambient.data() );
279 SGSky* thesky = globals->get_renderer()->getSky();
280 SGVec4f color = thesky->get_scene_color();
281 _scene_diffuse = color * diffuse;
282 _scene_diffuse[3] = color[3];
283 gamma_correct_rgb( _scene_diffuse.data() );
285 SGVec4f chrome = _scene_ambient * .4f + _scene_diffuse;
287 if (chrome != _scene_chrome) {
288 _scene_chrome = chrome;
289 for (int i = 0; i < 4; ++i)
290 _chromeProps[i]->setValue(static_cast<double>(_scene_chrome[i]));
293 /** specular light */
294 _sun_color = thesky->get_sun_color();
295 _scene_specular = _sun_color * specular;
296 _scene_specular[3] = _sun_color[3];
297 gamma_correct_rgb( _scene_specular.data() );
301 // calculate fog color adjusted for sunrise/sunset effects
302 void FGLight::update_adj_fog_color () {
304 // double pitch = globals->get_current_view()->getPitch_deg()
305 // * SGD_DEGREES_TO_RADIANS;
306 // double pitch_offset = globals->get_current_view()-> getPitchOffset_deg()
307 // * SGD_DEGREES_TO_RADIANS;
308 double heading = globals->get_current_view()->getHeading_deg()
309 * SGD_DEGREES_TO_RADIANS;
310 double heading_offset = globals->get_current_view()->getHeadingOffset_deg()
311 * SGD_DEGREES_TO_RADIANS;
313 // set fog color (we'll try to match the sunset color in the
314 // direction we are looking
316 // Do some sanity checking ...
317 if ( _sun_rotation < -2.0 * SGD_2PI || _sun_rotation > 2.0 * SGD_2PI ) {
318 SG_LOG( SG_EVENT, SG_ALERT, "Sun rotation bad = " << _sun_rotation );
322 if ( heading < -2.0 * SGD_2PI || heading > 2.0 * SGD_2PI ) {
323 SG_LOG( SG_EVENT, SG_ALERT, "Heading rotation bad = " << heading );
327 if ( heading_offset < -2.0 * SGD_2PI || heading_offset > 2.0 * SGD_2PI ) {
328 SG_LOG( SG_EVENT, SG_ALERT, "Heading offset bad = " << heading_offset );
332 static float gamma = system_gamma;
334 // first determine the difference between our view angle and local
335 // direction to the sun
336 //double vert_rotation = pitch + pitch_offset;
338 // revert to unmodified values before using them.
340 SGSky* thesky = globals->get_renderer()->getSky();
341 SGVec4f color = thesky->get_scene_color();
343 gamma_restore_rgb( _fog_color.data(), gamma );
344 gamma_restore_rgb( _sky_color.data(), gamma );
346 // Calculate the fog color in the direction of the sun for
347 // sunrise/sunset effects.
349 _sun_color[0] = color[0]*color[0]*color[0];
350 _sun_color[1] = color[1]*color[1]*color[1];
351 _sun_color[2] = color[2]*color[2];
353 // interpolate between the sunrise/sunset color and the color
354 // at the opposite direction of this effect. Take in account
355 // the current visibility.
357 float av = thesky->get_visibility();
358 if (av > 45000) av = 45000;
360 float avf = 0.87 - (45000 - av) / 83333.33;
361 float sif = 0.5 - cos(_sun_angle*2)/2;
366 // determine horizontal angle between current view direction and sun
367 // since _sun_rotation is relative to South, and heading is in the local frame
368 // we need to account for the 180 degrees offset and differing signs
369 // hence the negation and SGD_PI adjustment.
370 double hor_rotation = -_sun_rotation - SGD_PI - heading + heading_offset;
371 if (hor_rotation < 0 )
372 hor_rotation = fmod(hor_rotation, SGD_2PI) + SGD_2PI;
374 hor_rotation = fmod(hor_rotation, SGD_2PI);
376 float rf1 = fabs((hor_rotation - SGD_PI) / SGD_PI); // 0.0 .. 1.0
377 float rf2 = avf * pow(rf1*rf1, 1/sif) * 1.0639 * _saturation * _scattering;
378 float rf3 = 1.0 - rf2;
380 gamma = system_gamma * (0.9 - sif*avf);
381 _adj_fog_color = rf3 * _fog_color + rf2 * _sun_color;
382 _adj_fog_color[3] = 0;
383 gamma_correct_rgb( _adj_fog_color.data(), gamma);
385 // make sure the colors have their original value before they are being
386 // used by the rest of the program.
388 gamma_correct_rgb( _fog_color.data(), gamma );
389 gamma_correct_rgb( _sky_color.data(), gamma );
392 // update the cur_time_params structure with the current sun position
393 void FGLight::updateSunPos()
395 SGTime *t = globals->get_time_params();
396 SG_LOG( SG_EVENT, SG_DEBUG, " Updating Sun position" );
397 SG_LOG( SG_EVENT, SG_DEBUG, " Gst = " << t->getGst() );
399 fgSunPositionGST(t->getGst(), &_sun_lon, &_sun_lat);
401 // It might seem that sun_gc_lat needs to be converted to geodetic
402 // latitude here, but it doesn't. The sun latitude is the latitude
403 // of the point on the earth where the up vector has the same
404 // angle from geocentric Z as the sun direction. But geodetic
405 // latitude is defined as 90 - angle of up vector from Z!
406 SGVec3d sunpos = SGVec3d::fromGeoc(SGGeoc::fromRadM(_sun_lon, _sun_lat,
409 SG_LOG( SG_EVENT, SG_DEBUG, " t->cur_time = " << t->get_cur_time() );
410 SG_LOG( SG_EVENT, SG_DEBUG,
411 " Sun Geocentric lat = " << _sun_lat
412 << " Geodcentric lat = " << _sun_lat );
414 // update the sun light vector
415 _sun_vec = SGVec4f(toVec3f(normalize(sunpos)), 0);
416 _sun_vec_inv = - _sun_vec;
418 // calculate the sun's relative angle to local up
419 SGQuatd hlOr = SGQuatd::fromLonLat( globals->get_view_position() );
420 SGVec3d world_up = hlOr.backTransform( -SGVec3d::e3() );
421 // cout << "nup = " << nup[0] << "," << nup[1] << ","
422 // << nup[2] << endl;
423 // cout << "nsun = " << nsun[0] << "," << nsun[1] << ","
424 // << nsun[2] << endl;
426 SGVec3d nsun = normalize(sunpos);
427 SGVec3d nup = normalize(world_up);
428 _sun_angle = acos( dot( nup, nsun ) );
430 double signedPI = (_sun_angle < 0.0) ? -SGD_PI : SGD_PI;
431 _sun_angle = fmod(_sun_angle+signedPI, SGD_2PI) - signedPI;
433 SG_LOG( SG_EVENT, SG_DEBUG, "sun angle relative to current location = "
434 << get_sun_angle() );
436 // Get direction to the sun in the local frame.
437 SGVec3d local_sun_vec = hlOr.transform(nsun);
440 // atan2(y,x) returns the angle between the positive X-axis
441 // and the vector with the origin at 0, going through (x,y)
442 // Since the local frame coordinates have x-positive pointing Nord and
443 // y-positive pointing East we need to negate local_sun_vec.x()
444 // _sun_rotation is positive counterclockwise from South (sun in the East)
445 // and negative clockwise from South (sun in the West)
446 _sun_rotation = atan2(local_sun_vec.y(), -local_sun_vec.x());
448 // cout << " Sky needs to rotate = " << _sun_rotation << " rads = "
449 // << _sun_rotation * SGD_RADIANS_TO_DEGREES << " degrees." << endl;
451 _sunAngleRad->setDoubleValue(_sun_angle);