-//
-// C Interface: timer
-//
-// Description:
-//
-//
-// Author: Tobias Glaesser <tobi.web@gmx.de>, (C) 2004
-//
-// Copyright: See COPYING file that comes with this distribution
-//
-//
+#ifndef __SUPERTUX_TIMER_H__
+#define __SUPERTUX_TIMER_H__
-#ifndef SUPERTUX_TIMER_H
-#define SUPERTUX_TIMER_H
+extern float global_time;
-/* Timer type */
-typedef struct timer_type
- {
- unsigned int period;
- unsigned int time;
- unsigned int (*get_ticks) (void);
- }
-timer_type;
+/**
+ * new simpler timer designed to be used in the update functions of objects
+ */
+class Timer2 // TODO rename later
+{
+public:
+ Timer2();
+ ~Timer2();
-extern unsigned int st_pause_ticks, st_pause_count;
+ /** start the timer with the given period (in seconds).
+ * If cyclic=true then the timer willl be reset after each period.
+ * Set period to zero if you want to disable the timer.
+ */
+ void start(float period, bool cyclic = false);
+ /** returns true if a period (or more) passed since start call or last
+ * successfull check
+ */
+ bool check();
-unsigned int st_get_ticks(void);
-void st_pause_ticks_init(void);
-void st_pause_ticks_start(void);
-void st_pause_ticks_stop(void);
-void timer_init(timer_type* ptimer, int st_ticks);
-void timer_start(timer_type* ptimer, unsigned int period);
-void timer_stop(timer_type* ptimer);
-/*======================================================================
- int timer_check(timer_type* ptimer);
-
- param : pointer to a timer which needs to be checked
- return: NO = the timer is not started
- or it is over
- YES = otherwise
-======================================================================*/
-int timer_check(timer_type* ptimer);
-int timer_started(timer_type* ptimer);
-/*======================================================================
- int timer_get_left(timer_type* ptimer);
+ /** returns the period of the timer or 0 if it isn't started */
+ float get_period() const
+ { return period; }
+ float get_timeleft() const
+ { return period - (global_time - cycle_start); }
+ float get_timegone() const
+ { return global_time - cycle_start; }
+ bool started() const
+ { return period != 0 && get_timeleft() > 0; }
- param : pointer to a timer that you want to get the time left
- return: the time left (in millisecond)
- note : the returned value can be negative
-======================================================================*/
-int timer_get_left(timer_type* ptimer);
-int timer_get_gone(timer_type* ptimer);
+private:
+ float period;
+ float cycle_start;
+ bool cyclic;
+};
-#endif /*SUPERTUX_TIMER_H*/
+#endif