1 // Build a cloud layer based on metar
3 // Written by Harald JOHNSEN, started April 2005.
5 // Copyright (C) 2005 Harald JOHNSEN - hjohnsen@evc.net
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include <Main/fg_props.hxx>
29 #include <simgear/constants.h>
30 #include <simgear/sound/soundmgr_openal.hxx>
31 #include <simgear/scene/sky/sky.hxx>
32 #include <simgear/environment/visual_enviro.hxx>
33 #include <simgear/scene/sky/cloudfield.hxx>
34 #include <simgear/scene/sky/newcloud.hxx>
35 #include <simgear/math/sg_random.h>
36 #include <simgear/props/props_io.hxx>
38 #include <Main/globals.hxx>
39 #include <Airports/simple.hxx>
40 #include <Main/util.hxx>
42 #include "environment_ctrl.hxx"
43 #include "environment_mgr.hxx"
44 #include "fgmetar.hxx"
45 #include "fgclouds.hxx"
50 FGClouds::FGClouds(FGEnvironmentCtrl * controller) :
51 station_elevation_ft(0.0),
52 _controller( controller ),
54 rebuild_required(true),
55 last_scenario( "none" ),
56 last_env_config( new SGPropertyNode() ),
57 last_env_clouds( new SGPropertyNode() )
60 fgSetString("/environment/weather-scenario", last_scenario.c_str());
62 FGClouds::~FGClouds() {
65 int FGClouds::get_update_event(void) const {
68 void FGClouds::set_update_event(int count) {
73 void FGClouds::init(void) {
74 if( snd_lightning == NULL ) {
75 snd_lightning = new SGSoundSample(globals->get_fg_root().c_str(), "Sounds/thunder.wav");
76 snd_lightning->set_max_dist(7000.0f);
77 snd_lightning->set_reference_dist(3000.0f);
78 SGSoundMgr *soundMgr = globals->get_soundmgr();
79 soundMgr->add( snd_lightning, "thunder" );
80 sgEnviro.set_soundMgr( soundMgr );
83 rebuild_required = true;
86 void FGClouds::buildCloud(SGPropertyNode *cloud_def_root, SGPropertyNode *box_def_root, const string& name, sgVec3 pos, SGCloudField *layer) {
87 SGPropertyNode *box_def=NULL;
88 SGPropertyNode *cld_def=NULL;
90 SGPath texture_root = globals->get_fg_root();
91 texture_root.append("Textures");
92 texture_root.append("Sky");
94 box_def = box_def_root->getChild(name.c_str());
96 string base_name = name.substr(0,2);
98 if( name[2] == '-' ) {
99 box_def = box_def_root->getChild(base_name.c_str());
105 for(int i = 0; i < box_def->nChildren() ; i++) {
106 SGPropertyNode *abox = box_def->getChild(i);
107 if( strcmp(abox->getName(), "box") == 0) {
108 double x = abox->getDoubleValue("x") + pos[0];
109 double y = abox->getDoubleValue("y") + pos[1];
110 double z = abox->getDoubleValue("z") + pos[2];
111 SGVec3f newpos = SGVec3f(x, z, y);
113 string type = abox->getStringValue("type", "cu-small");
115 cld_def = cloud_def_root->getChild(type.c_str());
116 if ( !cld_def ) return;
118 double min_width = cld_def->getDoubleValue("min-cloud-width-m", 500.0);
119 double max_width = cld_def->getDoubleValue("max-cloud-width-m", 1000.0);
120 double min_height = cld_def->getDoubleValue("min-cloud-height-m", min_width);
121 double max_height = cld_def->getDoubleValue("max-cloud-height-m", max_width);
122 double min_sprite_width = cld_def->getDoubleValue("min-sprite-width-m", 200.0);
123 double max_sprite_width = cld_def->getDoubleValue("max-sprite-width-m", min_sprite_width);
124 double min_sprite_height = cld_def->getDoubleValue("min-sprite-height-m", min_sprite_width);
125 double max_sprite_height = cld_def->getDoubleValue("max-sprite-height-m", max_sprite_width);
126 int num_sprites = cld_def->getIntValue("num-sprites", 20);
127 int num_textures_x = cld_def->getIntValue("num-textures-x", 1);
128 int num_textures_y = cld_def->getIntValue("num-textures-y", 1);
129 double bottom_shade = cld_def->getDoubleValue("bottom-shade", 1.0);
130 string texture = cld_def->getStringValue("texture", "cl_cumulus.rgb");
148 layer->addCloud(newpos, cld);
153 void FGClouds::buildLayer(int iLayer, const string& name, double alt, double coverage) {
158 int CloudVarietyCount = 0;
159 double totalCount = 0.0;
161 if (! clouds_3d_enabled) return;
163 SGPropertyNode *cloud_def_root = fgGetNode("/environment/cloudlayers/clouds", false);
164 SGPropertyNode *box_def_root = fgGetNode("/environment/cloudlayers/boxes", false);
165 SGPropertyNode *layer_def_root = fgGetNode("/environment/cloudlayers/layers", false);
166 SGCloudField *layer = thesky->get_cloud_layer(iLayer)->get_layer3D();
170 // when we don't generate clouds the layer is rendered in 2D
171 if( coverage == 0.0 )
173 if( layer_def_root == NULL || cloud_def_root == NULL || box_def_root == NULL)
176 SGPropertyNode *layer_def=NULL;
178 layer_def = layer_def_root->getChild(name.c_str());
180 if( name[2] == '-' ) {
181 string base_name = name.substr(0,2);
182 layer_def = layer_def_root->getChild(base_name.c_str());
188 double grid_x_size = layer_def->getDoubleValue("grid-x-size", 1000.0);
189 double grid_y_size = layer_def->getDoubleValue("grid-y-size", 1000.0);
190 double grid_x_rand = layer_def->getDoubleValue("grid-x-rand", grid_x_size);
191 double grid_y_rand = layer_def->getDoubleValue("grid-y-rand", grid_y_size);
192 double grid_z_rand = layer_def->getDoubleValue("grid-z-rand");
194 for(int i = 0; i < layer_def->nChildren() ; i++) {
195 SGPropertyNode *acloud = layer_def->getChild(i);
196 if( strcmp(acloud->getName(), "cloud") == 0) {
197 string cloud_name = acloud->getStringValue("name");
198 tCloudVariety[CloudVarietyCount].name = cloud_name;
199 double count = acloud->getDoubleValue("count", 1.0);
200 tCloudVariety[CloudVarietyCount].count = count;
202 cloud_name = cloud_name + "-%d";
203 char variety_name[50];
206 snprintf(variety_name, sizeof(variety_name), cloud_name.c_str(), variety);
207 } while( box_def_root->getChild(variety_name, 0, false) );
210 if( CloudVarietyCount < 20 )
214 totalCount = 1.0 / totalCount;
216 for(double px = 0.0; px < SGCloudField::fieldSize; px += grid_x_size) {
217 for(double py = 0.0; py < SGCloudField::fieldSize; py += grid_y_size) {
218 double x = px + grid_x_rand * (sg_random() - 0.5) - (SGCloudField::fieldSize / 2.0);
219 double y = py + grid_y_rand * (sg_random() - 0.5) - (SGCloudField::fieldSize / 2.0);
220 double z = grid_z_rand * (sg_random() - 0.5);
221 double choice = sg_random();
223 for(int i = 0; i < CloudVarietyCount ; i ++) {
224 choice -= tCloudVariety[i].count * totalCount;
225 if( choice <= 0.0 ) {
227 buildCloud(cloud_def_root, box_def_root, tCloudVariety[i].name, pos, layer);
234 // Now we've built any clouds, enable them and set the density (coverage)
235 layer->setCoverage(coverage);
236 layer->applyCoverage();
237 thesky->get_cloud_layer(iLayer)->set_enable3dClouds(clouds_3d_enabled);
240 // TODO:call this after real metar updates
241 void FGClouds::buildCloudLayers(void) {
242 SGPropertyNode *metar_root = fgGetNode("/environment", true);
244 double wind_speed_kt = metar_root->getDoubleValue("wind-speed-kt");
245 double temperature_degc = metar_root->getDoubleValue("temperature-sea-level-degc");
246 double dewpoint_degc = metar_root->getDoubleValue("dewpoint-sea-level-degc");
247 double pressure_mb = metar_root->getDoubleValue("pressure-sea-level-inhg") * SG_INHG_TO_PA / 100.0;
249 double dewp = pow(10.0, 7.5 * dewpoint_degc / (237.7 + dewpoint_degc));
250 double temp = pow(10.0, 7.5 * temperature_degc / (237.7 + temperature_degc));
251 double rel_humidity = dewp * 100 / temp;
253 // formule d'Epsy, base d'un cumulus
254 double cumulus_base = 122.0 * (temperature_degc - dewpoint_degc);
255 double stratus_base = 100.0 * (100.0 - rel_humidity) * SG_FEET_TO_METER;
257 bool cu_seen = false;
259 for(int iLayer = 0 ; iLayer < thesky->get_cloud_layer_count(); iLayer++) {
260 SGPropertyNode *cloud_root = fgGetNode("/environment/clouds/layer", iLayer, true);
262 double alt_ft = cloud_root->getDoubleValue("elevation-ft");
263 double alt_m = alt_ft * SG_FEET_TO_METER;
264 string coverage = cloud_root->getStringValue("coverage");
267 double coverage_norm = 0.0;
268 if( coverage == "few" )
269 coverage_norm = 2.0/8.0; // <1-2
270 else if( coverage == "scattered" )
271 coverage_norm = 4.0/8.0; // 3-4
272 else if( coverage == "broken" )
273 coverage_norm = 6.0/8.0; // 5-7
274 else if( coverage == "overcast" )
275 coverage_norm = 8.0/8.0; // 8
277 string layer_type = "nn";
278 if( coverage == "cirrus" ) {
280 } else if( alt_ft > 16500 ) {
281 // layer_type = "ci|cs|cc";
283 } else if( alt_ft > 6500 ) {
284 // layer_type = "as|ac|ns";
286 if( pressure_mb < 1005.0 && coverage_norm >= 5.5 )
289 // layer_type = "st|cu|cb|sc";
290 if( cumulus_base * 0.80 < alt_m && cumulus_base * 1.20 > alt_m ) {
291 // +/- 20% from cumulus probable base
293 } else if( stratus_base * 0.80 < alt_m && stratus_base * 1.40 > alt_m ) {
294 // +/- 20% from stratus probable base
297 // above formulae is far from perfect
300 else if( alt_ft < 4500 )
307 buildLayer(iLayer, layer_type, alt_m, coverage_norm);
311 // copy from FGMetarEnvironmentCtrl until better
313 FGClouds::update_metar_properties( const FGMetar *m )
320 fgSetString("/environment/metar/station-id", m->getId());
321 fgSetDouble("/environment/metar/min-visibility-m",
322 m->getMinVisibility().getVisibility_m() );
323 fgSetDouble("/environment/metar/max-visibility-m",
324 m->getMaxVisibility().getVisibility_m() );
326 const SGMetarVisibility *dirvis = m->getDirVisibility();
327 for (i = 0; i < 8; i++, dirvis++) {
328 const char *min = "/environment/metar/visibility[%d]/min-m";
329 const char *max = "/environment/metar/visibility[%d]/max-m";
331 d = dirvis->getVisibility_m();
333 snprintf(s, 128, min, i);
335 snprintf(s, 128, max, i);
339 fgSetInt("/environment/metar/base-wind-range-from",
340 m->getWindRangeFrom() );
341 fgSetInt("/environment/metar/base-wind-range-to",
342 m->getWindRangeTo() );
343 fgSetDouble("/environment/metar/base-wind-speed-kt",
344 m->getWindSpeed_kt() );
345 fgSetDouble("/environment/metar/gust-wind-speed-kt",
346 m->getGustSpeed_kt() );
347 fgSetDouble("/environment/metar/temperature-degc",
348 m->getTemperature_C() );
349 fgSetDouble("/environment/metar/dewpoint-degc",
350 m->getDewpoint_C() );
351 fgSetDouble("/environment/metar/rel-humidity-norm",
352 m->getRelHumidity() );
353 fgSetDouble("/environment/metar/pressure-inhg",
354 m->getPressure_inHg() );
356 vector<SGMetarCloud> cv = m->getClouds();
357 vector<SGMetarCloud>::const_iterator cloud;
359 // Load into both the METAR and environment properties to stop interpolation
360 const char *cl[] = {"/environment/metar/clouds/layer[%i]",
361 "/environment/clouds/layer[%i]"};
363 for (j = 0; j < 2; j++)
365 for (i = 0, cloud = cv.begin(); cloud != cv.end(); cloud++, i++) {
366 const char *coverage_string[5] =
367 { "clear", "few", "scattered", "broken", "overcast" };
368 const double thickness[5] = { 0, 65, 600,750, 1000};
371 snprintf(s, 128, cl[j], i);
372 strncat(s, "/coverage", 128);
373 q = cloud->getCoverage();
374 fgSetString(s, coverage_string[q] );
376 snprintf(s, 128, cl[j], i);
377 strncat(s, "/elevation-ft", 128);
378 fgSetDouble(s, cloud->getAltitude_ft() + station_elevation_ft);
380 snprintf(s, 128, cl[j], i);
381 strncat(s, "/thickness-ft", 128);
382 fgSetDouble(s, thickness[q]);
384 snprintf(s, 128, cl[j], i);
385 strncat(s, "/span-m", 128);
386 fgSetDouble(s, 40000.0);
389 for (; i < FGEnvironmentMgr::MAX_CLOUD_LAYERS; i++) {
392 snprintf(s, 128, cl[j], i);
393 strncat(s, "/coverage", 128);
394 fgSetString(s, "clear");
396 snprintf(s, 128, cl[j], i);
397 strncat(s, "/elevation-ft", 128);
398 fgSetDouble(s, -9999);
400 snprintf(s, 128, cl[j], i);
401 strncat(s, "/thickness-ft", 128);
404 snprintf(s, 128, cl[j], i);
405 strncat(s, "/span-m", 128);
406 fgSetDouble(s, 40000.0);
410 fgSetDouble("/environment/metar/rain-norm", m->getRain());
411 fgSetDouble("/environment/metar/hail-norm", m->getHail());
412 fgSetDouble("/environment/metar/snow-norm", m->getSnow());
413 fgSetBool("/environment/metar/snow-cover", m->getSnowCover());
417 FGClouds::update_env_config ()
419 fgSetupWind( fgGetDouble("/environment/metar/base-wind-range-from"),
420 fgGetDouble("/environment/metar/base-wind-range-to"),
421 fgGetDouble("/environment/metar/base-wind-speed-kt"),
422 fgGetDouble("/environment/metar/gust-wind-speed-kt") );
424 fgDefaultWeatherValue( "visibility-m",
425 fgGetDouble("/environment/metar/min-visibility-m") );
427 set_temp_at_altitude( fgGetDouble("/environment/metar/temperature-degc"),
428 station_elevation_ft );
429 set_dewpoint_at_altitude( fgGetDouble("/environment/metar/dewpoint-degc"),
430 station_elevation_ft );
432 fgDefaultWeatherValue( "pressure-sea-level-inhg",
433 fgGetDouble("/environment/metar/pressure-inhg") );
437 void FGClouds::setLayer( int iLayer, float alt_ft, const string& coverage, const string& layer_type ) {
438 double coverage_norm = 0.0;
439 if( coverage == "few" )
440 coverage_norm = 2.0/8.0; // <1-2
441 else if( coverage == "scattered" )
442 coverage_norm = 4.0/8.0; // 3-4
443 else if( coverage == "broken" )
444 coverage_norm = 6.0/8.0; // 5-7
445 else if( coverage == "overcast" )
446 coverage_norm = 8.0/8.0; // 8
448 buildLayer(iLayer, layer_type, station_elevation_ft + alt_ft * SG_FEET_TO_METER, coverage_norm);
451 void FGClouds::buildScenario( const string& scenario ) {
453 string station = fgGetString("/environment/metar/station-id", "XXXX");
455 // fetch station elevation if exists
456 if( station == "XXXX" )
457 station_elevation_ft = fgGetDouble("/position/ground-elev-m", 0.0);
459 const FGAirport* a = globals->get_airports()->search( station );
460 station_elevation_ft = (a ? a->getElevation() : 0.0);
463 for(int iLayer = 0 ; iLayer < thesky->get_cloud_layer_count(); iLayer++) {
464 thesky->get_cloud_layer(iLayer)
465 ->setCoverage(SGCloudLayer::SG_CLOUD_CLEAR);
466 thesky->get_cloud_layer(iLayer)->get_layer3D()->clear();
469 station += " 011000Z ";
470 if( scenario == "Fair weather" ) {
471 fakeMetar = "15003KT 12SM SCT033 FEW200 20/08 Q1015 NOSIG";
472 //setLayer(0, 3300.0, "scattered", "cu");
473 } else if( scenario == "Thunderstorm" ) {
474 fakeMetar = "15012KT 08SM TSRA SCT040 BKN070 20/12 Q0995";
475 setLayer(0, 4000.0, "scattered", "cb");
476 setLayer(1, 7000.0, "scattered", "ns");
479 FGMetar *m = new FGMetar( station + fakeMetar );
480 update_metar_properties( m );
482 // propagate aloft tables
483 //_controller->reinit();
485 fgSetString("/environment/metar/last-metar", m->getData());
486 // TODO:de-activate real metar updates
487 if( scenario == "Fair weather" ) {
488 fgSetString("/environment/clouds/layer[1]/coverage", "cirrus");
493 void FGClouds::build() {
494 string scenario = fgGetString("/environment/weather-scenario", "METAR");
496 if(!rebuild_required && (scenario == last_scenario))
499 if( last_scenario == "none" ) {
500 // save clouds and weather conditions
501 SGPropertyNode *param = fgGetNode("/environment/config", true);
502 copyProperties( param, last_env_config );
503 param = fgGetNode("/environment/clouds", true);
504 copyProperties( param, last_env_clouds );
507 if( scenario == "METAR" ) {
508 string realMetar = fgGetString("/environment/metar/real-metar", "");
509 if( realMetar != "" ) {
510 fgSetString("/environment/metar/last-metar", realMetar.c_str());
511 FGMetar *m = new FGMetar( realMetar );
512 update_metar_properties( m );
514 // propagate aloft tables
515 _controller->reinit();
519 else if( scenario == "none" ) {
520 // restore clouds and weather conditions
521 SGPropertyNode *param = fgGetNode("/environment/config", true);
522 copyProperties( last_env_config, param );
523 param = fgGetNode("/environment/clouds", true);
524 copyProperties( last_env_clouds, param );
525 fgSetDouble("/environment/metar/rain-norm", 0.0);
526 fgSetDouble("/environment/metar/snow-norm", 0.0);
527 // update_env_config();
528 // propagate aloft tables
529 _controller->reinit();
533 buildScenario( scenario );
534 _controller->reinit();
538 last_scenario = scenario;
539 rebuild_required = false;
541 if( snd_lightning == NULL )
545 void FGClouds::set_3dClouds(bool enable)
547 if (enable != clouds_3d_enabled) {
548 clouds_3d_enabled = enable;
550 for(int iLayer = 0 ; iLayer < thesky->get_cloud_layer_count(); iLayer++) {
551 thesky->get_cloud_layer(iLayer)->set_enable3dClouds(enable);
554 thesky->get_cloud_layer(iLayer)->get_layer3D()->clear();
559 rebuild_required = true;
565 bool FGClouds::get_3dClouds() const {
566 return clouds_3d_enabled;