blob: 35df71158382c9dd8c8bfddfedbb922695af4512 (
plain) (
blame)
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
125
126
127
128
129
130
|
/*
* The Mana Client
* Copyright (C) 2010-2012 The Mana Developers
*
* This file is part of The Mana Client.
*
* 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
* 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, see <http://www.gnu.org/licenses/>.
*/
#ifndef SPRITE_H
#define SPRITE_H
#include "resources/spritedef.h"
class Graphics;
class Image;
// Default frame display delay in milliseconds
const int DEFAULT_FRAME_DELAY = 75;
class Sprite
{
public:
virtual ~Sprite() {}
/**
* Resets the sprite.
*
* @returns true if the sprite changed, false otherwise
*/
virtual bool reset() = 0;
/**
* Plays an action using the current direction.
*
* @returns true if the sprite changed, false otherwise
*/
virtual bool play(std::string action) = 0;
/**
* Inform the animation of the passed time so that it can output the
* correct animation frame.
*
* @returns true if the sprite changed, false otherwise
*/
virtual bool update(int time) = 0;
/**
* Draw the current animation frame at the coordinates given in screen
* pixels.
*/
virtual bool draw(Graphics* graphics, int posX, int posY) const = 0;
/**
* Gets the width in pixels of the image
*/
virtual int getWidth() const = 0;
/**
* Gets the height in pixels of the image
*/
virtual int getHeight() const = 0;
/**
* Gets the horizontal offset that the sprite will be drawn at
*/
virtual int getOffsetX() const
{ return 0; }
/**
* Gets the vertical offset that the sprite will be drawn at
*/
virtual int getOffsetY() const
{ return 0; }
/**
* Returns a reference to the current image being drawn.
*/
virtual const Image* getImage() const = 0;
/**
* Sets the direction.
*
* @returns true if the sprite changed, false otherwise
*/
virtual bool setDirection(SpriteDirection direction) = 0;
/**
* Sets the alpha value of the animated sprite
*/
virtual void setAlpha(float alpha)
{ mAlpha = alpha; }
/**
* Returns the current alpha opacity of the animated sprite.
*/
virtual float getAlpha() const
{ return mAlpha; }
/**
* Returns the current frame number for the sprite.
*/
virtual size_t getCurrentFrame() const = 0;
/**
* Returns the frame count for the sprite.
*/
virtual size_t getFrameCount() const = 0;
/**
* Returns the duration of the current sprite animation in milliseconds.
*/
virtual int getDuration() const = 0;
protected:
float mAlpha; /**< The alpha opacity used to draw */
};
#endif // SPRITE_H
|
