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 <Main/renderer.hxx>
46 #include <Main/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 prop->tie("/rendering/scene/saturation",SGRawValuePointer<float>(&_saturation));
149 prop->tie("/rendering/scene/scattering",SGRawValuePointer<float>(&_scattering));
150 prop->tie("/rendering/scene/overcast",SGRawValuePointer<float>(&_overcast));
152 _sunAngleRad = prop->getNode("/sim/time/sun-angle-rad", true);
153 _sunAngleRad->setDoubleValue(_sun_angle);
156 prop->tie("/rendering/scene/ambient/red",SGRawValuePointer<float>(&_scene_ambient[0]));
157 prop->tie("/rendering/scene/ambient/green",SGRawValuePointer<float>(&_scene_ambient[1]));
158 prop->tie("/rendering/scene/ambient/blue",SGRawValuePointer<float>(&_scene_ambient[2]));
159 prop->tie("/rendering/scene/diffuse/red",SGRawValuePointer<float>(&_scene_diffuse[0]));
160 prop->tie("/rendering/scene/diffuse/green",SGRawValuePointer<float>(&_scene_diffuse[1]));
161 prop->tie("/rendering/scene/diffuse/blue",SGRawValuePointer<float>(&_scene_diffuse[2]));
162 prop->tie("/rendering/scene/specular/red",SGRawValuePointer<float>(&_scene_specular[0]));
163 prop->tie("/rendering/scene/specular/green",SGRawValuePointer<float>(&_scene_specular[1]));
164 prop->tie("/rendering/scene/specular/blue",SGRawValuePointer<float>(&_scene_specular[2]));
165 prop->tie("/rendering/dome/sun/red",SGRawValuePointer<float>(&_sun_color[0]));
166 prop->tie("/rendering/dome/sun/green",SGRawValuePointer<float>(&_sun_color[1]));
167 prop->tie("/rendering/dome/sun/blue",SGRawValuePointer<float>(&_sun_color[2]));
168 prop->tie("/rendering/dome/sky/red",SGRawValuePointer<float>(&_sky_color[0]));
169 prop->tie("/rendering/dome/sky/green",SGRawValuePointer<float>(&_sky_color[1]));
170 prop->tie("/rendering/dome/sky/blue",SGRawValuePointer<float>(&_sky_color[2]));
171 prop->tie("/rendering/dome/cloud/red",SGRawValuePointer<float>(&_cloud_color[0]));
172 prop->tie("/rendering/dome/cloud/green",SGRawValuePointer<float>(&_cloud_color[1]));
173 prop->tie("/rendering/dome/cloud/blue",SGRawValuePointer<float>(&_cloud_color[2]));
174 prop->tie("/rendering/dome/fog/red",SGRawValuePointer<float>(&_fog_color[0]));
175 prop->tie("/rendering/dome/fog/green",SGRawValuePointer<float>(&_fog_color[1]));
176 prop->tie("/rendering/dome/fog/blue",SGRawValuePointer<float>(&_fog_color[2]));
177 // Properties used directly by effects
178 _chromeProps[0] = prop->getNode("/rendering/scene/chrome-light/red", true);
179 _chromeProps[1] = prop->getNode("/rendering/scene/chrome-light/green",
181 _chromeProps[2] = prop->getNode("/rendering/scene/chrome-light/blue", true);
182 _chromeProps[3] = prop->getNode("/rendering/scene/chrome-light/alpha",
184 for (int i = 0; i < 4; ++i)
185 _chromeProps[i]->setValue(0.0);
188 void FGLight::unbind () {
189 SGPropertyNode *prop = globals->get_props();
190 prop->untie("/rendering/scene/saturation");
191 prop->untie("/rendering/scene/scattering");
192 prop->untie("/rendering/scene/overcast");
193 prop->untie("/rendering/scene/ambient/red");
194 prop->untie("/rendering/scene/ambient/green");
195 prop->untie("/rendering/scene/ambient/blue");
196 prop->untie("/rendering/scene/diffuse/red");
197 prop->untie("/rendering/scene/diffuse/green");
198 prop->untie("/rendering/scene/diffuse/blue");
199 prop->untie("/rendering/scene/specular/red");
200 prop->untie("/rendering/scene/specular/green");
201 prop->untie("/rendering/scene/specular/blue");
202 prop->untie("/rendering/dome/sun/red");
203 prop->untie("/rendering/dome/sun/green");
204 prop->untie("/rendering/dome/sun/blue");
205 prop->untie("/rendering/dome/sky/red");
206 prop->untie("/rendering/dome/sky/green");
207 prop->untie("/rendering/dome/sky/blue");
208 prop->untie("/rendering/dome/cloud/red");
209 prop->untie("/rendering/dome/cloud/green");
210 prop->untie("/rendering/dome/cloud/blue");
211 prop->untie("/rendering/dome/fog/red");
212 prop->untie("/rendering/dome/fog/green");
213 prop->untie("/rendering/dome/fog/blue");
217 // update lighting parameters based on current sun position
218 void FGLight::update( double dt )
220 update_adj_fog_color();
222 if (_prev_sun_angle != _sun_angle) {
223 _prev_sun_angle = _sun_angle;
228 void FGLight::update_sky_color () {
229 // if the 4th field is 0.0, this specifies a direction ...
230 // const GLfloat white[4] = { 1.0, 1.0, 1.0, 1.0 };
231 const GLfloat base_sky_color[4] = { 0.31, 0.43, 0.69, 1.0 };
232 const GLfloat base_fog_color[4] = { 0.63, 0.72, 0.88, 1.0 };
234 SG_LOG( SG_EVENT, SG_DEBUG, "Updating light parameters." );
236 // calculate lighting parameters based on sun's relative angle to
238 static SGConstPropertyNode_ptr humidity = fgGetNode("/environment/relative-humidity");
239 float av = humidity->getFloatValue() * 45;
240 float visibility_log = log(av)/11.0;
241 float visibility_inv = (45000.0 - av)/45000.0;
243 float deg = _sun_angle * SGD_RADIANS_TO_DEGREES;
244 SG_LOG( SG_EVENT, SG_DEBUG, " Sun angle = " << deg );
246 if (_saturation < 0.0) _saturation = 0.0;
247 else if (_saturation > 1.0) _saturation = 1.0;
248 if (_scattering < 0.0) _scattering = 0.0;
249 else if (_scattering > 1.0) _scattering = 1.0;
250 if (_overcast < 0.0) _overcast = 0.0;
251 else if (_overcast > 1.0) _overcast = 1.0;
253 float ambient = _ambient_tbl->interpolate( deg ) + visibility_inv/10;
254 float diffuse = _diffuse_tbl->interpolate( deg );
255 float specular = _specular_tbl->interpolate( deg ) * visibility_log;
256 float sky_brightness = _sky_tbl->interpolate( deg );
258 ambient *= _saturation;
259 diffuse *= _saturation;
260 specular *= _saturation;
261 sky_brightness *= _saturation;
263 SG_LOG( SG_EVENT, SG_DEBUG,
264 " ambient = " << ambient << " diffuse = " << diffuse
265 << " specular = " << specular << " sky = " << sky_brightness );
267 // sky_brightness = 0.15; // used to force a dark sky (when testing)
269 // set fog and cloud color
270 float sqrt_sky_brightness = (1.0 - sqrt(1.0 - sky_brightness))*_scattering;
271 _fog_color[0] = base_fog_color[0] * sqrt_sky_brightness;
272 _fog_color[1] = base_fog_color[1] * sqrt_sky_brightness;
273 _fog_color[2] = base_fog_color[2] * sqrt_sky_brightness;
274 _fog_color[3] = base_fog_color[3];
275 gamma_correct_rgb( _fog_color.data() );
278 _sky_color[0] = (base_sky_color[0] + (1.0f-base_sky_color[0]) * _overcast) * sky_brightness;
279 _sky_color[1] = (base_sky_color[1] + (1.0f-base_sky_color[1]) * _overcast) * sky_brightness;
280 _sky_color[2] = (base_sky_color[2] + (1.0f-base_sky_color[2]) * _overcast) * sky_brightness;
281 _sky_color[3] = base_sky_color[3];
282 gamma_correct_rgb( _sky_color.data() );
284 sqrt_sky_brightness /= _scattering;
285 _cloud_color[0] = base_fog_color[0] * sky_brightness;
286 _cloud_color[1] = base_fog_color[1] * sky_brightness;
287 _cloud_color[2] = base_fog_color[2] * sky_brightness;
288 _cloud_color[3] = base_fog_color[3];
290 // adjust the cloud colors for sunrise/sunset effects (darken them)
291 if (_sun_angle > 1.0) {
292 float sun2 = sqrt(_sun_angle);
293 _cloud_color[0] /= sun2;
294 _cloud_color[1] /= sun2;
295 _cloud_color[2] /= sun2;
297 gamma_correct_rgb( _cloud_color.data() );
299 _scene_ambient[0] = _fog_color[0] * ambient;
300 _scene_ambient[1] = _fog_color[1] * ambient;
301 _scene_ambient[2] = _fog_color[2] * ambient;
302 _scene_ambient[3] = 1.0;
303 gamma_correct_rgb( _scene_ambient.data() );
305 SGSky* thesky = globals->get_renderer()->getSky();
307 SGVec4f color = thesky->get_scene_color();
308 _scene_diffuse[0] = color[0] * diffuse;
309 _scene_diffuse[1] = color[1] * diffuse;
310 _scene_diffuse[2] = color[2] * diffuse;
311 _scene_diffuse[3] = 1.0;
312 gamma_correct_rgb( _scene_diffuse.data() );
314 SGVec4f chrome = _scene_ambient * .4f + _scene_diffuse;
316 if (chrome != _scene_chrome) {
317 _scene_chrome = chrome;
318 for (int i = 0; i < 4; ++i)
319 _chromeProps[i]->setValue(static_cast<double>(_scene_chrome[i]));
322 // _sun_color = thesky->get_sun_color();
323 _scene_specular[0] = _sun_color[0] * specular;
324 _scene_specular[1] = _sun_color[1] * specular;
325 _scene_specular[2] = _sun_color[2] * specular;
326 _scene_specular[3] = 1.0;
327 gamma_correct_rgb( _scene_specular.data() );
331 // calculate fog color adjusted for sunrise/sunset effects
332 void FGLight::update_adj_fog_color () {
334 double pitch = globals->get_current_view()->getPitch_deg()
335 * SGD_DEGREES_TO_RADIANS;
336 double pitch_offset = globals->get_current_view()-> getPitchOffset_deg()
337 * SGD_DEGREES_TO_RADIANS;
338 double heading = globals->get_current_view()->getHeading_deg()
339 * SGD_DEGREES_TO_RADIANS;
340 double heading_offset = globals->get_current_view()->getHeadingOffset_deg()
341 * SGD_DEGREES_TO_RADIANS;
343 SG_LOG( SG_EVENT, SG_DEBUG, "Updating adjusted fog parameters." );
345 // set fog color (we'll try to match the sunset color in the
346 // direction we are looking
348 // Do some sanity checking ...
349 if ( _sun_rotation < -2.0 * SGD_2PI || _sun_rotation > 2.0 * SGD_2PI ) {
350 SG_LOG( SG_EVENT, SG_ALERT, "Sun rotation bad = " << _sun_rotation );
354 if ( heading < -2.0 * SGD_2PI || heading > 2.0 * SGD_2PI ) {
355 SG_LOG( SG_EVENT, SG_ALERT, "Heading rotation bad = " << heading );
359 if ( heading_offset < -2.0 * SGD_2PI || heading_offset > 2.0 * SGD_2PI ) {
360 SG_LOG( SG_EVENT, SG_ALERT, "Heading offset bad = " << heading_offset );
364 double hor_rotation, vert_rotation;
365 static float gamma = system_gamma;
367 // first determine the difference between our view angle and local
368 // direction to the sun
369 vert_rotation = pitch + pitch_offset;
370 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 // revert to unmodified values before using them.
378 SGSky* thesky = globals->get_renderer()->getSky();
379 SGVec4f color = thesky->get_scene_color();
381 gamma_restore_rgb( _fog_color.data(), gamma );
382 gamma_restore_rgb( _sky_color.data(), gamma );
384 // Calculate the fog color in the direction of the sun for
385 // sunrise/sunset effects.
387 _sun_color[0] = color[0]*color[0]*color[0];
388 _sun_color[1] = color[1]*color[1]*color[1];
389 _sun_color[2] = color[2]*color[2];
391 // interpolate between the sunrise/sunset color and the color
392 // at the opposite direction of this effect. Take in account
393 // the current visibility.
395 float av = thesky->get_visibility();
396 if (av > 45000) av = 45000;
398 float avf = 0.87 - (45000 - av) / 83333.33;
399 float sif = 0.5 - cos(_sun_angle*2)/2;
404 float rf1 = fabs((hor_rotation - SGD_PI) / SGD_PI); // 0.0 .. 1.0
405 float rf2 = avf * pow(rf1*rf1, 1/sif) * 1.0639 * _saturation * _scattering;
406 float rf3 = 1.0 - rf2;
408 gamma = system_gamma * (0.9 - sif*avf);
409 _adj_fog_color[0] = rf3 * _fog_color[0] + rf2 * _sun_color[0];
410 _adj_fog_color[1] = rf3 * _fog_color[1] + rf2 * _sun_color[1];
411 _adj_fog_color[2] = rf3 * _fog_color[2] + rf2 * _sun_color[2];
412 gamma_correct_rgb( _adj_fog_color.data(), gamma);
414 // make sure the colors have their original value before they are being
415 // used by the rest of the program.
417 gamma_correct_rgb( _fog_color.data(), gamma );
418 gamma_correct_rgb( _sky_color.data(), gamma );
421 // update the cur_time_params structure with the current sun position
422 void FGLight::updateSunPos()
424 SGTime *t = globals->get_time_params();
425 FGViewer *v = globals->get_current_view();
427 SG_LOG( SG_EVENT, SG_DEBUG, " Updating Sun position" );
428 SG_LOG( SG_EVENT, SG_DEBUG, " Gst = " << t->getGst() );
430 fgSunPositionGST(t->getGst(), &_sun_lon, &_sun_lat);
431 // It might seem that sun_gc_lat needs to be converted to geodetic
432 // latitude here, but it doesn't. The sun latitude is the latitude
433 // of the point on the earth where the up vector has the same
434 // angle from geocentric Z as the sun direction. But geodetic
435 // latitude is defined as 90 - angle of up vector from Z!
436 SGVec3d sunpos(SGVec3d::fromGeoc(SGGeoc::fromRadM(_sun_lon, _sun_lat,
437 SGGeodesy::EQURAD)));
439 SG_LOG( SG_EVENT, SG_DEBUG, " t->cur_time = " << t->get_cur_time() );
440 SG_LOG( SG_EVENT, SG_DEBUG,
441 " Sun Geocentric lat = " << _sun_lat
442 << " Geodcentric lat = " << _sun_lat );
444 // update the sun light vector
445 sun_vec() = SGVec4f(toVec3f(normalize(sunpos)), 0);
446 sun_vec_inv() = - sun_vec();
448 // calculate the sun's relative angle to local up
449 SGVec3d viewPos = v->get_view_pos();
450 SGQuatd hlOr = SGQuatd::fromLonLat(SGGeod::fromCart(viewPos));
451 SGVec3d world_up = hlOr.backTransform(-SGVec3d::e3());
452 SGVec3d nsun = normalize(sunpos);
453 // cout << "nup = " << nup[0] << "," << nup[1] << ","
454 // << nup[2] << endl;
455 // cout << "nsun = " << nsun[0] << "," << nsun[1] << ","
456 // << nsun[2] << endl;
458 _sun_angle = acos( dot ( world_up, nsun ) );
459 SG_LOG( SG_EVENT, SG_DEBUG, "sun angle relative to current location = "
460 << get_sun_angle() );
462 // Get direction to the sun in the local frame.
463 SGVec3d local_sun_vec = hlOr.transform(nsun);
465 // Angle from south. XXX Is this correct in the southern hemisphere?
466 _sun_rotation = atan2(local_sun_vec.x(), -local_sun_vec.y());
468 // cout << " Sky needs to rotate = " << _sun_rotation << " rads = "
469 // << _sun_rotation * SGD_RADIANS_TO_DEGREES << " degrees." << endl;
471 _sunAngleRad->setDoubleValue(_sun_angle);