unify include guard defines, __$FILENAME__
[blender-staging.git] / intern / ghost / intern / GHOST_TimerManager.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_TimerManager.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_TimerManager class.
31  */
32
33 #ifndef __GHOST_TIMERMANAGER_H__
34 #define __GHOST_TIMERMANAGER_H__
35
36 #include <vector>
37
38 #include "GHOST_Types.h"
39
40 class GHOST_TimerTask;
41
42
43 /**
44  * Manages a list of timer tasks.
45  * Timer tasks added are owned by the manager.
46  * Don't delete timer task objects.
47  * @author      Maarten Gribnau
48  * @date        May 31, 2001
49  */
50 class GHOST_TimerManager
51 {
52 public:
53         /**
54          * Constructor.
55          */
56         GHOST_TimerManager();
57
58         /**
59          * Destructor.
60          */
61         virtual ~GHOST_TimerManager();
62
63         /**
64          * Returns the number of timer tasks.
65          * @return The number of events on the stack.
66          */
67         virtual GHOST_TUns32 getNumTimers();
68
69         /**
70          * Returns whther this timer task ins in our list.
71          * @return Indication of presence.
72          */
73         virtual bool getTimerFound(GHOST_TimerTask* timer);
74
75         /**
76          * Adds a timer task to the list.
77          * It is only added when it not already present in the list.
78          * @param timer The timer task added to the list.
79          * @return Indication as to whether addition has succeeded.
80          */
81         virtual GHOST_TSuccess addTimer(GHOST_TimerTask* timer);
82
83         /**
84          * Removes a timer task from the list.
85          * It is only removed when it is found in the list.
86          * @param timer The timer task to be removed from the list.
87          * @return Indication as to whether removal has succeeded.
88          */
89         virtual GHOST_TSuccess removeTimer(GHOST_TimerTask* timer);
90
91         /**
92          * Finds the soonest time the next timer would fire.
93          * @return The soonest time the next timer would fire, 
94          * or GHOST_kFireTimeNever if no timers exist.
95          */
96         virtual GHOST_TUns64 nextFireTime();
97         
98         /**
99          * Checks all timer tasks to see if they are expired and fires them if needed.
100          * @param time The current time.
101          * @return True if any timers were fired.
102          */
103         virtual bool fireTimers(GHOST_TUns64 time);
104
105         /**
106          * Checks this timer task to see if they are expired and fires them if needed.
107          * @param time The current time.
108          * @param task The timer task to check and optionally fire.
109          * @return True if the timer fired.
110          */
111         virtual bool fireTimer(GHOST_TUns64 time, GHOST_TimerTask* task);
112
113 protected:
114         /**
115          * Deletes all timers.
116          */
117         void disposeTimers();
118
119         typedef std::vector<GHOST_TimerTask*> TTimerVector;
120         /** The list with event consumers. */
121         TTimerVector m_timers;
122 };
123
124 #endif // __GHOST_TIMERMANAGER_H__
125