1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  */
22 
23 // Based on code by omergilad.
24 
25 #ifndef GUI_ANIMATION_ANIMATION_H
26 #define GUI_ANIMATION_ANIMATION_H
27 
28 #include "gui/animation/Interpolator.h"
29 
30 namespace GUI {
31 
32 class Drawable;
33 
34 class Animation {
35 public:
36 	Animation();
37 	virtual ~Animation() = 0;
38 
39 	virtual void update(Drawable *drawable, long currentTime);
40 
41 	/**
42 	 * Set start time in millis
43 	 */
44 	virtual void start(long currentTime);
45 
46 	/**
47 	 * Set duration in millis
48 	 */
49 	virtual void setDuration(long duration);
50 
51 	virtual bool isFinished() const;
52 
53 	bool isFinishOnEnd() const;
54 
55 	void setFinishOnEnd(bool finishOnEnd);
56 
57 	InterpolatorPtr getInterpolator() const;
58 	void setInterpolator(InterpolatorPtr interpolator);
59 
60 protected:
61 	void finishAnimation();
62 
63 	virtual void updateInternal(Drawable *drawable, float interpolation);
64 
65 	long _startTime;
66 	long _duration;
67 	bool _finished;
68 	bool _finishOnEnd;
69 	InterpolatorPtr _interpolator;
70 };
71 
72 typedef Common::SharedPtr<Animation> AnimationPtr;
73 
74 } // End of namespace GUI
75 
76 #endif /* GUI_ANIMATION_ANIMATION_H */
77