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 <simgear/props/props.hxx>
  25 #include <simgear/structure/subsystem_mgr.hxx>
  26 #include <simgear/props/tiedpropertylist.hxx>
  27
  28 class SGPath;
  29 class SGBucket;
  30
  31 namespace simgear
  32 {
  33 const int NOWHERE = -9999;
  34
  35 class BufferedLogCallback;
  36
  37 typedef void (*SGTerraSyncCallback)(void* userData, long tileIndex);
  38
  39 class SGTerraSync : public SGSubsystem
  40 {
  41 public:
  42
  43     SGTerraSync(SGPropertyNode_ptr root);
  44     virtual ~SGTerraSync();
  45
  46     virtual void init();
  47     virtual void reinit();
  48     virtual void bind();
  49     virtual void unbind();
  50     virtual void update(double);
  51
  52     /// notify terrasync that the sim was repositioned, as opposed to
  53     /// us travelling in a direction. Avoid last_lat / last_lon blocking
  54     /// certain tiles when we reposition.
  55     void reposition();
  56
  57     bool isIdle();
  58     bool schedulePosition(int lat, int lon);
  59
  60     bool scheduleTile(const SGBucket& bucket);
  61
  62     void setTileRefreshCb(SGTerraSyncCallback refreshCb, void* userData = NULL);
  63
  64     /// retrive the associated log object, for displaying log
  65     /// output somewhere (a UI, presumably)
  66     BufferedLogCallback* log() const
  67         { return _log; }
  68 protected:
  69     void syncAirportsModels();
  70     void syncArea(int lat, int lon);
  71     void syncAreas(int lat, int lon, int lat_dir, int lon_dir);
  72     void refreshScenery(SGPath path,const std::string& relativeDir);
  73
  74     class SvnThread;
  75
  76 private:
  77     SvnThread* _svnThread;
  78     int last_lat;
  79     int last_lon;
  80     SGPropertyNode_ptr _terraRoot;
  81     SGPropertyNode_ptr _refreshDisplay;
  82     SGPropertyNode_ptr _stalledNode;
  83     SGPropertyNode_ptr _cacheHits;
  84
  85     // we manually bind+init TerraSync during early startup
  86     // to get better overlap of slow operations (Shared Models sync
  87     // and nav-cache rebuild). As a result we need to track the bind/init
  88     // state explicitly to avoid duplicate calls.
  89     bool _bound, _inited;
  90
  91     SGTerraSyncCallback _refreshCb;
  92     void* _userCbData;
  93     simgear::TiedPropertyList _tiedProperties;
  94     BufferedLogCallback* _log;
  95 };
  96
  97 }
  98
  99 #endif /* TERRASYNC_HXX_ */