src/Main/globals.hxx

   1 // globals.hxx -- Global state that needs to be shared among the sim modules
   2 //
   3 // Written by Curtis Olson, started July 2000.
   4 //
   5 // Copyright (C) 2000  Curtis L. Olson - curt@flightgear.org
   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
  24 #ifndef _GLOBALS_HXX
  25 #define _GLOBALS_HXX
  26
  27 #include <simgear/compiler.h>
  28
  29 #include <vector>
  30 #include STL_STRING
  31
  32 SG_USING_STD( vector );
  33 SG_USING_STD( string );
  34
  35 typedef vector<string> string_list;
  36
  37
  38 // Forward declarations
  39
  40 // This file is included, directly or indirectly, almost everywhere in
  41 // FlightGear, so if any of its dependencies changes, most of the sim
  42 // has to be recompiled.  Using these forward declarations helps us to
  43 // avoid including a lot of header files (and thus, a lot of
  44 // dependencies).  Since Most of the methods simply set or return
  45 // pointers, we don't need to know anything about the class details
  46 // anyway.
  47
  48 class SGEphemeris;
  49 class SGMagVar;
  50 class SGRoute;
  51 class SGTime;
  52 class SGPropertyNode;
  53 class SGCommandMgr;
  54
  55 class FGLogger;
  56 class FGEnvironmentMgr;
  57 class FGEnvironment;
  58 class FGControls;
  59 class FGSoundMgr;
  60 class FGAutopilot;
  61 class FGFX;
  62 class FGViewMgr;
  63 class FGViewer;
  64 class FGATCMgr;
  65 class FGATCDisplay;
  66 class FGAIMgr;
  67 class FGAircraftModel;
  68 class FGModelMgr;
  69
  70 class ssgRoot;
  71 class ssgBranch;
  72
  73
  74 /**
  75  * Bucket for subsystem pointers representing the sim's state.
  76  */
  77 class FGGlobals
  78 {
  79
  80 private:
  81
  82     // Number of milliseconds elapsed since the start of the program.
  83     double sim_time_ms;
  84
  85     // Root of FlightGear data tree
  86     string fg_root;
  87
  88     // Root of FlightGear scenery tree
  89     string fg_scenery;
  90
  91 #if 0
  92     // Freeze sim
  93     bool freeze;
  94 #endif
  95
  96     // Fullscreen mode for old 3DFX cards.
  97 #if defined(FX) && defined(XMESA)
  98     bool fullscreen;
  99 #endif
 100
 101     // An offset in seconds from the true time.  Allows us to adjust
 102     // the effective time of day.
 103     long int warp;
 104
 105     // How much to change the value of warp each iteration.  Allows us
 106     // to make time progress faster than normal (or even run in reverse.)
 107     long int warp_delta;
 108
 109     // Logger
 110     FGLogger *logger;
 111
 112     // Time structure
 113     SGTime *time_params;
 114
 115     // Sky structures
 116     SGEphemeris *ephem;
 117
 118     // Magnetic Variation
 119     SGMagVar *mag;
 120
 121     // Current autopilot
 122     FGAutopilot *autopilot;
 123
 124     // Global autopilot "route"
 125     SGRoute *route;
 126
 127     // sound manager
 128     FGSoundMgr *soundmgr;
 129
 130     // sound-effects manager
 131     FGFX *fx;
 132
 133     // environment information
 134     FGEnvironmentMgr * environment_mgr;
 135
 136     // ATC manager
 137     FGATCMgr *ATC_mgr;
 138
 139     // ATC Renderer
 140     FGATCDisplay *ATC_display;
 141
 142     // AI manager
 143     FGAIMgr *AI_mgr;
 144
 145     // control input state
 146     FGControls *controls;
 147
 148     // viewer manager
 149     FGViewMgr *viewmgr;
 150
 151     // properties
 152     SGPropertyNode *props;
 153     SGPropertyNode *initial_state;
 154
 155     SGCommandMgr *commands;
 156
 157     FGAircraftModel *acmodel;
 158
 159     FGModelMgr * model_mgr;
 160
 161     // list of serial port-like configurations
 162     string_list *channel_options_list;
 163
 164     // SSG scene graph
 165     ssgRoot * scene_graph;
 166     ssgBranch * terrain_branch;
 167     ssgBranch * gnd_lights_branch;
 168     ssgBranch * rwy_lights_branch;
 169     ssgBranch * models_branch;
 170     ssgBranch * aircraft_branch;
 171
 172 public:
 173
 174     FGGlobals();
 175     ~FGGlobals();
 176
 177     inline double get_sim_time_ms () const { return sim_time_ms; }
 178     inline void inc_sim_time_ms (double dt) { sim_time_ms += dt; }
 179     inline void set_sim_time_ms (double t) { sim_time_ms = t; }
 180
 181     inline const string &get_fg_root () const { return fg_root; }
 182     inline void set_fg_root (const string &root) { fg_root = root; }
 183
 184     inline const string &get_fg_scenery () const { return fg_scenery; }
 185     inline void set_fg_scenery (const string &scenery) {
 186       fg_scenery = scenery;
 187     }
 188
 189 #if 0
 190     inline bool get_freeze() const { return freeze; }
 191     inline void set_freeze( bool f ) { freeze = f; }
 192 #endif
 193
 194 #if defined(FX) && defined(XMESA)
 195     inline bool get_fullscreen() const { return fullscreen; }
 196     inline bool set_fullscreen( bool f ) { fullscreen = f; }
 197 #endif
 198
 199     inline long int get_warp() const { return warp; }
 200     inline void set_warp( long int w ) { warp = w; }
 201     inline void inc_warp( long int w ) { warp += w; }
 202
 203     inline long int get_warp_delta() const { return warp_delta; }
 204     inline void set_warp_delta( long int d ) { warp_delta = d; }
 205     inline void inc_warp_delta( long int d ) { warp_delta += d; }
 206
 207     inline FGLogger * get_logger () { return logger; }
 208     inline void set_logger (FGLogger * l) { logger = l; }
 209
 210     inline SGTime *get_time_params() const { return time_params; }
 211     inline void set_time_params( SGTime *t ) { time_params = t; }
 212
 213     inline SGEphemeris *get_ephem() const { return ephem; }
 214     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 215
 216     inline SGMagVar *get_mag() const { return mag; }
 217     inline void set_mag( SGMagVar *m ) { mag = m; }
 218
 219     inline FGAutopilot *get_autopilot() const { return autopilot; }
 220     inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
 221
 222     inline SGRoute *get_route() const { return route; }
 223     inline void set_route( SGRoute *r ) { route = r; }
 224
 225     inline FGEnvironmentMgr * get_environment_mgr() {
 226       return environment_mgr;
 227     }
 228     inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
 229       environment_mgr = mgr;
 230     }
 231     const FGEnvironment * get_environment() const;
 232     const FGEnvironment * get_environment(double lat, double lon,
 233                                           double alt) const;
 234
 235     inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
 236     inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
 237
 238     inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
 239     inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
 240
 241     inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
 242     inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
 243
 244     inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
 245     inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
 246
 247     inline FGFX *get_fx() const { return fx; }
 248     inline void set_fx( FGFX *x ) { fx = x; }
 249
 250     inline FGControls *get_controls() const { return controls; }
 251     inline void set_controls( FGControls *c ) { controls = c; }
 252
 253     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
 254     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
 255     FGViewer *get_current_view() const;
 256
 257     inline SGPropertyNode *get_props () { return props; }
 258     inline void set_props( SGPropertyNode *n ) { props = n; }
 259
 260     inline SGCommandMgr *get_commands () { return commands; }
 261
 262     inline FGAircraftModel *get_aircraft_model () { return acmodel; }
 263
 264     inline void set_aircraft_model (FGAircraftModel * model)
 265     {
 266         acmodel = model;
 267     }
 268
 269     inline FGModelMgr *get_model_mgr () { return model_mgr; }
 270
 271     inline void set_model_mgr (FGModelMgr * mgr)
 272     {
 273       model_mgr = mgr;
 274     }
 275
 276     inline string_list *get_channel_options_list () {
 277         return channel_options_list;
 278     }
 279     inline void set_channel_options_list( string_list *l ) {
 280         channel_options_list = l;
 281     }
 282
 283     inline ssgRoot * get_scene_graph () const { return scene_graph; }
 284     inline void set_scene_graph (ssgRoot * s) { scene_graph = s; }
 285
 286     inline ssgBranch * get_terrain_branch () const { return terrain_branch; }
 287     inline void set_terrain_branch (ssgBranch * t) { terrain_branch = t; }
 288
 289     inline ssgBranch * get_gnd_lights_branch () const {
 290       return gnd_lights_branch;
 291     }
 292     inline void set_gnd_lights_branch (ssgBranch * t) {
 293       gnd_lights_branch = t;
 294     }
 295
 296     inline ssgBranch * get_rwy_lights_branch () const {
 297       return rwy_lights_branch;
 298     }
 299     inline void set_rwy_lights_branch (ssgBranch * t) {
 300       rwy_lights_branch = t;
 301     }
 302
 303     inline ssgBranch * get_models_branch () const {
 304       return models_branch;
 305     }
 306     inline void set_models_branch (ssgBranch * t) {
 307       models_branch = t;
 308     }
 309
 310     inline ssgBranch * get_aircraft_branch () const {
 311       return aircraft_branch;
 312     }
 313     inline void set_aircraft_branch (ssgBranch * t) {
 314       aircraft_branch = t;
 315     }
 316
 317
 318     /**
 319      * Save the current state as the initial state.
 320      */
 321     void saveInitialState ();
 322
 323
 324     /**
 325      * Restore the saved initial state, if any.
 326      */
 327     void restoreInitialState ();
 328
 329 };
 330
 331
 332 extern FGGlobals *globals;
 333
 334
 335 #endif // _GLOBALS_HXX