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/scene/model/particles.hxx>
  31 #include <simgear/structure/event_mgr.hxx>
  32
  33 #include <Main/main.hxx>
  34 #include <Main/renderer.hxx>
  35 #include <Main/fg_props.hxx>
  36 #include <FDM/flight.hxx>
  37
  38 #include "environment.hxx"
  39 #include "environment_mgr.hxx"
  40 #include "environment_ctrl.hxx"
  41 #include "realwx_ctrl.hxx"
  42 #include "fgclouds.hxx"
  43 #include "precipitation_mgr.hxx"
  44 #include "ridge_lift.hxx"
  45 #include "terrainsampler.hxx"
  46 #include "Airports/simple.hxx"
  47 #include "gravity.hxx"
  48
  49 class FG3DCloudsListener : public SGPropertyChangeListener {
  50 public:
  51   FG3DCloudsListener( FGClouds * fgClouds );
  52   virtual ~FG3DCloudsListener();
  53
  54   virtual void valueChanged (SGPropertyNode * node);
  55
  56 private:
  57   FGClouds * _fgClouds;
  58   SGPropertyNode_ptr _shaderNode;
  59   SGPropertyNode_ptr _enableNode;
  60 };
  61
  62 FG3DCloudsListener::FG3DCloudsListener( FGClouds * fgClouds ) :
  63     _fgClouds( fgClouds )
  64 {
  65   _shaderNode = fgGetNode( "/sim/rendering/shader-effects", true );
  66   _shaderNode->addChangeListener( this );
  67
  68   _enableNode = fgGetNode( "/sim/rendering/clouds3d-enable", true );
  69   _enableNode->addChangeListener( this );
  70
  71   valueChanged( _enableNode );
  72 }
  73
  74 FG3DCloudsListener::~FG3DCloudsListener()
  75 {
  76   _enableNode->removeChangeListener( this );
  77   _shaderNode->removeChangeListener( this );
  78 }
  79
  80 void FG3DCloudsListener::valueChanged( SGPropertyNode * node )
  81 {
  82   _fgClouds->set_3dClouds( _enableNode->getBoolValue() && _shaderNode->getBoolValue() );
  83 }
  84
  85 FGEnvironmentMgr::FGEnvironmentMgr () :
  86   _environment(new FGEnvironment()),
  87   fgClouds(new FGClouds()),
  88   _cloudLayersDirty(true),
  89   _altitude_n(fgGetNode("/position/altitude-ft", true)),
  90   _longitude_n(fgGetNode( "/position/longitude-deg", true )),
  91   _latitude_n( fgGetNode( "/position/latitude-deg", true )),
  92   _3dCloudsEnableListener(new FG3DCloudsListener(fgClouds) ),
  93   _sky(globals->get_renderer()->getSky())
  94 {
  95   set_subsystem("controller", Environment::LayerInterpolateController::createInstance( fgGetNode("/environment/config", true ) ));
  96   set_subsystem("realwx", Environment::RealWxController::createInstance( fgGetNode("/environment/realwx", true ) ), 1.0 );
  97
  98   set_subsystem("precipitation", new FGPrecipitationMgr);
  99   set_subsystem("terrainsampler", Environment::TerrainSampler::createInstance( fgGetNode("/environment/terrain", true ) ));
 100   set_subsystem("ridgelift", new FGRidgeLift);
 101 }
 102
 103 FGEnvironmentMgr::~FGEnvironmentMgr ()
 104 {
 105   SGSubsystem * subsys;
 106
 107   subsys = get_subsystem( "ridgelift" );
 108   remove_subsystem( "ridgelift" );
 109   delete subsys;
 110
 111   subsys = get_subsystem( "terrainsampler" );
 112   remove_subsystem( "terrainsampler" );
 113   delete subsys;
 114
 115   subsys = get_subsystem( "precipitation" );
 116   remove_subsystem("precipitation");
 117   delete subsys;
 118
 119   subsys = get_subsystem("realwx");
 120   remove_subsystem("realwx");
 121   delete subsys;
 122
 123   subsys = get_subsystem("controller");
 124   remove_subsystem("controller");
 125   delete subsys;
 126
 127   delete fgClouds;
 128   delete _environment;
 129
 130   delete _3dCloudsEnableListener;
 131 }
 132
 133 void
 134 FGEnvironmentMgr::init ()
 135 {
 136   SG_LOG( SG_ENVIRONMENT, SG_INFO, "Initializing environment subsystem");
 137   SGSubsystemGroup::init();
 138   fgClouds->Init();
 139
 140   // FIXME: is this really part of the environment_mgr?
 141   // Initialize the longitude, latitude and altitude to the initial position
 142   // of the aircraft so that the atmospheric properties (pressure, temperature
 143   // and density) can be initialized accordingly.
 144   _altitude_n->setDoubleValue(fgGetDouble("/sim/presets/altitude-ft"));
 145   _longitude_n->setDoubleValue(fgGetDouble("/sim/presets/longitude-deg"));
 146   _latitude_n->setDoubleValue(fgGetDouble("/sim/presets/latitude-deg"));
 147
 148   globals->get_event_mgr()->addTask("updateClosestAirport", this,
 149                                     &FGEnvironmentMgr::updateClosestAirport, 30 );
 150 }
 151
 152 void
 153 FGEnvironmentMgr::shutdown()
 154 {
 155   globals->get_event_mgr()->removeTask("updateClosestAirport");
 156 }
 157
 158 void
 159 FGEnvironmentMgr::reinit ()
 160 {
 161   SG_LOG( SG_ENVIRONMENT, SG_INFO, "Reinitializing environment subsystem");
 162   SGSubsystemGroup::reinit();
 163 }
 164
 165 void
 166 FGEnvironmentMgr::bind ()
 167 {
 168   SGSubsystemGroup::bind();
 169   _environment->Tie( fgGetNode("/environment", true ) );
 170
 171   _tiedProperties.setRoot( fgGetNode( "/environment", true ) );
 172
 173   _tiedProperties.Tie( "effective-visibility-m", _sky,
 174           &SGSky::get_visibility );
 175
 176   _tiedProperties.Tie("rebuild-layers", fgClouds,
 177           &FGClouds::get_update_event,
 178           &FGClouds::set_update_event);
 179
 180 //  _tiedProperties.Tie("turbulence/use-cloud-turbulence", &sgEnviro,
 181 //          &SGEnviro::get_turbulence_enable_state,
 182 //          &SGEnviro::set_turbulence_enable_state);
 183
 184   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 185       SGPropertyNode_ptr layerNode = fgGetNode("/environment/clouds",true)->getChild("layer", i, true );
 186
 187       _tiedProperties.Tie( layerNode->getNode("span-m",true), this, i,
 188               &FGEnvironmentMgr::get_cloud_layer_span_m,
 189               &FGEnvironmentMgr::set_cloud_layer_span_m);
 190
 191       _tiedProperties.Tie( layerNode->getNode("elevation-ft",true), this, i,
 192               &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
 193               &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
 194
 195       _tiedProperties.Tie( layerNode->getNode("thickness-ft",true), this, i,
 196               &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
 197               &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
 198
 199       _tiedProperties.Tie( layerNode->getNode("transition-ft",true), this, i,
 200               &FGEnvironmentMgr::get_cloud_layer_transition_ft,
 201               &FGEnvironmentMgr::set_cloud_layer_transition_ft);
 202
 203       _tiedProperties.Tie( layerNode->getNode("coverage",true), this, i,
 204               &FGEnvironmentMgr::get_cloud_layer_coverage,
 205               &FGEnvironmentMgr::set_cloud_layer_coverage);
 206
 207       _tiedProperties.Tie( layerNode->getNode("coverage-type",true), this, i,
 208               &FGEnvironmentMgr::get_cloud_layer_coverage_type,
 209               &FGEnvironmentMgr::set_cloud_layer_coverage_type);
 210
 211       _tiedProperties.Tie( layerNode->getNode( "visibility-m",true), this, i,
 212               &FGEnvironmentMgr::get_cloud_layer_visibility_m,
 213               &FGEnvironmentMgr::set_cloud_layer_visibility_m);
 214
 215       _tiedProperties.Tie( layerNode->getNode( "alpha",true), this, i,
 216               &FGEnvironmentMgr::get_cloud_layer_maxalpha,
 217               &FGEnvironmentMgr::set_cloud_layer_maxalpha);
 218   }
 219
 220   _tiedProperties.setRoot( fgGetNode("/sim/rendering", true ) );
 221
 222   _tiedProperties.Tie( "clouds3d-density", _sky,
 223           &SGSky::get_3dCloudDensity,
 224           &SGSky::set_3dCloudDensity);
 225
 226   _tiedProperties.Tie("clouds3d-vis-range", _sky,
 227           &SGSky::get_3dCloudVisRange,
 228           &SGSky::set_3dCloudVisRange);
 229
 230   _tiedProperties.Tie("clouds3d-wrap", _sky,
 231           &SGSky::get_3dCloudWrap,
 232           &SGSky::set_3dCloudWrap);
 233
 234 //  _tiedProperties.Tie("lightning-enable", &sgEnviro,
 235 //          &SGEnviro::get_lightning_enable_state,
 236 //          &SGEnviro::set_lightning_enable_state);
 237
 238 }
 239
 240 void
 241 FGEnvironmentMgr::unbind ()
 242 {
 243   _tiedProperties.Untie();
 244   _environment->Untie();
 245   SGSubsystemGroup::unbind();
 246 }
 247
 248 void
 249 FGEnvironmentMgr::update (double dt)
 250 {
 251   SGSubsystemGroup::update(dt);
 252
 253   _environment->set_elevation_ft( _altitude_n->getDoubleValue() );
 254
 255   simgear::Particles::setWindFrom( _environment->get_wind_from_heading_deg(),
 256                                    _environment->get_wind_speed_kt() );
 257   if( _cloudLayersDirty ) {
 258     _cloudLayersDirty = false;
 259     fgClouds->set_update_event( fgClouds->get_update_event()+1 );
 260   }
 261
 262
 263   fgSetDouble( "/environment/gravitational-acceleration-mps2",
 264     Environment::Gravity::instance()->getGravity(SGGeod::fromDegFt(
 265       _longitude_n->getDoubleValue(),
 266       _latitude_n->getDoubleValue(),
 267       _altitude_n->getDoubleValue()
 268   )));
 269 }
 270
 271 void
 272 FGEnvironmentMgr::updateClosestAirport()
 273 {
 274   SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "FGEnvironmentMgr::update: updating closest airport");
 275
 276   SGGeod pos = globals->get_aircraft_position();
 277   FGAirport * nearestAirport = FGAirport::findClosest(pos, 100.0);
 278   if( nearestAirport == NULL )
 279   {
 280     SG_LOG(SG_ENVIRONMENT,SG_WARN,"FGEnvironmentMgr::update: No airport within 100NM range");
 281   }
 282   else
 283   {
 284     const string currentId = fgGetString("/sim/airport/closest-airport-id", "");
 285     if (currentId != nearestAirport->ident())
 286     {
 287       SG_LOG(SG_ENVIRONMENT, SG_INFO, "FGEnvironmentMgr::updateClosestAirport: selected:" << nearestAirport->ident());
 288       fgSetString("/sim/airport/closest-airport-id",
 289                   nearestAirport->ident().c_str());
 290     }
 291   }
 292
 293 }
 294
 295 FGEnvironment
 296 FGEnvironmentMgr::getEnvironment () const
 297 {
 298   return *_environment;
 299 }
 300
 301 FGEnvironment
 302 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 303 {
 304   // Always returns the same environment
 305   // for now; we'll make it interesting
 306   // later.
 307   FGEnvironment env = *_environment;
 308   env.set_elevation_ft(alt);
 309   return env;
 310 }
 311
 312 FGEnvironment
 313 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
 314 {
 315   // Always returns the same environment
 316   // for now; we'll make it interesting
 317   // later.
 318   FGEnvironment env = *_environment;
 319   env.set_elevation_ft(aPos.getElevationFt());
 320   return env;
 321
 322 }
 323
 324 double
 325 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 326 {
 327   return _sky->get_cloud_layer(index)->getSpan_m();
 328 }
 329
 330 void
 331 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 332 {
 333   _sky->get_cloud_layer(index)->setSpan_m(span_m);
 334 }
 335
 336 double
 337 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 338 {
 339   return _sky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 340 }
 341
 342 void
 343 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 344 {
 345   FGEnvironment env = *_environment;
 346   env.set_elevation_ft(elevation_ft);
 347
 348   _sky->get_cloud_layer(index)
 349     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 350
 351   _sky->get_cloud_layer(index)
 352     ->setSpeed(env.get_wind_speed_kt() * 0.5151);       // 1 kt = 0.5151 m/s
 353
 354   _sky->get_cloud_layer(index)
 355     ->setDirection(env.get_wind_from_heading_deg());
 356 }
 357
 358 double
 359 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 360 {
 361   return _sky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 362 }
 363
 364 void
 365 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 366 {
 367   _sky->get_cloud_layer(index)
 368     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 369 }
 370
 371 double
 372 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 373 {
 374   return _sky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 375 }
 376
 377 void
 378 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 379                                                  double transition_ft)
 380 {
 381   _sky->get_cloud_layer(index)
 382     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 383 }
 384
 385 const char *
 386 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 387 {
 388   return _sky->get_cloud_layer(index)->getCoverageString().c_str();
 389 }
 390
 391 void
 392 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 393                                             const char * coverage_name)
 394 {
 395   if( _sky->get_cloud_layer(index)->getCoverageString() == coverage_name )
 396     return;
 397
 398   _sky->get_cloud_layer(index)->setCoverageString(coverage_name);
 399   _cloudLayersDirty = true;
 400 }
 401
 402 int
 403 FGEnvironmentMgr::get_cloud_layer_coverage_type (int index) const
 404 {
 405   return _sky->get_cloud_layer(index)->getCoverage();
 406 }
 407
 408 double
 409 FGEnvironmentMgr::get_cloud_layer_visibility_m (int index) const
 410 {
 411     return _sky->get_cloud_layer(index)->getVisibility_m();
 412 }
 413
 414 void
 415 FGEnvironmentMgr::set_cloud_layer_visibility_m (int index, double visibility_m)
 416 {
 417     _sky->get_cloud_layer(index)->setVisibility_m(visibility_m);
 418 }
 419
 420 double
 421 FGEnvironmentMgr::get_cloud_layer_maxalpha (int index ) const
 422 {
 423     return _sky->get_cloud_layer(index)->getMaxAlpha();
 424 }
 425
 426 void
 427 FGEnvironmentMgr::set_cloud_layer_maxalpha (int index, double maxalpha)
 428 {
 429     _sky->get_cloud_layer(index)->setMaxAlpha(maxalpha);
 430 }
 431
 432 void
 433 FGEnvironmentMgr::set_cloud_layer_coverage_type (int index, int type )
 434 {
 435   if( type < 0 || type >= SGCloudLayer::SG_MAX_CLOUD_COVERAGES ) {
 436     SG_LOG(SG_ENVIRONMENT,SG_WARN,"Unknown cloud layer type " << type << " ignored" );
 437     return;
 438   }
 439
 440   if( static_cast<SGCloudLayer::Coverage>(type) == _sky->get_cloud_layer(index)->getCoverage() )
 441     return;
 442
 443   _sky->get_cloud_layer(index)->setCoverage(static_cast<SGCloudLayer::Coverage>(type));
 444   _cloudLayersDirty = true;
 445 }
 446
 447
 448 // end of environment-mgr.cxx