]> git.mxchange.org Git - flightgear.git/blobdiff - src/Main/globals.hxx
Interim windows build fix
[flightgear.git] / src / Main / globals.hxx
index 2ec9cc3771ff476ad6a7adfc1883fd869c4eb468..82dd12681ff03050be786207911c88bb46907b40 100644 (file)
 
 #include <vector>
 #include <string>
+#include <memory>
 
 typedef std::vector<std::string> string_list;
+typedef std::vector<SGPath> PathList;
 
 // Forward declarations
 
@@ -46,7 +48,6 @@ typedef std::vector<std::string> string_list;
 
 class SGEphemeris;
 class SGCommandMgr;
-class SGMagVar;
 class SGMaterialLib;
 class SGPropertyNode;
 class SGTime;
@@ -55,14 +56,9 @@ class SGSubsystemMgr;
 class SGSubsystem;
 class SGSoundMgr;
 
-class FGATISMgr;
-class FGAircraftModel;
 class FGControls;
-class FGFlightPlanDispatcher;
-class FGNavList;
 class FGTACANList;
 class FGLocale;
-class FGModelMgr;
 class FGRouteMgr;
 class FGScenery;
 class FGTileMgr;
@@ -70,7 +66,11 @@ class FGViewMgr;
 class FGViewer;
 class FGRenderer;
 class FGFontCache;
+class FGSampleQueue;
 
+namespace simgear { namespace pkg {
+  class Root;
+}}
 
 /**
  * Bucket for subsystem pointers representing the sim's state.
@@ -83,7 +83,6 @@ private:
 
     // properties, destroy last
     SGPropertyNode_ptr props;
-    SGPropertyNode_ptr initial_state;
 
     // localization
     FGLocale* locale;
@@ -98,8 +97,17 @@ private:
     // Root of FlightGear data tree
     std::string fg_root;
 
+    /**
+     * locations to search for (non-scenery) data. 
+     */
+    PathList additional_data_paths;
+    
+    // Users home directory for data
+    std::string fg_home;
+
     // Roots of FlightGear scenery tree
     string_list fg_scenery;
+    string_list secure_fg_scenery;
 
     std::string browser;
 
@@ -109,32 +117,11 @@ private:
     // Sky structures
     SGEphemeris *ephem;
 
-    // Magnetic Variation
-    SGMagVar *mag;
-
     // Material properties library
-    SGMaterialLib *matlib;
-
-    // Global autopilot "route"
-    FGRouteMgr *route_mgr;
-
-    // ATC manager
-    FGATISMgr *ATIS_mgr;
-
-    // control input state
-    FGControls *controls;
-
-    // viewer manager
-    FGViewMgr *viewmgr;
+    SGSharedPtr<SGMaterialLib> matlib;
 
     SGCommandMgr *commands;
 
-  //FGFlightPlanDispatcher *fpDispatcher;
-
-    FGAircraftModel *acmodel;
-
-    FGModelMgr * model_mgr;
-
     // list of serial port-like configurations
     string_list *channel_options_list;
 
@@ -142,48 +129,72 @@ private:
     // 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
-    FGNavList *navlist;
-    FGNavList *loclist;
-    FGNavList *gslist;
-    FGNavList *dmelist;
-    FGNavList *tacanlist;
-    FGNavList *carrierlist;
     FGTACANList *channellist;
 
     /// roots of Aircraft trees
     string_list fg_aircraft_dirs;
+    SGPath catalog_aircraft_dir;
 
     bool haveUserSettings;
 
+    SGPropertyNode_ptr positionLon, positionLat, positionAlt;
+    SGPropertyNode_ptr viewLon, viewLat, viewAlt;
+    SGPropertyNode_ptr orientHeading, orientPitch, orientRoll;
+    
+    /**
+     * helper to initialise standard properties on a new property tree
+     */
+    void initProperties();
+    
+    SGSharedPtr<FGSampleQueue> _chatter_queue;
+    
+    void cleanupListeners();
+    
+    typedef std::vector<SGPropertyChangeListener*> SGPropertyChangeListenerVec;
+    SGPropertyChangeListenerVec _listeners_to_cleanup;
+  
+    SGSharedPtr<simgear::pkg::Root> _packageRoot;
 public:
 
     FGGlobals();
     virtual ~FGGlobals();
 
     virtual FGRenderer *get_renderer () const;
+    void set_renderer(FGRenderer* render);
+    
+    SGSubsystemMgr *get_subsystem_mgr () const;
+
+    SGSubsystem *get_subsystem (const char * name) const;
 
-    virtual SGSubsystemMgr *get_subsystem_mgr () const;
+    template<class T>
+    T* get_subsystem() const
+    {
+        return dynamic_cast<T*>(get_subsystem(T::subsystemName()));
+    }
 
-    virtual SGSubsystem *get_subsystem (const char * name);
 
-    virtual void add_subsystem (const char * name,
+    void add_subsystem (const char * name,
                                 SGSubsystem * subsystem,
                                 SGSubsystemMgr::GroupType
                                 type = SGSubsystemMgr::GENERAL,
                                 double min_time_sec = 0);
 
-    virtual SGEventMgr *get_event_mgr () const;
+    template<class T>
+    T* add_new_subsystem (SGSubsystemMgr::GroupType
+                                type = SGSubsystemMgr::GENERAL,
+                                double min_time_sec = 0)
+    {
+        T* sub = new T;
+        add_subsystem(T::subsystemName(), sub, type, min_time_sec);
+        return sub;
+    }
 
-    virtual SGSoundMgr *get_soundmgr () const;
+    SGEventMgr *get_event_mgr () const;
+
+    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; }
@@ -192,10 +203,52 @@ public:
     inline const std::string &get_fg_root () const { return fg_root; }
     void set_fg_root (const std::string &root);
 
