1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/***************************************************************************
* Copyright (C) 2005-2019 by the FIFE team *
* http://www.fifengine.net *
* This file is part of FIFE. *
* *
* FIFE is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
#ifndef FIFE_TIMER_H
#define FIFE_TIMER_H
// Standard C++ library includes
#include <functional>
// 3rd party library includes
// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "timeevent.h"
namespace FIFE {
/** Simple Timer class
*
* This is a simple wrapper around the TimeEvent,
* which makes the later usable without having to
* subclass it every time.
*
* @code
* m_timer.setInterval(1000);
* m_timer.setCallback(std::bind(&Class::update, this) );
* m_timer.start();
* @endcode
*
* @warning Note that the callback must be available
* when it is triggered. If your called function is a
* bound member function and it goes out of scope,
* when the callback is called you'll most likely
* have a segfault. So this is best used as a member
* calling an update function.
*
* @note You don't have to call TimeManager::registerEvent @b ever
*
* @see Console
*/
class Timer : protected TimeEvent {
public:
typedef std::function<void()> type_callback;
/** Default constructor.
*
* Constructs an idle timer, use @see setInterval and @see setCallback
* to set it up for use.
*/
Timer();
/** Destructor.
*
* Stops and destroys the timer.
*/
virtual ~Timer();
/** Set the interval in milliseconds
*
* @param msec The interval
* If you use an intervall 0 the timer will fire every frame.
*/
void setInterval(int32_t msec);
/** Start the timer
*
* Without calling this function, nothing will happen.
* It is save to call this more than once.
*/
void start();
/** Stop the timer
*
* Stops execution of the callback
* It is save to call this more than once.
*/
void stop();
/** Set the callback that will be called
*
* @param callback A @c std::function returning void
*/
void setCallback(const type_callback& callback);
protected:
bool m_active;
type_callback m_callback;
void updateEvent(uint32_t);
};
}//FIFE
#endif
|
