blob: 847c01a650a140c289b6d3f867a7c867be72f1e4 (
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
|
/*
* The Mana Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 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
class Graphics;
/**
* A sprite is some visible object on a map. This abstract class defines the
* interface used by the map to sort and display the sprite.
*/
class Sprite
{
public:
/**
* Destructor.
*/
virtual
~Sprite() {}
/**
* Draws the sprite to the given graphics context.
*
* Note: this function could be simplified if the graphics context
* would support setting a translation offset. It already does this
* partly with the clipping rectangle support.
*/
virtual void draw(Graphics *graphics, int offsetX, int offsetY) const = 0;
/**
* Returns the horizontal size of the sprites graphical representation
* in pixels or 0 when it is undefined.
*/
virtual int getWidth() const
{ return 0; }
/**
* Returns the vertical size of the sprites graphical representation
* in pixels or 0 when it is undefined.
*/
virtual int getHeight() const
{ return 0; }
/**
* Returns the pixel Y coordinate of the sprite.
*/
virtual int getPixelY() const = 0;
/**
* Returns the number of Image layers used to draw the sprite.
*/
virtual int getNumberOfLayers() const
{ return 0; }
/**
* Returns the current alpha value used to draw the sprite.
*/
virtual float getAlpha() const = 0;
/**
* Sets the alpha value used to draw the sprite.
*/
virtual void setAlpha(float alpha) = 0;
};
#endif
|