+    /**
+     * Get list of data locations. fg_root is always the final item in the
+     * result.
+     */
+    PathList get_data_paths() const;
+    
+    /**
+     * Get data locations which contain the file path suffix. Eg pass ing
+     * 'AI/Traffic' to get all data paths which define <path>/AI/Traffic subdir
+     */
+    PathList get_data_paths(const std::string& suffix) const;
+    
+    void append_data_path(const SGPath& path);
+    
+    /**
+     * Given a path suffix (eg 'Textures' or 'AI/Traffic'), find the
+     * first data directory which defines it.
+     */
+    SGPath find_data_dir(const std::string& pathSuffix) const;
+    
+    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 const string_list &get_secure_fg_scenery () const { return secure_fg_scenery; }
+    /**
+     * Add a scenery directory
+     *
+     * secure = allow Nasal to read this directory; to avoid
+     * can-read-any-file security holes, do NOT set this on directories
+     * obtained from the property tree (e.g. /sim/terrasync/scenery-dir)
+     * or other Nasal-writable places
+     */ 
+    void append_fg_scenery (const std::string &scenery, bool secure = false);
+
+    void clear_fg_scenery();
+
+    /**
+     * specify a path we'll prepend to the aircraft paths list if non-empty.
+     * This is used with packaged aircraft, to ensure their catalog (and hence,
+     * dependency packages) are found correctly.
+     */
+    void set_catalog_aircraft_path(const SGPath& path);
+
+    string_list get_aircraft_paths() const;
 
-    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);
     
@@ -222,7 +275,7 @@ public:
      *  2. All aircraft directories if branch starts with Aircraft/
      *  3. fg_data directory
      */
-    SGPath resolve_ressource_path(const std::string& branch) const;
+    SGPath resolve_resource_path(const std::string& branch) const;
 
     inline const std::string &get_browser () const { return browser; }
     void set_browser (const std::string &b) { browser = b; }
@@ -239,47 +292,31 @@ 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 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; }
-    FGViewer *get_current_view() const;
+    void set_matlib( SGMaterialLib *m );
 
     inline SGPropertyNode *get_props () { return props; }
-    inline void set_props( SGPropertyNode *n ) { props = n; }
 
+    /**
+     * @brief reset the property tree to new, empty tree. Ensure all
+     * subsystems are shutdown and unbound before call this.
+     */
+    void resetPropertyRoot();
+    
     inline FGLocale* get_locale () { return locale; }
 
     inline SGCommandMgr *get_commands () { return commands; }
 
-    inline FGAircraftModel *get_aircraft_model () { return acmodel; }
-
-    inline void set_aircraft_model (FGAircraftModel * model)
-    {
-        acmodel = model;
-    }
-
-    const SGGeod & get_aircraft_position() const;
-
-    SGVec3d get_aircraft_positon_cart() const;
-    
-    inline FGModelMgr *get_model_mgr () { return model_mgr; }
+    SGGeod get_aircraft_position() const;
 
-    inline void set_model_mgr (FGModelMgr * mgr)
-    {
-      model_mgr = mgr;
-    }
+    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;
     }
@@ -295,40 +332,20 @@ public:
         initial_waypoints = list;
     }
 
-    inline FGScenery * get_scenery () const { return scenery; }
-    inline void set_scenery ( FGScenery *s ) { scenery = s; }
+    FGViewMgr *get_viewmgr() const;
+    FGViewer *get_current_view() const;
 
-    inline FGTileMgr * get_tile_mgr () const { return tile_mgr; }
-    inline void set_tile_mgr ( FGTileMgr *t ) { tile_mgr = t; }
+    FGControls *get_controls() const;
 
-    inline FGFontCache *get_fontcache() const { return fontcache; }
+    FGScenery * get_scenery () const;
 
-    inline FGNavList *get_navlist() const { return navlist; }
-    inline void set_navlist( FGNavList *n ) { navlist = n; }
-    inline FGNavList *get_loclist() const { return loclist; }
-    inline void set_loclist( FGNavList *n ) { loclist = n; }
-    inline FGNavList *get_gslist() const { return gslist; }
-    inline void set_gslist( FGNavList *n ) { gslist = n; }
-    inline FGNavList *get_dmelist() const { return dmelist; }
-    inline void set_dmelist( FGNavList *n ) { dmelist = n; }
-    inline FGNavList *get_tacanlist() const { return tacanlist; }
-    inline void set_tacanlist( FGNavList *n ) { tacanlist = n; }
-    inline FGNavList *get_carrierlist() const { return carrierlist; }
-    inline void set_carrierlist( FGNavList *n ) { carrierlist = n; }
+    FGTileMgr * get_tile_mgr () const;
+
+    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 ();
-
-
-    /**
-     * Restore the saved initial state, if any.
-     */
-    void restoreInitialState ();
-
     /**
      * Load user settings from autosave.xml
      */
@@ -338,6 +355,14 @@ public:
      * Save user settings in autosave.xml
      */
     void saveUserSettings();
+    
+    FGSampleQueue* get_chatter_queue() const;
+    void set_chatter_queue(FGSampleQueue* queue);
+    
+    void addListenerToCleanup(SGPropertyChangeListener* l);
+  
+    simgear::pkg::Root* packageRoot();
+    void setPackageRoot(const SGSharedPtr<simgear::pkg::Root>& p);
 };