Timer.hpp
Go to the documentation of this file.
1 //
3 // Thor C++ Library
4 // Copyright (c) 2011-2016 Jan Haller
5 //
6 // This software is provided 'as-is', without any express or implied
7 // warranty. In no event will the authors be held liable for any damages
8 // arising from the use of this software.
9 //
10 // Permission is granted to anyone to use this software for any purpose,
11 // including commercial applications, and to alter it and redistribute it
12 // freely, subject to the following restrictions:
13 //
14 // 1. The origin of this software must not be misrepresented; you must not
15 // claim that you wrote the original software. If you use this software
16 // in a product, an acknowledgment in the product documentation would be
17 // appreciated but is not required.
18 //
19 // 2. Altered source versions must be plainly marked as such, and must not be
20 // misrepresented as being the original software.
21 //
22 // 3. This notice may not be removed or altered from any source distribution.
23 //
25 
28 
29 #ifndef THOR_TIMER_HPP
30 #define THOR_TIMER_HPP
31 
32 #include <Thor/Time/StopWatch.hpp>
33 #include <Thor/Config.hpp>
34 
35 #include <SFML/System/Time.hpp>
36 
37 
38 namespace thor
39 {
40 
43 
46 class THOR_API Timer
47 {
48  // ---------------------------------------------------------------------------------------------------------------------------
49  // Public member functions
50  public:
53  Timer();
54 
57  virtual ~Timer();
58 
61  sf::Time getRemainingTime() const;
62 
65  bool isRunning() const;
66 
69  bool isExpired() const;
70 
73  void start();
74 
77  void stop();
78 
82  virtual void reset(sf::Time timeLimit);
83 
87  virtual void restart(sf::Time timeLimit);
88 
89 
90  // ---------------------------------------------------------------------------------------------------------------------------
91  // Private variables
92  private:
93  StopWatch mStopWatch;
94  sf::Time mLimit;
95 };
96 
98 
99 } // namespace thor
100 
101 #endif // THOR_TIMER_HPP
Pausable clock class that measures elapsed time.
Definition: StopWatch.hpp:46
Definition: AnimationMap.hpp:42
Configuration header of the library.
Class thor::StopWatch.
Clock class that has the semantics of a countdown timer.
Definition: Timer.hpp:46