Cleanup: remove author/date info from doxy headers
[blender.git] / intern / ghost / intern / GHOST_TimerTask.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file ghost/intern/GHOST_TimerTask.h
21  *  \ingroup GHOST
22  * Declaration of GHOST_TimerTask class.
23  */
24
25 #ifndef __GHOST_TIMERTASK_H__
26 #define __GHOST_TIMERTASK_H__
27
28 #include "GHOST_ITimerTask.h"
29
30
31 /**
32  * Implementation of a timer task.
33  */
34 class GHOST_TimerTask : public GHOST_ITimerTask
35 {
36 public:
37         /**
38          * Constructor.
39          * \param start         The timer start time.
40          * \param interval      The interval between calls to the timerProc
41          * \param timerProc     The callback invoked when the interval expires.
42          * \param userData: The timer user data.
43          */
44         GHOST_TimerTask(GHOST_TUns64 start,
45                         GHOST_TUns64 interval,
46                         GHOST_TimerProcPtr timerProc,
47                         GHOST_TUserDataPtr userData = NULL)
48                 : m_start(start),
49                 m_interval(interval),
50                 m_next(start),
51                 m_timerProc(timerProc),
52                 m_userData(userData),
53                 m_auxData(0)
54         {
55         }
56
57         /**
58          * Returns the timer start time.
59          * \return The timer start time.
60          */
61         inline GHOST_TUns64 getStart() const
62         {
63                 return m_start;
64         }
65
66         /**
67          * Changes the timer start time.
68          * \param start The timer start time.
69          */
70         void setStart(GHOST_TUns64 start)
71         {
72                 m_start = start;
73         }
74
75         /**
76          * Returns the timer interval.
77          * \return The timer interval.
78          */
79         inline GHOST_TUns64 getInterval() const
80         {
81                 return m_interval;
82         }
83
84         /**
85          * Changes the timer interval.
86          * \param interval The timer interval.
87          */
88         void setInterval(GHOST_TUns64 interval)
89         {
90                 m_interval = interval;
91         }
92
93         /**
94          * Returns the time the timerProc will be called.
95          * \return The time the timerProc will be called.
96          */
97         inline GHOST_TUns64 getNext() const
98         {
99                 return m_next;
100         }
101
102         /**
103          * Changes the time the timerProc will be called.
104          * \param next The time the timerProc will be called.
105          */
106         void setNext(GHOST_TUns64 next)
107         {
108                 m_next = next;
109         }
110
111         /**
112          * Returns the timer callback.
113          * \return the timer callback.
114          */
115         inline GHOST_TimerProcPtr getTimerProc() const
116         {
117                 return m_timerProc;
118         }
119
120         /**
121          * Changes the timer callback.
122          * \param timerProc: The timer callback.
123          */
124         inline void setTimerProc(const GHOST_TimerProcPtr timerProc)
125         {
126                 m_timerProc = timerProc;
127         }
128
129         /**
130          * Returns the timer user data.
131          * \return The timer user data.
132          */
133         inline GHOST_TUserDataPtr getUserData() const
134         {
135                 return m_userData;
136         }
137
138         /**
139          * Changes the time user data.
140          * \param userData: The timer user data.
141          */
142         void setUserData(const GHOST_TUserDataPtr userData)
143         {
144                 m_userData = userData;
145         }
146
147         /**
148          * Returns the auxiliary storage room.
149          * \return The auxiliary storage room.
150          */
151         inline GHOST_TUns32 getAuxData() const
152         {
153                 return m_auxData;
154         }
155
156         /**
157          * Changes the auxiliary storage room.
158          * \param auxData The auxiliary storage room.
159          */
160         void setAuxData(GHOST_TUns32 auxData)
161         {
162                 m_auxData = auxData;
163         }
164
165 protected:
166         /** The time the timer task was started. */
167         GHOST_TUns64 m_start;
168
169         /** The interval between calls. */
170         GHOST_TUns64 m_interval;
171
172         /** The time the timerProc will be called. */
173         GHOST_TUns64 m_next;
174
175         /** The callback invoked when the timer expires. */
176         GHOST_TimerProcPtr m_timerProc;
177
178         /** The timer task user data. */
179         GHOST_TUserDataPtr m_userData;
180
181         /** Auxiliary storage room. */
182         GHOST_TUns32 m_auxData;
183 };
184
185 #endif // __GHOST_TIMERTASK_H__