simgear/scene/tsync/terrasync.hxx

   1 // terrasync.hxx -- scenery fetcher
   2 //
   3 // Copyright (C) 2011  Thorsten Brehm <brehmt@gmail.com>
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18 //
  19 // $Id$
  20
  21 #ifndef TERRASYNC_HXX_
  22 #define TERRASYNC_HXX_
  23
  24 #include <set>
  25
  26 #include <simgear/props/props.hxx>
  27 #include <simgear/structure/subsystem_mgr.hxx>
  28 #include <simgear/props/tiedpropertylist.hxx>
  29
  30 class SGPath;
  31 class SGBucket;
  32
  33 namespace simgear
  34 {
  35 const int NOWHERE = -9999;
  36
  37 class BufferedLogCallback;
  38
  39 class SGTerraSync : public SGSubsystem
  40 {
  41 public:
  42
  43     SGTerraSync();
  44     virtual ~SGTerraSync();
  45
  46     virtual void init();
  47     virtual void shutdown();
  48     virtual void reinit();
  49     virtual void bind();
  50     virtual void unbind();
  51     virtual void update(double);
  52
  53     /// notify terrasync that the sim was repositioned, as opposed to
  54     /// us travelling in a direction. Avoid last_lat / last_lon blocking
  55     /// certain tiles when we reposition.
  56     void reposition();
  57
  58     bool isIdle();
  59
  60     bool scheduleTile(const SGBucket& bucket);
  61
  62     void setRoot(SGPropertyNode_ptr root);
  63
  64     /// retrive the associated log object, for displaying log
  65     /// output somewhere (a UI, presumably)
  66     BufferedLogCallback* log() const
  67         { return _log; }
  68
  69     /**
  70      * Test if a scenery directory is queued or actively syncing.
  71      * File path is the tile name, eg 'e001n52' or 'w003n56'. Will return true
  72      * if either the Terrain or Objects variant is being synced.
  73      *
  74      */
  75     bool isTileDirPending(const std::string& sceneryDir) const;
  76
  77
  78     void scheduleDataDir(const std::string& dataDir);
  79
  80     bool isDataDirPending(const std::string& dataDir) const;
  81 protected:
  82     void syncAirportsModels();
  83
  84     void syncAreaByPath(const std::string& aPath);
  85
  86     class SvnThread;
  87
  88 private:
  89     SvnThread* _svnThread;
  90     SGPropertyNode_ptr _terraRoot;
  91     SGPropertyNode_ptr _stalledNode;
  92     SGPropertyNode_ptr _cacheHits;
  93
  94     // we manually bind+init TerraSync during early startup
  95     // to get better overlap of slow operations (Shared Models sync
  96     // and nav-cache rebuild). As a result we need to track the bind/init
  97     // state explicitly to avoid duplicate calls.
  98     bool _bound, _inited;
  99
 100     simgear::TiedPropertyList _tiedProperties;
 101     BufferedLogCallback* _log;
 102
 103     typedef std::set<std::string> string_set;
 104     string_set _activeTileDirs;
 105 };
 106
 107 }
 108
 109 #endif /* TERRASYNC_HXX_ */