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 class FGScenery;
  70
  71 class ssgRoot;
  72 class ssgBranch;
  73
  74
  75 /**
  76  * Bucket for subsystem pointers representing the sim's state.
  77  */
  78 class FGGlobals
  79 {
  80
  81 private:
  82
  83     // Number of milliseconds elapsed since the start of the program.
  84     double sim_time_sec;
  85
  86     // Root of FlightGear data tree
  87     string fg_root;
  88
  89     // Root of FlightGear scenery tree
  90     string fg_scenery;
  91
  92 #if 0
  93     // Freeze sim
  94     bool freeze;
  95 #endif
  96
  97     // Fullscreen mode for old 3DFX cards.
  98 #if defined(FX) && defined(XMESA)
  99     bool fullscreen;
 100 #endif
 101
 102     // An offset in seconds from the true time.  Allows us to adjust
 103     // the effective time of day.
 104     long int warp;
 105
 106     // How much to change the value of warp each iteration.  Allows us
 107     // to make time progress faster than normal (or even run in reverse.)
 108     long int warp_delta;
 109
 110     // Logger
 111     FGLogger *logger;
 112
 113     // Time structure
 114     SGTime *time_params;
 115
 116     // Sky structures
 117     SGEphemeris *ephem;
 118
 119     // Magnetic Variation
 120     SGMagVar *mag;
 121
 122     // Current autopilot
 123     FGAutopilot *autopilot;
 124
 125     // Global autopilot "route"
 126     SGRoute *route;
 127
 128     // sound manager
 129     FGSoundMgr *soundmgr;
 130
 131     // sound-effects manager
 132     FGFX *fx;
 133
 134     // environment information
 135     FGEnvironmentMgr * environment_mgr;
 136
 137     // ATC manager
 138     FGATCMgr *ATC_mgr;
 139
 140     // ATC Renderer
 141     FGATCDisplay *ATC_display;
 142
 143     // AI manager
 144     FGAIMgr *AI_mgr;
 145
 146     // control input state
 147     FGControls *controls;
 148
 149     // viewer manager
 150     FGViewMgr *viewmgr;
 151
 152     // properties
 153     SGPropertyNode *props;
 154     SGPropertyNode *initial_state;
 155
 156     SGCommandMgr *commands;
 157
 158     FGAircraftModel *acmodel;
 159
 160     FGModelMgr * model_mgr;
 161
 162     // list of serial port-like configurations
 163     string_list *channel_options_list;
 164
 165     // FlightGear scenery manager
 166     FGScenery *scenery;
 167
 168     // SSG scene graph
 169     ssgRoot * scene_graph;
 170     ssgBranch * terrain_branch;
 171     ssgBranch * gnd_lights_branch;
 172     ssgBranch * rwy_lights_branch;
 173     ssgBranch * models_branch;
 174     ssgBranch * aircraft_branch;
 175
 176 public:
 177
 178     FGGlobals();
 179     ~FGGlobals();
 180
 181     inline double get_sim_time_sec () const { return sim_time_sec; }
 182     inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
 183     inline void set_sim_time_sec (double t) { sim_time_sec = t; }
 184
 185     inline const string &get_fg_root () const { return fg_root; }
 186     inline void set_fg_root (const string &root) { fg_root = root; }
 187
 188     inline const string &get_fg_scenery () const { return fg_scenery; }
 189     inline void set_fg_scenery (const string &scenery) {
 190       fg_scenery = scenery;
 191     }
 192
 193 #if 0
 194     inline bool get_freeze() const { return freeze; }
 195     inline void set_freeze( bool f ) { freeze = f; }
 196 #endif
 197
 198 #if defined(FX) && defined(XMESA)
 199     inline bool get_fullscreen() const { return fullscreen; }
 200     inline bool set_fullscreen( bool f ) { fullscreen = f; }
 201 #endif
 202
 203     inline long int get_warp() const { return warp; }
 204     inline void set_warp( long int w ) { warp = w; }
 205     inline void inc_warp( long int w ) { warp += w; }
 206
 207     inline long int get_warp_delta() const { return warp_delta; }
 208     inline void set_warp_delta( long int d ) { warp_delta = d; }
 209     inline void inc_warp_delta( long int d ) { warp_delta += d; }
 210
 211     inline FGLogger * get_logger () { return logger; }
 212     inline void set_logger (FGLogger * l) { logger = l; }
 213
 214     inline SGTime *get_time_params() const { return time_params; }
 215     inline void set_time_params( SGTime *t ) { time_params = t; }
 216
 217     inline SGEphemeris *get_ephem() const { return ephem; }
 218     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 219
 220     inline SGMagVar *get_mag() const { return mag; }
 221     inline void set_mag( SGMagVar *m ) { mag = m; }
 222
 223     inline FGAutopilot *get_autopilot() const { return autopilot; }
 224     inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
 225
 226     inline SGRoute *get_route() const { return route; }
 227     inline void set_route( SGRoute *r ) { route = r; }
 228
 229     inline FGEnvironmentMgr * get_environment_mgr() {
 230       return environment_mgr;
 231     }
 232     inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
 233       environment_mgr = mgr;
 234     }
 235
 236     inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
 237     inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
 238
 239     inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
 240     inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
 241
 242     inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
 243     inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
 244
 245     inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
 246     inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
 247
 248     inline FGFX *get_fx() const { return fx; }
 249     inline void set_fx( FGFX *x ) { fx = x; }
 250
 251     inline FGControls *get_controls() const { return controls; }
 252     inline void set_controls( FGControls *c ) { controls = c; }
 253
 254     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
 255     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
 256     FGViewer *get_current_view() const;
 257
 258     inline SGPropertyNode *get_props () { return props; }
 259     inline void set_props( SGPropertyNode *n ) { props = n; }
 260
 261     inline SGCommandMgr *get_commands () { return commands; }
 262
 263     inline FGAircraftModel *get_aircraft_model () { return acmodel; }
 264
 265     inline void set_aircraft_model (FGAircraftModel * model)
 266     {
 267         acmodel = model;
 268     }
 269
 270     inline FGModelMgr *get_model_mgr () { return model_mgr; }
 271
 272     inline void set_model_mgr (FGModelMgr * mgr)
 273     {
 274       model_mgr = mgr;
 275     }
 276
 277     inline string_list *get_channel_options_list () {
 278         return channel_options_list;
 279     }
 280     inline void set_channel_options_list( string_list *l ) {
 281         channel_options_list = l;
 282     }
 283
 284     inline FGScenery * get_scenery () const { return scenery; }
 285     inline void set_scenery ( FGScenery *s ) { scenery = s; }
 286
 287     inline ssgRoot * get_scene_graph () const { return scene_graph; }
 288     inline void set_scene_graph (ssgRoot * s) { scene_graph = s; }
 289
 290     inline ssgBranch * get_terrain_branch () const { return terrain_branch; }
 291     inline void set_terrain_branch (ssgBranch * t) { terrain_branch = t; }
 292
 293     inline ssgBranch * get_gnd_lights_branch () const {
 294       return gnd_lights_branch;
 295     }
 296     inline void set_gnd_lights_branch (ssgBranch * t) {
 297       gnd_lights_branch = t;
 298     }
 299
 300     inline ssgBranch * get_rwy_lights_branch () const {
 301       return rwy_lights_branch;
 302     }
 303     inline void set_rwy_lights_branch (ssgBranch * t) {
 304       rwy_lights_branch = t;
 305     }
 306
 307     inline ssgBranch * get_models_branch () const {
 308       return models_branch;
 309     }
 310     inline void set_models_branch (ssgBranch * t) {
 311       models_branch = t;
 312     }
 313
 314     inline ssgBranch * get_aircraft_branch () const {
 315       return aircraft_branch;
 316     }
 317     inline void set_aircraft_branch (ssgBranch * t) {
 318       aircraft_branch = t;
 319     }
 320
 321
 322     /**
 323      * Save the current state as the initial state.
 324      */
 325     void saveInitialState ();
 326
 327
 328     /**
 329      * Restore the saved initial state, if any.
 330      */
 331     void restoreInitialState ();
 332
 333 };
 334
 335
 336 extern FGGlobals *globals;
 337
 338
 339 #endif // _GLOBALS_HXX