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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23 #include <simgear/debug/logstream.hxx>
  24 #include <simgear/scene/sky/sky.hxx>
  25
  26 #include <Main/fg_props.hxx>
  27 #include <Aircraft/aircraft.hxx>
  28
  29 #include "environment.hxx"
  30 #include "environment_ctrl.hxx"
  31 #include "environment_mgr.hxx"
  32
  33 extern SGSky *thesky;           // FIXME: from main.cxx
  34
  35
  36 FGEnvironmentMgr::FGEnvironmentMgr ()
  37   : _environment(new FGEnvironment),
  38     _controller(new FGInterpolateEnvironmentCtrl)
  39 {
  40   _controller->setEnvironment(_environment);
  41   set_subsystem("controller", _controller, 0.5);
  42 }
  43
  44 FGEnvironmentMgr::~FGEnvironmentMgr ()
  45 {
  46   delete _environment;
  47   delete _controller;
  48 }
  49
  50 void
  51 FGEnvironmentMgr::init ()
  52 {
  53   SG_LOG( SG_GENERAL, SG_INFO, "Initializing environment subsystem");
  54   FGSubsystemGroup::init();
  55   _update_fdm();
  56 }
  57
  58 void
  59 FGEnvironmentMgr::reinit ()
  60 {
  61   SG_LOG( SG_GENERAL, SG_INFO, "Reinitializing environment subsystem");
  62   FGSubsystemGroup::reinit();
  63   _update_fdm();
  64 }
  65
  66 void
  67 FGEnvironmentMgr::bind ()
  68 {
  69   fgTie("/environment/visibility-m", _environment,
  70         &FGEnvironment::get_visibility_m, &FGEnvironment::set_visibility_m);
  71   fgSetArchivable("/environment/visibility-m");
  72   fgTie("/environment/temperature-sea-level-degc", _environment,
  73         &FGEnvironment::get_temperature_sea_level_degc,
  74         &FGEnvironment::set_temperature_sea_level_degc);
  75   fgSetArchivable("/environment/temperature-sea-level-degc");
  76   fgTie("/environment/temperature-degc", _environment,
  77         &FGEnvironment::get_temperature_degc); // FIXME: read-only for now
  78   fgTie("/environment/dewpoint-sea-level-degc", _environment,
  79         &FGEnvironment::get_dewpoint_sea_level_degc,
  80         &FGEnvironment::set_dewpoint_sea_level_degc);
  81   fgSetArchivable("/environment/dewpoint-sea-level-degc");
  82   fgTie("/environment/dewpoint-degc", _environment,
  83         &FGEnvironment::get_dewpoint_degc); // FIXME: read-only for now
  84   fgTie("/environment/pressure-sea-level-inhg", _environment,
  85         &FGEnvironment::get_pressure_sea_level_inhg,
  86         &FGEnvironment::set_pressure_sea_level_inhg);
  87   fgSetArchivable("/environment/pressure-sea-level-inhg");
  88   fgTie("/environment/pressure-inhg", _environment,
  89         &FGEnvironment::get_pressure_inhg); // FIXME: read-only for now
  90   fgTie("/environment/density-slugft3", _environment,
  91         &FGEnvironment::get_density_slugft3); // read-only
  92   fgTie("/environment/wind-from-heading-deg", _environment,
  93         &FGEnvironment::get_wind_from_heading_deg,
  94         &FGEnvironment::set_wind_from_heading_deg);
  95   fgTie("/environment/wind-speed-kt", _environment,
  96         &FGEnvironment::get_wind_speed_kt, &FGEnvironment::set_wind_speed_kt);
  97   fgTie("/environment/wind-from-north-fps", _environment,
  98         &FGEnvironment::get_wind_from_north_fps,
  99         &FGEnvironment::set_wind_from_north_fps);
 100   fgSetArchivable("/environment/wind-from-north-fps");
 101   fgTie("/environment/wind-from-east-fps", _environment,
 102         &FGEnvironment::get_wind_from_east_fps,
 103         &FGEnvironment::set_wind_from_east_fps);
 104   fgSetArchivable("/environment/wind-from-east-fps");
 105   fgTie("/environment/wind-from-down-fps", _environment,
 106         &FGEnvironment::get_wind_from_down_fps,
 107         &FGEnvironment::set_wind_from_down_fps);
 108   fgSetArchivable("/environment/wind-from-down-fps");
 109   fgTie("/environment/turbulence/magnitude-norm", _environment,
 110         &FGEnvironment::get_turbulence_magnitude_norm,
 111         &FGEnvironment::set_turbulence_magnitude_norm);
 112   fgSetArchivable("/environment/turbulence/magnitude-norm");
 113   fgTie("/environment/turbulence/rate-hz", _environment,
 114         &FGEnvironment::get_turbulence_rate_hz,
 115         &FGEnvironment::set_turbulence_rate_hz);
 116   fgSetArchivable("/environment/turbulence/rate-hz");
 117
 118   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 119     char buf[128];
 120     sprintf(buf, "/environment/clouds/layer[%d]/span-m", i);
 121     fgTie(buf, this, i,
 122           &FGEnvironmentMgr::get_cloud_layer_span_m,
 123           &FGEnvironmentMgr::set_cloud_layer_span_m);
 124     fgSetArchivable(buf);
 125     sprintf(buf, "/environment/clouds/layer[%d]/elevation-ft", i);
 126     fgTie(buf, this, i,
 127           &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
 128           &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
 129     fgSetArchivable(buf);
 130     sprintf(buf, "/environment/clouds/layer[%d]/thickness-ft", i);
 131     fgTie(buf, this, i,
 132           &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
 133           &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
 134     fgSetArchivable(buf);
 135     sprintf(buf, "/environment/clouds/layer[%d]/transition-ft", i);
 136     fgTie(buf, this, i,
 137           &FGEnvironmentMgr::get_cloud_layer_transition_ft,
 138           &FGEnvironmentMgr::set_cloud_layer_transition_ft);
 139     fgSetArchivable(buf);
 140     sprintf(buf, "/environment/clouds/layer[%d]/coverage", i);
 141     fgTie(buf, this, i,
 142           &FGEnvironmentMgr::get_cloud_layer_coverage,
 143           &FGEnvironmentMgr::set_cloud_layer_coverage);
 144     fgSetArchivable(buf);
 145   }
 146 }
 147
 148 void
 149 FGEnvironmentMgr::unbind ()
 150 {
 151   fgUntie("/environment/visibility-m");
 152   fgUntie("/environment/temperature-sea-level-degc");
 153   fgUntie("/environment/temperature-degc");
 154   fgUntie("/environment/dewpoint-sea-level-degc");
 155   fgUntie("/environment/dewpoint-degc");
 156   fgUntie("/environment/pressure-sea-level-inhg");
 157   fgUntie("/environment/pressure-inhg");
 158   fgUntie("/environment/density-inhg");
 159   fgUntie("/environment/wind-from-north-fps");
 160   fgUntie("/environment/wind-from-east-fps");
 161   fgUntie("/environment/wind-from-down-fps");
 162   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 163     char buf[128];
 164     sprintf(buf, "/environment/clouds/layer[%d]/span-m", i);
 165     fgUntie(buf);
 166     sprintf(buf, "/environment/clouds/layer[%d]/elevation-ft", i);
 167     fgUntie(buf);
 168     sprintf(buf, "/environment/clouds/layer[%d]/thickness-ft", i);
 169     fgUntie(buf);
 170     sprintf(buf, "/environment/clouds/layer[%d]/transition-ft", i);
 171     fgUntie(buf);
 172     sprintf(buf, "/environment/clouds/layer[%d]/type", i);
 173     fgUntie(buf);
 174   }
 175 }
 176
 177 void
 178 FGEnvironmentMgr::update (double dt)
 179 {
 180   FGSubsystemGroup::update(dt);
 181
 182                                 // FIXME: the FDMs should update themselves
 183   current_aircraft.fdm_state
 184     ->set_Velocities_Local_Airmass(_environment->get_wind_from_north_fps(),
 185                                    _environment->get_wind_from_east_fps(),
 186                                    _environment->get_wind_from_down_fps());
 187   _environment->set_elevation_ft(fgGetDouble("/position/altitude-ft"));
 188
 189   _update_fdm();
 190 }
 191
 192 FGEnvironment
 193 FGEnvironmentMgr::getEnvironment () const
 194 {
 195   return *_environment;
 196 }
 197
 198 FGEnvironment
 199 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 200 {
 201                                 // Always returns the same environment
 202                                 // for now; we'll make it interesting
 203                                 // later.
 204   FGEnvironment env = *_environment;
 205   env.set_elevation_ft(alt);
 206   return env;
 207 }
 208
 209 void
 210 FGEnvironmentMgr::_update_fdm () const
 211 {
 212   //
 213   // Pass atmosphere on to FDM
 214   // FIXME: have FDMs read properties directly.
 215   //
 216   if (fgGetBool("/environment/params/control-fdm-atmosphere")) {
 217                                 // convert from Rankine to Celsius
 218     cur_fdm_state
 219       ->set_Static_temperature((9.0/5.0)
 220                                * (_environment->get_temperature_degc() + 273.15));
 221                                 // convert from inHG to PSF
 222     cur_fdm_state
 223       ->set_Static_pressure(_environment->get_pressure_inhg() * 70.726566);
 224                                 // keep in slugs/ft^3
 225     cur_fdm_state
 226       ->set_Density(_environment->get_density_slugft3());
 227   }
 228 }
 229
 230 double
 231 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 232 {
 233   return thesky->get_cloud_layer(index)->getSpan_m();
 234 }
 235
 236 void
 237 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 238 {
 239   thesky->get_cloud_layer(index)->setSpan_m(span_m);
 240 }
 241
 242 double
 243 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 244 {
 245   return thesky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 246 }
 247
 248 void
 249 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 250 {
 251   thesky->get_cloud_layer(index)
 252     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 253 }
 254
 255 double
 256 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 257 {
 258   return thesky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 259 }
 260
 261 void
 262 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 263 {
 264   thesky->get_cloud_layer(index)
 265     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 266 }
 267
 268 double
 269 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 270 {
 271   return thesky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 272 }
 273
 274 void
 275 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 276                                                  double transition_ft)
 277 {
 278   thesky->get_cloud_layer(index)
 279     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 280 }
 281
 282 const char *
 283 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 284 {
 285   switch (thesky->get_cloud_layer(index)->getCoverage()) {
 286   case SGCloudLayer::SG_CLOUD_OVERCAST:
 287     return "overcast";
 288   case SGCloudLayer::SG_CLOUD_BROKEN:
 289     return "broken";
 290   case SGCloudLayer::SG_CLOUD_SCATTERED:
 291     return "scattered";
 292   case SGCloudLayer::SG_CLOUD_FEW:
 293     return "few";
 294   case SGCloudLayer::SG_CLOUD_CIRRUS:
 295     return "cirrus";
 296   case SGCloudLayer::SG_CLOUD_CLEAR:
 297     return "clear";
 298   default:
 299     return "unknown";
 300   }
 301 }
 302
 303 void
 304 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 305                                             const char * coverage_name)
 306 {
 307   SGCloudLayer::Coverage coverage;
 308   if (!strcmp(coverage_name, "overcast"))
 309     coverage = SGCloudLayer::SG_CLOUD_OVERCAST;
 310   else if (!strcmp(coverage_name, "broken"))
 311     coverage = SGCloudLayer::SG_CLOUD_BROKEN;
 312   else if (!strcmp(coverage_name, "scattered"))
 313     coverage = SGCloudLayer::SG_CLOUD_SCATTERED;
 314   else if (!strcmp(coverage_name, "few"))
 315     coverage = SGCloudLayer::SG_CLOUD_FEW;
 316   else if (!strcmp(coverage_name, "cirrus"))
 317     coverage = SGCloudLayer::SG_CLOUD_CIRRUS;
 318   else if (!strcmp(coverage_name, "clear"))
 319     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 320   else {
 321     SG_LOG(SG_INPUT, SG_WARN, "Unknown cloud type " << coverage_name);
 322     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 323   }
 324   thesky->get_cloud_layer(index)->setCoverage(coverage);
 325 }
 326
 327
 328
 329 // end of environment-mgr.cxx