OpenWalnut  1.3.1
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 #include <boost/shared_ptr.hpp>
29 
30 #include "../../common/WTimer.h"
31 
32 
33 
34 /**
35  * Frame-based animation timing.
36  */
38 {
39 public:
40  /**
41  * Convenience typedef for a shared_ptr
42  */
43  typedef boost::shared_ptr< WGEAnimationFrameTimer > SPtr;
44 
45  /**
46  * Convenience typedef for a const shared_ptr.
47  */
48  typedef boost::shared_ptr< const WGEAnimationFrameTimer > ConstSPtr;
49 
50  /**
51  * Constructs a frame based animation timer. The specified number of frames is used to convert the number of frames to a time.
52  *
53  * \param framesPerSecond frames per second.
54  */
55  explicit WGEAnimationFrameTimer( float framesPerSecond = 24.0 );
56 
57  /**
58  * Destructor.
59  */
60  virtual ~WGEAnimationFrameTimer();
61 
62  /**
63  * Resets the start-tick.
64  */
65  virtual void reset();
66 
67  /**
68  * Returns the elapsed time since the last reset in seconds with milliseconds precision.
69  *
70  * \return elapsed time in seconds with millisecond precision.
71  */
72  virtual double elapsed() const;
73 
74  /**
75  * Increments frame count.
76  */
77  virtual void tick();
78 
79 private:
80  /**
81  * The current tick value.
82  */
83  size_t m_tick;
84 
85  /**
86  * The number of frames per second.
87  */
89 };
90 
91 #endif // WGEANIMATIONFRAMETIMER_H