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 #include "Airports/simple.hxx"
  46
  47 class SGSky;
  48 extern SGSky *thesky;
  49
  50 FGEnvironmentMgr::FGEnvironmentMgr () :
  51   _environment(new FGEnvironment()),
  52   fgClouds(new FGClouds()),
  53   _cloudLayersDirty(true),
  54   _altitudeNode(fgGetNode("/position/altitude-ft", true)),
  55   _longitude_n(fgGetNode( "/position/longitude-deg", true )),
  56   _latitude_n( fgGetNode( "/position/latitude-deg", true )),
  57   _positionTimeToLive(0.0)
  58 {
  59   set_subsystem("controller", Environment::LayerInterpolateController::createInstance( fgGetNode("/environment/config", true ) ));
  60   set_subsystem("realwx", Environment::RealWxController::createInstance( fgGetNode("/environment/realwx", true ) ), 1.0 );
  61
  62   set_subsystem("precipitation", new FGPrecipitationMgr);
  63   set_subsystem("terrainsampler", Environment::TerrainSampler::createInstance( fgGetNode("/environment/terrain", true ) ));
  64   set_subsystem("ridgelift", new FGRidgeLift);
  65 }
  66
  67 FGEnvironmentMgr::~FGEnvironmentMgr ()
  68 {
  69   SGSubsystem * subsys;
  70
  71   subsys = get_subsystem( "ridgelift" );
  72   remove_subsystem( "ridgelift" );
  73   delete subsys;
  74
  75   subsys = get_subsystem( "terrainsampler" );
  76   remove_subsystem( "terrainsampler" );
  77   delete subsys;
  78
  79   subsys = get_subsystem( "precipitation" );
  80   remove_subsystem("precipitation");
  81   delete subsys;
  82
  83   subsys = get_subsystem("realwx");
  84   remove_subsystem("realwx");
  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   _positionTimeToLive -= dt;
 212   if( _positionTimeToLive <= 0.0 )
 213   {
 214       // update closest airport information
 215       _positionTimeToLive = 30.0;
 216
 217       SG_LOG(SG_ALL, SG_INFO, "FGEnvironmentMgr::update: updating closest airport");
 218
 219       SGGeod pos = SGGeod::fromDeg(_longitude_n->getDoubleValue(),
 220                                    _latitude_n->getDoubleValue());
 221
 222       FGAirport * nearestAirport = FGAirport::findClosest(pos, 100.0);
 223       if( nearestAirport == NULL )
 224       {
 225           SG_LOG(SG_ALL,SG_WARN,"FGEnvironmentMgr::update: No airport within 100NM range");
 226       }
 227       else
 228       {
 229           const string currentId = fgGetString("/sim/airport/closest-airport-id", "");
 230           if (currentId != nearestAirport->ident())
 231           {
 232               fgSetString("/sim/airport/closest-airport-id",
 233                       nearestAirport->ident().c_str());
 234           }
 235       }
 236   }
 237 }
 238
 239 FGEnvironment
 240 FGEnvironmentMgr::getEnvironment () const
 241 {
 242   return *_environment;
 243 }
 244
 245 FGEnvironment
 246 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 247 {
 248   // Always returns the same environment
 249   // for now; we'll make it interesting
 250   // later.
 251   FGEnvironment env = *_environment;
 252   env.set_elevation_ft(alt);
 253   return env;
 254 }
 255
 256 FGEnvironment
 257 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
 258 {
 259   // Always returns the same environment
 260   // for now; we'll make it interesting
 261   // later.
 262   FGEnvironment env = *_environment;
 263   env.set_elevation_ft(aPos.getElevationFt());
 264   return env;
 265
 266 }
 267
 268 double
 269 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 270 {
 271   return thesky->get_cloud_layer(index)->getSpan_m();
 272 }
 273
 274 void
 275 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 276 {
 277   thesky->get_cloud_layer(index)->setSpan_m(span_m);
 278 }
 279
 280 double
 281 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 282 {
 283   return thesky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 284 }
 285
 286 void
 287 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 288 {
 289   FGEnvironment env = *_environment;
 290   env.set_elevation_ft(elevation_ft);
 291
 292   thesky->get_cloud_layer(index)
 293     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 294
 295   thesky->get_cloud_layer(index)
 296     ->setSpeed(env.get_wind_speed_kt() * 0.5151);       // 1 kt = 0.5151 m/s
 297
 298   thesky->get_cloud_layer(index)
 299     ->setDirection(env.get_wind_from_heading_deg());
 300 }
 301
 302 double
 303 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 304 {
 305   return thesky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 306 }
 307
 308 void
 309 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 310 {
 311   thesky->get_cloud_layer(index)
 312     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 313 }
 314
 315 double
 316 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 317 {
 318   return thesky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 319 }
 320
 321 void
 322 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 323                                                  double transition_ft)
 324 {
 325   thesky->get_cloud_layer(index)
 326     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 327 }
 328
 329 const char *
 330 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 331 {
 332   return thesky->get_cloud_layer(index)->getCoverageString().c_str();
 333 }
 334
 335 void
 336 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 337                                             const char * coverage_name)
 338 {
 339   if( thesky->get_cloud_layer(index)->getCoverageString() == coverage_name )
 340     return;
 341
 342   thesky->get_cloud_layer(index)->setCoverageString(coverage_name);
 343   _cloudLayersDirty = true;
 344 }
 345
 346 int
 347 FGEnvironmentMgr::get_cloud_layer_coverage_type (int index) const
 348 {
 349   return thesky->get_cloud_layer(index)->getCoverage();
 350 }
 351
 352 double
 353 FGEnvironmentMgr::get_cloud_layer_visibility_m (int index) const
 354 {
 355     return thesky->get_cloud_layer(index)->getVisibility_m();
 356 }
 357
 358 void
 359 FGEnvironmentMgr::set_cloud_layer_visibility_m (int index, double visibility_m)
 360 {
 361     thesky->get_cloud_layer(index)->setVisibility_m(visibility_m);
 362 }
 363
 364 double
 365 FGEnvironmentMgr::get_cloud_layer_maxalpha (int index ) const
 366 {
 367     return thesky->get_cloud_layer(index)->getMaxAlpha();
 368 }
 369
 370 void
 371 FGEnvironmentMgr::set_cloud_layer_maxalpha (int index, double maxalpha)
 372 {
 373     thesky->get_cloud_layer(index)->setMaxAlpha(maxalpha);
 374 }
 375
 376 void
 377 FGEnvironmentMgr::set_cloud_layer_coverage_type (int index, int type )
 378 {
 379   if( type < 0 || type >= SGCloudLayer::SG_MAX_CLOUD_COVERAGES ) {
 380     SG_LOG(SG_ALL,SG_WARN,"Unknown cloud layer type " << type << " ignored" );
 381     return;
 382   }
 383
 384   if( static_cast<SGCloudLayer::Coverage>(type) == thesky->get_cloud_layer(index)->getCoverage() )
 385     return;
 386
 387   thesky->get_cloud_layer(index)->setCoverage(static_cast<SGCloudLayer::Coverage>(type));
 388   _cloudLayersDirty = true;
 389 }
 390
 391
 392 // end of environment-mgr.cxx