src/Environment/environment_mgr.cxx

   1 // environment-mgr.cxx -- manager for natural environment information.
   2 //
   3 // Written by David Megginson, started February 2002.
   4 //
   5 // Copyright (C) 2002  David Megginson - david@megginson.com
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #include <cstring>
  26
  27 #include <simgear/constants.h>
  28 #include <simgear/debug/logstream.hxx>
  29 #include <simgear/scene/sky/sky.hxx>
  30 #include <simgear/environment/visual_enviro.hxx>
  31 #include <simgear/scene/model/particles.hxx>
  32
  33 #include <Main/main.hxx>
  34 #include <Main/fg_props.hxx>
  35 #include <FDM/flight.hxx>
  36
  37 #include "environment.hxx"
  38 #include "environment_mgr.hxx"
  39 #include "environment_ctrl.hxx"
  40 #include "realwx_ctrl.hxx"
  41 #include "fgclouds.hxx"
  42 #include "precipitation_mgr.hxx"
  43 #include "ridge_lift.hxx"
  44 #include "terrainsampler.hxx"
  45
  46 class SGSky;
  47 extern SGSky *thesky;
  48
  49 FGEnvironmentMgr::FGEnvironmentMgr () :
  50   _environment(new FGEnvironment()),
  51   fgClouds(new FGClouds()),
  52   _altitudeNode(fgGetNode("/position/altitude-ft", true)),
  53   _cloudLayersDirty(true)
  54 {
  55   set_subsystem("controller", Environment::LayerInterpolateController::createInstance( fgGetNode("/environment/config", true ) ));
  56   set_subsystem("realwx", Environment::RealWxController::createInstance( fgGetNode("/environment/realwx", true ) ), 1.0 );
  57
  58   set_subsystem("precipitation", new FGPrecipitationMgr);
  59   set_subsystem("terrainsampler", Environment::TerrainSampler::createInstance( fgGetNode("/environment/terrain", true ) ));
  60   set_subsystem("ridgelift", new FGRidgeLift);
  61 }
  62
  63 FGEnvironmentMgr::~FGEnvironmentMgr ()
  64 {
  65   SGSubsystem * subsys;
  66
  67   subsys = get_subsystem( "ridgelift" );
  68   remove_subsystem( "ridgelift" );
  69   delete subsys;
  70
  71   subsys = get_subsystem( "terrainsampler" );
  72   remove_subsystem( "terrainsampler" );
  73   delete subsys;
  74
  75   subsys = get_subsystem( "precipitation" );
  76   remove_subsystem("precipitation");
  77   delete subsys;
  78
  79   subsys = get_subsystem("metarfetcher");
  80   remove_subsystem("metarfetcher");
  81   delete subsys;
  82
  83   subsys = get_subsystem("metarcontroller");
  84   remove_subsystem("metarcontroller");
  85   delete subsys;
  86
  87   subsys = get_subsystem("controller");
  88   remove_subsystem("controller");
  89   delete subsys;
  90
  91   delete fgClouds;
  92   delete _environment;
  93 }
  94
  95 void
  96 FGEnvironmentMgr::init ()
  97 {
  98   SG_LOG( SG_GENERAL, SG_INFO, "Initializing environment subsystem");
  99   SGSubsystemGroup::init();
 100 }
 101
 102 void
 103 FGEnvironmentMgr::reinit ()
 104 {
 105   SG_LOG( SG_GENERAL, SG_INFO, "Reinitializing environment subsystem");
 106   SGSubsystemGroup::reinit();
 107 }
 108
 109 void
 110 FGEnvironmentMgr::bind ()
 111 {
 112   SGSubsystemGroup::bind();
 113   _environment->Tie( fgGetNode("/environment", true ) );
 114
 115   _tiedProperties.setRoot( fgGetNode( "/environment", true ) );
 116
 117   _tiedProperties.Tie( "effective-visibility-m", thesky,
 118        &SGSky::get_visibility );
 119
 120   _tiedProperties.Tie("rebuild-layers", fgClouds,
 121       &FGClouds::get_update_event,
 122       &FGClouds::set_update_event);
 123
 124   _tiedProperties.Tie("turbulence/use-cloud-turbulence", &sgEnviro,
 125       &SGEnviro::get_turbulence_enable_state,
 126       &SGEnviro::set_turbulence_enable_state);
 127
 128   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 129     SGPropertyNode_ptr layerNode = fgGetNode("/environment/clouds",true)->getChild("layer", i, true );
 130
 131     _tiedProperties.Tie( layerNode->getNode("span-m",true), this, i,
 132           &FGEnvironmentMgr::get_cloud_layer_span_m,
 133           &FGEnvironmentMgr::set_cloud_layer_span_m);
 134
 135     _tiedProperties.Tie( layerNode->getNode("elevation-ft",true), this, i,
 136           &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
 137           &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
 138
 139     _tiedProperties.Tie( layerNode->getNode("thickness-ft",true), this, i,
 140           &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
 141           &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
 142
 143     _tiedProperties.Tie( layerNode->getNode("transition-ft",true), this, i,
 144           &FGEnvironmentMgr::get_cloud_layer_transition_ft,
 145           &FGEnvironmentMgr::set_cloud_layer_transition_ft);
 146
 147     _tiedProperties.Tie( layerNode->getNode("coverage",true), this, i,
 148           &FGEnvironmentMgr::get_cloud_layer_coverage,
 149           &FGEnvironmentMgr::set_cloud_layer_coverage);
 150
 151     _tiedProperties.Tie( layerNode->getNode("coverage-type",true), this, i,
 152           &FGEnvironmentMgr::get_cloud_layer_coverage_type,
 153           &FGEnvironmentMgr::set_cloud_layer_coverage_type);
 154
 155     _tiedProperties.Tie( layerNode->getNode( "visibility-m",true), this, i,
 156         &FGEnvironmentMgr::get_cloud_layer_visibility_m,
 157         &FGEnvironmentMgr::set_cloud_layer_visibility_m);
 158
 159     _tiedProperties.Tie( layerNode->getNode( "alpha",true), this, i,
 160         &FGEnvironmentMgr::get_cloud_layer_maxalpha,
 161         &FGEnvironmentMgr::set_cloud_layer_maxalpha);
 162   }
 163
 164   _tiedProperties.setRoot( fgGetNode("/sim/rendering", true ) );
 165
 166   _tiedProperties.Tie( "clouds3d-enable", fgClouds,
 167           &FGClouds::get_3dClouds,
 168           &FGClouds::set_3dClouds);
 169
 170   _tiedProperties.Tie( "clouds3d-density", thesky,
 171           &SGSky::get_3dCloudDensity,
 172           &SGSky::set_3dCloudDensity);
 173
 174   _tiedProperties.Tie("clouds3d-vis-range", thesky,
 175         &SGSky::get_3dCloudVisRange,
 176         &SGSky::set_3dCloudVisRange);
 177
 178   _tiedProperties.Tie("precipitation-enable", &sgEnviro,
 179           &SGEnviro::get_precipitation_enable_state,
 180           &SGEnviro::set_precipitation_enable_state);
 181
 182   _tiedProperties.Tie("lightning-enable", &sgEnviro,
 183       &SGEnviro::get_lightning_enable_state,
 184       &SGEnviro::set_lightning_enable_state);
 185
 186   sgEnviro.config(fgGetNode("/sim/rendering/precipitation"));
 187 }
 188
 189 void
 190 FGEnvironmentMgr::unbind ()
 191 {
 192   _tiedProperties.Untie();
 193   _environment->Untie();
 194   SGSubsystemGroup::unbind();
 195 }
 196
 197 void
 198 FGEnvironmentMgr::update (double dt)
 199 {
 200   SGSubsystemGroup::update(dt);
 201
 202   _environment->set_elevation_ft( _altitudeNode->getDoubleValue() );
 203
 204   simgear::Particles::setWindFrom( _environment->get_wind_from_heading_deg(),
 205                                    _environment->get_wind_speed_kt() );
 206   if( _cloudLayersDirty ) {
 207     _cloudLayersDirty = false;
 208     fgClouds->set_update_event( fgClouds->get_update_event()+1 );
 209   }
 210 }
 211
 212 FGEnvironment
 213 FGEnvironmentMgr::getEnvironment () const
 214 {
 215   return *_environment;
 216 }
 217
 218 FGEnvironment
 219 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 220 {
 221   // Always returns the same environment
 222   // for now; we'll make it interesting
 223   // later.
 224   FGEnvironment env = *_environment;
 225   env.set_elevation_ft(alt);
 226   return env;
 227 }
 228
 229 FGEnvironment
 230 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
 231 {
 232   // Always returns the same environment
 233   // for now; we'll make it interesting
 234   // later.
 235   FGEnvironment env = *_environment;
 236   env.set_elevation_ft(aPos.getElevationFt());
 237   return env;
 238
 239 }
 240
 241 double
 242 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 243 {
 244   return thesky->get_cloud_layer(index)->getSpan_m();
 245 }
 246
 247 void
 248 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 249 {
 250   thesky->get_cloud_layer(index)->setSpan_m(span_m);
 251 }
 252
 253 double
 254 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 255 {
 256   return thesky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 257 }
 258
 259 void
 260 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 261 {
 262   FGEnvironment env = *_environment;
 263   env.set_elevation_ft(elevation_ft);
 264
 265   thesky->get_cloud_layer(index)
 266     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 267
 268   thesky->get_cloud_layer(index)
 269     ->setSpeed(env.get_wind_speed_kt() * 0.5151);       // 1 kt = 0.5151 m/s
 270
 271   thesky->get_cloud_layer(index)
 272     ->setDirection(env.get_wind_from_heading_deg());
 273 }
 274
 275 double
 276 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 277 {
 278   return thesky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 279 }
 280
 281 void
 282 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 283 {
 284   thesky->get_cloud_layer(index)
 285     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 286 }
 287
 288 double
 289 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 290 {
 291   return thesky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 292 }
 293
 294 void
 295 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 296                                                  double transition_ft)
 297 {
 298   thesky->get_cloud_layer(index)
 299     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 300 }
 301
 302 const char *
 303 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 304 {
 305   return thesky->get_cloud_layer(index)->getCoverageString().c_str();
 306 }
 307
 308 void
 309 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 310                                             const char * coverage_name)
 311 {
 312   if( thesky->get_cloud_layer(index)->getCoverageString() == coverage_name )
 313     return;
 314
 315   thesky->get_cloud_layer(index)->setCoverageString(coverage_name);
 316   _cloudLayersDirty = true;
 317 }
 318
 319 int
 320 FGEnvironmentMgr::get_cloud_layer_coverage_type (int index) const
 321 {
 322   return thesky->get_cloud_layer(index)->getCoverage();
 323 }
 324
 325 double
 326 FGEnvironmentMgr::get_cloud_layer_visibility_m (int index) const
 327 {
 328     return thesky->get_cloud_layer(index)->getVisibility_m();
 329 }
 330
 331 void
 332 FGEnvironmentMgr::set_cloud_layer_visibility_m (int index, double visibility_m)
 333 {
 334     thesky->get_cloud_layer(index)->setVisibility_m(visibility_m);
 335 }
 336
 337 double
 338 FGEnvironmentMgr::get_cloud_layer_maxalpha (int index ) const
 339 {
 340     return thesky->get_cloud_layer(index)->getMaxAlpha();
 341 }
 342
 343 void
 344 FGEnvironmentMgr::set_cloud_layer_maxalpha (int index, double maxalpha)
 345 {
 346     thesky->get_cloud_layer(index)->setMaxAlpha(maxalpha);
 347 }
 348
 349
 350
 351
 352 void
 353 FGEnvironmentMgr::set_cloud_layer_coverage_type (int index, int type )
 354 {
 355   if( type < 0 || type >= SGCloudLayer::SG_MAX_CLOUD_COVERAGES ) {
 356     SG_LOG(SG_ALL,SG_WARN,"Unknown cloud layer type " << type << " ignored" );
 357     return;
 358   }
 359
 360   if( static_cast<SGCloudLayer::Coverage>(type) == thesky->get_cloud_layer(index)->getCoverage() )
 361     return;
 362
 363   thesky->get_cloud_layer(index)->setCoverage(static_cast<SGCloudLayer::Coverage>(type));
 364   _cloudLayersDirty = true;
 365 }
 366
 367
 368 // end of environment-mgr.cxx