blob: b82bf7bbf7fd813236b5fa82d00998df5f24c00d (
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*
* 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/>.
*/
#pragma once
#include "resources/spritedef.h"
class Animation;
class Graphics;
class Image;
struct Frame;
// Default frame display delay in milliseconds
const int DEFAULT_FRAME_DELAY = 75;
/**
* Animates a sprite by adding playback state.
*/
class Sprite
{
public:
/**
* Constructor.
* @param sprite the sprite to animate
*/
Sprite(SpriteDef *sprite);
/**
* An helper function, which will request the sprite to animate
* from the resource manager.
*
* @param filename the file of the sprite to animate
* @param variant the sprite variant
*/
static Sprite *load(const std::string &filename, int variant = 0);
~Sprite();
/**
* Resets the sprite.
*
* @returns true if the sprite changed, false otherwise
*/
bool reset();
/**
* Plays an action using the current direction.
*
* @returns true if the sprite changed, false otherwise
*/
bool play(const std::string &action);
/**
* Inform the animation of the passed time so that it can output the
* correct animation frame.
*
* @returns true if the sprite changed, false otherwise
*/
bool update(int time);
/**
* Draw the current animation frame at the coordinates given in screen
* pixels.
*/
bool draw(Graphics *graphics, int posX, int posY) const;
/**
* Gets the width in pixels of the image
*/
int getWidth() const;
/**
* Gets the height in pixels of the image
*/
int getHeight() const;
/**
* Gets the horizontal offset that the sprite will be drawn at
*/
int getOffsetX() const;
/**
* Gets the vertical offset that the sprite will be drawn at
*/
int getOffsetY() const;
/**
* Returns a reference to the current image being drawn.
*/
const Image *getImage() const;
/**
* Sets the direction.
*
* @returns true if the sprite changed, false otherwise
*/
bool setDirection(SpriteDirection direction);
/**
* Sets the alpha value of the sprite.
*/
void setAlpha(float alpha) { mAlpha = alpha; }
/**
* Returns the current alpha opacity of the sprite.
*/
float getAlpha() const { return mAlpha; }
/**
* Returns the duration of the current sprite animation in milliseconds.
*/
int getDuration() const;
private:
bool updateCurrentAnimation(int dt);
float mAlpha = 1.0f; /**< The alpha opacity used to draw */
SpriteDirection mDirection = DIRECTION_DOWN; /**< The sprite direction. */
int mFrameIndex = 0; /**< The index of the current frame. */
int mFrameTime = 0; /**< The time since start of frame. */
ResourceRef<SpriteDef> mSprite; /**< The sprite definition. */
Action *mAction = nullptr; /**< The currently active action. */
Animation *mAnimation = nullptr; /**< The currently active animation. */
Frame *mFrame = nullptr; /**< The currently active frame. */
};
|
