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.
28 #include <Main/fg_props.hxx>
30 #include <simgear/constants.h>
31 #include <simgear/sound/soundmgr_openal.hxx>
32 #include <simgear/scene/sky/sky.hxx>
33 //#include <simgear/environment/visual_enviro.hxx>
34 #include <simgear/scene/sky/cloudfield.hxx>
35 #include <simgear/scene/sky/newcloud.hxx>
36 #include <simgear/structure/commands.hxx>
37 #include <simgear/math/sg_random.h>
38 #include <simgear/props/props_io.hxx>
40 #include <Main/globals.hxx>
41 #include <Airports/simple.hxx>
42 #include <Main/util.hxx>
44 #include "fgclouds.hxx"
48 static bool do_delete_3Dcloud (const SGPropertyNode *arg);
49 static bool do_move_3Dcloud (const SGPropertyNode *arg);
50 static bool do_add_3Dcloud (const SGPropertyNode *arg);
52 FGClouds::FGClouds() :
56 clouds_3d_enabled(false),
66 int FGClouds::get_update_event(void) const {
70 void FGClouds::set_update_event(int count) {
75 void FGClouds::Init(void) {
77 if( snd_lightning == NULL ) {
78 snd_lightning = new SGSoundSample("Sounds/thunder.wav", SGPath());
79 snd_lightning->set_max_dist(7000.0f);
80 snd_lightning->set_reference_dist(3000.0f);
81 SGSoundMgr *smgr = globals->get_soundmgr();
82 SGSampleGroup *sgr = smgr->find("weather", true);
83 sgr->add( snd_lightning, "thunder" );
87 globals->get_commands()->addCommand("add-cloud", do_add_3Dcloud);
88 globals->get_commands()->addCommand("del-cloud", do_delete_3Dcloud);
89 globals->get_commands()->addCommand("move-cloud", do_move_3Dcloud);
92 // Build an invidual cloud. Returns the extents of the cloud for coverage calculations
93 double FGClouds::buildCloud(SGPropertyNode *cloud_def_root, SGPropertyNode *box_def_root, const string& name, double grid_z_rand, SGCloudField *layer) {
94 SGPropertyNode *box_def=NULL;
95 SGPropertyNode *cld_def=NULL;
98 SGPath texture_root = globals->get_fg_root();
99 texture_root.append("Textures");
100 texture_root.append("Sky");
102 box_def = box_def_root->getChild(name.c_str());
104 string base_name = name.substr(0,2);
106 if( name[2] == '-' ) {
107 box_def = box_def_root->getChild(base_name.c_str());
113 double x = sg_random() * SGCloudField::fieldSize - (SGCloudField::fieldSize / 2.0);
114 double y = sg_random() * SGCloudField::fieldSize - (SGCloudField::fieldSize / 2.0);
115 double z = grid_z_rand * (sg_random() - 0.5);
117 float lon = fgGetNode("/position/longitude-deg", false)->getFloatValue();
118 float lat = fgGetNode("/position/latitude-deg", false)->getFloatValue();
122 for(int i = 0; i < box_def->nChildren() ; i++) {
123 SGPropertyNode *abox = box_def->getChild(i);
124 if( strcmp(abox->getName(), "box") == 0) {
126 string type = abox->getStringValue("type", "cu-small");
127 cld_def = cloud_def_root->getChild(type.c_str());
128 if ( !cld_def ) return 0.0;
130 double w = abox->getDoubleValue("width", 1000.0);
131 double h = abox->getDoubleValue("height", 1000.0);
132 int hdist = abox->getIntValue("hdist", 1);
133 int vdist = abox->getIntValue("vdist", 1);
135 double c = abox->getDoubleValue("count", 5);
136 int count = (int) (c + (sg_random() - 0.5) * c);
138 extent = max(w*w, extent);
140 for (int j = 0; j < count; j++) {
142 // Locate the clouds randomly in the defined space. The hdist and
143 // vdist values control the horizontal and vertical distribution
144 // by simply summing random components.
149 for (int k = 0; k < hdist; k++)
151 x += (sg_random() / hdist);
152 y += (sg_random() / hdist);
155 for (int k = 0; k < vdist; k++)
157 z += (sg_random() / vdist);
160 x = w * (x - 0.5) + pos[0]; // N/S
161 y = w * (y - 0.5) + pos[1]; // E/W
162 z = h * z + pos[2]; // Up/Down. pos[2] is the cloudbase
164 //SGVec3f newpos = SGVec3f(x, y, z);
165 SGNewCloud cld = SGNewCloud(texture_root, cld_def);
167 //layer->addCloud(newpos, cld.genCloud());
168 layer->addCloud(lon, lat, z, x, y, index++, cld.genCloud());
173 // Return the maximum extent of the cloud
177 void FGClouds::buildLayer(int iLayer, const string& name, double coverage) {
182 int CloudVarietyCount = 0;
183 double totalCount = 0.0;
185 SGPropertyNode *cloud_def_root = fgGetNode("/environment/cloudlayers/clouds", false);
186 SGPropertyNode *box_def_root = fgGetNode("/environment/cloudlayers/boxes", false);
187 SGPropertyNode *layer_def_root = fgGetNode("/environment/cloudlayers/layers", false);
188 SGCloudField *layer = thesky->get_cloud_layer(iLayer)->get_layer3D();
191 // If we don't have the required properties, then render the cloud in 2D
192 if ((! clouds_3d_enabled) || coverage == 0.0 ||
193 layer_def_root == NULL || cloud_def_root == NULL || box_def_root == NULL) {
194 thesky->get_cloud_layer(iLayer)->set_enable3dClouds(false);
198 // If we can't find a definition for this cloud type, then render the cloud in 2D
199 SGPropertyNode *layer_def=NULL;
200 layer_def = layer_def_root->getChild(name.c_str());
202 if( name[2] == '-' ) {
203 string base_name = name.substr(0,2);
204 layer_def = layer_def_root->getChild(base_name.c_str());
207 thesky->get_cloud_layer(iLayer)->set_enable3dClouds(false);
212 // At this point, we know we've got some 3D clouds to generate.
213 thesky->get_cloud_layer(iLayer)->set_enable3dClouds(true);
215 double grid_z_rand = layer_def->getDoubleValue("grid-z-rand");
217 for(int i = 0; i < layer_def->nChildren() ; i++) {
218 SGPropertyNode *acloud = layer_def->getChild(i);
219 if( strcmp(acloud->getName(), "cloud") == 0) {
220 string cloud_name = acloud->getStringValue("name");
221 tCloudVariety[CloudVarietyCount].name = cloud_name;
222 double count = acloud->getDoubleValue("count", 1.0);
223 tCloudVariety[CloudVarietyCount].count = count;
225 cloud_name = cloud_name + "-%d";
226 char variety_name[50];
229 snprintf(variety_name, sizeof(variety_name) - 1, cloud_name.c_str(), variety);
230 } while( box_def_root->getChild(variety_name, 0, false) );
233 if( CloudVarietyCount < 20 )
237 totalCount = 1.0 / totalCount;
239 // Determine how much cloud coverage we need in m^2.
240 double cov = coverage * SGCloudField::fieldSize * SGCloudField::fieldSize;
243 double choice = sg_random();
245 for(int i = 0; i < CloudVarietyCount ; i ++) {
246 choice -= tCloudVariety[i].count * totalCount;
247 if( choice <= 0.0 ) {
248 cov -= buildCloud(cloud_def_root,
250 tCloudVariety[i].name,
258 // Now we've built any clouds, enable them and set the density (coverage)
259 //layer->setCoverage(coverage);
260 //layer->applyCoverage();
261 thesky->get_cloud_layer(iLayer)->set_enable3dClouds(clouds_3d_enabled);
264 void FGClouds::buildCloudLayers(void) {
265 SGPropertyNode *metar_root = fgGetNode("/environment", true);
267 //double wind_speed_kt = metar_root->getDoubleValue("wind-speed-kt");
268 double temperature_degc = metar_root->getDoubleValue("temperature-sea-level-degc");
269 double dewpoint_degc = metar_root->getDoubleValue("dewpoint-sea-level-degc");
270 double pressure_mb = metar_root->getDoubleValue("pressure-sea-level-inhg") * SG_INHG_TO_PA / 100.0;
271 double rel_humidity = metar_root->getDoubleValue("relative-humidity");
273 // formule d'Epsy, base d'un cumulus
274 double cumulus_base = 122.0 * (temperature_degc - dewpoint_degc);
275 double stratus_base = 100.0 * (100.0 - rel_humidity) * SG_FEET_TO_METER;
277 for(int iLayer = 0 ; iLayer < thesky->get_cloud_layer_count(); iLayer++) {
278 SGPropertyNode *cloud_root = fgGetNode("/environment/clouds/layer", iLayer, true);
280 double alt_ft = cloud_root->getDoubleValue("elevation-ft");
281 double alt_m = alt_ft * SG_FEET_TO_METER;
282 string coverage = cloud_root->getStringValue("coverage");
284 double coverage_norm = 0.0;
285 if( coverage == "few" )
286 coverage_norm = 2.0/8.0; // <1-2
287 else if( coverage == "scattered" )
288 coverage_norm = 4.0/8.0; // 3-4
289 else if( coverage == "broken" )
290 coverage_norm = 6.0/8.0; // 5-7
291 else if( coverage == "overcast" )
292 coverage_norm = 8.0/8.0; // 8
294 string layer_type = "nn";
296 if( coverage == "cirrus" ) {
298 } else if( alt_ft > 16500 ) {
299 // layer_type = "ci|cs|cc";
301 } else if( alt_ft > 6500 ) {
302 // layer_type = "as|ac|ns";
304 if( pressure_mb < 1005.0 && coverage_norm >= 0.5 )
307 // layer_type = "st|cu|cb|sc";
308 if( cumulus_base * 0.80 < alt_m && cumulus_base * 1.20 > alt_m ) {
309 // +/- 20% from cumulus probable base
311 } else if( stratus_base * 0.80 < alt_m && stratus_base * 1.40 > alt_m ) {
312 // +/- 20% from stratus probable base
315 // above formulae is far from perfect
318 else if( alt_ft < 4500 )
325 cloud_root->setStringValue("layer-type",layer_type);
326 buildLayer(iLayer, layer_type, coverage_norm);
330 void FGClouds::set_3dClouds(bool enable)
332 if (enable != clouds_3d_enabled) {
333 clouds_3d_enabled = enable;
338 bool FGClouds::get_3dClouds() const
340 return clouds_3d_enabled;
344 * Adds a 3D cloud to a cloud layer.
347 * layer - the layer index to add this cloud to. (Defaults to 0)
348 * index - the index for this cloud (to be used later)
349 * lon/lat/alt - the position for the cloud
350 * (Various) - cloud definition properties. See README.3DClouds
354 do_add_3Dcloud (const SGPropertyNode *arg)
356 int l = arg->getIntValue("layer", 0);
357 int index = arg->getIntValue("index", 0);
359 SGPath texture_root = globals->get_fg_root();
360 texture_root.append("Textures");
361 texture_root.append("Sky");
363 float lon = arg->getFloatValue("lon-deg", 0.0f);
364 float lat = arg->getFloatValue("lat-deg", 0.0f);
365 float alt = arg->getFloatValue("alt-ft", 0.0f);
366 float x = arg->getFloatValue("x-offset-m", 0.0f);
367 float y = arg->getFloatValue("y-offset-m", 0.0f);
370 SGCloudField *layer = thesky->get_cloud_layer(l)->get_layer3D();
371 SGNewCloud cld = SGNewCloud(texture_root, arg);
372 bool success = layer->addCloud(lon, lat, alt, x, y, index, cld.genCloud());
374 // Adding a 3D cloud immediately makes this layer 3D.
375 thesky->get_cloud_layer(l)->set_enable3dClouds(true);
381 * Removes a 3D cloud from a cloud layer
385 * layer - the layer index to remove this cloud from. (defaults to 0)
386 * index - the cloud index
390 do_delete_3Dcloud (const SGPropertyNode *arg)
392 int l = arg->getIntValue("layer", 0);
393 int i = arg->getIntValue("index", 0);
395 SGCloudField *layer = thesky->get_cloud_layer(l)->get_layer3D();
396 return layer->deleteCloud(i);
400 * Move a cloud within a 3D layer
403 * layer - the layer index to add this cloud to. (Defaults to 0)
404 * index - the cloud index to move.
405 * lon/lat/alt - the position for the cloud
409 do_move_3Dcloud (const SGPropertyNode *arg)
411 int l = arg->getIntValue("layer", 0);
412 int i = arg->getIntValue("index", 0);
414 float lon = arg->getFloatValue("lon-deg", 0.0f);
415 float lat = arg->getFloatValue("lat-deg", 0.0f);
416 float alt = arg->getFloatValue("alt-ft", 0.0f);
417 float x = arg->getFloatValue("x-offset-m", 0.0f);
418 float y = arg->getFloatValue("y-offset-m", 0.0f);
420 SGCloudField *layer = thesky->get_cloud_layer(l)->get_layer3D();
421 return layer->repositionCloud(i, lon, lat, alt, x, y);