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