]> git.mxchange.org Git - flightgear.git/blobdiff - src/Main/globals.hxx
hla: add io chanel configuration shortcut hla-local.
[flightgear.git] / src / Main / globals.hxx
index fc1c52184b33894c1142725e8c1c811f5d66368b..97f07307adb119231396c4679f160d5b5d9b4284 100644 (file)
@@ -2,7 +2,7 @@
 //
 // Written by Curtis Olson, started July 2000.
 //
-// Copyright (C) 2000  Curtis L. Olson - curt@flightgear.org
+// Copyright (C) 2000  Curtis L. Olson - http://www.flightgear.org/~curt
 //
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License as
@@ -16,7 +16,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
 #define _GLOBALS_HXX
 
 #include <simgear/compiler.h>
+#include <simgear/props/props.hxx>
+#include <simgear/structure/subsystem_mgr.hxx>
+#include <simgear/misc/sg_path.hxx>
 
 #include <vector>
-#include STL_STRING
+#include <string>
+
+typedef std::vector<std::string> string_list;
+
+// Forward declarations
+
+// This file is included, directly or indirectly, almost everywhere in
+// FlightGear, so if any of its dependencies changes, most of the sim
+// has to be recompiled.  Using these forward declarations helps us to
+// avoid including a lot of header files (and thus, a lot of
+// dependencies).  Since Most of the methods simply set or return
+// pointers, we don't need to know anything about the class details
+// anyway.
+
+class SGEphemeris;
+class SGCommandMgr;
+class SGMaterialLib;
+class SGPropertyNode;
+class SGTime;
+class SGEventMgr;
+class SGSubsystemMgr;
+class SGSubsystem;
+class SGSoundMgr;
+
+class FGATISMgr;
+class FGControls;
+class FGTACANList;
+class FGLocale;
+class FGRouteMgr;
+class FGScenery;
+class FGTileMgr;
+class FGViewMgr;
+class FGViewer;
+class FGRenderer;
+class FGFontCache;
+
+
+/**
+ * Bucket for subsystem pointers representing the sim's state.
+ */
+
+class FGGlobals
+{
 
+private:
 
-#include <simgear/ephemeris/ephemeris.hxx>
-#include <simgear/magvar/magvar.hxx>
-#include <simgear/route/route.hxx>
-#include <simgear/timing/sg_time.hxx>
-#include <simgear/misc/props.hxx>
-
-#include "viewmgr.hxx"
-
-FG_USING_STD( vector );
-FG_USING_STD( string );
-
-typedef vector<string> string_list;
+    // properties, destroy last
+    SGPropertyNode_ptr props;
+    SGPropertyNode_ptr initial_state;
 
+    // localization
+    FGLocale* locale;
 
-class FGGlobals {
+    FGRenderer *renderer;
+    SGSubsystemMgr *subsystem_mgr;
+    SGEventMgr *event_mgr;
 
-private:
+    // Number of milliseconds elapsed since the start of the program.
+    double sim_time_sec;
 
     // Root of FlightGear data tree
-    string fg_root;
-
-    // Root of FlightGear scenery tree
-    string fg_scenery;
+    std::string fg_root;
 
-    // Freeze sim
-    bool freeze;
+    // Users home directory for data
+    std::string fg_home;
 
-    // An offset in seconds from the true time.  Allows us to adjust
-    // the effective time of day.
-    long int warp;
+    // Roots of FlightGear scenery tree
+    string_list fg_scenery;
 
-    // How much to change the value of warp each iteration.  Allows us
-    // to make time progress faster than normal (or even run in reverse.)
-    long int warp_delta;
+    std::string browser;
 
     // Time structure
     SGTime *time_params;
@@ -71,46 +107,120 @@ private:
     // Sky structures
     SGEphemeris *ephem;
 
-    // Magnetic Variation
-    SGMagVar *mag;
+    // Material properties library
+    SGMaterialLib *matlib;
 
     // Global autopilot "route"
-    SGRoute *route;
+    FGRouteMgr *route_mgr;
 
-    // viewer maneger
+    // ATC manager
+    FGATISMgr *ATIS_mgr;
+
+    // control input state
+    FGControls *controls;
+
+    // viewer manager
     FGViewMgr *viewmgr;
-    FGViewer *current_view;
 
-    // properties
-    SGPropertyNode *props;
-    SGPropertyNode *initial_state;
+    SGCommandMgr *commands;
 
     // list of serial port-like configurations
     string_list *channel_options_list;
 
+    // A list of initial waypoints that are read from the command line
+    // and or flight-plan file during initialization
+    string_list *initial_waypoints;
+
+    // FlightGear scenery manager
+    FGScenery *scenery;
+
+    // Tile manager
+    FGTileMgr *tile_mgr;
+
+    FGFontCache *fontcache;
+
+    // Navigational Aids
+    FGTACANList *channellist;
+
+    /// roots of Aircraft trees
+    string_list fg_aircraft_dirs;
+
+    bool haveUserSettings;
+
+    SGPropertyNode_ptr positionLon, positionLat, positionAlt;
+    SGPropertyNode_ptr viewLon, viewLat, viewAlt;
+    SGPropertyNode_ptr orientHeading, orientPitch, orientRoll;
 public:
 
     FGGlobals();
-    ~FGGlobals();
+    virtual ~FGGlobals();
 
-    inline const string &get_fg_root () const { return fg_root; }
-    inline void set_fg_root (const string &root) { fg_root = root; }
+    virtual FGRenderer *get_renderer () const;
 
-    inline const string &get_fg_scenery () const { return fg_scenery; }
-    inline void set_fg_scenery (const string &scenery) {
-      fg_scenery = scenery;
-    }
+    virtual SGSubsystemMgr *get_subsystem_mgr () const;
+
+    virtual SGSubsystem *get_subsystem (const char * name);
+
+    virtual void add_subsystem (const char * name,
+                                SGSubsystem * subsystem,
+                                SGSubsystemMgr::GroupType
+                                type = SGSubsystemMgr::GENERAL,
+                                double min_time_sec = 0);
+
+    virtual SGEventMgr *get_event_mgr () const;
+
+    virtual SGSoundMgr *get_soundmgr () const;
+
+    inline double get_sim_time_sec () const { return sim_time_sec; }
+    inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
+    inline void set_sim_time_sec (double t) { sim_time_sec = t; }
+
+    inline const std::string &get_fg_root () const { return fg_root; }
+    void set_fg_root (const std::string &root);
+
+    inline const std::string &get_fg_home () const { return fg_home; }
+    void set_fg_home (const std::string &home);
+
+    inline const string_list &get_fg_scenery () const { return fg_scenery; }
+    void append_fg_scenery (const std::string &scenery);
 
-    inline bool get_freeze() const { return freeze; }
-    inline void set_freeze( bool f ) { freeze = f; }
+    const string_list& get_aircraft_paths() const { return fg_aircraft_dirs; }
+    void append_aircraft_path(const std::string& path);
+    void append_aircraft_paths(const std::string& path);
+    
+    /**
+     * Given a path to an aircraft-related resource file, resolve it
+     * against the appropriate root. This means looking at the location
+     * defined by /sim/aircraft-dir, and then aircraft_path in turn,
+     * finishing with fg_root/Aircraft.
+     *
+     * if the path could not be resolved, an empty path is returned.
+     */
+    SGPath resolve_aircraft_path(const std::string& branch) const;
+    
+    /**
+     * Same as above, but test for non 'Aircraft/' branch paths, and
+     * always resolve them against fg_root.
+     */
+    SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
+    
+    /**
+     * Search in the following directories:
+     *
+     *  1. Root directory of current aircraft (defined by /sim/aircraft-dir)
+     *  2. All aircraft directories if branch starts with Aircraft/
+     *  3. fg_data directory
+     */
+    SGPath resolve_resource_path(const std::string& branch) const;
 
-    inline long int get_warp() const { return warp; }
-    inline void set_warp( long int w ) { warp = w; }
-    inline void inc_warp( long int w ) { warp += w; }
+    inline const std::string &get_browser () const { return browser; }
+    void set_browser (const std::string &b) { browser = b; }
 
-    inline long int get_warp_delta() const { return warp_delta; }
-    inline void set_warp_delta( long int d ) { warp_delta = d; }
-    inline void inc_warp_delta( long int d ) { warp_delta += d; }
+    long int get_warp() const;
+    void set_warp( long int w );
+
+    long int get_warp_delta() const;
+    void set_warp_delta( long int d );
 
     inline SGTime *get_time_params() const { return time_params; }
     inline void set_time_params( SGTime *t ) { time_params = t; }
@@ -118,20 +228,36 @@ public:
     inline SGEphemeris *get_ephem() const { return ephem; }
     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 
-    inline SGMagVar *get_mag() const { return mag; }
-    inline void set_mag( SGMagVar *m ) { mag = m; }
+    inline SGMaterialLib *get_matlib() const { return matlib; }
+    inline void set_matlib( SGMaterialLib *m ) { matlib = m; }
+
+    inline FGATISMgr *get_ATIS_mgr() const { return ATIS_mgr; }
+    inline void set_ATIS_mgr( FGATISMgr *a ) {ATIS_mgr = a; }
 
-    inline SGRoute *get_route() const { return route; }
-    inline void set_route( SGRoute *r ) { route = r; }
+    inline FGControls *get_controls() const { return controls; }
+    inline void set_controls( FGControls *c ) { controls = c; }
 
     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
-    inline FGViewer *get_current_view() const { return current_view; }
-    inline void set_current_view( FGViewer *v ) { current_view = v; }
+    FGViewer *get_current_view() const;
 
     inline SGPropertyNode *get_props () { return props; }
     inline void set_props( SGPropertyNode *n ) { props = n; }
 
+    inline FGLocale* get_locale () { return locale; }
+
+    inline SGCommandMgr *get_commands () { return commands; }
+
+    SGGeod get_aircraft_position() const;
+
+    SGVec3d get_aircraft_position_cart() const;
+
+    void get_aircraft_orientation(double& heading, double& pitch, double& roll);
+  
+    SGGeod get_view_position() const;
+  
+    SGVec3d get_view_position_cart() const;
+  
     inline string_list *get_channel_options_list () {
        return channel_options_list;
     }
@@ -139,8 +265,26 @@ public:
        channel_options_list = l;
     }
 
+    inline string_list *get_initial_waypoints () {
+        return initial_waypoints;
+    }
+  
+    inline void set_initial_waypoints (string_list *list) {
+        initial_waypoints = list;
+    }
 
-    /**
+    inline FGScenery * get_scenery () const { return scenery; }
+    inline void set_scenery ( FGScenery *s ) { scenery = s; }
+
+    inline FGTileMgr * get_tile_mgr () const { return tile_mgr; }
+    inline void set_tile_mgr ( FGTileMgr *t ) { tile_mgr = t; }
+
+    inline FGFontCache *get_fontcache() const { return fontcache; }
+  
+    inline FGTACANList *get_channellist() const { return channellist; }
+    inline void set_channellist( FGTACANList *c ) { channellist = c; }
+  
+   /**
      * Save the current state as the initial state.
      */
     void saveInitialState ();
@@ -151,6 +295,15 @@ public:
      */
     void restoreInitialState ();
 
+    /**
+     * Load user settings from autosave.xml
+     */
+    void loadUserSettings(const SGPath& datapath);
+
+    /**
+     * Save user settings in autosave.xml
+     */
+    void saveUserSettings();
 };
 
 
@@ -158,5 +311,3 @@ extern FGGlobals *globals;
 
 
 #endif // _GLOBALS_HXX
-
-