X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=src%2Ftimer.h;h=42e1b8fd897f91c462c45bbd8f4bc74570548bd4;hb=e91a85357ef52e2411a673bbd297147425857892;hp=8c69b3d678b4b07bc74b916e19630008df8c8014;hpb=e147eea9f117721dbcf79d1465452b6ae91fe33c;p=supertux.git diff --git a/src/timer.h b/src/timer.h index 8c69b3d67..42e1b8fd8 100644 --- a/src/timer.h +++ b/src/timer.h @@ -1,62 +1,64 @@ +// $Id$ +// +// SuperTux +// Copyright (C) 2005 Matthias Braun // -// C Interface: timer -// -// Description: -// -// -// Author: Tobias Glaesser , (C) 2004 -// -// Copyright: See COPYING file that comes with this distribution -// +// This program is free software; you can redistribute it and/or +// modify it under the terms of the GNU General Public License +// as published by the Free Software Foundation; either version 2 +// of the License, or (at your option) any later version. // +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA +// 02111-1307, USA. +#ifndef __SUPERTUX_TIMER_H__ +#define __SUPERTUX_TIMER_H__ -#ifndef SUPERTUX_TIMER_H -#define SUPERTUX_TIMER_H +extern float global_time; -extern unsigned int st_pause_ticks, st_pause_count; - -unsigned int st_get_ticks(void); -void st_pause_ticks_init(void); -void st_pause_ticks_start(void); -void st_pause_ticks_stop(void); - -class timer_type +/** + * new simpler timer designed to be used in the update functions of objects + */ +class Timer { - public: - unsigned int period; - unsigned int time; - unsigned int (*get_ticks) (void); +public: + Timer(); + ~Timer(); - public: - void init(bool st_ticks); - void start(unsigned int period); - void stop(); + /** 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(); + /** stop the timer */ + void stop() + { start(0); } - /*====================================================================== - 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 check(); - int started(); -}; -/*====================================================================== - 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); -void timer_fwrite(timer_type* ptimer, FILE* fi); -void timer_fread(timer_type* ptimer, FILE* fi); +private: + float period; + float cycle_start; + bool cyclic; +}; -#endif /*SUPERTUX_TIMER_H*/ +#endif -/* Local Variables: */ -/* mode:c++ */ -/* End */