1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/* 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.
*
*/
#ifndef GOB_ANIOBJECT_H
#define GOB_ANIOBJECT_H
#include "common/system.h"
namespace Gob {
class ANIFile;
class Surface;
/** An ANI object, controlling an animation within an ANI file. */
class ANIObject {
public:
enum Mode {
kModeContinuous, ///< Play the animation continuously.
kModeOnce ///< Play the animation only once.
};
ANIObject(const ANIFile &ani);
virtual ~ANIObject();
/** Make the object visible/invisible. */
void setVisible(bool visible);
/** Is the object currently visible? */
bool isVisible() const;
/** Pause/Unpause the animation. */
void setPause(bool pause);
/** Is the animation currently paused? */
bool isPaused() const;
/** Set the animation mode. */
void setMode(Mode mode);
/** Set the current position to the animation's default. */
void setPosition();
/** Set the current position. */
void setPosition(int16 x, int16 y);
/** Return the current position. */
void getPosition(int16 &x, int16 &y) const;
/** Return the current frame position. */
void getFramePosition(int16 &x, int16 &y) const;
/** Return the current frame size. */
void getFrameSize(int16 &width, int16 &height) const;
/** Are there coordinates within the animation sprite? */
bool isIn(int16 x, int16 y) const;
/** Is this object within the animation sprite? */
bool isIn(const ANIObject &obj) const;
/** Set the animation number. */
void setAnimation(uint16 animation);
/** Rewind the current animation to the first frame. */
void rewind();
/** Return the current animation number. */
uint16 getAnimation() const;
/** Return the current frame number. */
uint16 getFrame() const;
/** Is this the last frame within this animation cycle? */
bool lastFrame() const;
/** Draw the current frame onto the surface and return the affected rectangle. */
void draw(Surface &dest, int16 &left, int16 &top, int16 &right, int16 &bottom);
/** Draw the current frame from the surface and return the affected rectangle. */
void clear(Surface &dest, int16 &left , int16 &top, int16 &right, int16 &bottom);
/** Advance the animation to the next frame. */
virtual void advance();
private:
const ANIFile *_ani; ///< The managed ANI file.
uint16 _animation; ///< The current animation number
uint16 _frame; ///< The current frame.
bool _visible; ///< Is the object currently visible?
bool _paused; ///< Is the animation currently paused?
Mode _mode; ///< The animation mode.
int16 _x; ///< The current X position.
int16 _y; ///< The current Y position.
Surface *_background; ///< The saved background.
bool _drawn; ///< Was the animation drawn?
int16 _backgroundLeft; ///< The left position of the saved background.
int16 _backgroundTop; ///< The top of the saved background.
int16 _backgroundRight; ///< The right position of the saved background.
int16 _backgroundBottom; ///< The bottom position of the saved background.
};
} // End of namespace Gob
#endif // GOB_ANIOBJECT_H
|
