blob: fbce6ec59cbc8d63f80610810d5d636305d19524 (
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
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
|
/*
* 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/Sound.h
*/
#ifndef SIGMOD_SOUND
#define SIGMOD_SOUND
// Sigmod includes
#include "Object.h"
// Qt includes
#include <QtCore/QByteArray>
#include <QtCore/QMetaType>
#include <QtCore/QString>
namespace Sigmod
{
// Forward declarations
class Game;
/**
* \class Sigmod::Sound Sound.h sigmod/Sound.h
* \brief Class describing a sound.
*
* Any sound in the sigmod must be declared as an instance of this class.
* Sounds can be effects (can make as many as desired, but stop once done
* playing) or music (can only have one instance and loops by default).
*/
class SIGMOD_EXPORT Sound : public Object
{
Q_OBJECT
Q_ENUMS(Type)
public:
/**
* \enum Type
* \brief The type of the sound stored.
*/
enum Type
{
SoundEffect = 0,
Music = 1
};
/**
* \var TypeStr
* String values for the types of sound.
*/
static const QStringList TypeStr;
/**
* Copy constructor.
*
* \param sound The sound to copy.
*/
Sound(const Sound& sound);
/**
* Create a new sound belonging to \p parent and id \p id.
*
* \param parent The parent of the sound.
* \param id The id number for the sound.
*/
Sound(const Game* parent, const int id);
/**
* Data copy constructor. Copies the data from \p sound as a child of \p parent with id \p id.
*
* \param sound The sound to copy the data from.
* \param parent The parent of the sound.
* \param id The id number for the sound.
*/
Sound(const Sound& sound, 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 sound.
* \param id The id number for the sound.
*/
Sound(const QDomElement& xml, const Game* parent, const int id = -1);
/**
* Check to make sure the sound'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 sound in XML format.
*
* \return The XML structure representing the sound.
*/
QDomElement save() const;
/**
* Sets the name of the sound. This is only used internally.
*
* \param name The name of the sound.
*/
void setName(const QString& name);
/**
* Sets the type of the sound.
*
* \param type The type of the sound.
*/
void setType(const Type type);
/**
* Sets the data for the sound. Any formats supported by \link http://phonon.kde.org/ Phonon \endlink
* are supported here.
*
* \param data The data for the sound.
*/
void setData(const QByteArray& data);
/**
* \sa setName
*
* \return The name of the sound.
*/
QString name() const;
/**
* \sa setType
*
* \return The type of sound.
*/
Type type() const;
/**
* \sa setData
*
* \return The data for the sound.
*/
QByteArray data() const;
bool nameCheck(const QString& name) const;
bool typeCheck(const Type type) const;
bool dataCheck(const QByteArray& data) const;
Sound& operator=(const Sound& rhs);
private:
QString m_name;
Type m_type;
QByteArray m_data;
};
}
Q_DECLARE_METATYPE(Sigmod::Sound::Type)
#endif
|
