src/Time/TimeManager.hxx

   1 // TimeManager.hxx -- simulation-wide time management
   2 //
   3 // Written by James Turner, started July 2010.
   4 //
   5 // Copyright (C) 2010  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 #ifndef FG_TIME_TIMEMANAGER_HXX
  22 #define FG_TIME_TIMEMANAGER_HXX
  23
  24 #include <simgear/structure/subsystem_mgr.hxx>
  25 #include <simgear/props/props.hxx>
  26 #include <simgear/props/propertyObject.hxx>
  27
  28 // forward decls
  29 class SGTime;
  30
  31 class TimeManager : public SGSubsystem, public SGPropertyChangeListener
  32 {
  33 public:
  34   TimeManager();
  35
  36   void computeTimeDeltas(double& simDt, double& realDt);
  37
  38   virtual void init();
  39   virtual void reinit();
  40   virtual void postinit();
  41   virtual void shutdown();
  42
  43   void update(double dt);
  44
  45 // SGPropertyChangeListener overrides
  46   virtual void valueChanged(SGPropertyNode *);
  47
  48   void setTimeOffset(const std::string& offset_type, long int offset);
  49 private:
  50
  51   /**
  52    * Ensure a consistent update-rate using a combination of
  53    * sleep()-ing and busy-waiting.
  54    */
  55   void throttleUpdateRate();
  56
  57   /**
  58    * Compute frame (update) rate and write it to a property
  59    */
  60   void computeFrameRate();
  61
  62   void updateLocalTime();
  63
  64   // set up a time offset (aka warp) if one is specified
  65   void initTimeOffset();
  66
  67   bool _inited;
  68   SGTime* _impl;
  69   SGTimeStamp _lastStamp;
  70   bool _firstUpdate;
  71   double _dtRemainder;
  72   SGPropertyNode_ptr _maxDtPerFrame;
  73   SGPropertyNode_ptr _clockFreeze;
  74   SGPropertyNode_ptr _timeOverride;
  75   SGPropertyNode_ptr _warp;
  76   SGPropertyNode_ptr _warpDelta;
  77
  78   bool _lastClockFreeze;
  79   bool _adjustWarpOnUnfreeze;
  80
  81   // frame-rate / worst-case latency / update-rate counters
  82   SGPropertyNode_ptr _frameRate;
  83   SGPropertyNode_ptr _frameRateWorst;
  84   SGPropertyNode_ptr _frameLatency;
  85   time_t _lastFrameTime;
  86   double _frameLatencyMax;
  87   int _frameCount;
  88
  89   SGPropObjBool _sceneryLoaded;
  90   SGPropObjInt _modelHz;
  91   SGPropObjDouble _timeDelta, _simTimeDelta;
  92 };
  93
  94 #endif // of FG_TIME_TIMEMANAGER_HXX