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 - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _GLOBALS_HXX
  25 #define _GLOBALS_HXX
  26
  27 #include <simgear/compiler.h>
  28 #include <simgear/props/props.hxx>
  29 #include <simgear/structure/subsystem_mgr.hxx>
  30 #include <simgear/misc/sg_path.hxx>
  31
  32 #include <vector>
  33 #include <string>
  34 #include <memory>
  35
  36 typedef std::vector<std::string> string_list;
  37 typedef std::vector<SGPath> PathList;
  38
  39 // Forward declarations
  40
  41 // This file is included, directly or indirectly, almost everywhere in
  42 // FlightGear, so if any of its dependencies changes, most of the sim
  43 // has to be recompiled.  Using these forward declarations helps us to
  44 // avoid including a lot of header files (and thus, a lot of
  45 // dependencies).  Since Most of the methods simply set or return
  46 // pointers, we don't need to know anything about the class details
  47 // anyway.
  48
  49 class SGEphemeris;
  50 class SGCommandMgr;
  51 class SGMaterialLib;
  52 class SGPropertyNode;
  53 class SGTime;
  54 class SGEventMgr;
  55 class SGSubsystemMgr;
  56 class SGSubsystem;
  57 class SGSoundMgr;
  58
  59 class FGControls;
  60 class FGTACANList;
  61 class FGLocale;
  62 class FGRouteMgr;
  63 class FGScenery;
  64 class FGTileMgr;
  65 class FGViewMgr;
  66 class FGViewer;
  67 class FGRenderer;
  68 class FGFontCache;
  69 class FGSampleQueue;
  70
  71 namespace simgear { namespace pkg {
  72   class Root;
  73 }}
  74
  75 /**
  76  * Bucket for subsystem pointers representing the sim's state.
  77  */
  78
  79 class FGGlobals
  80 {
  81
  82 private:
  83
  84     // properties, destroy last
  85     SGPropertyNode_ptr props;
  86
  87     // localization
  88     FGLocale* locale;
  89
  90     FGRenderer *renderer;
  91     SGSubsystemMgr *subsystem_mgr;
  92     SGEventMgr *event_mgr;
  93
  94     // Number of milliseconds elapsed since the start of the program.
  95     double sim_time_sec;
  96
  97     // Root of FlightGear data tree
  98     std::string fg_root;
  99
 100     /**
 101      * locations to search for (non-scenery) data.
 102      */
 103     PathList additional_data_paths;
 104
 105     // Users home directory for data
 106     std::string fg_home;
 107
 108     // Roots of FlightGear scenery tree
 109     string_list fg_scenery;
 110
 111     std::string browser;
 112
 113     // Time structure
 114     SGTime *time_params;
 115
 116     // Sky structures
 117     SGEphemeris *ephem;
 118
 119     // Material properties library
 120     SGSharedPtr<SGMaterialLib> matlib;
 121
 122     // Global autopilot "route"
 123     FGRouteMgr *route_mgr;
 124
 125     // control input state
 126     FGControls *controls;
 127
 128     // viewer manager
 129     FGViewMgr *viewmgr;
 130
 131     SGCommandMgr *commands;
 132
 133     // list of serial port-like configurations
 134     string_list *channel_options_list;
 135
 136     // A list of initial waypoints that are read from the command line
 137     // and or flight-plan file during initialization
 138     string_list *initial_waypoints;
 139
 140     // FlightGear scenery manager
 141     SGSharedPtr<FGScenery> _scenery;
 142
 143     // Tile manager
 144     SGSharedPtr<FGTileMgr> _tile_mgr;
 145
 146     FGFontCache *fontcache;
 147
 148     // Navigational Aids
 149     FGTACANList *channellist;
 150
 151     /// roots of Aircraft trees
 152     string_list fg_aircraft_dirs;
 153     SGPath catalog_aircraft_dir;
 154
 155     bool haveUserSettings;
 156
 157     SGPropertyNode_ptr positionLon, positionLat, positionAlt;
 158     SGPropertyNode_ptr viewLon, viewLat, viewAlt;
 159     SGPropertyNode_ptr orientHeading, orientPitch, orientRoll;
 160
 161     /**
 162      * helper to initialise standard properties on a new property tree
 163      */
 164     void initProperties();
 165
 166     SGSharedPtr<FGSampleQueue> _chatter_queue;
 167
 168     void cleanupListeners();
 169
 170     typedef std::vector<SGPropertyChangeListener*> SGPropertyChangeListenerVec;
 171     SGPropertyChangeListenerVec _listeners_to_cleanup;
 172
 173     SGSharedPtr<simgear::pkg::Root> _packageRoot;
 174 public:
 175
 176     FGGlobals();
 177     virtual ~FGGlobals();
 178
 179     virtual FGRenderer *get_renderer () const;
 180     void set_renderer(FGRenderer* render);
 181
 182     virtual SGSubsystemMgr *get_subsystem_mgr () const;
 183
 184     virtual SGSubsystem *get_subsystem (const char * name);
 185
 186     virtual void add_subsystem (const char * name,
 187                                 SGSubsystem * subsystem,
 188                                 SGSubsystemMgr::GroupType
 189                                 type = SGSubsystemMgr::GENERAL,
 190                                 double min_time_sec = 0);
 191
 192     virtual SGEventMgr *get_event_mgr () const;
 193
 194     virtual SGSoundMgr *get_soundmgr () const;
 195
 196     inline double get_sim_time_sec () const { return sim_time_sec; }
 197     inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
 198     inline void set_sim_time_sec (double t) { sim_time_sec = t; }
 199
 200     inline const std::string &get_fg_root () const { return fg_root; }
 201     void set_fg_root (const std::string &root);
 202
 203     /**
 204      * Get list of data locations. fg_root is always the final item in the
 205      * result.
 206      */
 207     PathList get_data_paths() const;
 208
 209     /**
 210      * Get data locations which contain the file path suffix. Eg pass ing
 211      * 'AI/Traffic' to get all data paths which define <path>/AI/Traffic subdir
 212      */
 213     PathList get_data_paths(const std::string& suffix) const;
 214
 215     void append_data_path(const SGPath& path);
 216
 217     /**
 218      * Given a path suffix (eg 'Textures' or 'AI/Traffic'), find the
 219      * first data directory which defines it.
 220      */
 221     SGPath find_data_dir(const std::string& pathSuffix) const;
 222
 223     inline const std::string &get_fg_home () const { return fg_home; }
 224     void set_fg_home (const std::string &home);
 225
 226     inline const string_list &get_fg_scenery () const { return fg_scenery; }
 227     void append_fg_scenery (const std::string &scenery);
 228
 229     void clear_fg_scenery();
 230
 231     /**
 232      * specify a path we'll prepend to the aircraft paths list if non-empty.
 233      * This is used with packaged aircraft, to ensure their catalog (and hence,
 234      * dependency packages) are found correctly.
 235      */
 236     void set_catalog_aircraft_path(const SGPath& path);
 237
 238     string_list get_aircraft_paths() const;
 239
 240     void append_aircraft_path(const std::string& path);
 241     void append_aircraft_paths(const std::string& path);
 242
 243     /**
 244      * Given a path to an aircraft-related resource file, resolve it
 245      * against the appropriate root. This means looking at the location
 246      * defined by /sim/aircraft-dir, and then aircraft_path in turn,
 247      * finishing with fg_root/Aircraft.
 248      *
 249      * if the path could not be resolved, an empty path is returned.
 250      */
 251     SGPath resolve_aircraft_path(const std::string& branch) const;
 252
 253     /**
 254      * Same as above, but test for non 'Aircraft/' branch paths, and
 255      * always resolve them against fg_root.
 256      */
 257     SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
 258
 259     /**
 260      * Search in the following directories:
 261      *
 262      *  1. Root directory of current aircraft (defined by /sim/aircraft-dir)
 263      *  2. All aircraft directories if branch starts with Aircraft/
 264      *  3. fg_data directory
 265      */
 266     SGPath resolve_resource_path(const std::string& branch) const;
 267
 268     inline const std::string &get_browser () const { return browser; }
 269     void set_browser (const std::string &b) { browser = b; }
 270
 271     long int get_warp() const;
 272     void set_warp( long int w );
 273
 274     long int get_warp_delta() const;
 275     void set_warp_delta( long int d );
 276
 277     inline SGTime *get_time_params() const { return time_params; }
 278     inline void set_time_params( SGTime *t ) { time_params = t; }
 279
 280     inline SGEphemeris *get_ephem() const { return ephem; }
 281     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 282
 283     inline SGMaterialLib *get_matlib() const { return matlib; }
 284     void set_matlib( SGMaterialLib *m );
 285
 286     inline FGControls *get_controls() const { return controls; }
 287     inline void set_controls( FGControls *c ) { controls = c; }
 288
 289     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
 290     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
 291     FGViewer *get_current_view() const;
 292
 293     inline SGPropertyNode *get_props () { return props; }
 294
 295     /**
 296      * @brief reset the property tree to new, empty tree. Ensure all
 297      * subsystems are shutdown and unbound before call this.
 298      */
 299     void resetPropertyRoot();
 300
 301     inline FGLocale* get_locale () { return locale; }
 302
 303     inline SGCommandMgr *get_commands () { return commands; }
 304
 305     SGGeod get_aircraft_position() const;
 306
 307     SGVec3d get_aircraft_position_cart() const;
 308
 309     void get_aircraft_orientation(double& heading, double& pitch, double& roll);
 310
 311     SGGeod get_view_position() const;
 312
 313     SGVec3d get_view_position_cart() const;
 314
 315     inline string_list *get_channel_options_list () {
 316         return channel_options_list;
 317     }
 318     inline void set_channel_options_list( string_list *l ) {
 319         channel_options_list = l;
 320     }
 321
 322     inline string_list *get_initial_waypoints () {
 323         return initial_waypoints;
 324     }
 325
 326     inline void set_initial_waypoints (string_list *list) {
 327         initial_waypoints = list;
 328     }
 329
 330     FGScenery * get_scenery () const;
 331     void set_scenery ( FGScenery *s );
 332
 333     FGTileMgr * get_tile_mgr () const;
 334     void set_tile_mgr ( FGTileMgr *t );
 335
 336     inline FGFontCache *get_fontcache() const { return fontcache; }
 337
 338     inline FGTACANList *get_channellist() const { return channellist; }
 339     inline void set_channellist( FGTACANList *c ) { channellist = c; }
 340
 341     /**
 342      * Load user settings from autosave.xml
 343      */
 344     void loadUserSettings(const SGPath& datapath);
 345
 346     /**
 347      * Save user settings in autosave.xml
 348      */
 349     void saveUserSettings();
 350
 351     FGSampleQueue* get_chatter_queue() const;
 352     void set_chatter_queue(FGSampleQueue* queue);
 353
 354     void addListenerToCleanup(SGPropertyChangeListener* l);
 355
 356     simgear::pkg::Root* packageRoot();
 357     void setPackageRoot(const SGSharedPtr<simgear::pkg::Root>& p);
 358 };
 359
 360
 361 extern FGGlobals *globals;
 362
 363
 364 #endif // _GLOBALS_HXX