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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*
* The ManaPlus Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2020 The ManaPlus Developers
* Copyright (C) 2020-2023 The ManaVerse Developers
*
* This file is part of The ManaPlus 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 RESOURCES_SPRITE_ANIMATEDSPRITE_H
#define RESOURCES_SPRITE_ANIMATEDSPRITE_H
#include "resources/sprite/sprite.h"
class Animation;
class AnimationDelayLoad;
struct Frame;
/**
* Animates a sprite by adding playback state.
*/
class AnimatedSprite final : public Sprite
{
public:
/**
* Constructor.
* @param sprite the sprite to animate
*/
explicit AnimatedSprite(SpriteDef *restrict const sprite);
A_DELETE_COPY(AnimatedSprite)
/**
* 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 AnimatedSprite *load(const std::string &restrict filename,
const int variant) A_WARN_UNUSED;
static AnimatedSprite *delayedLoad(const std::string &restrict
filename,
const int variant) A_WARN_UNUSED;
static AnimatedSprite *clone(const AnimatedSprite *restrict const
anim);
~AnimatedSprite() override final;
bool reset() restrict2 override final;
bool play(const std::string &restrict spriteAction)
restrict2 override final;
bool update(const int time) restrict2 override final;
void draw(Graphics *restrict const graphics,
const int posX,
const int posY) const restrict2 override final A_NONNULL(2);
void drawRescaled(Graphics *restrict const graphics,
const int posX,
const int posY,
const int dx,
const int dy) const restrict2 A_NONNULL(2);
void drawRaw(Graphics *restrict const graphics,
const int posX,
const int posY) const restrict2 A_NONNULL(2);
int getWidth() const restrict2 override final A_WARN_UNUSED;
int getHeight() const restrict2 override final A_WARN_UNUSED;
const Image* getImage() const restrict2 noexcept2 override final
A_WARN_UNUSED;
bool setSpriteDirection(const SpriteDirection::Type direction)
restrict2 override final;
int getNumberOfLayers() const restrict2 noexcept2 A_WARN_UNUSED
{ return 1; }
std::string getIdPath() const restrict2 A_WARN_UNUSED;
unsigned int getCurrentFrame() const restrict2 noexcept2 override final
A_WARN_UNUSED
{ return mFrameIndex; }
unsigned int getFrameCount() const
restrict2 override final A_WARN_UNUSED;
void setAlpha(float alpha) restrict2 override final;
const void *getHash() const restrict2 override final A_WARN_UNUSED;
bool updateNumber(const unsigned num) restrict2 override final;
void clearDelayLoad() restrict2 noexcept2
{ mDelayLoad = nullptr; }
void setSprite(SpriteDef *restrict const sprite) restrict2 noexcept2
{ mSprite = sprite; }
bool isTerminated() const restrict2 noexcept2
{ return mTerminated; }
constexpr2 static void setEnableCache(const bool b) noexcept2
{ mEnableCache = b; }
void setLastTime(const int time) noexcept2
{ mLastTime = time; }
#ifdef UNITTESTS
SpriteDef *getSprite() restrict2
{ return mSprite; }
const Frame *getFrame() const restrict2
{ return mFrame; }
const Animation *getAnimation() const restrict2
{ return mAnimation; }
unsigned int getFrameIndex() const restrict2
{ return mFrameIndex; }
unsigned int getFrameTime() const restrict2
{ return mFrameTime; }
#endif // UNITTESTS
#ifdef DEBUG_ANIMATIONS
void setSpriteName(const std::string &restrict name) noexcept2
{ mSpriteName = name; }
std::string getSpriteName() const noexcept2 A_WARN_UNUSED
{ return mSpriteName; }
#endif // DEBUG_ANIMATIONS
private:
bool updateCurrentAnimation(const unsigned int dt) restrict2;
void setDelayLoad(const std::string &restrict filename,
const int variant) restrict2;
#ifdef DEBUG_ANIMATIONS
std::string mSpriteName;
#endif // DEBUG_ANIMATIONS
SpriteDirection::Type mDirection; /**< The sprite direction. */
int mLastTime; /**< The last time update was called. */
unsigned int mFrameIndex; /**< The index of the current frame. */
unsigned int mFrameTime; /**< The time since start of frame. */
/**< The sprite definition. */
SpriteDef *restrict mSprite;
/**< The currently active action. */
const Action *restrict mAction;
/**< The currently active animation. */
const Animation *restrict mAnimation;
/**< The currently active frame. */
const Frame *restrict mFrame;
unsigned mNumber;
unsigned mNumber1;
AnimationDelayLoad *mDelayLoad;
bool mTerminated;
static bool mEnableCache;
};
#endif // RESOURCES_SPRITE_ANIMATEDSPRITE_H
|
