Debian Codegraph @

engine/core/util/time/timeevent.h

raw
1 /***************************************************************************
2 * Copyright (C) 2005-2019 by the FIFE team *
3 * http://www.fifengine.net *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or *
7 * modify it under the terms of the GNU Lesser General Public *
8 * License as published by the Free Software Foundation; either *
9 * version 2.1 of the License, or (at your option) any later version. *
10 * *
11 * This library is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_TIMEVENT_H
23 #define FIFE_TIMEVENT_H
24
25 // Standard C++ library includes
26
27 // 3rd party library includes
28
29 // FIFE includes
30 // These includes are split up in two parts, separated by one empty line
31 // First block: files included from the FIFE root src directory
32 // Second block: files included from the same folder
33 #include "util/base/fife_stdint.h"
34
35 namespace FIFE {
36
37 /** Interface for events to be registered with TimeManager.
38 *
39 * To register a class with TimeManager firstly derive a class
40 * from this and override the updateEvent() function. updateEvent()
41 * will be called periodically depending on the value of getPeriod()
42 * which can be set using the constructor or setPeriod(). A value
43 * of -1 will never be updated, 0 will updated every frame and a value
44 * over 0 defines the number of milliseconds between updates.
45 *
46 * @see TimeManager
47 */
48 class TimeEvent {
49 public:
50 /** Default constructor.
51 *
52 * @param period The period of the event. See class description.
53 */
54 TimeEvent(int32_t period = -1);
55
56 /** Destructor.
57 *
58 */
59 virtual ~TimeEvent();
60
61 /** Update function to be overridden by client.
62 *
63 * @param time Time delta.
64 */
65 virtual void updateEvent(uint32_t time) = 0;
66
67 /** Called by TimeManager to update the event.
68 *
69 * @param time Current time. Used To check if its time to update.
70 */
71 void managerUpdateEvent(uint32_t time);
72
73 /** Set the period of the event.
74 *
75 * @param period The period of the event. See class description.
76 */
77 void setPeriod(int32_t period);
78
79 /** Get the period of the event.
80 *
81 * @return The period of the event. See class description.
82 */
83 int32_t getPeriod();
84
85 /** Get the last time the event was updated.
86 *
87 * @return Time of last update.
88 */
89 uint32_t getLastUpdateTime();
90
91 /** Set the last time the event was updated.
92 *
93 * @param ms Time of last update.
94 */
95 void setLastUpdateTime(uint32_t ms);
96
97 private:
98 // The period of the event. See the class description.
99 int32_t m_period;
100
101 // The last time the class was updated.
102 uint32_t m_last_updated;
103 };
104
105 }//FIFE
106
107 #endif