OpenWalnut  1.4.0
WGEAnimationFrameTimer.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WGEANIMATIONFRAMETIMER_H
26 #define WGEANIMATIONFRAMETIMER_H
27 
28 #ifndef Q_MOC_RUN
29 #include <boost/shared_ptr.hpp>
30 #endif
31 
32 #include "../../common/WTimer.h"
33 
34 
35 
36 /**
37  * Frame-based animation timing.
38  */
40 {
41 public:
42  /**
43  * Convenience typedef for a shared_ptr
44  */
45  typedef boost::shared_ptr< WGEAnimationFrameTimer > SPtr;
46 
47  /**
48  * Convenience typedef for a const shared_ptr.
49  */
50  typedef boost::shared_ptr< const WGEAnimationFrameTimer > ConstSPtr;
51 
52  /**
53  * Constructs a frame based animation timer. The specified number of frames is used to convert the number of frames to a time.
54  *
55  * \param framesPerSecond frames per second.
56  */
57  explicit WGEAnimationFrameTimer( float framesPerSecond = 24.0 );
58 
59  /**
60  * Destructor.
61  */
62  virtual ~WGEAnimationFrameTimer();
63 
64  /**
65  * Resets the start-tick.
66  */
67  virtual void reset();
68 
69  /**
70  * Returns the elapsed time since the last reset in seconds with milliseconds precision.
71  *
72  * \return elapsed time in seconds with millisecond precision.
73  */
74  virtual double elapsed() const;
75 
76  /**
77  * Increments frame count.
78  */
79  virtual void tick();
80 
81 private:
82  /**
83  * The current tick value.
84  */
85  size_t m_tick;
86 
87  /**
88  * The number of frames per second.
89  */
91 };
92 
93 #endif // WGEANIMATIONFRAMETIMER_H
virtual double elapsed() const
Returns the elapsed time since the last reset in seconds with milliseconds precision.
Frame-based animation timing.
double m_framesPerSecond
The number of frames per second.
boost::shared_ptr< WGEAnimationFrameTimer > SPtr
Convenience typedef for a shared_ptr.
virtual void reset()
Resets the start-tick.
WGEAnimationFrameTimer(float framesPerSecond=24.0)
Constructs a frame based animation timer.
boost::shared_ptr< const WGEAnimationFrameTimer > ConstSPtr
Convenience typedef for a const shared_ptr.
Base class for timing.
Definition: WTimer.h:37
virtual ~WGEAnimationFrameTimer()
Destructor.
virtual void tick()
Increments frame count.
size_t m_tick
The current tick value.