blob: 50bd5915b90f433befa3eb1007a54925feb808f6 (
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
|
/*
* The ManaVerse Client
* Copyright (C) 2010 The Mana Developers
* Copyright (C) 2011-2019 The ManaPlus Developers
*
* This file is part of The ManaVerse 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_SPRITE_H
#define RESOURCES_SPRITE_SPRITE_H
#include "resources/sprite/spritedef.h"
#include "localconsts.h"
class Graphics;
class Image;
class Sprite notfinal
{
public:
A_DELETE_COPY(Sprite)
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(const 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(const int time) = 0;
/**
* Draw the current animation frame at the coordinates given in screen
* pixels.
*/
virtual void draw(Graphics *const graphics,
const int posX, const int posY)
const A_NONNULL(2) = 0;
/**
* Gets the width in pixels of the image of the current frame
*/
virtual int getWidth() const A_WARN_UNUSED = 0;
/**
* Gets the height in pixels of the image of the current frame
*/
virtual int getHeight() const A_WARN_UNUSED = 0;
/**
* Returns a reference to the current image being drawn.
*/
virtual const Image* getImage() const A_WARN_UNUSED = 0;
/**
* Sets the direction.
*
* @returns true if the sprite changed, false otherwise
*/
virtual bool setSpriteDirection(const SpriteDirection::Type
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 A_WARN_UNUSED
{ return mAlpha; }
/**
* Returns the current frame number for the sprite.
*/
virtual unsigned int getCurrentFrame() const A_WARN_UNUSED = 0;
/**
* Returns the frame count for the sprite.
*/
virtual unsigned int getFrameCount() const A_WARN_UNUSED = 0;
virtual const void *getHash() const A_WARN_UNUSED
{ return nullptr; }
virtual const void *getHash2() const A_WARN_UNUSED
{ return this; }
virtual bool updateNumber(const unsigned num) = 0;
protected:
Sprite() :
mAlpha()
{
}
float mAlpha; /**< The alpha opacity used to draw */
};
#endif // RESOURCES_SPRITE_SPRITE_H
|
