diff options
Diffstat (limited to 'intern/ghost/intern/GHOST_TimerTask.h')
-rw-r--r-- | intern/ghost/intern/GHOST_TimerTask.h | 300 |
1 files changed, 149 insertions, 151 deletions
diff --git a/intern/ghost/intern/GHOST_TimerTask.h b/intern/ghost/intern/GHOST_TimerTask.h index 375de377a25..561d9b3e705 100644 --- a/intern/ghost/intern/GHOST_TimerTask.h +++ b/intern/ghost/intern/GHOST_TimerTask.h @@ -27,159 +27,157 @@ #include "GHOST_ITimerTask.h" - /** * Implementation of a timer task. */ -class GHOST_TimerTask : public GHOST_ITimerTask -{ -public: - /** - * Constructor. - * \param start The timer start time. - * \param interval The interval between calls to the timerProc - * \param timerProc The callback invoked when the interval expires. - * \param userData: The timer user data. - */ - GHOST_TimerTask(GHOST_TUns64 start, - GHOST_TUns64 interval, - GHOST_TimerProcPtr timerProc, - GHOST_TUserDataPtr userData = NULL) - : m_start(start), - m_interval(interval), - m_next(start), - m_timerProc(timerProc), - m_userData(userData), - m_auxData(0) - { - } - - /** - * Returns the timer start time. - * \return The timer start time. - */ - inline GHOST_TUns64 getStart() const - { - return m_start; - } - - /** - * Changes the timer start time. - * \param start The timer start time. - */ - void setStart(GHOST_TUns64 start) - { - m_start = start; - } - - /** - * Returns the timer interval. - * \return The timer interval. - */ - inline GHOST_TUns64 getInterval() const - { - return m_interval; - } - - /** - * Changes the timer interval. - * \param interval The timer interval. - */ - void setInterval(GHOST_TUns64 interval) - { - m_interval = interval; - } - - /** - * Returns the time the timerProc will be called. - * \return The time the timerProc will be called. - */ - inline GHOST_TUns64 getNext() const - { - return m_next; - } - - /** - * Changes the time the timerProc will be called. - * \param next The time the timerProc will be called. - */ - void setNext(GHOST_TUns64 next) - { - m_next = next; - } - - /** - * Returns the timer callback. - * \return the timer callback. - */ - inline GHOST_TimerProcPtr getTimerProc() const - { - return m_timerProc; - } - - /** - * Changes the timer callback. - * \param timerProc: The timer callback. - */ - inline void setTimerProc(const GHOST_TimerProcPtr timerProc) - { - m_timerProc = timerProc; - } - - /** - * Returns the timer user data. - * \return The timer user data. - */ - inline GHOST_TUserDataPtr getUserData() const - { - return m_userData; - } - - /** - * Changes the time user data. - * \param userData: The timer user data. - */ - void setUserData(const GHOST_TUserDataPtr userData) - { - m_userData = userData; - } - - /** - * Returns the auxiliary storage room. - * \return The auxiliary storage room. - */ - inline GHOST_TUns32 getAuxData() const - { - return m_auxData; - } - - /** - * Changes the auxiliary storage room. - * \param auxData The auxiliary storage room. - */ - void setAuxData(GHOST_TUns32 auxData) - { - m_auxData = auxData; - } - -protected: - /** The time the timer task was started. */ - GHOST_TUns64 m_start; - - /** The interval between calls. */ - GHOST_TUns64 m_interval; - - /** The time the timerProc will be called. */ - GHOST_TUns64 m_next; - - /** The callback invoked when the timer expires. */ - GHOST_TimerProcPtr m_timerProc; - - /** The timer task user data. */ - GHOST_TUserDataPtr m_userData; - - /** Auxiliary storage room. */ - GHOST_TUns32 m_auxData; +class GHOST_TimerTask : public GHOST_ITimerTask { + public: + /** + * Constructor. + * \param start The timer start time. + * \param interval The interval between calls to the timerProc + * \param timerProc The callback invoked when the interval expires. + * \param userData: The timer user data. + */ + GHOST_TimerTask(GHOST_TUns64 start, + GHOST_TUns64 interval, + GHOST_TimerProcPtr timerProc, + GHOST_TUserDataPtr userData = NULL) + : m_start(start), + m_interval(interval), + m_next(start), + m_timerProc(timerProc), + m_userData(userData), + m_auxData(0) + { + } + + /** + * Returns the timer start time. + * \return The timer start time. + */ + inline GHOST_TUns64 getStart() const + { + return m_start; + } + + /** + * Changes the timer start time. + * \param start The timer start time. + */ + void setStart(GHOST_TUns64 start) + { + m_start = start; + } + + /** + * Returns the timer interval. + * \return The timer interval. + */ + inline GHOST_TUns64 getInterval() const + { + return m_interval; + } + + /** + * Changes the timer interval. + * \param interval The timer interval. + */ + void setInterval(GHOST_TUns64 interval) + { + m_interval = interval; + } + + /** + * Returns the time the timerProc will be called. + * \return The time the timerProc will be called. + */ + inline GHOST_TUns64 getNext() const + { + return m_next; + } + + /** + * Changes the time the timerProc will be called. + * \param next The time the timerProc will be called. + */ + void setNext(GHOST_TUns64 next) + { + m_next = next; + } + + /** + * Returns the timer callback. + * \return the timer callback. + */ + inline GHOST_TimerProcPtr getTimerProc() const + { + return m_timerProc; + } + + /** + * Changes the timer callback. + * \param timerProc: The timer callback. + */ + inline void setTimerProc(const GHOST_TimerProcPtr timerProc) + { + m_timerProc = timerProc; + } + + /** + * Returns the timer user data. + * \return The timer user data. + */ + inline GHOST_TUserDataPtr getUserData() const + { + return m_userData; + } + + /** + * Changes the time user data. + * \param userData: The timer user data. + */ + void setUserData(const GHOST_TUserDataPtr userData) + { + m_userData = userData; + } + + /** + * Returns the auxiliary storage room. + * \return The auxiliary storage room. + */ + inline GHOST_TUns32 getAuxData() const + { + return m_auxData; + } + + /** + * Changes the auxiliary storage room. + * \param auxData The auxiliary storage room. + */ + void setAuxData(GHOST_TUns32 auxData) + { + m_auxData = auxData; + } + + protected: + /** The time the timer task was started. */ + GHOST_TUns64 m_start; + + /** The interval between calls. */ + GHOST_TUns64 m_interval; + + /** The time the timerProc will be called. */ + GHOST_TUns64 m_next; + + /** The callback invoked when the timer expires. */ + GHOST_TimerProcPtr m_timerProc; + + /** The timer task user data. */ + GHOST_TUserDataPtr m_userData; + + /** Auxiliary storage room. */ + GHOST_TUns32 m_auxData; }; -#endif // __GHOST_TIMERTASK_H__ +#endif // __GHOST_TIMERTASK_H__ |