/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

// Based on code by omergilad.

#ifndef GUI_ANIMATION_ANIMATION_H
#define GUI_ANIMATION_ANIMATION_H

#include "gui/animation/Interpolator.h"

namespace GUI {

class Drawable;

class Animation {
public:
	Animation();
	virtual ~Animation() = 0;

	virtual void update(Drawable *drawable, long currentTime);

	/**
	 * Set start time in millis
	 */
	virtual void start(long currentTime);

	/**
	 * Set duration in millis
	 */
	virtual void setDuration(long duration);

	virtual bool isFinished() const;

	bool isFinishOnEnd() const;

	void setFinishOnEnd(bool finishOnEnd);

	InterpolatorPtr getInterpolator() const;
	void setInterpolator(InterpolatorPtr interpolator);

protected:
	void finishAnimation();

	virtual void updateInternal(Drawable *drawable, float interpolation);

	long _startTime;
	long _duration;
	bool _finished;
	bool _finishOnEnd;
	InterpolatorPtr _interpolator;
};

typedef Common::SharedPtr<Animation> AnimationPtr;

} // End of namespace GUI

#endif /* GUI_ANIMATION_ANIMATION_H */