FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
timer.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 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 // Standard C++ library includes
23 
24 // 3rd party library includes
25 
26 // FIFE includes
27 // These includes are split up in two parts, separated by one empty line
28 // First block: files included from the FIFE root src directory
29 // Second block: files included from the same folder
30 #include "timemanager.h"
31 #include "timer.h"
32 
33 namespace FIFE {
34 
35  // Remember TimeEvent(-1) means that even a registered event won't be called
37  : TimeEvent(-1),
38  m_active(false) {
39  }
40 
42  stop();
43  }
44 
45  void Timer::start() {
46  if(m_active)
47  return;
50  m_active = true;
51  }
52 
53  void Timer::stop() {
54  if(!m_active)
55  return;
57  m_active = false;
58  }
59 
60  void Timer::setInterval(int32_t msec) {
61  setPeriod(msec);
62  stop();
63  }
65  m_callback = cb;
66  }
67 
69  if(!m_active)
70  return;
71 
72  if( m_callback ) {
73  m_callback();
74  }
75  }
76 }
void registerEvent(TimeEvent *event)
Adds a TimeEvent.
Definition: timemanager.cpp:84
bool m_active
Definition: timer.h:106
void setInterval(int32_t msec)
Set the interval in milliseconds.
Definition: timer.cpp:60
void start()
Start the timer.
Definition: timer.cpp:45
static TimeManager * instance()
Definition: singleton.h:84
void unregisterEvent(TimeEvent *event)
Removes a TimeEvent.
Definition: timemanager.cpp:89
Interface for events to be registered with TimeManager.
Definition: timeevent.h:48
type_callback m_callback
Definition: timer.h:107
boost::function0< void > type_callback
Definition: timer.h:63
void setPeriod(int32_t period)
Set the period of the event.
Definition: timeevent.cpp:56
void setLastUpdateTime(uint32_t ms)
Set the last time the event was updated.
Definition: timeevent.cpp:68
void stop()
Stop the timer.
Definition: timer.cpp:53
Timer()
Default constructor.
Definition: timer.cpp:36
virtual ~Timer()
Destructor.
Definition: timer.cpp:41
unsigned int uint32_t
Definition: core.h:40
void setCallback(const type_callback &callback)
Set the callback that will be called.
Definition: timer.cpp:64
void updateEvent(uint32_t)
Update function to be overridden by client.
Definition: timer.cpp:68