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