blob: 98d148b704be9907cb25b2a4f5bd218e648a22bb (
plain)
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
|
/*
* Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com>
*
* 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 3 of the License, or
* (at your option) 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/>.
*/
/**
* \file sigmod/Sprite.h
*/
#ifndef SIGMOD_SPRITE
#define SIGMOD_SPRITE
// Sigmod includes
#include "Object.h"
// Qt includes
#include <QtCore/QByteArray>
namespace Sigmod
{
// Forward declarations
class Game;
/**
* \class Sigmod::Sprite Sprite.h sigmod/Sprite.h
* \brief Class for holding an image.
*
* This class is used to hold an image and give it a name for easy reference.
*/
class SIGMOD_EXPORT Sprite : public Object
{
Q_OBJECT
public:
/**
* Copy constructor.
*
* \param sprite The sprite to copy.
*/
Sprite(const Sprite& sprite);
/**
* Create a new sprite belonging to \p parent and id \p id.
*
* \param parent The parent of the sprite.
* \param id The id number for the sprite.
*/
Sprite(const Game* parent, const int id);
/**
* Data copy constructor. Copies the data from \p sprite as a child of \p parent with id \p id.
*
* \param sprite The sprite to copy the data from.
* \param parent The parent of the sprite.
* \param id The id number for the sprite.
*/
Sprite(const Sprite& sprite, const Game* parent, const int id);
/**
* XML data constructor.
*
* \param xml The XML structure to extract the data from.
* \param parent The parent of the sprite.
* \param id The id number for the sprite.
*/
Sprite(const QDomElement& xml, const Game* parent, const int id = -1);
/**
* Check to make sure the sprite's values are valid.
*/
void validate();
/**
* Load data from XML.
*
* \param xml The XML structure to extract data from.
*/
void load(const QDomElement& xml);
/**
* Get the data for the ability in XML format.
*
* \return The XML structure representing the sprite.
*/
QDomElement save() const;
/**
* Sets the name of the sprite. This is only used internally.
*
* \param name The name of the sprite.
*/
void setName(const QString& name);
/**
* Sets the data for the sprite. When stored, it will be base64 encoded to ensure that no
* non-printable characters appear in the sigmod file.
*
* \param sprite The data for the sprite.
*/
void setSprite(const QByteArray& sprite);
/**
* \sa setName
*
* \return The name of the skin.
*/
QString name() const;
/**
* \sa setSprite
*
* \return The data for the sprite.
*/
QByteArray sprite() const;
bool nameCheck(const QString& name) const;
bool spriteCheck(const QByteArray& sprite) const;
Sprite& operator=(const Sprite& rhs);
private:
QString m_name;
QByteArray m_sprite;
};
}
#endif
|
