/***************************************************************************
 *   Copyright (C) 2005-2008 by the FIFE team                              *
 *   http://www.fifengine.de                                               *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_TIMEVENT_H
#define FIFE_TIMEVENT_H

// Standard C++ library includes

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder

namespace FIFE {

	/** Interface for events to be registered with TimeManager.  
	*
	* To register a class with TimeManager firstly derive a class
	* from this and override the updateEvent() function. updateEvent() 
	* will be called periodically depending on the value of getPeriod()
	* which can be set using the constructor or setPeriod(). A value
	* of -1 will never be updated, 0 will updated every frame and a value
	* over 0 defines the number of milliseconds between updates.
	*  
	* @see TimeManager
	*/
	class TimeEvent {
	public:
		/** Default constructor.
		 *
		 * @param period The period of the event. See class description.
		 */
		TimeEvent(int period = -1);
		
		/** Destructor.
		 *
		 */
		virtual ~TimeEvent(); 

		/** Update function to be overridden by client.
		 *
		 * @param time_delta Time.
		 */
		virtual void updateEvent(unsigned long time) = 0;

		/** Called by TimeManager to update the event.
		 *
		 * @param time Current time. Used To check if its time to update.
		 */
		void managerUpdateEvent(unsigned long time);

		/** Set the period of the event.
		 *
		 * @param period The period of the event. See class description.
		 */
		void setPeriod(int period);

		/** Get the period of the event.
		 *
		 * @return The period of the event. See class description.
		 */
		int getPeriod();		

		/** Get the last time the event was updated.
		 *
		 * @return Time of last update.
		 */
		unsigned long getLastUpdateTime();	

		/** Set the last time the event was updated.
		 *
		 * @param Time of last update.
		 */
		void setLastUpdateTime(unsigned long);	

    private:
		// The period of the event. See the class description.
		int m_period;

		// The last time the class was updated.
		unsigned long m_last_updated;
    };

}//FIFE

#endif