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