OpenTTD Source: src/smallmap_gui.cpp Source File

OpenTTD Source 1.11.0-RC1

smallmap_gui.cpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD 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, version 2.
4 * OpenTTD 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.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #include "stdafx.h"
11 #include "clear_map.h"
12 #include "industry.h"
13 #include "station_map.h"
14 #include "landscape.h"
15 #include "tree_map.h"
16 #include "viewport_func.h"
17 #include "town.h"
18 #include "tunnelbridge_map.h"
19 #include "core/endian_func.hpp"
20 #include "vehicle_base.h"
21 #include "sound_func.h"
22 #include "window_func.h"
23 #include "company_base.h"
24 #include "guitimer_func.h"
25
26 #include "smallmap_gui.h"
27
28 #include "table/strings.h"
29
30 #include <bitset>
31
32 #include "safeguards.h"
33
34 static int _smallmap_industry_count;
35 static int _smallmap_company_count;
36 static int _smallmap_cargo_count;
37
39 static uint8 _linkstat_colours_in_legenda[] = {0, 1, 3, 5, 7, 9, 11};
40
41 static const int NUM_NO_COMPANY_ENTRIES = 4;
42
44 #define MK(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, false}
45
47 #define MC(col_break) {0, STR_TINY_BLACK_HEIGHT, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, col_break}
48
50 #define MO(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, false}
51
53 #define MOEND() {0, 0, INVALID_INDUSTRYTYPE, 0, OWNER_NONE, true, true, false}
54
56 #define MKEND() {0, STR_NULL, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, true, false}
57
62 #define MS(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, true}
63
65 static LegendAndColour _legend_land_contours[] = {
66 MK(PC_BLACK, STR_SMALLMAP_LEGENDA_ROADS),
67 MK(PC_GREY, STR_SMALLMAP_LEGENDA_RAILROADS),
68 MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_STATIONS_AIRPORTS_DOCKS),
69 MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
70 MK(PC_WHITE, STR_SMALLMAP_LEGENDA_VEHICLES),
71
72 /* Placeholders for the colours and heights of the legend.
73 * The following values are set at BuildLandLegend() based
74 * on each colour scheme and the maximum map height. */
75 MC(true),
76 MC(false),
77 MC(false),
78 MC(false),
79 MC(false),
80 MC(false),
81 MC(true),
82 MC(false),
83 MC(false),
84 MC(false),
85 MC(false),
86 MC(false),
87 MKEND()
88 };
89
90 static const LegendAndColour _legend_vehicles[] = {
91 MK(PC_RED, STR_SMALLMAP_LEGENDA_TRAINS),
92 MK(PC_YELLOW, STR_SMALLMAP_LEGENDA_ROAD_VEHICLES),
93 MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_SHIPS),
94 MK(PC_WHITE, STR_SMALLMAP_LEGENDA_AIRCRAFT),
95
96 MS(PC_BLACK, STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES),
97 MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
98 MKEND()
99 };
100
101 static const LegendAndColour _legend_routes[] = {
102 MK(PC_BLACK, STR_SMALLMAP_LEGENDA_ROADS),
103 MK(PC_GREY, STR_SMALLMAP_LEGENDA_RAILROADS),
104 MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
105
106 MS(PC_VERY_DARK_BROWN, STR_SMALLMAP_LEGENDA_RAILROAD_STATION),
107 MK(PC_ORANGE, STR_SMALLMAP_LEGENDA_TRUCK_LOADING_BAY),
108 MK(PC_YELLOW, STR_SMALLMAP_LEGENDA_BUS_STATION),
109 MK(PC_RED, STR_SMALLMAP_LEGENDA_AIRPORT_HELIPORT),
110 MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_DOCK),
111 MKEND()
112 };
113
114 static const LegendAndColour _legend_vegetation[] = {
115 MK(PC_ROUGH_LAND, STR_SMALLMAP_LEGENDA_ROUGH_LAND),
116 MK(PC_GRASS_LAND, STR_SMALLMAP_LEGENDA_GRASS_LAND),
117 MK(PC_BARE_LAND, STR_SMALLMAP_LEGENDA_BARE_LAND),
118 MK(PC_RAINFOREST, STR_SMALLMAP_LEGENDA_RAINFOREST),
119 MK(PC_FIELDS, STR_SMALLMAP_LEGENDA_FIELDS),
120 MK(PC_TREES, STR_SMALLMAP_LEGENDA_TREES),
121
122 MS(PC_GREEN, STR_SMALLMAP_LEGENDA_FOREST),
123 MK(PC_GREY, STR_SMALLMAP_LEGENDA_ROCKS),
124 MK(PC_ORANGE, STR_SMALLMAP_LEGENDA_DESERT),
125 MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_SNOW),
126 MK(PC_BLACK, STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES),
127 MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
128 MKEND()
129 };
130
131 static LegendAndColour _legend_land_owners[NUM_NO_COMPANY_ENTRIES + MAX_COMPANIES + 1] = {
132 MO(PC_WATER, STR_SMALLMAP_LEGENDA_WATER),
133 MO(0x00, STR_SMALLMAP_LEGENDA_NO_OWNER), // This colour will vary depending on settings.
134 MO(PC_DARK_RED, STR_SMALLMAP_LEGENDA_TOWNS),
135 MO(PC_DARK_GREY, STR_SMALLMAP_LEGENDA_INDUSTRIES),
136 /* The legend will be terminated the first time it is used. */
137 MOEND(),
138 };
139
140 #undef MK
141 #undef MC
142 #undef MS
143 #undef MO
144 #undef MOEND
145 #undef MKEND
146
148 static LegendAndColour _legend_linkstats[NUM_CARGO + lengthof(_linkstat_colours_in_legenda) + 1];
153 static LegendAndColour _legend_from_industries[NUM_INDUSTRYTYPES + 1];
155 static uint _industry_to_list_pos[NUM_INDUSTRYTYPES];
157 static bool _smallmap_show_heightmap = false;
159 static IndustryType _smallmap_industry_highlight = INVALID_INDUSTRYTYPE;
161 static bool _smallmap_industry_highlight_state;
163 static uint _company_to_list_pos[MAX_COMPANIES];
164
168 void BuildIndustriesLegend()
169 {
170 uint j = 0;
171
172 /* Add each name */
173 for (IndustryType ind : _sorted_industry_types) {
174 const IndustrySpec *indsp = GetIndustrySpec(ind);
175 if (indsp->enabled) {
176 _legend_from_industries[j].legend = indsp->name;
177 _legend_from_industries[j].colour = indsp->map_colour;
178 _legend_from_industries[j].type = ind;
179 _legend_from_industries[j].show_on_map = true;
180 _legend_from_industries[j].col_break = false;
181 _legend_from_industries[j].end = false;
182
183 /* Store widget number for this industry type. */
184 _industry_to_list_pos[ind] = j;
185 j++;
186 }
187 }
188 /* Terminate the list */
189 _legend_from_industries[j].end = true;
190
191 /* Store number of enabled industries */
192 _smallmap_industry_count = j;
193 }
194
198 void BuildLinkStatsLegend()
199 {
200 /* Clear the legend */
201 memset(_legend_linkstats, 0, sizeof(_legend_linkstats));
202
203 uint i = 0;
204 for (; i < _sorted_cargo_specs.size(); ++i) {
205 const CargoSpec *cs = _sorted_cargo_specs[i];
206
207 _legend_linkstats[i].legend = cs->name;
208 _legend_linkstats[i].colour = cs->legend_colour;
209 _legend_linkstats[i].type = cs->Index();
210 _legend_linkstats[i].show_on_map = true;
211 }
212
213 _legend_linkstats[i].col_break = true;
214 _smallmap_cargo_count = i;
215
216 for (; i < _smallmap_cargo_count + lengthof(_linkstat_colours_in_legenda); ++i) {
217 _legend_linkstats[i].legend = STR_EMPTY;
218 _legend_linkstats[i].colour = LinkGraphOverlay::LINK_COLOURS[_linkstat_colours_in_legenda[i - _smallmap_cargo_count]];
219 _legend_linkstats[i].show_on_map = true;
220 }
221
222 _legend_linkstats[_smallmap_cargo_count].legend = STR_LINKGRAPH_LEGEND_UNUSED;
223 _legend_linkstats[i - 1].legend = STR_LINKGRAPH_LEGEND_OVERLOADED;
224 _legend_linkstats[(_smallmap_cargo_count + i - 1) / 2].legend = STR_LINKGRAPH_LEGEND_SATURATED;
225 _legend_linkstats[i].end = true;
226 }
227
228 static const LegendAndColour * const _legend_table[] = {
229 _legend_land_contours,
230 _legend_vehicles,
231 _legend_from_industries,
232 _legend_linkstats,
233 _legend_routes,
234 _legend_vegetation,
235 _legend_land_owners,
236 };
237
238 #define MKCOLOUR(x) TO_LE32X(x)
239
240 #define MKCOLOUR_XXXX(x) (MKCOLOUR(0x01010101) * (uint)(x))
241 #define MKCOLOUR_X0X0(x) (MKCOLOUR(0x01000100) * (uint)(x))
242 #define MKCOLOUR_0X0X(x) (MKCOLOUR(0x00010001) * (uint)(x))
243 #define MKCOLOUR_0XX0(x) (MKCOLOUR(0x00010100) * (uint)(x))
244 #define MKCOLOUR_X00X(x) (MKCOLOUR(0x01000001) * (uint)(x))
245
246 #define MKCOLOUR_XYXY(x, y) (MKCOLOUR_X0X0(x) | MKCOLOUR_0X0X(y))
247 #define MKCOLOUR_XYYX(x, y) (MKCOLOUR_X00X(x) | MKCOLOUR_0XX0(y))
248
249 #define MKCOLOUR_0000 MKCOLOUR_XXXX(0x00)
250 #define MKCOLOUR_0FF0 MKCOLOUR_0XX0(0xFF)
251 #define MKCOLOUR_F00F MKCOLOUR_X00X(0xFF)
252 #define MKCOLOUR_FFFF MKCOLOUR_XXXX(0xFF)
253
254 #include "table/heightmap_colours.h"
255
257 struct SmallMapColourScheme {
258 uint32 *height_colours;
259 const uint32 *height_colours_base;
260 size_t colour_count;
261 uint32 default_colour;
262 };
263
265 static SmallMapColourScheme _heightmap_schemes[] = {
266 {nullptr, _green_map_heights, lengthof(_green_map_heights), MKCOLOUR_XXXX(0x54)},
267 {nullptr, _dark_green_map_heights, lengthof(_dark_green_map_heights), MKCOLOUR_XXXX(0x62)},
268 {nullptr, _violet_map_heights, lengthof(_violet_map_heights), MKCOLOUR_XXXX(0x81)},
269 };
270
274 void BuildLandLegend()
275 {
276 /* The smallmap window has never been initialized, so no need to change the legend. */
277 if (_heightmap_schemes[0].height_colours == nullptr) return;
278
279 /*
280 * The general idea of this function is to fill the legend with an appropriate evenly spaced
281 * selection of height levels. All entries with STR_TINY_BLACK_HEIGHT are reserved for this.
282 * At the moment there are twelve of these.
283 *
284 * The table below defines up to which height level a particular delta in the legend should be
285 * used. One could opt for just dividing the maximum height and use that as delta, but that
286 * creates many "ugly" legend labels, e.g. once every 950 meter. As a result, this table will
287 * reduce the number of deltas to 7: every 100m, 200m, 300m, 500m, 750m, 1000m and 1250m. The
288 * deltas are closer together at the lower numbers because going from 12 entries to just 4, as
289 * would happen when replacing 200m and 300m by 250m, would mean the legend would be short and
290 * that might not be considered appropriate.
291 *
292 * The current method yields at least 7 legend entries and at most 12. It can be increased to
293 * 8 by adding a 150m and 400m option, but especially 150m creates ugly heights.
294 *
295 * It tries to evenly space the legend items over the two columns that are there for the legend.
296 */
297
298 /* Table for delta; if max_height is less than the first column, use the second column as value. */
299 uint deltas[][2] = { { 24, 2 }, { 48, 4 }, { 72, 6 }, { 120, 10 }, { 180, 15 }, { 240, 20 }, { MAX_TILE_HEIGHT + 1, 25 }};
300 uint i = 0;
301 for (; _settings_game.construction.max_heightlevel >= deltas[i][0]; i++) {
302 /* Nothing to do here. */
303 }
304 uint delta = deltas[i][1];
305
306 int total_entries = (_settings_game.construction.max_heightlevel / delta) + 1;
307 int rows = CeilDiv(total_entries, 2);
308 int j = 0;
309
310 for (i = 0; i < lengthof(_legend_land_contours) - 1 && j < total_entries; i++) {
311 if (_legend_land_contours[i].legend != STR_TINY_BLACK_HEIGHT) continue;
312
313 _legend_land_contours[i].col_break = j % rows == 0;
314 _legend_land_contours[i].end = false;
315 _legend_land_contours[i].height = j * delta;
316 _legend_land_contours[i].colour = _heightmap_schemes[_settings_client.gui.smallmap_land_colour].height_colours[j * delta];
317 j++;
318 }
319 _legend_land_contours[i].end = true;
320 }
321
325 void BuildOwnerLegend()
326 {
327 _legend_land_owners[1].colour = _heightmap_schemes[_settings_client.gui.smallmap_land_colour].default_colour;
328
329 int i = NUM_NO_COMPANY_ENTRIES;
330 for (const Company *c : Company::Iterate()) {
331 _legend_land_owners[i].colour = _colour_gradient[c->colour][5];
332 _legend_land_owners[i].company = c->index;
333 _legend_land_owners[i].show_on_map = true;
334 _legend_land_owners[i].col_break = false;
335 _legend_land_owners[i].end = false;
336 _company_to_list_pos[c->index] = i;
337 i++;
338 }
339
340 /* Terminate the list */
341 _legend_land_owners[i].end = true;
342
343 /* Store maximum amount of owner legend entries. */
344 _smallmap_company_count = i;
345 }
346
347 struct AndOr {
348 uint32 mor;
349 uint32 mand;
350 };
351
352 static inline uint32 ApplyMask(uint32 colour, const AndOr *mask)
353 {
354 return (colour & mask->mand) | mask->mor;
355 }
356
357
359 static const AndOr _smallmap_contours_andor[] = {
360 {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_CLEAR
361 {MKCOLOUR_0XX0(PC_GREY ), MKCOLOUR_F00F}, // MP_RAILWAY
362 {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F}, // MP_ROAD
363 {MKCOLOUR_0XX0(PC_DARK_RED ), MKCOLOUR_F00F}, // MP_HOUSE
364 {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_TREES
365 {MKCOLOUR_XXXX(PC_LIGHT_BLUE), MKCOLOUR_0000}, // MP_STATION
366 {MKCOLOUR_XXXX(PC_WATER ), MKCOLOUR_0000}, // MP_WATER
367 {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_VOID
368 {MKCOLOUR_XXXX(PC_DARK_RED ), MKCOLOUR_0000}, // MP_INDUSTRY
369 {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_TUNNELBRIDGE
370 {MKCOLOUR_0XX0(PC_DARK_RED ), MKCOLOUR_F00F}, // MP_OBJECT
371 {MKCOLOUR_0XX0(PC_GREY ), MKCOLOUR_F00F},
372 };
373
375 static const AndOr _smallmap_vehicles_andor[] = {
376 {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_CLEAR
377 {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F}, // MP_RAILWAY
378 {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F}, // MP_ROAD
379 {MKCOLOUR_0XX0(PC_DARK_RED ), MKCOLOUR_F00F}, // MP_HOUSE
380 {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_TREES
381 {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F}, // MP_STATION
382 {MKCOLOUR_XXXX(PC_WATER ), MKCOLOUR_0000}, // MP_WATER
383 {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_VOID
384 {MKCOLOUR_XXXX(PC_DARK_RED ), MKCOLOUR_0000}, // MP_INDUSTRY
385 {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_TUNNELBRIDGE
386 {MKCOLOUR_0XX0(PC_DARK_RED ), MKCOLOUR_F00F}, // MP_OBJECT
387 {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F},
388 };
389
391 static const byte _tiletype_importance[] = {
392 2, // MP_CLEAR
393 8, // MP_RAILWAY
394 7, // MP_ROAD
395 5, // MP_HOUSE
396 2, // MP_TREES
397 9, // MP_STATION
398 2, // MP_WATER
399 1, // MP_VOID
400 6, // MP_INDUSTRY
401 8, // MP_TUNNELBRIDGE
402 2, // MP_OBJECT
403 0,
404 };
405
406
413 static inline uint32 GetSmallMapContoursPixels(TileIndex tile, TileType t)
414 {
415 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
416 return ApplyMask(cs->height_colours[TileHeight(tile)], &_smallmap_contours_andor[t]);
417 }
418
426 static inline uint32 GetSmallMapVehiclesPixels(TileIndex tile, TileType t)
427 {
428 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
429 return ApplyMask(cs->default_colour, &_smallmap_vehicles_andor[t]);
430 }
431
439 static inline uint32 GetSmallMapIndustriesPixels(TileIndex tile, TileType t)
440 {
441 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
442 return ApplyMask(_smallmap_show_heightmap ? cs->height_colours[TileHeight(tile)] : cs->default_colour, &_smallmap_vehicles_andor[t]);
443 }
444
452 static inline uint32 GetSmallMapRoutesPixels(TileIndex tile, TileType t)
453 {
454 switch (t) {
455 case MP_STATION:
456 switch (GetStationType(tile)) {
457 case STATION_RAIL: return MKCOLOUR_XXXX(PC_VERY_DARK_BROWN);
458 case STATION_AIRPORT: return MKCOLOUR_XXXX(PC_RED);
459 case STATION_TRUCK: return MKCOLOUR_XXXX(PC_ORANGE);
460 case STATION_BUS: return MKCOLOUR_XXXX(PC_YELLOW);
461 case STATION_DOCK: return MKCOLOUR_XXXX(PC_LIGHT_BLUE);
462 default: return MKCOLOUR_FFFF;
463 }
464
465 case MP_RAILWAY: {
466 AndOr andor = {
467 MKCOLOUR_0XX0(GetRailTypeInfo(GetRailType(tile))->map_colour),
468 _smallmap_contours_andor[t].mand
469 };
470
471 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
472 return ApplyMask(cs->default_colour, &andor);
473 }
474
475 case MP_ROAD: {
476 const RoadTypeInfo *rti = nullptr;
477 if (GetRoadTypeRoad(tile) != INVALID_ROADTYPE) {
478 rti = GetRoadTypeInfo(GetRoadTypeRoad(tile));
479 } else {
480 rti = GetRoadTypeInfo(GetRoadTypeTram(tile));
481 }
482 if (rti != nullptr) {
483 AndOr andor = {
484 MKCOLOUR_0XX0(rti->map_colour),
485 _smallmap_contours_andor[t].mand
486 };
487
488 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
489 return ApplyMask(cs->default_colour, &andor);
490 }
491 FALLTHROUGH;
492 }
493
494 default:
495 /* Ground colour */
496 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
497 return ApplyMask(cs->default_colour, &_smallmap_contours_andor[t]);
498 }
499 }
500
508 static inline uint32 GetSmallMapLinkStatsPixels(TileIndex tile, TileType t)
509 {
510 return _smallmap_show_heightmap ? GetSmallMapContoursPixels(tile, t) : GetSmallMapRoutesPixels(tile, t);
511 }
512
513 static const uint32 _vegetation_clear_bits[] = {
514 MKCOLOUR_XXXX(PC_GRASS_LAND),
515 MKCOLOUR_XXXX(PC_ROUGH_LAND),
516 MKCOLOUR_XXXX(PC_GREY),
517 MKCOLOUR_XXXX(PC_FIELDS),
518 MKCOLOUR_XXXX(PC_LIGHT_BLUE),
519 MKCOLOUR_XXXX(PC_ORANGE),
520 MKCOLOUR_XXXX(PC_GRASS_LAND),
521 MKCOLOUR_XXXX(PC_GRASS_LAND),
522 };
523
531 static inline uint32 GetSmallMapVegetationPixels(TileIndex tile, TileType t)
532 {
533 switch (t) {
534 case MP_CLEAR:
535 if (IsClearGround(tile, CLEAR_GRASS)) {
536 if (GetClearDensity(tile) < 3) return MKCOLOUR_XXXX(PC_BARE_LAND);
537 if (GetTropicZone(tile) == TROPICZONE_RAINFOREST) return MKCOLOUR_XXXX(PC_RAINFOREST);
538 }
539 return _vegetation_clear_bits[GetClearGround(tile)];
540
541 case MP_INDUSTRY:
542 return IsTileForestIndustry(tile) ? MKCOLOUR_XXXX(PC_GREEN) : MKCOLOUR_XXXX(PC_DARK_RED);
543
544 case MP_TREES:
545 if (GetTreeGround(tile) == TREE_GROUND_SNOW_DESERT || GetTreeGround(tile) == TREE_GROUND_ROUGH_SNOW) {
546 return (_settings_game.game_creation.landscape == LT_ARCTIC) ? MKCOLOUR_XYYX(PC_LIGHT_BLUE, PC_TREES) : MKCOLOUR_XYYX(PC_ORANGE, PC_TREES);
547 }
548 return (GetTropicZone(tile) == TROPICZONE_RAINFOREST) ? MKCOLOUR_XYYX(PC_RAINFOREST, PC_TREES) : MKCOLOUR_XYYX(PC_GRASS_LAND, PC_TREES);
549
550 default:
551 return ApplyMask(MKCOLOUR_XXXX(PC_GRASS_LAND), &_smallmap_vehicles_andor[t]);
552 }
553 }
554
562 static inline uint32 GetSmallMapOwnerPixels(TileIndex tile, TileType t)
563 {
564 Owner o;
565
566 switch (t) {
567 case MP_INDUSTRY: return MKCOLOUR_XXXX(PC_DARK_GREY);
568 case MP_HOUSE: return MKCOLOUR_XXXX(PC_DARK_RED);
569 default: o = GetTileOwner(tile); break;
570 /* FIXME: For MP_ROAD there are multiple owners.
571 * GetTileOwner returns the rail owner (level crossing) resp. the owner of ROADTYPE_ROAD (normal road),
572 * even if there are no ROADTYPE_ROAD bits on the tile.
573 */
574 }
575
576 if ((o < MAX_COMPANIES && !_legend_land_owners[_company_to_list_pos[o]].show_on_map) || o == OWNER_NONE || o == OWNER_WATER) {
577 if (t == MP_WATER) return MKCOLOUR_XXXX(PC_WATER);
578 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
579 return _smallmap_show_heightmap ? cs->height_colours[TileHeight(tile)] : cs->default_colour;
580 } else if (o == OWNER_TOWN) {
581 return MKCOLOUR_XXXX(PC_DARK_RED);
582 }
583
584 return MKCOLOUR_XXXX(_legend_land_owners[_company_to_list_pos[o]].colour);
585 }
586
588 static const byte _vehicle_type_colours[6] = {
589 PC_RED, PC_YELLOW, PC_LIGHT_BLUE, PC_WHITE, PC_BLACK, PC_RED
590 };
591
592
594 /* static */ void SmallMapWindow::BreakIndustryChainLink()
595 {
596 InvalidateWindowClassesData(WC_INDUSTRY_CARGOES, NUM_INDUSTRYTYPES);
597 }
598
599 inline Point SmallMapWindow::SmallmapRemapCoords(int x, int y) const
600 {
601 Point pt;
602 pt.x = (y - x) * 2;
603 pt.y = y + x;
604 return pt;
605 }
606
613 inline Point SmallMapWindow::RemapTile(int tile_x, int tile_y) const
614 {
615 int x_offset = tile_x - this->scroll_x / (int)TILE_SIZE;
616 int y_offset = tile_y - this->scroll_y / (int)TILE_SIZE;
617
618 if (this->zoom == 1) return SmallmapRemapCoords(x_offset, y_offset);
619
620 /* For negative offsets, round towards -inf. */
621 if (x_offset < 0) x_offset -= this->zoom - 1;
622 if (y_offset < 0) y_offset -= this->zoom - 1;
623
624 return SmallmapRemapCoords(x_offset / this->zoom, y_offset / this->zoom);
625 }
626
637 inline Point SmallMapWindow::PixelToTile(int px, int py, int *sub, bool add_sub) const
638 {
639 if (add_sub) px += this->subscroll; // Total horizontal offset.
640
641 /* For each two rows down, add a x and a y tile, and
642 * For each four pixels to the right, move a tile to the right. */
643 Point pt = {((py >> 1) - (px >> 2)) * this->zoom, ((py >> 1) + (px >> 2)) * this->zoom};
644 px &= 3;
645
646 if (py & 1) { // Odd number of rows, handle the 2 pixel shift.
647 if (px < 2) {
648 pt.x += this->zoom;
649 px += 2;
650 } else {
651 pt.y += this->zoom;
652 px -= 2;
653 }
654 }
655
656 *sub = px;
657 return pt;
658 }
659
669 Point SmallMapWindow::ComputeScroll(int tx, int ty, int x, int y, int *sub)
670 {
671 assert(x >= 0 && y >= 0);
672
673 int new_sub;
674 Point tile_xy = PixelToTile(x, y, &new_sub, false);
675 tx -= tile_xy.x;
676 ty -= tile_xy.y;
677
678 Point scroll;
679 if (new_sub == 0) {
680 *sub = 0;
681 scroll.x = (tx + this->zoom) * TILE_SIZE;
682 scroll.y = (ty - this->zoom) * TILE_SIZE;
683 } else {
684 *sub = 4 - new_sub;
685 scroll.x = (tx + 2 * this->zoom) * TILE_SIZE;
686 scroll.y = (ty - 2 * this->zoom) * TILE_SIZE;
687 }
688 return scroll;
689 }
690
697 void SmallMapWindow::SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt)
698 {
699 static const int zoomlevels[] = {1, 2, 4, 6, 8}; // Available zoom levels. Bigger number means more zoom-out (further away).
700 static const int MIN_ZOOM_INDEX = 0;
701 static const int MAX_ZOOM_INDEX = lengthof(zoomlevels) - 1;
702
703 int new_index, cur_index, sub;
704 Point tile;
705 switch (change) {
706 case ZLC_INITIALIZE:
707 cur_index = - 1; // Definitely different from new_index.
708 new_index = MIN_ZOOM_INDEX;
709 tile.x = tile.y = 0;
710 break;
711
712 case ZLC_ZOOM_IN:
713 case ZLC_ZOOM_OUT:
714 for (cur_index = MIN_ZOOM_INDEX; cur_index <= MAX_ZOOM_INDEX; cur_index++) {
715 if (this->zoom == zoomlevels[cur_index]) break;
716 }
717 assert(cur_index <= MAX_ZOOM_INDEX);
718
719 tile = this->PixelToTile(zoom_pt->x, zoom_pt->y, &sub);
720 new_index = Clamp(cur_index + ((change == ZLC_ZOOM_IN) ? -1 : 1), MIN_ZOOM_INDEX, MAX_ZOOM_INDEX);
721 break;
722
723 default: NOT_REACHED();
724 }
725
726 if (new_index != cur_index) {
727 this->zoom = zoomlevels[new_index];
728 if (cur_index >= 0) {
729 Point new_tile = this->PixelToTile(zoom_pt->x, zoom_pt->y, &sub);
730 this->SetNewScroll(this->scroll_x + (tile.x - new_tile.x) * TILE_SIZE,
731 this->scroll_y + (tile.y - new_tile.y) * TILE_SIZE, sub);
732 } else if (this->map_type == SMT_LINKSTATS) {
733 this->overlay->SetDirty();
734 }
735 this->SetWidgetDisabledState(WID_SM_ZOOM_IN, this->zoom == zoomlevels[MIN_ZOOM_INDEX]);
736 this->SetWidgetDisabledState(WID_SM_ZOOM_OUT, this->zoom == zoomlevels[MAX_ZOOM_INDEX]);
737 this->SetDirty();
738 }
739 }
740
746 inline uint32 SmallMapWindow::GetTileColours(const TileArea &ta) const
747 {
748 int importance = 0;
749 TileIndex tile = INVALID_TILE; // Position of the most important tile.
750 TileType et = MP_VOID; // Effective tile type at that position.
751
752 TILE_AREA_LOOP(ti, ta) {
753 TileType ttype = GetTileType(ti);
754
755 switch (ttype) {
756 case MP_TUNNELBRIDGE: {
757 TransportType tt = GetTunnelBridgeTransportType(ti);
758
759 switch (tt) {
760 case TRANSPORT_RAIL: ttype = MP_RAILWAY; break;
761 case TRANSPORT_ROAD: ttype = MP_ROAD; break;
762 default: ttype = MP_WATER; break;
763 }
764 break;
765 }
766
767 case MP_INDUSTRY:
768 /* Special handling of industries while in "Industries" smallmap view. */
769 if (this->map_type == SMT_INDUSTRY) {
770 /* If industry is allowed to be seen, use its colour on the map.
771 * This has the highest priority above any value in _tiletype_importance. */
772 IndustryType type = Industry::GetByTile(ti)->type;
773 if (_legend_from_industries[_industry_to_list_pos[type]].show_on_map) {
774 if (type == _smallmap_industry_highlight) {
775 if (_smallmap_industry_highlight_state) return MKCOLOUR_XXXX(PC_WHITE);
776 } else {
777 return GetIndustrySpec(type)->map_colour * 0x01010101;
778 }
779 }
780 /* Otherwise make it disappear */
781 ttype = IsTileOnWater(ti) ? MP_WATER : MP_CLEAR;
782 }
783 break;
784
785 default:
786 break;
787 }
788
789 if (_tiletype_importance[ttype] > importance) {
790 importance = _tiletype_importance[ttype];
791 tile = ti;
792 et = ttype;
793 }
794 }
795
796 switch (this->map_type) {
797 case SMT_CONTOUR:
798 return GetSmallMapContoursPixels(tile, et);
799
800 case SMT_VEHICLES:
801 return GetSmallMapVehiclesPixels(tile, et);
802
803 case SMT_INDUSTRY:
804 return GetSmallMapIndustriesPixels(tile, et);
805
806 case SMT_LINKSTATS:
807 return GetSmallMapLinkStatsPixels(tile, et);
808
809 case SMT_ROUTES:
810 return GetSmallMapRoutesPixels(tile, et);
811
812 case SMT_VEGETATION:
813 return GetSmallMapVegetationPixels(tile, et);
814
815 case SMT_OWNER:
816 return GetSmallMapOwnerPixels(tile, et);
817
818 default: NOT_REACHED();
819 }
820 }
821
835 void SmallMapWindow::DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const
836 {
837 void *dst_ptr_abs_end = blitter->MoveTo(_screen.dst_ptr, 0, _screen.height);
838 uint min_xy = _settings_game.construction.freeform_edges ? 1 : 0;
839
840 do {
841 /* Check if the tile (xc,yc) is within the map range */
842 if (xc >= MapMaxX() || yc >= MapMaxY()) continue;
843
844 /* Check if the dst pointer points to a pixel inside the screen buffer */
845 if (dst < _screen.dst_ptr) continue;
846 if (dst >= dst_ptr_abs_end) continue;
847
848 /* Construct tilearea covered by (xc, yc, xc + this->zoom, yc + this->zoom) such that it is within min_xy limits. */
849 TileArea ta;
850 if (min_xy == 1 && (xc == 0 || yc == 0)) {
851 if (this->zoom == 1) continue; // The tile area is empty, don't draw anything.
852
853 ta = TileArea(TileXY(std::max(min_xy, xc), std::max(min_xy, yc)), this->zoom - (xc == 0), this->zoom - (yc == 0));
854 } else {
855 ta = TileArea(TileXY(xc, yc), this->zoom, this->zoom);
856 }
857 ta.ClampToMap(); // Clamp to map boundaries (may contain MP_VOID tiles!).
858
859 uint32 val = this->GetTileColours(ta);
860 uint8 *val8 = (uint8 *)&val;
861 int idx = std::max(0, -start_pos);
862 for (int pos = std::max(0, start_pos); pos < end_pos; pos++) {
863 blitter->SetPixel(dst, idx, 0, val8[idx]);
864 idx++;
865 }
866 /* Switch to next tile in the column */
867 } while (xc += this->zoom, yc += this->zoom, dst = blitter->MoveTo(dst, pitch, 0), --reps != 0);
868 }
869
875 void SmallMapWindow::DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
876 {
877 for (const Vehicle *v : Vehicle::Iterate()) {
878 if (v->type == VEH_EFFECT) continue;
879 if (v->vehstatus & (VS_HIDDEN | VS_UNCLICKABLE)) continue;
880
881 /* Remap into flat coordinates. */
882 Point pt = this->RemapTile(v->x_pos / (int)TILE_SIZE, v->y_pos / (int)TILE_SIZE);
883
884 int y = pt.y - dpi->top;
885 if (!IsInsideMM(y, 0, dpi->height)) continue; // y is out of bounds.
886
887 bool skip = false; // Default is to draw both pixels.
888 int x = pt.x - this->subscroll - 3 - dpi->left; // Offset X coordinate.
889 if (x < 0) {
890 /* if x+1 is 0, that means we're on the very left edge,
891 * and should thus only draw a single pixel */
892 if (++x != 0) continue;
893 skip = true;
894 } else if (x >= dpi->width - 1) {
895 /* Check if we're at the very right edge, and if so draw only a single pixel */
896 if (x != dpi->width - 1) continue;
897 skip = true;
898 }
899
900 /* Calculate pointer to pixel and the colour */
901 byte colour = (this->map_type == SMT_VEHICLES) ? _vehicle_type_colours[v->type] : PC_WHITE;
902
903 /* And draw either one or two pixels depending on clipping */
904 blitter->SetPixel(dpi->dst_ptr, x, y, colour);
905 if (!skip) blitter->SetPixel(dpi->dst_ptr, x + 1, y, colour);
906 }
907 }
908
913 void SmallMapWindow::DrawTowns(const DrawPixelInfo *dpi) const
914 {
915 for (const Town *t : Town::Iterate()) {
916 /* Remap the town coordinate */
917 Point pt = this->RemapTile(TileX(t->xy), TileY(t->xy));
918 int x = pt.x - this->subscroll - (t->cache.sign.width_small >> 1);
919 int y = pt.y;
920
921 /* Check if the town sign is within bounds */
922 if (x + t->cache.sign.width_small > dpi->left &&
923 x < dpi->left + dpi->width &&
924 y + FONT_HEIGHT_SMALL > dpi->top &&
925 y < dpi->top + dpi->height) {
926 /* And draw it. */
927 SetDParam(0, t->index);
928 DrawString(x, x + t->cache.sign.width_small, y, STR_SMALLMAP_TOWN);
929 }
930 }
931 }
932
936 void SmallMapWindow::DrawMapIndicators() const
937 {
938 /* Find main viewport. */
939 const Viewport *vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport;
940
941 Point upper_left_smallmap_coord = InverseRemapCoords2(vp->virtual_left, vp->virtual_top);
942 Point lower_right_smallmap_coord = InverseRemapCoords2(vp->virtual_left + vp->virtual_width - 1, vp->virtual_top + vp->virtual_height - 1);
943
944 Point upper_left = this->RemapTile(upper_left_smallmap_coord.x / (int)TILE_SIZE, upper_left_smallmap_coord.y / (int)TILE_SIZE);
945 upper_left.x -= this->subscroll;
946
947 Point lower_right = this->RemapTile(lower_right_smallmap_coord.x / (int)TILE_SIZE, lower_right_smallmap_coord.y / (int)TILE_SIZE);
948 lower_right.x -= this->subscroll;
949
950 SmallMapWindow::DrawVertMapIndicator(upper_left.x, upper_left.y, lower_right.y);
951 SmallMapWindow::DrawVertMapIndicator(lower_right.x, upper_left.y, lower_right.y);
952
953 SmallMapWindow::DrawHorizMapIndicator(upper_left.x, lower_right.x, upper_left.y);
954 SmallMapWindow::DrawHorizMapIndicator(upper_left.x, lower_right.x, lower_right.y);
955 }
956
968 void SmallMapWindow::DrawSmallMap(DrawPixelInfo *dpi) const
969 {
970 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
971 DrawPixelInfo *old_dpi;
972
973 old_dpi = _cur_dpi;
974 _cur_dpi = dpi;
975
976 /* Clear it */
977 GfxFillRect(dpi->left, dpi->top, dpi->left + dpi->width - 1, dpi->top + dpi->height - 1, PC_BLACK);
978
979 /* Which tile is displayed at (dpi->left, dpi->top)? */
980 int dx;
981 Point tile = this->PixelToTile(dpi->left, dpi->top, &dx);
982 int tile_x = this->scroll_x / (int)TILE_SIZE + tile.x;
983 int tile_y = this->scroll_y / (int)TILE_SIZE + tile.y;
984
985 void *ptr = blitter->MoveTo(dpi->dst_ptr, -dx - 4, 0);
986 int x = - dx - 4;
987 int y = 0;
988
989 for (;;) {
990 /* Distance from left edge */
991 if (x >= -3) {
992 if (x >= dpi->width) break; // Exit the loop.
993
994 int end_pos = std::min(dpi->width, x + 4);
995 int reps = (dpi->height - y + 1) / 2; // Number of lines.
996 if (reps > 0) {
997 this->DrawSmallMapColumn(ptr, tile_x, tile_y, dpi->pitch * 2, reps, x, end_pos, blitter);
998 }
999 }
1000
1001 if (y == 0) {
1002 tile_y += this->zoom;
1003 y++;
1004 ptr = blitter->MoveTo(ptr, 0, 1);
1005 } else {
1006 tile_x -= this->zoom;
1007 y--;
1008 ptr = blitter->MoveTo(ptr, 0, -1);
1009 }
1010 ptr = blitter->MoveTo(ptr, 2, 0);
1011 x += 2;
1012 }
1013
1014 /* Draw vehicles */
1015 if (this->map_type == SMT_CONTOUR || this->map_type == SMT_VEHICLES) this->DrawVehicles(dpi, blitter);
1016
1017 /* Draw link stat overlay */
1018 if (this->map_type == SMT_LINKSTATS) this->overlay->Draw(dpi);
1019
1020 /* Draw town names */
1021 if (this->show_towns) this->DrawTowns(dpi);
1022
1023 /* Draw map indicators */
1024 this->DrawMapIndicators();
1025
1026 _cur_dpi = old_dpi;
1027 }
1028
1032 void SmallMapWindow::SetupWidgetData()
1033 {
1034 StringID legend_tooltip;
1035 StringID enable_all_tooltip;
1036 StringID disable_all_tooltip;
1037 int plane;
1038 switch (this->map_type) {
1039 case SMT_INDUSTRY:
1040 legend_tooltip = STR_SMALLMAP_TOOLTIP_INDUSTRY_SELECTION;
1041 enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_INDUSTRIES;
1042 disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_INDUSTRIES;
1043 plane = 0;
1044 break;
1045
1046 case SMT_OWNER:
1047 legend_tooltip = STR_SMALLMAP_TOOLTIP_COMPANY_SELECTION;
1048 enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_COMPANIES;
1049 disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_COMPANIES;
1050 plane = 0;
1051 break;
1052
1053 case SMT_LINKSTATS:
1054 legend_tooltip = STR_SMALLMAP_TOOLTIP_CARGO_SELECTION;
1055 enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_CARGOS;
1056 disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_CARGOS;
1057 plane = 0;
1058 break;
1059
1060 default:
1061 legend_tooltip = STR_NULL;
1062 enable_all_tooltip = STR_NULL;
1063 disable_all_tooltip = STR_NULL;
1064 plane = 1;
1065 break;
1066 }
1067
1068 this->GetWidget<NWidgetCore>(WID_SM_LEGEND)->SetDataTip(STR_NULL, legend_tooltip);
1069 this->GetWidget<NWidgetCore>(WID_SM_ENABLE_ALL)->SetDataTip(STR_SMALLMAP_ENABLE_ALL, enable_all_tooltip);
1070 this->GetWidget<NWidgetCore>(WID_SM_DISABLE_ALL)->SetDataTip(STR_SMALLMAP_DISABLE_ALL, disable_all_tooltip);
1071 this->GetWidget<NWidgetStacked>(WID_SM_SELECT_BUTTONS)->SetDisplayedPlane(plane);
1072 }
1073
1074 SmallMapWindow::SmallMapWindow(WindowDesc *desc, int window_number) : Window(desc), refresh(GUITimer(FORCE_REFRESH_PERIOD))
1075 {
1076 _smallmap_industry_highlight = INVALID_INDUSTRYTYPE;
1077 this->overlay = new LinkGraphOverlay(this, WID_SM_MAP, 0, this->GetOverlayCompanyMask(), 1);
1078 this->InitNested(window_number);
1079 this->LowerWidget(this->map_type + WID_SM_CONTOUR);
1080
1081 this->RebuildColourIndexIfNecessary();
1082
1083 this->SetWidgetLoweredState(WID_SM_SHOW_HEIGHT, _smallmap_show_heightmap);
1084
1085 this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME, this->show_towns);
1086
1087 this->SetupWidgetData();
1088
1089 this->SetZoomLevel(ZLC_INITIALIZE, nullptr);
1090 this->SmallMapCenterOnCurrentPos();
1091 this->SetOverlayCargoMask();
1092 }
1093
1094 SmallMapWindow::~SmallMapWindow()
1095 {
1096 delete this->overlay;
1097 this->BreakIndustryChainLink();
1098 }
1099
1103 void SmallMapWindow::RebuildColourIndexIfNecessary()
1104 {
1105 /* Rebuild colour indices if necessary. */
1106 if (SmallMapWindow::max_heightlevel == _settings_game.construction.max_heightlevel) return;
1107
1108 for (uint n = 0; n < lengthof(_heightmap_schemes); n++) {
1109 /* The heights go from 0 up to and including maximum. */
1110 int heights = _settings_game.construction.max_heightlevel + 1;
1111 _heightmap_schemes[n].height_colours = ReallocT<uint32>(_heightmap_schemes[n].height_colours, heights);
1112
1113 for (int z = 0; z < heights; z++) {
1114 size_t access_index = (_heightmap_schemes[n].colour_count * z) / heights;
1115
1116 /* Choose colour by mapping the range (0..max heightlevel) on the complete colour table. */
1117 _heightmap_schemes[n].height_colours[z] = _heightmap_schemes[n].height_colours_base[access_index];
1118 }
1119 }
1120
1121 SmallMapWindow::max_heightlevel = _settings_game.construction.max_heightlevel;
1122 BuildLandLegend();
1123 }
1124
1125 /* virtual */ void SmallMapWindow::SetStringParameters(int widget) const
1126 {
1127 switch (widget) {
1128 case WID_SM_CAPTION:
1129 SetDParam(0, STR_SMALLMAP_TYPE_CONTOURS + this->map_type);
1130 break;
1131 }
1132 }
1133
1134 /* virtual */ void SmallMapWindow::OnInit()
1135 {
1136 uint min_width = 0;
1137 this->min_number_of_columns = INDUSTRY_MIN_NUMBER_OF_COLUMNS;
1138 this->min_number_of_fixed_rows = lengthof(_linkstat_colours_in_legenda);
1139 for (uint i = 0; i < lengthof(_legend_table); i++) {
1140 uint height = 0;
1141 uint num_columns = 1;
1142 for (const LegendAndColour *tbl = _legend_table[i]; !tbl->end; ++tbl) {
1143 StringID str;
1144 if (i == SMT_INDUSTRY) {
1145 SetDParam(0, tbl->legend);
1146 SetDParam(1, IndustryPool::MAX_SIZE);
1147 str = STR_SMALLMAP_INDUSTRY;
1148 } else if (i == SMT_LINKSTATS) {
1149 SetDParam(0, tbl->legend);
1150 str = STR_SMALLMAP_LINKSTATS;
1151 } else if (i == SMT_OWNER) {
1152 if (tbl->company != INVALID_COMPANY) {
1153 if (!Company::IsValidID(tbl->company)) {
1154 /* Rebuild the owner legend. */
1155 BuildOwnerLegend();
1156 this->OnInit();
1157 return;
1158 }
1159 /* Non-fixed legend entries for the owner view. */
1160 SetDParam(0, tbl->company);
1161 str = STR_SMALLMAP_COMPANY;
1162 } else {
1163 str = tbl->legend;
1164 }
1165 } else {
1166 if (tbl->col_break) {
1167 this->min_number_of_fixed_rows = std::max(this->min_number_of_fixed_rows, height);
1168 height = 0;
1169 num_columns++;
1170 }
1171 height++;
1172 str = tbl->legend;
1173 }
1174 min_width = std::max(GetStringBoundingBox(str).width, min_width);
1175 }
1176 this->min_number_of_fixed_rows = std::max(this->min_number_of_fixed_rows, height);
1177 this->min_number_of_columns = std::max(this->min_number_of_columns, num_columns);
1178 }
1179
1180 /* The width of a column is the minimum width of all texts + the size of the blob + some spacing */
1181 this->column_width = min_width + LEGEND_BLOB_WIDTH + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
1182 }
1183
1184 /* virtual */ void SmallMapWindow::OnPaint()
1185 {
1186 if (this->map_type == SMT_OWNER) {
1187 for (const LegendAndColour *tbl = _legend_table[this->map_type]; !tbl->end; ++tbl) {
1188 if (tbl->company != INVALID_COMPANY && !Company::IsValidID(tbl->company)) {
1189 /* Rebuild the owner legend. */
1190 BuildOwnerLegend();
1191 this->InvalidateData(1);
1192 break;
1193 }
1194 }
1195 }
1196
1197 this->DrawWidgets();
1198 }
1199
1200 /* virtual */ void SmallMapWindow::DrawWidget(const Rect &r, int widget) const
1201 {
1202 switch (widget) {
1203 case WID_SM_MAP: {
1204 DrawPixelInfo new_dpi;
1205 if (!FillDrawPixelInfo(&new_dpi, r.left + 1, r.top + 1, r.right - r.left - 1, r.bottom - r.top - 1)) return;
1206 this->DrawSmallMap(&new_dpi);
1207 break;
1208 }
1209
1210 case WID_SM_LEGEND: {
1211 uint columns = this->GetNumberColumnsLegend(r.right - r.left + 1);
1212 uint number_of_rows = this->GetNumberRowsLegend(columns);
1213 bool rtl = _current_text_dir == TD_RTL;
1214 uint y_org = r.top + WD_FRAMERECT_TOP;
1215 uint x = rtl ? r.right - this->column_width - WD_FRAMERECT_RIGHT : r.left + WD_FRAMERECT_LEFT;
1216 uint y = y_org;
1217 uint i = 0; // Row counter for industry legend.
1218 uint row_height = FONT_HEIGHT_SMALL;
1219
1220 uint text_left = rtl ? 0 : LEGEND_BLOB_WIDTH + WD_FRAMERECT_LEFT;
1221 uint text_right = this->column_width - 1 - (rtl ? LEGEND_BLOB_WIDTH + WD_FRAMERECT_RIGHT : 0);
1222 uint blob_left = rtl ? this->column_width - 1 - LEGEND_BLOB_WIDTH : 0;
1223 uint blob_right = rtl ? this->column_width - 1 : LEGEND_BLOB_WIDTH;
1224
1225 StringID string = STR_NULL;
1226 switch (this->map_type) {
1227 case SMT_INDUSTRY:
1228 string = STR_SMALLMAP_INDUSTRY;
1229 break;
1230 case SMT_LINKSTATS:
1231 string = STR_SMALLMAP_LINKSTATS;
1232 break;
1233 case SMT_OWNER:
1234 string = STR_SMALLMAP_COMPANY;
1235 break;
1236 default:
1237 break;
1238 }
1239
1240 for (const LegendAndColour *tbl = _legend_table[this->map_type]; !tbl->end; ++tbl) {
1241 if (tbl->col_break || ((this->map_type == SMT_INDUSTRY || this->map_type == SMT_OWNER || this->map_type == SMT_LINKSTATS) && i++ >= number_of_rows)) {
1242 /* Column break needed, continue at top, COLUMN_WIDTH pixels
1243 * (one "row") to the right. */
1244 x += rtl ? -(int)this->column_width : this->column_width;
1245 y = y_org;
1246 i = 1;
1247 }
1248
1249 uint8 legend_colour = tbl->colour;
1250
1251 switch (this->map_type) {
1252 case SMT_INDUSTRY:
1253 /* Industry name must be formatted, since it's not in tiny font in the specs.
1254 * So, draw with a parameter and use the STR_SMALLMAP_INDUSTRY string, which is tiny font */
1255 SetDParam(0, tbl->legend);
1256 SetDParam(1, Industry::GetIndustryTypeCount(tbl->type));
1257 if (tbl->show_on_map && tbl->type == _smallmap_industry_highlight) {
1258 legend_colour = _smallmap_industry_highlight_state ? PC_WHITE : PC_BLACK;
1259 }
1260 FALLTHROUGH;
1261
1262 case SMT_LINKSTATS:
1263 SetDParam(0, tbl->legend);
1264 FALLTHROUGH;
1265
1266 case SMT_OWNER:
1267 if (this->map_type != SMT_OWNER || tbl->company != INVALID_COMPANY) {
1268 if (this->map_type == SMT_OWNER) SetDParam(0, tbl->company);
1269 if (!tbl->show_on_map) {
1270 /* Simply draw the string, not the black border of the legend colour.
1271 * This will enforce the idea of the disabled item */
1272 DrawString(x + text_left, x + text_right, y, string, TC_GREY);
1273 } else {
1274 DrawString(x + text_left, x + text_right, y, string, TC_BLACK);
1275 GfxFillRect(x + blob_left, y + 1, x + blob_right, y + row_height - 1, PC_BLACK); // Outer border of the legend colour
1276 }
1277 break;
1278 }
1279 FALLTHROUGH;
1280
1281 default:
1282 if (this->map_type == SMT_CONTOUR) SetDParam(0, tbl->height * TILE_HEIGHT_STEP);
1283 /* Anything that is not an industry or a company is using normal process */
1284 GfxFillRect(x + blob_left, y + 1, x + blob_right, y + row_height - 1, PC_BLACK);
1285 DrawString(x + text_left, x + text_right, y, tbl->legend);
1286 break;
1287 }
1288 GfxFillRect(x + blob_left + 1, y + 2, x + blob_right - 1, y + row_height - 2, legend_colour); // Legend colour
1289
1290 y += row_height;
1291 }
1292 }
1293 }
1294 }
1295
1300 void SmallMapWindow::SwitchMapType(SmallMapType map_type)
1301 {
1302 this->RaiseWidget(this->map_type + WID_SM_CONTOUR);
1303 this->map_type = map_type;
1304 this->LowerWidget(this->map_type + WID_SM_CONTOUR);
1305
1306 this->SetupWidgetData();
1307
1308 if (map_type == SMT_LINKSTATS) this->overlay->SetDirty();
1309 if (map_type != SMT_INDUSTRY) this->BreakIndustryChainLink();
1310 this->SetDirty();
1311 }
1312
1321 inline uint SmallMapWindow::GetNumberRowsLegend(uint columns) const
1322 {
1323 /* Reserve one column for link colours */
1324 uint num_rows_linkstats = CeilDiv(_smallmap_cargo_count, columns - 1);
1325 uint num_rows_others = CeilDiv(std::max(_smallmap_industry_count, _smallmap_company_count), columns);
1326 return std::max({this->min_number_of_fixed_rows, num_rows_linkstats, num_rows_others});
1327 }
1328
1340 void SmallMapWindow::SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item)
1341 {
1342 if (_ctrl_pressed) {
1343 /* Disable all, except the clicked one */
1344 bool changes = false;
1345 for (int i = begin_legend_item; i != end_legend_item; i++) {
1346 bool new_state = (i == click_pos);
1347 if (legend[i].show_on_map != new_state) {
1348 changes = true;
1349 legend[i].show_on_map = new_state;
1350 }
1351 }
1352 if (!changes) {
1353 /* Nothing changed? Then show all (again). */
1354 for (int i = begin_legend_item; i != end_legend_item; i++) {
1355 legend[i].show_on_map = true;
1356 }
1357 }
1358 } else {
1359 legend[click_pos].show_on_map = !legend[click_pos].show_on_map;
1360 }
1361
1362 if (this->map_type == SMT_INDUSTRY) this->BreakIndustryChainLink();
1363 }
1364
1368 void SmallMapWindow::SetOverlayCargoMask()
1369 {
1370 CargoTypes cargo_mask = 0;
1371 for (int i = 0; i != _smallmap_cargo_count; ++i) {
1372 if (_legend_linkstats[i].show_on_map) SetBit(cargo_mask, _legend_linkstats[i].type);
1373 }
1374 this->overlay->SetCargoMask(cargo_mask);
1375 }
1376
1382 int SmallMapWindow::GetPositionOnLegend(Point pt)
1383 {
1384 const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_LEGEND);
1385 uint line = (pt.y - wi->pos_y - WD_FRAMERECT_TOP) / FONT_HEIGHT_SMALL;
1386 uint columns = this->GetNumberColumnsLegend(wi->current_x);
1387 uint number_of_rows = this->GetNumberRowsLegend(columns);
1388 if (line >= number_of_rows) return -1;
1389
1390 bool rtl = _current_text_dir == TD_RTL;
1391 int x = pt.x - wi->pos_x;
1392 if (rtl) x = wi->current_x - x;
1393 uint column = (x - WD_FRAMERECT_LEFT) / this->column_width;
1394
1395 return (column * number_of_rows) + line;
1396 }
1397
1398 /* virtual */ void SmallMapWindow::OnMouseOver(Point pt, int widget)
1399 {
1400 IndustryType new_highlight = INVALID_INDUSTRYTYPE;
1401 if (widget == WID_SM_LEGEND && this->map_type == SMT_INDUSTRY) {
1402 int industry_pos = GetPositionOnLegend(pt);
1403 if (industry_pos >= 0 && industry_pos < _smallmap_industry_count) {
1404 new_highlight = _legend_from_industries[industry_pos].type;
1405 }
1406 }
1407 if (new_highlight != _smallmap_industry_highlight) {
1408 _smallmap_industry_highlight = new_highlight;
1409 this->refresh.SetInterval(_smallmap_industry_highlight != INVALID_INDUSTRYTYPE ? BLINK_PERIOD : FORCE_REFRESH_PERIOD);
1410 _smallmap_industry_highlight_state = true;
1411 this->SetDirty();
1412 }
1413 }
1414
1415 /* virtual */ void SmallMapWindow::OnClick(Point pt, int widget, int click_count)
1416 {
1417 switch (widget) {
1418 case WID_SM_MAP: { // Map window
1419 if (click_count > 0) this->mouse_capture_widget = widget;
1420
1421 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1422 Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
1423 int sub;
1424 pt = this->PixelToTile(pt.x - wid->pos_x, pt.y - wid->pos_y, &sub);
1425 ScrollWindowTo(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, -1, w);
1426
1427 this->SetDirty();
1428 break;
1429 }
1430
1431 case WID_SM_ZOOM_IN:
1432 case WID_SM_ZOOM_OUT: {
1433 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1434 Point pt = { (int)wid->current_x / 2, (int)wid->current_y / 2};
1435 this->SetZoomLevel((widget == WID_SM_ZOOM_IN) ? ZLC_ZOOM_IN : ZLC_ZOOM_OUT, &pt);
1436 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
1437 break;
1438 }
1439
1440 case WID_SM_CONTOUR: // Show land contours
1441 case WID_SM_VEHICLES: // Show vehicles
1442 case WID_SM_INDUSTRIES: // Show industries
1443 case WID_SM_LINKSTATS: // Show route map
1444 case WID_SM_ROUTES: // Show transport routes
1445 case WID_SM_VEGETATION: // Show vegetation
1446 case WID_SM_OWNERS: // Show land owners
1447 this->SwitchMapType((SmallMapType)(widget - WID_SM_CONTOUR));
1448 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
1449 break;
1450
1451 case WID_SM_CENTERMAP: // Center the smallmap again
1452 this->SmallMapCenterOnCurrentPos();
1453 this->HandleButtonClick(WID_SM_CENTERMAP);
1454 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
1455 break;
1456
1457 case WID_SM_TOGGLETOWNNAME: // Toggle town names
1458 this->show_towns = !this->show_towns;
1459 this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME, this->show_towns);
1460
1461 this->SetDirty();
1462 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
1463 break;
1464
1465 case WID_SM_LEGEND: // Legend
1466 if (this->map_type == SMT_INDUSTRY || this->map_type == SMT_LINKSTATS || this->map_type == SMT_OWNER) {
1467 int click_pos = this->GetPositionOnLegend(pt);
1468 if (click_pos < 0) break;
1469
1470 /* If industry type small map*/
1471 if (this->map_type == SMT_INDUSTRY) {
1472 /* If click on industries label, find right industry type and enable/disable it. */
1473 if (click_pos < _smallmap_industry_count) {
1474 this->SelectLegendItem(click_pos, _legend_from_industries, _smallmap_industry_count);
1475 }
1476 } else if (this->map_type == SMT_LINKSTATS) {
1477 if (click_pos < _smallmap_cargo_count) {
1478 this->SelectLegendItem(click_pos, _legend_linkstats, _smallmap_cargo_count);
1479 this->SetOverlayCargoMask();
1480 }
1481 } else if (this->map_type == SMT_OWNER) {
1482 if (click_pos < _smallmap_company_count) {
1483 this->SelectLegendItem(click_pos, _legend_land_owners, _smallmap_company_count, NUM_NO_COMPANY_ENTRIES);
1484 }
1485 }
1486 this->SetDirty();
1487 }
1488 break;
1489
1490 case WID_SM_ENABLE_ALL:
1491 case WID_SM_DISABLE_ALL: {
1492 LegendAndColour *tbl = nullptr;
1493 switch (this->map_type) {
1494 case SMT_INDUSTRY:
1495 tbl = _legend_from_industries;
1496 this->BreakIndustryChainLink();
1497 break;
1498 case SMT_OWNER:
1499 tbl = &(_legend_land_owners[NUM_NO_COMPANY_ENTRIES]);
1500 break;
1501 case SMT_LINKSTATS:
1502 tbl = _legend_linkstats;
1503 break;
1504 default:
1505 NOT_REACHED();
1506 }
1507 for (;!tbl->end && tbl->legend != STR_LINKGRAPH_LEGEND_UNUSED; ++tbl) {
1508 tbl->show_on_map = (widget == WID_SM_ENABLE_ALL);
1509 }
1510 if (this->map_type == SMT_LINKSTATS) this->SetOverlayCargoMask();
1511 this->SetDirty();
1512 break;
1513 }
1514
1515 case WID_SM_SHOW_HEIGHT: // Enable/disable showing of heightmap.
1516 _smallmap_show_heightmap = !_smallmap_show_heightmap;
1517 this->SetWidgetLoweredState(WID_SM_SHOW_HEIGHT, _smallmap_show_heightmap);
1518 this->SetDirty();
1519 break;
1520 }
1521 }
1522
1531 /* virtual */ void SmallMapWindow::OnInvalidateData(int data, bool gui_scope)
1532 {
1533 if (!gui_scope) return;
1534
1535 switch (data) {
1536 case 1:
1537 /* The owner legend has already been rebuilt. */
1538 this->ReInit();
1539 break;
1540
1541 case 0: {
1542 extern std::bitset<NUM_INDUSTRYTYPES> _displayed_industries;
1543 if (this->map_type != SMT_INDUSTRY) this->SwitchMapType(SMT_INDUSTRY);
1544
1545 for (int i = 0; i != _smallmap_industry_count; i++) {
1546 _legend_from_industries[i].show_on_map = _displayed_industries.test(_legend_from_industries[i].type);
1547 }
1548 break;
1549 }
1550
1551 case 2:
1552 this->RebuildColourIndexIfNecessary();
1553 break;
1554
1555 default: NOT_REACHED();
1556 }
1557 this->SetDirty();
1558 }
1559
1560 /* virtual */ bool SmallMapWindow::OnRightClick(Point pt, int widget)
1561 {
1562 if (widget != WID_SM_MAP || _scrolling_viewport) return false;
1563
1564 _scrolling_viewport = true;
1565 return true;
1566 }
1567
1568 /* virtual */ void SmallMapWindow::OnMouseWheel(int wheel)
1569 {
1570 if (_settings_client.gui.scrollwheel_scrolling != 2) {
1571 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1572 int cursor_x = _cursor.pos.x - this->left - wid->pos_x;
1573 int cursor_y = _cursor.pos.y - this->top - wid->pos_y;
1574 if (IsInsideMM(cursor_x, 0, wid->current_x) && IsInsideMM(cursor_y, 0, wid->current_y)) {
1575 Point pt = {cursor_x, cursor_y};
1576 this->SetZoomLevel((wheel < 0) ? ZLC_ZOOM_IN : ZLC_ZOOM_OUT, &pt);
1577 }
1578 }
1579 }
1580
1581 /* virtual */ void SmallMapWindow::OnRealtimeTick(uint delta_ms)
1582 {
1583 /* Update the window every now and then */
1584 if (!this->refresh.Elapsed(delta_ms)) return;
1585
1586 if (this->map_type == SMT_LINKSTATS) {
1587 uint32 company_mask = this->GetOverlayCompanyMask();
1588 if (this->overlay->GetCompanyMask() != company_mask) {
1589 this->overlay->SetCompanyMask(company_mask);
1590 } else {
1591 this->overlay->SetDirty();
1592 }
1593 }
1594 _smallmap_industry_highlight_state = !_smallmap_industry_highlight_state;
1595
1596 this->refresh.SetInterval(_smallmap_industry_highlight != INVALID_INDUSTRYTYPE ? BLINK_PERIOD : FORCE_REFRESH_PERIOD);
1597 this->SetDirty();
1598 }
1599
1607 void SmallMapWindow::SetNewScroll(int sx, int sy, int sub)
1608 {
1609 const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1610 Point hv = InverseRemapCoords(wi->current_x * ZOOM_LVL_BASE * TILE_SIZE / 2, wi->current_y * ZOOM_LVL_BASE * TILE_SIZE / 2);
1611 hv.x *= this->zoom;
1612 hv.y *= this->zoom;
1613
1614 if (sx < -hv.x) {
1615 sx = -hv.x;
1616 sub = 0;
1617 }
1618 if (sx > (int)(MapMaxX() * TILE_SIZE) - hv.x) {
1619 sx = MapMaxX() * TILE_SIZE - hv.x;
1620 sub = 0;
1621 }
1622 if (sy < -hv.y) {
1623 sy = -hv.y;
1624 sub = 0;
1625 }
1626 if (sy > (int)(MapMaxY() * TILE_SIZE) - hv.y) {
1627 sy = MapMaxY() * TILE_SIZE - hv.y;
1628 sub = 0;
1629 }
1630
1631 this->scroll_x = sx;
1632 this->scroll_y = sy;
1633 this->subscroll = sub;
1634 if (this->map_type == SMT_LINKSTATS) this->overlay->SetDirty();
1635 }
1636
1637 /* virtual */ void SmallMapWindow::OnScroll(Point delta)
1638 {
1639 if (_settings_client.gui.scroll_mode == VSM_VIEWPORT_RMB_FIXED || _settings_client.gui.scroll_mode == VSM_MAP_RMB_FIXED) _cursor.fix_at = true;
1640
1641 /* While tile is at (delta.x, delta.y)? */
1642 int sub;
1643 Point pt = this->PixelToTile(delta.x, delta.y, &sub);
1644 this->SetNewScroll(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, sub);
1645
1646 this->SetDirty();
1647 }
1648
1652 void SmallMapWindow::SmallMapCenterOnCurrentPos()
1653 {
1654 const Viewport *vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport;
1655 Point viewport_center = InverseRemapCoords2(vp->virtual_left + vp->virtual_width / 2, vp->virtual_top + vp->virtual_height / 2);
1656
1657 int sub;
1658 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1659 Point sxy = this->ComputeScroll(viewport_center.x / (int)TILE_SIZE, viewport_center.y / (int)TILE_SIZE,
1660 std::max(0, (int)wid->current_x / 2 - 2), wid->current_y / 2, &sub);
1661 this->SetNewScroll(sxy.x, sxy.y, sub);
1662 this->SetDirty();
1663 }
1664
1670 Point SmallMapWindow::GetStationMiddle(const Station *st) const
1671 {
1672 int x = (st->rect.right + st->rect.left + 1) / 2;
1673 int y = (st->rect.bottom + st->rect.top + 1) / 2;
1674 Point ret = this->RemapTile(x, y);
1675
1676 /* Same magic 3 as in DrawVehicles; that's where I got it from.
1677 * No idea what it is, but without it the result looks bad.
1678 */
1679 ret.x -= 3 + this->subscroll;
1680 return ret;
1681 }
1682
1683 SmallMapWindow::SmallMapType SmallMapWindow::map_type = SMT_CONTOUR;
1684 bool SmallMapWindow::show_towns = true;
1685 int SmallMapWindow::max_heightlevel = -1;
1686
1695 class NWidgetSmallmapDisplay : public NWidgetContainer {
1696 const SmallMapWindow *smallmap_window;
1697 public:
1698 NWidgetSmallmapDisplay() : NWidgetContainer(NWID_VERTICAL)
1699 {
1700 this->smallmap_window = nullptr;
1701 }
1702
1703 void SetupSmallestSize(Window *w, bool init_array) override
1704 {
1705 NWidgetBase *display = this->head;
1706 NWidgetBase *bar = display->next;
1707
1708 display->SetupSmallestSize(w, init_array);
1709 bar->SetupSmallestSize(w, init_array);
1710
1711 this->smallmap_window = dynamic_cast<SmallMapWindow *>(w);
1712 assert(this->smallmap_window != nullptr);
1713 this->smallest_x = std::max(display->smallest_x, bar->smallest_x + smallmap_window->GetMinLegendWidth());
1714 this->smallest_y = display->smallest_y + std::max(bar->smallest_y, smallmap_window->GetLegendHeight(smallmap_window->min_number_of_columns));
1715 this->fill_x = std::max(display->fill_x, bar->fill_x);
1716 this->fill_y = (display->fill_y == 0 && bar->fill_y == 0) ? 0 : std::min(display->fill_y, bar->fill_y);
1717 this->resize_x = std::max(display->resize_x, bar->resize_x);
1718 this->resize_y = std::min(display->resize_y, bar->resize_y);
1719 }
1720
1721 void AssignSizePosition(SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl) override
1722 {
1723 this->pos_x = x;
1724 this->pos_y = y;
1725 this->current_x = given_width;
1726 this->current_y = given_height;
1727
1728 NWidgetBase *display = this->head;
1729 NWidgetBase *bar = display->next;
1730
1731 if (sizing == ST_SMALLEST) {
1732 this->smallest_x = given_width;
1733 this->smallest_y = given_height;
1734 /* Make display and bar exactly equal to their minimal size. */
1735 display->AssignSizePosition(ST_SMALLEST, x, y, display->smallest_x, display->smallest_y, rtl);
1736 bar->AssignSizePosition(ST_SMALLEST, x, y + display->smallest_y, bar->smallest_x, bar->smallest_y, rtl);
1737 }
1738
1739 uint bar_height = std::max(bar->smallest_y, this->smallmap_window->GetLegendHeight(this->smallmap_window->GetNumberColumnsLegend(given_width - bar->smallest_x)));
1740 uint display_height = given_height - bar_height;
1741 display->AssignSizePosition(ST_RESIZE, x, y, given_width, display_height, rtl);
1742 bar->AssignSizePosition(ST_RESIZE, x, y + display_height, given_width, bar_height, rtl);
1743 }
1744
1745 NWidgetCore *GetWidgetFromPos(int x, int y) override
1746 {
1747 if (!IsInsideBS(x, this->pos_x, this->current_x) || !IsInsideBS(y, this->pos_y, this->current_y)) return nullptr;
1748 for (NWidgetBase *child_wid = this->head; child_wid != nullptr; child_wid = child_wid->next) {
1749 NWidgetCore *widget = child_wid->GetWidgetFromPos(x, y);
1750 if (widget != nullptr) return widget;
1751 }
1752 return nullptr;
1753 }
1754
1755 void Draw(const Window *w) override
1756 {
1757 for (NWidgetBase *child_wid = this->head; child_wid != nullptr; child_wid = child_wid->next) child_wid->Draw(w);
1758 }
1759 };
1760
1762 static const NWidgetPart _nested_smallmap_display[] = {
1763 NWidget(WWT_PANEL, COLOUR_BROWN, WID_SM_MAP_BORDER),
1764 NWidget(WWT_INSET, COLOUR_BROWN, WID_SM_MAP), SetMinimalSize(346, 140), SetResize(1, 1), SetPadding(2, 2, 2, 2), EndContainer(),
1765 EndContainer(),
1766 };
1767
1769 static const NWidgetPart _nested_smallmap_bar[] = {
1770 NWidget(WWT_PANEL, COLOUR_BROWN),
1771 NWidget(NWID_HORIZONTAL),
1772 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SM_LEGEND), SetResize(1, 1),
1773 NWidget(NWID_VERTICAL),
1774 /* Top button row. */
1775 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1776 NWidget(WWT_PUSHIMGBTN, COLOUR_BROWN, WID_SM_ZOOM_IN),
1777 SetDataTip(SPR_IMG_ZOOMIN, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_IN), SetFill(1, 1),
1778 NWidget(WWT_PUSHIMGBTN, COLOUR_BROWN, WID_SM_CENTERMAP),
1779 SetDataTip(SPR_IMG_SMALLMAP, STR_SMALLMAP_CENTER), SetFill(1, 1),
1780 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_BLANK),
1781 SetDataTip(SPR_DOT_SMALL, STR_NULL), SetFill(1, 1),
1782 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_CONTOUR),
1783 SetDataTip(SPR_IMG_SHOW_COUNTOURS, STR_SMALLMAP_TOOLTIP_SHOW_LAND_CONTOURS_ON_MAP), SetFill(1, 1),
1784 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_VEHICLES),
1785 SetDataTip(SPR_IMG_SHOW_VEHICLES, STR_SMALLMAP_TOOLTIP_SHOW_VEHICLES_ON_MAP), SetFill(1, 1),
1786 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_INDUSTRIES),
1787 SetDataTip(SPR_IMG_INDUSTRY, STR_SMALLMAP_TOOLTIP_SHOW_INDUSTRIES_ON_MAP), SetFill(1, 1),
1788 EndContainer(),
1789 /* Bottom button row. */
1790 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1791 NWidget(WWT_PUSHIMGBTN, COLOUR_BROWN, WID_SM_ZOOM_OUT),
1792 SetDataTip(SPR_IMG_ZOOMOUT, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_OUT), SetFill(1, 1),
1793 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_TOGGLETOWNNAME),
1794 SetDataTip(SPR_IMG_TOWN, STR_SMALLMAP_TOOLTIP_TOGGLE_TOWN_NAMES_ON_OFF), SetFill(1, 1),
1795 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_LINKSTATS),
1796 SetDataTip(SPR_IMG_CARGOFLOW, STR_SMALLMAP_TOOLTIP_SHOW_LINK_STATS_ON_MAP), SetFill(1, 1),
1797 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_ROUTES),
1798 SetDataTip(SPR_IMG_SHOW_ROUTES, STR_SMALLMAP_TOOLTIP_SHOW_TRANSPORT_ROUTES_ON), SetFill(1, 1),
1799 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_VEGETATION),
1800 SetDataTip(SPR_IMG_PLANTTREES, STR_SMALLMAP_TOOLTIP_SHOW_VEGETATION_ON_MAP), SetFill(1, 1),
1801 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_OWNERS),
1802 SetDataTip(SPR_IMG_COMPANY_GENERAL, STR_SMALLMAP_TOOLTIP_SHOW_LAND_OWNERS_ON_MAP), SetFill(1, 1),
1803 EndContainer(),
1804 NWidget(NWID_SPACER), SetResize(0, 1),
1805 EndContainer(),
1806 EndContainer(),
1807 EndContainer(),
1808 };
1809
1810 static NWidgetBase *SmallMapDisplay(int *biggest_index)
1811 {
1812 NWidgetContainer *map_display = new NWidgetSmallmapDisplay;
1813
1814 MakeNWidgets(_nested_smallmap_display, lengthof(_nested_smallmap_display), biggest_index, map_display);
1815 MakeNWidgets(_nested_smallmap_bar, lengthof(_nested_smallmap_bar), biggest_index, map_display);
1816 return map_display;
1817 }
1818
1819
1820 static const NWidgetPart _nested_smallmap_widgets[] = {
1821 NWidget(NWID_HORIZONTAL),
1822 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1823 NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SM_CAPTION), SetDataTip(STR_SMALLMAP_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1824 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1825 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1826 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1827 EndContainer(),
1828 NWidgetFunction(SmallMapDisplay), // Smallmap display and legend bar + image buttons.
1829 /* Bottom button row and resize box. */
1830 NWidget(NWID_HORIZONTAL),
1831 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_SM_SELECT_BUTTONS),
1832 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1833 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_SM_ENABLE_ALL), SetDataTip(STR_SMALLMAP_ENABLE_ALL, STR_NULL),
1834 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_SM_DISABLE_ALL), SetDataTip(STR_SMALLMAP_DISABLE_ALL, STR_NULL),
1835 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SM_SHOW_HEIGHT), SetDataTip(STR_SMALLMAP_SHOW_HEIGHT, STR_SMALLMAP_TOOLTIP_SHOW_HEIGHT),
1836 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 0), SetResize(1, 0),
1837 EndContainer(),
1838 EndContainer(),
1839 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 0), SetResize(1, 0),
1840 EndContainer(),
1841 EndContainer(),
1842 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
1843 EndContainer(),
1844 };
1845
1846 static WindowDesc _smallmap_desc(
1847 WDP_AUTO, "smallmap", 484, 314,
1848 WC_SMALLMAP, WC_NONE,
1849 0,
1850 _nested_smallmap_widgets, lengthof(_nested_smallmap_widgets)
1851 );
1852
1856 void ShowSmallMap()
1857 {
1858 AllocateWindowDescFront<SmallMapWindow>(&_smallmap_desc, 0);
1859 }
1860
1869 bool ScrollMainWindowTo(int x, int y, int z, bool instant)
1870 {
1871 bool res = ScrollWindowTo(x, y, z, FindWindowById(WC_MAIN_WINDOW, 0), instant);
1872
1873 /* If a user scrolls to a tile (via what way what so ever) and already is on
1874 * that tile (e.g.: pressed twice), move the smallmap to that location,
1875 * so you directly see where you are on the smallmap. */
1876
1877 if (res) return res;
1878
1879 SmallMapWindow *w = dynamic_cast<SmallMapWindow*>(FindWindowById(WC_SMALLMAP, 0));
1880 if (w != nullptr) w->SmallMapCenterOnCurrentPos();
1881
1882 return res;
1883 }
_sorted_industry_types
std::array< IndustryType, NUM_INDUSTRYTYPES > _sorted_industry_types
Industry types sorted by name.
Definition: industry_gui.cpp:185
PC_WHITE
static const uint8 PC_WHITE
White palette colour.
Definition: gfx_func.h:209
MP_CLEAR
@ MP_CLEAR
A tile without any structures, i.e. grass, rocks, farm fields etc.
Definition: tile_type.h:41
MP_HOUSE
@ MP_HOUSE
A house by a town.
Definition: tile_type.h:44
BuildOwnerLegend
void BuildOwnerLegend()
Completes the array for the owned property legend.
Definition: smallmap_gui.cpp:325
LegendAndColour::type
IndustryType type
Type of industry. Only valid for industry entries.
Definition: smallmap_gui.h:34
WD_FRAMERECT_TOP
@ WD_FRAMERECT_TOP
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:62
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
LinkGraphOverlay::LINK_COLOURS
static const uint8 LINK_COLOURS[]
Colours for the various "load" states of links.
Definition: linkgraph_gui.h:43
RoadTypeInfo
Definition: road.h:75
sound_func.h
GetSmallMapRoutesPixels
static uint32 GetSmallMapRoutesPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Routes".
Definition: smallmap_gui.cpp:452
NUM_INDUSTRYTYPES
static const IndustryType NUM_INDUSTRYTYPES
total number of industry types, new and old; limited to 240 because we need some special ids like INV...
Definition: industry_type.h:26
_green_map_heights
static const uint32 _green_map_heights[]
Height map colours for the green colour scheme, ordered by height.
Definition: heightmap_colours.h:13
SmallMapWindow::min_number_of_fixed_rows
uint min_number_of_fixed_rows
Minimal number of rows in the legends for the fixed layouts only (all except #SMT_INDUSTRY).
Definition: smallmap_gui.h:73
IndustrySpec::map_colour
byte map_colour
colour used for the small map
Definition: industrytype.h:126
_smallmap_show_heightmap
static bool _smallmap_show_heightmap
Show heightmap in industry and owner mode of smallmap window.
Definition: smallmap_gui.cpp:157
NWidgetFunction
static NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
Definition: widget_type.h:1145
Blitter::SetPixel
virtual void SetPixel(void *video, int x, int y, uint8 colour)=0
Draw a pixel with a given colour on the video-buffer.
WC_INDUSTRY_CARGOES
@ WC_INDUSTRY_CARGOES
Industry cargoes chain; Window numbers:
Definition: window_type.h:504
WID_SM_ROUTES
@ WID_SM_ROUTES
Button to select the routes view.
Definition: smallmap_widget.h:26
SmallMapWindow::map_type
static SmallMapType map_type
Currently displayed legends.
Definition: smallmap_gui.h:63
ScrollWindowTo
bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2397
NWidgetSmallmapDisplay::Draw
void Draw(const Window *w) override
Definition: smallmap_gui.cpp:1755
SmallMapWindow::LEGEND_BLOB_WIDTH
static const uint LEGEND_BLOB_WIDTH
Width of the coloured blob in front of a line text in the WID_SM_LEGEND widget.
Definition: smallmap_gui.h:67
WID_SM_VEGETATION
@ WID_SM_VEGETATION
Button to select the vegetation view.
Definition: smallmap_widget.h:27
endian_func.hpp
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1045
ConstructionSettings::max_heightlevel
uint8 max_heightlevel
maximum allowed heightlevel
Definition: settings_type.h:317
PC_YELLOW
static const uint8 PC_YELLOW
Yellow palette colour.
Definition: gfx_func.h:219
PC_DARK_RED
static const uint8 PC_DARK_RED
Dark red palette colour.
Definition: gfx_func.h:212
smallmap_gui.h
GameCreationSettings::landscape
byte landscape
the landscape we're currently in
Definition: settings_type.h:305
guitimer_func.h
SmallMapColourScheme::height_colours_base
const uint32 * height_colours_base
Base table for determining the colours.
Definition: smallmap_gui.cpp:259
_sorted_cargo_specs
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:132
MOEND
#define MOEND()
Macro used for forcing a rebuild of the owner legend the first time it is used.
Definition: smallmap_gui.cpp:53
Window::ReInit
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:995
company_base.h
TRANSPORT_RAIL
@ TRANSPORT_RAIL
Transport by train.
Definition: transport_type.h:27
SmallMapWindow::ZLC_ZOOM_IN
@ ZLC_ZOOM_IN
Zoom in.
Definition: smallmap_gui.h:60
tunnelbridge_map.h
SmallMapWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: smallmap_gui.cpp:1184
Blitter
How all blitters should look like.
Definition: base.hpp:28
_smallmap_cargo_count
static int _smallmap_cargo_count
Number of cargos in the link stats legend.
Definition: smallmap_gui.cpp:36
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
Station
Station data structure.
Definition: station_base.h:450
SmallMapWindow::SmallMapCenterOnCurrentPos
void SmallMapCenterOnCurrentPos()
Center the small map on the current center of the viewport.
Definition: smallmap_gui.cpp:1652
WWT_IMGBTN
@ WWT_IMGBTN
(Toggle) Button with image
Definition: widget_type.h:50
INVALID_ROADTYPE
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition: road_type.h:27
Window::viewport
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:326
PC_ORANGE
static const uint8 PC_ORANGE
Orange palette colour.
Definition: gfx_func.h:217
PC_RED
static const uint8 PC_RED
Red palette colour.
Definition: gfx_func.h:213
SmallMapWindow::DrawHorizMapIndicator
static void DrawHorizMapIndicator(int x, int x2, int y)
Draws horizontal part of map indicator.
Definition: smallmap_gui.h:105
LegendAndColour::company
CompanyID company
Company to display. Only valid for company entries of the owner legend.
Definition: smallmap_gui.h:36
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
MS
#define MS(a, b)
Macro for break marker in arrays of LegendAndColour.
Definition: smallmap_gui.cpp:62
SmallMapWindow::OnRightClick
bool OnRightClick(Point pt, int widget) override
A click with the right mouse button has been made on the window.
Definition: smallmap_gui.cpp:1560
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
PC_RAINFOREST
static const uint8 PC_RAINFOREST
Pale green palette colour for rainforest.
Definition: gfx_func.h:232
TROPICZONE_RAINFOREST
@ TROPICZONE_RAINFOREST
Rainforest tile.
Definition: tile_type.h:72
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1133
SmallMapWindow::GetOverlayCompanyMask
uint32 GetOverlayCompanyMask() const
Get a bitmask for company links to be displayed.
Definition: smallmap_gui.h:145
CLEAR_GRASS
@ CLEAR_GRASS
0-3
Definition: clear_map.h:20
IsClearGround
static bool IsClearGround(TileIndex t, ClearGround ct)
Set the type of clear tile.
Definition: clear_map.h:71
SmallMapWindow::SetupWidgetData
void SetupWidgetData()
Function to set up widgets depending on the information being shown on the smallmap.
Definition: smallmap_gui.cpp:1032
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
MP_RAILWAY
@ MP_RAILWAY
A railway.
Definition: tile_type.h:42
SND_15_BEEP
@ SND_15_BEEP
19 == 0x13 GUI button click
Definition: sound_type.h:58
vehicle_base.h
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:929
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:13
WID_SM_LEGEND
@ WID_SM_LEGEND
Bottom panel to display smallmap legends.
Definition: smallmap_widget.h:18
SmallMapWindow::GetTileColours
uint32 GetTileColours(const TileArea &ta) const
Decide which colours to show to the user for a group of tiles.
Definition: smallmap_gui.cpp:746
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:79
WID_SM_CONTOUR
@ WID_SM_CONTOUR
Button to select the contour view (height map).
Definition: smallmap_widget.h:22
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:640
SmallMapColourScheme::default_colour
uint32 default_colour
Default colour of the land.
Definition: smallmap_gui.cpp:261
CargoSpec
Specification of a cargo type.
Definition: cargotype.h:55
VSM_VIEWPORT_RMB_FIXED
@ VSM_VIEWPORT_RMB_FIXED
Viewport moves with mouse movement on holding right mouse button, cursor position is fixed.
Definition: settings_type.h:84
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
MP_INDUSTRY
@ MP_INDUSTRY
Part of an industry.
Definition: tile_type.h:49
town.h
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
_smallmap_industry_count
static int _smallmap_industry_count
Number of used industries.
Definition: smallmap_gui.cpp:34
SmallMapWindow::zoom
int zoom
Zoom level. Bigger number means more zoom-out (further away).
Definition: smallmap_gui.h:79
MAX_TILE_HEIGHT
static const uint MAX_TILE_HEIGHT
Maximum allowed tile height.
Definition: tile_type.h:22
WID_SM_SHOW_HEIGHT
@ WID_SM_SHOW_HEIGHT
Show heightmap toggle button.
Definition: smallmap_widget.h:34
TransportType
TransportType
Available types of transport.
Definition: transport_type.h:19
clear_map.h
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:222
PC_GRASS_LAND
static const uint8 PC_GRASS_LAND
Dark green palette colour for grass land.
Definition: gfx_func.h:230
Window::HandleButtonClick
void HandleButtonClick(byte widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition: window.cpp:635
Viewport::virtual_top
int virtual_top
Virtual top coordinate.
Definition: viewport_type.h:29
SmallMapWindow::SwitchMapType
void SwitchMapType(SmallMapType map_type)
Select a new map type.
Definition: smallmap_gui.cpp:1300
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
NWidgetBase::smallest_y
uint smallest_y
Smallest vertical size of the widget in a filled window.
Definition: widget_type.h:170
MakeNWidgets
NWidgetContainer * MakeNWidgets(const NWidgetPart *parts, int count, int *biggest_index, NWidgetContainer *container)
Construct a nested widget tree from an array of parts.
Definition: widget.cpp:2799
NWidgetSmallmapDisplay
Custom container class for displaying smallmap with a vertically resizing legend panel.
Definition: smallmap_gui.cpp:1695
MP_ROAD
@ MP_ROAD
A tile with road (or tram tracks)
Definition: tile_type.h:43
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:52
SmallMapWindow::column_width
uint column_width
Width of a column in the WID_SM_LEGEND widget.
Definition: smallmap_gui.h:74
SmallMapWindow::OnInit
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: smallmap_gui.cpp:1134
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:199
SmallMapWindow::min_number_of_columns
uint min_number_of_columns
Minimal number of columns in legends.
Definition: smallmap_gui.h:72
_dark_green_map_heights
static const uint32 _dark_green_map_heights[]
Height map colours for the dark green colour scheme, ordered by height.
Definition: heightmap_colours.h:132
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:909
SmallMapWindow::scroll_x
int32 scroll_x
Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display.
Definition: smallmap_gui.h:76
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1013
SmallMapWindow
Class managing the smallmap window.
Definition: smallmap_gui.h:43
SmallMapWindow::show_towns
static bool show_towns
Display town names in the smallmap.
Definition: smallmap_gui.h:64
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:842
GetClearGround
static ClearGround GetClearGround(TileIndex t)
Get the type of clear tile.
Definition: clear_map.h:59
LinkGraphOverlay::SetCompanyMask
void SetCompanyMask(uint32 company_mask)
Set a new company mask and rebuild the cache.
Definition: linkgraph_gui.cpp:368
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
SmallMapWindow::GetNumberColumnsLegend
uint GetNumberColumnsLegend(uint width) const
Return number of columns that can be displayed in width pixels.
Definition: smallmap_gui.h:124
SmallMapWindow::DrawSmallMap
void DrawSmallMap(DrawPixelInfo *dpi) const
Draws the small map.
Definition: smallmap_gui.cpp:968
GameSettings::game_creation
GameCreationSettings game_creation
settings used during the creation of a game (map)
Definition: settings_type.h:560
SmallMapWindow::GetStationMiddle
Point GetStationMiddle(const Station *st) const
Get the center of the given station as point on the screen in the smallmap window.
Definition: smallmap_gui.cpp:1670
IsInsideMM
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
Definition: math_func.hpp:204
SmallMapWindow::SetZoomLevel
void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt)
Initialize or change the zoom level.
Definition: smallmap_gui.cpp:697
IsTileOnWater
static bool IsTileOnWater(TileIndex t)
Tests if the tile was built on water.
Definition: water_map.h:130
_smallmap_industry_highlight_state
static bool _smallmap_industry_highlight_state
State of highlight blinking.
Definition: smallmap_gui.cpp:161
WindowDesc
High level window description.
Definition: window_gui.h:166
SmallMapWindow::ComputeScroll
Point ComputeScroll(int tx, int ty, int x, int y, int *sub)
Compute base parameters of the smallmap such that tile (tx, ty) starts at pixel (x,...
Definition: smallmap_gui.cpp:669
TRANSPORT_ROAD
@ TRANSPORT_ROAD
Transport by road vehicle.
Definition: transport_type.h:28
GetRailTypeInfo
static const RailtypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:304
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:428
SmallMapWindow::GetMinLegendWidth
uint GetMinLegendWidth() const
Compute minimal required width of the legends.
Definition: smallmap_gui.h:115
GUISettings::scrollwheel_scrolling
uint8 scrollwheel_scrolling
scrolling using the scroll wheel?
Definition: settings_type.h:130
WID_SM_SELECT_BUTTONS
@ WID_SM_SELECT_BUTTONS
Selection widget for the buttons present in some smallmap modes.
Definition: smallmap_widget.h:31
LinkGraphOverlay
Handles drawing of links into some window.
Definition: linkgraph_gui.h:37
VS_HIDDEN
@ VS_HIDDEN
Vehicle is not visible.
Definition: vehicle_base.h:30
CargoSpec::Index
CargoID Index() const
Determines index of this cargospec.
Definition: cargotype.h:88
Viewport
Data structure for viewport, display of a part of the world.
Definition: viewport_type.h:22
GUITimer
Definition: guitimer_func.h:13
_nested_smallmap_bar
static const NWidgetPart _nested_smallmap_bar[]
Widget parts of the smallmap legend bar + image buttons.
Definition: smallmap_gui.cpp:1769
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:154
SmallMapWindow::ZoomLevelChange
ZoomLevelChange
Available kinds of zoomlevel changes.
Definition: smallmap_gui.h:57
GetClearDensity
static uint GetClearDensity(TileIndex t)
Get the density of a non-field clear tile.
Definition: clear_map.h:83
SmallMapWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: smallmap_gui.cpp:1531
SmallMapWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: smallmap_gui.cpp:1415
SmallMapWindow::GetNumberRowsLegend
uint GetNumberRowsLegend(uint columns) const
Get the number of rows in the legend from the number of columns.
Definition: smallmap_gui.cpp:1321
InverseRemapCoords
static Point InverseRemapCoords(int x, int y)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Definition: landscape.h:112
SmallMapWindow::ZLC_ZOOM_OUT
@ ZLC_ZOOM_OUT
Zoom out.
Definition: smallmap_gui.h:59
ST_SMALLEST
@ ST_SMALLEST
Initialize nested widget tree to smallest size. Also updates current_x and current_y.
Definition: widget_type.h:110
SmallMapWindow::DrawVehicles
void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
Adds vehicles to the smallmap.
Definition: smallmap_gui.cpp:875
TILE_AREA_LOOP
#define TILE_AREA_LOOP(var, ta)
A loop which iterates over the tiles of a TileArea.
Definition: tilearea_type.h:232
TileHeight
static uint TileHeight(TileIndex tile)
Returns the height of a tile.
Definition: tile_map.h:29
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:580
WID_SM_LINKSTATS
@ WID_SM_LINKSTATS
Button to select the link stats view.
Definition: smallmap_widget.h:25
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1861
Industry::GetByTile
static Industry * GetByTile(TileIndex tile)
Get the industry of the given tile.
Definition: industry.h:144
_vehicle_type_colours
static const byte _vehicle_type_colours[6]
Vehicle colours in #SMT_VEHICLES mode.
Definition: smallmap_gui.cpp:588
LinkGraphOverlay::SetCargoMask
void SetCargoMask(CargoTypes cargo_mask)
Set a new cargo mask and rebuild the cache.
Definition: linkgraph_gui.cpp:357
Pool::MAX_SIZE
static const size_t MAX_SIZE
Make template parameter accessible from outside.
Definition: pool_type.hpp:85
SmallMapWindow::DrawVertMapIndicator
static void DrawVertMapIndicator(int x, int y, int y2)
Draws vertical part of map indicator.
Definition: smallmap_gui.h:93
Viewport::virtual_left
int virtual_left
Virtual left coordinate.
Definition: viewport_type.h:28
Industry::type
IndustryType type
type of industry.
Definition: industry.h:83
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:320
BaseStation::rect
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
Definition: base_station_base.h:76
LegendAndColour::col_break
bool col_break
Perform a column break and go further at the next column.
Definition: smallmap_gui.h:39
WID_SM_ZOOM_IN
@ WID_SM_ZOOM_IN
Button to zoom in one step.
Definition: smallmap_widget.h:20
WID_SM_VEHICLES
@ WID_SM_VEHICLES
Button to select the vehicles view.
Definition: smallmap_widget.h:23
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
NWidgetBase::smallest_x
uint smallest_x
Smallest horizontal size of the widget in a filled window.
Definition: widget_type.h:169
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
_legend_land_contours
static LegendAndColour _legend_land_contours[]
Legend text giving the colours to look for on the minimap.
Definition: smallmap_gui.cpp:65
SmallMapWindow::DrawMapIndicators
void DrawMapIndicators() const
Adds map indicators to the smallmap.
Definition: smallmap_gui.cpp:936
heightmap_colours.h
NWidgetBase::AssignSizePosition
virtual void AssignSizePosition(SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl)=0
WID_SM_DISABLE_ALL
@ WID_SM_DISABLE_ALL
Button to disable display of all legend entries.
Definition: smallmap_widget.h:33
IsInsideBS
static bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
Definition: math_func.hpp:188
MP_WATER
@ MP_WATER
Water tile.
Definition: tile_type.h:47
_smallmap_contours_andor
static const AndOr _smallmap_contours_andor[]
Colour masks for "Contour" and "Routes" modes.
Definition: smallmap_gui.cpp:359
SmallMapColourScheme
Colour scheme of the smallmap.
Definition: smallmap_gui.cpp:257
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:61
GetStationType
static StationType GetStationType(TileIndex t)
Get the station type of this tile.
Definition: station_map.h:44
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:124
_smallmap_company_count
static int _smallmap_company_count
Number of entries in the owner legend.
Definition: smallmap_gui.cpp:35
_tiletype_importance
static const byte _tiletype_importance[]
Mapping of tile type to importance of the tile (higher number means more interesting to show).
Definition: smallmap_gui.cpp:391
SmallMapWindow::max_heightlevel
static int max_heightlevel
Currently used/cached maximum heightlevel.
Definition: smallmap_gui.h:65
_legend_from_industries
static LegendAndColour _legend_from_industries[NUM_INDUSTRYTYPES+1]
Allow room for all industries, plus a terminator entry This is required in order to have the industry...
Definition: smallmap_gui.cpp:153
_smallmap_industry_highlight
static IndustryType _smallmap_industry_highlight
Highlight a specific industry type.
Definition: smallmap_gui.cpp:159
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:16
VEH_EFFECT
@ VEH_EFFECT
Effect vehicle type (smoke, explosions, sparks, bubbles)
Definition: vehicle_type.h:31
MC
#define MC(col_break)
Macro for a height legend entry with configurable colour.
Definition: smallmap_gui.cpp:47
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:80
BlitterFactory::GetCurrentBlitter
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:140
GetTropicZone
static TropicZone GetTropicZone(TileIndex tile)
Get the tropic zone.
Definition: tile_map.h:238
SmallMapWindow::GetPositionOnLegend
int GetPositionOnLegend(Point pt)
Determines the mouse position on the legend.
Definition: smallmap_gui.cpp:1382
LegendAndColour::legend
StringID legend
String corresponding to the coloured item.
Definition: smallmap_gui.h:33
WID_SM_BLANK
@ WID_SM_BLANK
Empty button as placeholder.
Definition: smallmap_widget.h:19
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:392
MAX_COMPANIES
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
industry.h
safeguards.h
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:317
ConstructionSettings::freeform_edges
bool freeform_edges
allow terraforming the tiles at the map edges
Definition: settings_type.h:329
CursorVars::fix_at
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition: gfx_type.h:120
_industry_to_list_pos
static uint _industry_to_list_pos[NUM_INDUSTRYTYPES]
For connecting industry type to position in industries list(small map legend)
Definition: smallmap_gui.cpp:155
_displayed_industries
std::bitset< NUM_INDUSTRYTYPES > _displayed_industries
Communication from the industry chain window to the smallmap window about what industries to display.
Definition: industry_gui.cpp:49
_smallmap_vehicles_andor
static const AndOr _smallmap_vehicles_andor[]
Colour masks for "Vehicles", "Industry", and "Vegetation" modes.
Definition: smallmap_gui.cpp:375
MP_TUNNELBRIDGE
@ MP_TUNNELBRIDGE
Tunnel entry/exit and bridge heads.
Definition: tile_type.h:50
_heightmap_schemes
static SmallMapColourScheme _heightmap_schemes[]
Available colour schemes for height maps.
Definition: smallmap_gui.cpp:265
VSM_MAP_RMB_FIXED
@ VSM_MAP_RMB_FIXED
Map moves with mouse movement on holding right mouse button, cursor position is fixed.
Definition: settings_type.h:85
Viewport::virtual_width
int virtual_width
width << zoom
Definition: viewport_type.h:30
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
ScrollMainWindowTo
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
Definition: smallmap_gui.cpp:1869
GetSmallMapIndustriesPixels
static uint32 GetSmallMapIndustriesPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Industries".
Definition: smallmap_gui.cpp:439
SmallMapWindow::SmallMapType
SmallMapType
Types of legends in the WID_SM_LEGEND widget.
Definition: smallmap_gui.h:46
NWidgetContainer::head
NWidgetBase * head
Pointer to first widget in container.
Definition: widget_type.h:381
stdafx.h
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:206
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:114
landscape.h
IndustrySpec
Defines the data structure for constructing industry.
Definition: industrytype.h:107
Window::InvalidateData
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3261
SmallMapWindow::DrawSmallMapColumn
void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const
Draws one column of tiles of the small map in a certain mode onto the screen buffer,...
Definition: smallmap_gui.cpp:835
viewport_func.h
Window::mouse_capture_widget
int mouse_capture_widget
Widgetindex of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse captu...
Definition: window_gui.h:335
NWidgetBase::current_y
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:173
SmallMapWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: smallmap_gui.cpp:1200
PC_TREES
static const uint8 PC_TREES
Green palette colour for trees.
Definition: gfx_func.h:234
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
GetSmallMapOwnerPixels
static uint32 GetSmallMapOwnerPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Owner".
Definition: smallmap_gui.cpp:562
InverseRemapCoords2
Point InverseRemapCoords2(int x, int y, bool clamp_to_map, bool *clamped)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Definition: landscape.cpp:103
PC_GREY
static const uint8 PC_GREY
Grey palette colour.
Definition: gfx_func.h:208
SmallMapWindow::BreakIndustryChainLink
static void BreakIndustryChainLink()
Notify the industry chain window to stop sending newly selected industries.
Definition: smallmap_gui.cpp:594
NWidgetBase::next
NWidgetBase * next
Pointer to next widget in container. Managed by parent container widget.
Definition: widget_type.h:178
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
GetTileOwner
static Owner GetTileOwner(TileIndex tile)
Returns the owner of a tile.
Definition: tile_map.h:178
FillDrawPixelInfo
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition: gfx.cpp:1616
FONT_HEIGHT_SMALL
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:176
SmallMapWindow::OnRealtimeTick
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition: smallmap_gui.cpp:1581
PC_FIELDS
static const uint8 PC_FIELDS
Light brown palette colour for fields.
Definition: gfx_func.h:233
BuildIndustriesLegend
void BuildIndustriesLegend()
Fills an array for the industries legends.
Definition: smallmap_gui.cpp:168
IsTileForestIndustry
bool IsTileForestIndustry(TileIndex tile)
Check whether the tile is a forest.
Definition: industry_cmd.cpp:962
MP_TREES
@ MP_TREES
Tile got trees.
Definition: tile_type.h:45
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
MK
#define MK(a, b)
Macro for ordinary entry of LegendAndColour.
Definition: smallmap_gui.cpp:44
PC_VERY_DARK_BROWN
static const uint8 PC_VERY_DARK_BROWN
Almost-black brown palette colour.
Definition: gfx_func.h:215
WID_SM_ZOOM_OUT
@ WID_SM_ZOOM_OUT
Button to zoom out one step.
Definition: smallmap_widget.h:21
IndustrySpec::enabled
bool enabled
entity still available (by default true).newgrf can disable it, though
Definition: industrytype.h:140
MKEND
#define MKEND()
Macro for end of list marker in arrays of LegendAndColour.
Definition: smallmap_gui.cpp:56
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:103
NWidgetBase::fill_y
uint fill_y
Vertical fill stepsize (from initial size, 0 means not resizable).
Definition: widget_type.h:163
SmallMapWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: smallmap_gui.cpp:1125
WID_SM_OWNERS
@ WID_SM_OWNERS
Button to select the owners view.
Definition: smallmap_widget.h:28
SmallMapWindow::subscroll
int32 subscroll
Number of pixels (0..3) between the right end of the base tile and the pixel at the top-left corner o...
Definition: smallmap_gui.h:78
SmallMapWindow::OnScroll
void OnScroll(Point delta) override
Handle the request for (viewport) scrolling.
Definition: smallmap_gui.cpp:1637
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:998
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
Pool::PoolItem<&_company_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:378
Industry::GetIndustryTypeCount
static uint16 GetIndustryTypeCount(IndustryType type)
Get the count of industries for this type.
Definition: industry.h:179
NWidgetSmallmapDisplay::AssignSizePosition
void AssignSizePosition(SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl) override
Definition: smallmap_gui.cpp:1721
MapMaxY
static uint MapMaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition: map_func.h:111
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:175
GetSmallMapLinkStatsPixels
static uint32 GetSmallMapLinkStatsPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "link stats".
Definition: smallmap_gui.cpp:508
MP_VOID
@ MP_VOID
Invisible tiles at the SW and SE border.
Definition: tile_type.h:48
SmallMapWindow::OnMouseOver
void OnMouseOver(Point pt, int widget) override
The mouse is currently moving over the window or has just moved outside of the window.
Definition: smallmap_gui.cpp:1398
ST_RESIZE
@ ST_RESIZE
Resize the nested widget tree.
Definition: widget_type.h:111
Blitter::MoveTo
virtual void * MoveTo(void *video, int x, int y)=0
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
TileXY
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition: map_func.h:163
INVALID_INDUSTRYTYPE
static const IndustryType INVALID_INDUSTRYTYPE
one above amount is considered invalid
Definition: industry_type.h:27
SmallMapWindow::SetOverlayCargoMask
void SetOverlayCargoMask()
Set the link graph overlay cargo mask from the legend.
Definition: smallmap_gui.cpp:1368
SmallMapWindow::SetNewScroll
void SetNewScroll(int sx, int sy, int sub)
Set new scroll_x, scroll_y, and subscroll values after limiting them such that the center of the smal...
Definition: smallmap_gui.cpp:1607
_violet_map_heights
static const uint32 _violet_map_heights[]
Height map colours for the violet colour scheme, ordered by height.
Definition: heightmap_colours.h:235
TileType
TileType
The different types of tiles.
Definition: tile_type.h:40
SmallMapWindow::INDUSTRY_MIN_NUMBER_OF_COLUMNS
static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS
Minimal number of columns in the WID_SM_LEGEND widget for the #SMT_INDUSTRY legend.
Definition: smallmap_gui.h:68
PC_ROUGH_LAND
static const uint8 PC_ROUGH_LAND
Dark green palette colour for rough land.
Definition: gfx_func.h:229
LegendAndColour::height
uint8 height
Height in tiles. Only valid for height legend entries.
Definition: smallmap_gui.h:35
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1113
NWidgetBase::fill_x
uint fill_x
Horizontal fill stepsize (from initial size, 0 means not resizable).
Definition: widget_type.h:162
LegendAndColour::colour
uint8 colour
Colour of the item on the map.
Definition: smallmap_gui.h:32
LinkGraphOverlay::Draw
void Draw(const DrawPixelInfo *dpi)
Draw the linkgraph overlay or some part of it, in the area given.
Definition: linkgraph_gui.cpp:239
InvalidateWindowClassesData
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3339
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:946
tree_map.h
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
GetRailType
static RailType GetRailType(TileIndex t)
Gets the rail type of the given tile.
Definition: rail_map.h:115
NWidgetBase::resize_y
uint resize_y
Vertical resize step (0 means not resizable).
Definition: widget_type.h:165
ShowSmallMap
void ShowSmallMap()
Show the smallmap window.
Definition: smallmap_gui.cpp:1856
MP_STATION
@ MP_STATION
A tile of a station.
Definition: tile_type.h:46
LegendAndColour::show_on_map
bool show_on_map
For filtering industries, if true, industry is shown on the map in colour.
Definition: smallmap_gui.h:37
RoadTypeInfo::map_colour
byte map_colour
Colour on mini-map.
Definition: road.h:154
NUM_CARGO
@ NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:64
NWidgetSmallmapDisplay::SetupSmallestSize
void SetupSmallestSize(Window *w, bool init_array) override
Definition: smallmap_gui.cpp:1703
WID_SM_INDUSTRIES
@ WID_SM_INDUSTRIES
Button to select the industries view.
Definition: smallmap_widget.h:24
SmallMapWindow::DrawTowns
void DrawTowns(const DrawPixelInfo *dpi) const
Adds town names to the smallmap.
Definition: smallmap_gui.cpp:913
GetRoadTypeInfo
static const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition: road.h:224
_company_to_list_pos
static uint _company_to_list_pos[MAX_COMPANIES]
For connecting company ID to position in owner list (small map legend)
Definition: smallmap_gui.cpp:163
CargoSpec::name
StringID name
Name of this type of cargo.
Definition: cargotype.h:70
WC_MAIN_WINDOW
@ WC_MAIN_WINDOW
Main window; Window numbers:
Definition: window_type.h:44
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:77
WWT_INSET
@ WWT_INSET
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:49
MapMaxX
static uint MapMaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition: map_func.h:102
PC_WATER
static const uint8 PC_WATER
Dark blue palette colour for water.
Definition: gfx_func.h:235
NWidgetContainer
Baseclass for container widgets.
Definition: widget_type.h:367
Window::top
int top
y position of top edge of the window
Definition: window_gui.h:318
GetTreeGround
static TreeGround GetTreeGround(TileIndex t)
Returns the groundtype for tree tiles.
Definition: tree_map.h:88
GUITimer::Elapsed
bool Elapsed(uint delta)
Test if a timer has elapsed.
Definition: guitimer_func.h:55
TileArea
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Definition: tilearea_type.h:96
SmallMapWindow::RemapTile
Point RemapTile(int tile_x, int tile_y) const
Remap tile to location on this smallmap.
Definition: smallmap_gui.cpp:613
GUISettings::smallmap_land_colour
uint8 smallmap_land_colour
colour used for land and heightmap at the smallmap
Definition: settings_type.h:105
VS_UNCLICKABLE
@ VS_UNCLICKABLE
Vehicle is not clickable by the user (shadow vehicles).
Definition: vehicle_base.h:32
WID_SM_TOGGLETOWNNAME
@ WID_SM_TOGGLETOWNNAME
Toggle button to display town names.
Definition: smallmap_widget.h:30
LinkGraphOverlay::SetDirty
void SetDirty()
Mark the linkgraph dirty to be rebuilt next time Draw() is called.
Definition: linkgraph_gui.h:62
station_map.h
window_func.h
_legend_linkstats
static LegendAndColour _legend_linkstats[NUM_CARGO+lengthof(_linkstat_colours_in_legenda)+1]
Legend entries for the link stats view.
Definition: smallmap_gui.cpp:148
SoundSettings::click_beep
bool click_beep
Beep on a random selection of buttons.
Definition: settings_type.h:198
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
Town
Town data structure.
Definition: town.h:50
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:367
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:319
NWidgetBase::pos_y
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:176
LinkGraphOverlay::GetCompanyMask
uint32 GetCompanyMask()
Get a bitmask of the currently shown companies.
Definition: linkgraph_gui.h:68
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:83
WID_SM_MAP
@ WID_SM_MAP
Panel containing the smallmap.
Definition: smallmap_widget.h:17
INVALID_COMPANY
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
TILE_HEIGHT_STEP
static const int TILE_HEIGHT_STEP
One Z unit tile height difference is displayed as 50m.
Definition: viewport_func.h:19
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:982
TREE_GROUND_SNOW_DESERT
@ TREE_GROUND_SNOW_DESERT
a desert or snow tile, depend on landscape
Definition: tree_map.h:55
AndOr
Definition: smallmap_gui.cpp:347
CeilDiv
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:254
GameSettings::construction
ConstructionSettings construction
construction of things in-game
Definition: settings_type.h:561
SmallMapWindow::refresh
GUITimer refresh
Refresh timer.
Definition: smallmap_gui.h:81
GetIndustrySpec
const IndustrySpec * GetIndustrySpec(IndustryType thistype)
Accessor for array _industry_specs.
Definition: industry_cmd.cpp:121
WID_SM_MAP_BORDER
@ WID_SM_MAP_BORDER
Border around the smallmap.
Definition: smallmap_widget.h:16
SmallMapWindow::scroll_y
int32 scroll_y
Vertical world coordinate of the base tile left of the top-left corner of the smallmap display.
Definition: smallmap_gui.h:77
Window
Data structure for an opened window.
Definition: window_gui.h:276
SizingType
SizingType
Different forms of sizing nested widgets, using NWidgetBase::AssignSizePosition()
Definition: widget_type.h:109
GetTileType
static TileType GetTileType(TileIndex tile)
Get the tiletype of a given tile.
Definition: tile_map.h:96
IndustrySpec::name
StringID name
Displayed name of the industry.
Definition: industrytype.h:127
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:318
Window::RaiseWidget
void RaiseWidget(byte widget_index)
Marks a widget as raised.
Definition: window_gui.h:483
SmallMapWindow::SelectLegendItem
void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item=0)
Select and toggle a legend item.
Definition: smallmap_gui.cpp:1340
GUISettings::scroll_mode
uint8 scroll_mode
viewport scroll mode
Definition: settings_type.h:106
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:602
SmallMapWindow::RebuildColourIndexIfNecessary
void RebuildColourIndexIfNecessary()
Rebuilds the colour indices used for fast access to the smallmap contour colours based on the heightl...
Definition: smallmap_gui.cpp:1103
PC_DARK_GREY
static const uint8 PC_DARK_GREY
Dark grey palette colour.
Definition: gfx_func.h:207
Viewport::virtual_height
int virtual_height
height << zoom
Definition: viewport_type.h:31
SmallMapWindow::ZLC_INITIALIZE
@ ZLC_INITIALIZE
Initialize zoom level.
Definition: smallmap_gui.h:58
SmallMapColourScheme::height_colours
uint32 * height_colours
Cached colours for each level in a map.
Definition: smallmap_gui.cpp:258
PC_LIGHT_BLUE
static const uint8 PC_LIGHT_BLUE
Light blue palette colour.
Definition: gfx_func.h:227
GetSmallMapVehiclesPixels
static uint32 GetSmallMapVehiclesPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Vehicles".
Definition: smallmap_gui.cpp:426
NWID_SELECTION
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition: widget_type.h:78
OrthogonalTileArea::ClampToMap
void ClampToMap()
Clamp the tile area to map borders.
Definition: tilearea.cpp:142
MO
#define MO(a, b)
Macro for non-company owned property entry of LegendAndColour.
Definition: smallmap_gui.cpp:50
NWidgetCore
Base class for a 'real' widget.
Definition: widget_type.h:282
GetTunnelBridgeTransportType
static TransportType GetTunnelBridgeTransportType(TileIndex t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
Definition: tunnelbridge_map.h:39
LegendAndColour
Structure for holding relevant data for legends in small map.
Definition: smallmap_gui.h:31
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
CursorVars::pos
Point pos
logical mouse position
Definition: gfx_type.h:117
Window::LowerWidget
void LowerWidget(byte widget_index)
Marks a widget as lowered.
Definition: window_gui.h:474
Company
Definition: company_base.h:110
LegendAndColour::end
bool end
This is the end of the list.
Definition: smallmap_gui.h:38
NWidgetBase::resize_x
uint resize_x
Horizontal resize step (0 means not resizable).
Definition: widget_type.h:164
OWNER_WATER
@ OWNER_WATER
The tile/execution is done by "water".
Definition: company_type.h:26
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:172
_linkstat_colours_in_legenda
static uint8 _linkstat_colours_in_legenda[]
Link stat colours shown in legenda.
Definition: smallmap_gui.cpp:39
WID_SM_CENTERMAP
@ WID_SM_CENTERMAP
Button to move smallmap center to main window center.
Definition: smallmap_widget.h:29
BuildLinkStatsLegend
void BuildLinkStatsLegend()
Populate legend table for the link stat view.
Definition: smallmap_gui.cpp:198
_scrolling_viewport
bool _scrolling_viewport
A viewport is being scrolled with the mouse.
Definition: window.cpp:77
WC_SMALLMAP
@ WC_SMALLMAP
Small map; Window numbers:
Definition: window_type.h:97
PC_GREEN
static const uint8 PC_GREEN
Green palette colour.
Definition: gfx_func.h:223
Window::SetWidgetLoweredState
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:453
SmallMapWindow::PixelToTile
Point PixelToTile(int px, int py, int *sub, bool add_sub=true) const
Determine the tile relative to the base tile of the smallmap, and the pixel position at that tile for...
Definition: smallmap_gui.cpp:637
NWidgetCore::GetWidgetFromPos
NWidgetCore * GetWidgetFromPos(int x, int y) override
Definition: widget.cpp:912
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
NUM_NO_COMPANY_ENTRIES
static const int NUM_NO_COMPANY_ENTRIES
Number of entries in the owner legend that are not companies.
Definition: smallmap_gui.cpp:41
SmallMapWindow::FORCE_REFRESH_PERIOD
static const uint FORCE_REFRESH_PERIOD
map is redrawn after that many milliseconds.
Definition: smallmap_gui.h:69
WID_SM_ENABLE_ALL
@ WID_SM_ENABLE_ALL
Button to enable display of all legend entries.
Definition: smallmap_widget.h:32
OWNER_TOWN
@ OWNER_TOWN
A town owns the tile, or a town is expanding.
Definition: company_type.h:24
SmallMapWindow::GetLegendHeight
uint GetLegendHeight(uint num_columns) const
Compute height given a number of columns.
Definition: smallmap_gui.h:134
SmallMapWindow::OnMouseWheel
void OnMouseWheel(int wheel) override
The mouse wheel has been turned.
Definition: smallmap_gui.cpp:1568
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:577
PC_BARE_LAND
static const uint8 PC_BARE_LAND
Brown palette colour for bare land.
Definition: gfx_func.h:231
BuildLandLegend
void BuildLandLegend()
(Re)build the colour tables for the legends.
Definition: smallmap_gui.cpp:274
SmallMapColourScheme::colour_count
size_t colour_count
The number of colours.
Definition: smallmap_gui.cpp:260
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:155
GetSmallMapVegetationPixels
static uint32 GetSmallMapVegetationPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the smallmap in mode "Vegetation".
Definition: smallmap_gui.cpp:531
NWidgetSmallmapDisplay::smallmap_window
const SmallMapWindow * smallmap_window
Window manager instance.
Definition: smallmap_gui.cpp:1696
_nested_smallmap_display
static const NWidgetPart _nested_smallmap_display[]
Widget parts of the smallmap display.
Definition: smallmap_gui.cpp:1762
WID_SM_CAPTION
@ WID_SM_CAPTION
Caption of the window.
Definition: smallmap_widget.h:15
SmallMapWindow::BLINK_PERIOD
static const uint BLINK_PERIOD
highlight blinking interval in milliseconds.
Definition: smallmap_gui.h:70
GetSmallMapContoursPixels
static uint32 GetSmallMapContoursPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Contour".
Definition: smallmap_gui.cpp:413
NWidgetSmallmapDisplay::GetWidgetFromPos
NWidgetCore * GetWidgetFromPos(int x, int y) override
Definition: smallmap_gui.cpp:1745
NWidgetBase::SetupSmallestSize
virtual void SetupSmallestSize(Window *w, bool init_array)=0
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
TREE_GROUND_ROUGH_SNOW
@ TREE_GROUND_ROUGH_SNOW
A snow tile that is rough underneath.
Definition: tree_map.h:57