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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/*
* The ManaPlus Client
* Copyright (C) 2008 Douglas Boffey <dougaboffey@netscape.net>
* Copyright (C) 2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2015 The ManaPlus 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 GUI_USERPALETTE_H
#define GUI_USERPALETTE_H
#include "enums/gui/usercolorid.h"
#include "gui/palette.h"
#include "gui/models/listmodel.h"
/**
* Class controlling the game's color palette.
*/
class UserPalette final : public Palette, public ListModel
{
public:
/**
* Constructor
*/
UserPalette();
A_DELETE_COPY(UserPalette)
/**
* Destructor
*/
~UserPalette();
/**
* Gets the committed color associated with the specified type.
*
* @param type the color type requested
*
* @return the requested committed color
*/
inline const Color &getCommittedColor(const UserColorIdT type)
const A_WARN_UNUSED
{
return mColors[static_cast<size_t>(type)].committedColor;
}
/**
* Gets the test color associated with the specified type.
*
* @param type the color type requested
*
* @return the requested test color
*/
inline const Color &getTestColor(const UserColorIdT type)
const A_WARN_UNUSED
{ return mColors[static_cast<size_t>(type)].testColor; }
/**
* Sets the test color associated with the specified type.
*
* @param type the color type requested
* @param color the color that should be tested
*/
inline void setTestColor(const UserColorIdT type,
const Color &color)
{ mColors[static_cast<size_t>(type)].testColor = color; }
/**
* Sets the color for the specified type.
*
* @param type color to be set
* @param r red component
* @param g green component
* @param b blue component
*/
void setColor(const UserColorIdT type,
const int r,
const int g,
const int b);
/**
* Sets the gradient type for the specified color.
*
* @param grad gradient type to set
*/
void setGradient(const UserColorIdT type,
const GradientTypeT grad);
/**
* Sets the gradient delay for the specified color.
*
* @param grad gradient type to set
*/
void setGradientDelay(const UserColorIdT type,
const int delay)
{ mColors[static_cast<size_t>(type)].delay = delay; }
/**
* Returns the number of colors known.
*
* @return the number of colors known
*/
inline int getNumberOfElements() override final A_WARN_UNUSED
{ return static_cast<int>(mColors.size()); }
/**
* Returns the name of the ith color.
*
* @param i index of color interested in
*
* @return the name of the color
*/
std::string getElementAt(int i) override final A_WARN_UNUSED;
/**
* Commit the colors
*/
inline void commit()
{ commit(false); }
/**
* Rollback the colors
*/
void rollback();
/**
* Gets the ColorType used by the color for the element at index i in
* the current color model.
*
* @param i the index of the color
*
* @return the color type of the color with the given index
*/
int getColorTypeAt(const int i) A_WARN_UNUSED;
/**
* Gets the color associated with the type. Sets the alpha channel
* before returning.
*
* @param type the color type requested
* @param alpha alpha channel to use
*
* @return the requested color
*/
inline const Color &getColor(UserColorIdT type,
const int alpha = 255) A_WARN_UNUSED
{
if (static_cast<size_t>(type) >= mColors.size())
{
logger->log("incorrect color request type: %d from %u",
static_cast<int>(type),
static_cast<unsigned int>(mColors.size()));
type = UserColorId::BEING;
}
Color* col = &mColors[static_cast<size_t>(type)].color;
col->a = alpha;
return *col;
}
int getIdByChar(const signed char c, bool &valid) const A_WARN_UNUSED;
/**
* Gets the GradientType associated with the specified type.
*
* @param type the color type of the color
*
* @return the gradient type of the color with the given index
*/
inline GradientTypeT getGradientType(const UserColorIdT type)
const A_WARN_UNUSED
{ return mColors[static_cast<size_t>(type)].grad; }
/**
* Gets the gradient delay for the specified type.
*
* @param type the color type of the color
*
* @return the gradient delay of the color with the given index
*/
inline int getGradientDelay(const UserColorIdT type)
const A_WARN_UNUSED
{ return mColors[static_cast<size_t>(type)].delay; }
inline const Color &getColorWithAlpha(const UserColorIdT type)
A_WARN_UNUSED
{
Color *const col = &mColors[static_cast<size_t>(type)].color;
col->a = mColors[static_cast<size_t>(type)].delay;
return *col;
}
private:
/**
* Define a color replacement.
*
* @param i the index of the color to replace
* @param r red component
* @param g green component
* @param b blue component
*/
void setColorAt(int i, int r, int g, int b);
/**
* Commit the colors. Commit the non-static color values, if
* commitNonStatic is true. Only needed in the constructor.
*/
void commit(const bool commitNonStatic);
/**
* Prefixes the given string with "Color", lowercases all letters but
* the first and all following a '_'. All '_'s will be removed.
*
* E.g.: HIT_PLAYER_MONSTER -> HitPlayerMonster
*
* @param typeName string to transform
*
* @return the transformed string
*/
static std::string getConfigName(const std::string &typeName)
A_WARN_UNUSED;
/**
* Initialise color
*
* @param c character that needs initialising
* @param rgb default color if not found in config
* @param text identifier of color
*/
void addColor(const UserColorIdT type,
const unsigned rgb,
GradientTypeT grad,
const std::string &text,
int delay = GRADIENT_DELAY);
};
extern UserPalette *userPalette;
#endif // GUI_USERPALETTE_H
|
