OpenTTD Source 20260311-master-g511d3794ce
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include "core/backup_type.hpp"
12#include "clear_map.h"
13#include "industry.h"
14#include "station_map.h"
15#include "landscape.h"
16#include "tree_map.h"
17#include "viewport_func.h"
18#include "town.h"
19#include "tunnelbridge_map.h"
20#include "core/endian_func.hpp"
21#include "vehicle_base.h"
22#include "sound_func.h"
23#include "window_func.h"
24#include "company_base.h"
25#include "zoom_func.h"
26#include "strings_func.h"
27#include "blitter/factory.hpp"
29#include "timer/timer.h"
30#include "timer/timer_window.h"
31#include "smallmap_gui.h"
32#include "core/enum_type.hpp"
33
35
36#include "table/strings.h"
37
38#include <bitset>
39
40#include "safeguards.h"
41
45
50 IndustryType type;
51 uint8_t height;
52 CompanyID company;
54 bool end;
55 bool col_break;
56};
57
59static const uint8_t _linkstat_colours_in_legenda[] = {0, 1, 3, 5, 7, 9, 11};
60
61static const int NUM_NO_COMPANY_ENTRIES = 4;
62
64#define MK(a, b) {b, a, IT_INVALID, 0, CompanyID::Invalid(), true, false, false}
65
67#define MC(col_break) {STR_TINY_BLACK_HEIGHT, {}, IT_INVALID, 0, CompanyID::Invalid(), true, false, col_break}
68
70#define MO(a, b) {b, a, IT_INVALID, 0, CompanyID::Invalid(), true, false, false}
71
73#define MOEND() {STR_NULL, {}, IT_INVALID, 0, OWNER_NONE, true, true, false}
74
76#define MKEND() {STR_NULL, {}, IT_INVALID, 0, CompanyID::Invalid(), true, true, false}
77
82#define MS(a, b) {b, a, IT_INVALID, 0, CompanyID::Invalid(), true, false, true}
83
86 MK(PC_BLACK, STR_SMALLMAP_LEGENDA_ROADS),
87 MK(PC_GREY, STR_SMALLMAP_LEGENDA_RAILROADS),
88 MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_STATIONS_AIRPORTS_DOCKS),
89 MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
90 MK(PC_WHITE, STR_SMALLMAP_LEGENDA_VEHICLES),
91
92 /* Placeholders for the colours and heights of the legend.
93 * The following values are set at BuildLandLegend() based
94 * on each colour scheme and the maximum map height. */
95 MC(true),
96 MC(false),
97 MC(false),
98 MC(false),
99 MC(false),
100 MC(false),
101 MC(true),
102 MC(false),
103 MC(false),
104 MC(false),
105 MC(false),
106 MC(false),
107 MKEND()
108};
109
110static const LegendAndColour _legend_vehicles[] = {
111 MK(PC_RED, STR_SMALLMAP_LEGENDA_TRAINS),
112 MK(PC_YELLOW, STR_SMALLMAP_LEGENDA_ROAD_VEHICLES),
113 MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_SHIPS),
114 MK(PC_WHITE, STR_SMALLMAP_LEGENDA_AIRCRAFT),
115
116 MS(PC_BLACK, STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES),
117 MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
118 MKEND()
119};
120
121static const LegendAndColour _legend_routes[] = {
122 MK(PC_BLACK, STR_SMALLMAP_LEGENDA_ROADS),
123 MK(PC_GREY, STR_SMALLMAP_LEGENDA_RAILROADS),
124 MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
125
126 MS(PC_VERY_DARK_BROWN, STR_SMALLMAP_LEGENDA_RAILROAD_STATION),
127 MK(PC_ORANGE, STR_SMALLMAP_LEGENDA_TRUCK_LOADING_BAY),
128 MK(PC_YELLOW, STR_SMALLMAP_LEGENDA_BUS_STATION),
129 MK(PC_RED, STR_SMALLMAP_LEGENDA_AIRPORT_HELIPORT),
130 MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_DOCK),
131 MKEND()
132};
133
134static const LegendAndColour _legend_vegetation[] = {
135 MK(PC_ROUGH_LAND, STR_SMALLMAP_LEGENDA_ROUGH_LAND),
136 MK(PC_GRASS_LAND, STR_SMALLMAP_LEGENDA_GRASS_LAND),
137 MK(PC_BARE_LAND, STR_SMALLMAP_LEGENDA_BARE_LAND),
138 MK(PC_RAINFOREST, STR_SMALLMAP_LEGENDA_RAINFOREST),
139 MK(PC_FIELDS, STR_SMALLMAP_LEGENDA_FIELDS),
140 MK(PC_TREES, STR_SMALLMAP_LEGENDA_TREES),
141
142 MS(PC_GREEN, STR_SMALLMAP_LEGENDA_FOREST),
143 MK(PC_GREY, STR_SMALLMAP_LEGENDA_ROCKS),
144 MK(PC_ORANGE, STR_SMALLMAP_LEGENDA_DESERT),
145 MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_SNOW),
146 MK(PC_BLACK, STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES),
147 MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
148 MKEND()
149};
150
151static LegendAndColour _legend_land_owners[NUM_NO_COMPANY_ENTRIES + MAX_COMPANIES + 1] = {
152 MO(PC_WATER, STR_SMALLMAP_LEGENDA_WATER),
153 MO({}, STR_SMALLMAP_LEGENDA_NO_OWNER), // This colour will vary depending on settings.
154 MO(PC_DARK_RED, STR_SMALLMAP_LEGENDA_TOWNS),
155 MO(PC_DARK_GREY, STR_SMALLMAP_LEGENDA_INDUSTRIES),
156 /* The legend will be terminated the first time it is used. */
157 MOEND(),
158};
159
160#undef MK
161#undef MC
162#undef MS
163#undef MO
164#undef MOEND
165#undef MKEND
166
179static bool _smallmap_show_heightmap = false;
181static IndustryType _smallmap_industry_highlight = IT_INVALID;
186
191{
192 uint j = 0;
193
194 /* Add each name */
195 for (IndustryType ind : _sorted_industry_types) {
196 const IndustrySpec *indsp = GetIndustrySpec(ind);
197 if (indsp->enabled) {
198 _legend_from_industries[j].legend = indsp->name;
199 _legend_from_industries[j].colour = indsp->map_colour;
200 _legend_from_industries[j].type = ind;
201 _legend_from_industries[j].show_on_map = true;
202 _legend_from_industries[j].col_break = false;
203 _legend_from_industries[j].end = false;
204
205 /* Store widget number for this industry type. */
206 _industry_to_list_pos[ind] = j;
207 j++;
208 }
209 }
210 /* Terminate the list */
211 _legend_from_industries[j].end = true;
212
213 /* Store number of enabled industries */
215}
216
221{
222 /* Clear the legend */
223 std::fill(std::begin(_legend_linkstats), std::end(_legend_linkstats), LegendAndColour{});
224
225 uint i = 0;
226 for (; i < _sorted_cargo_specs.size(); ++i) {
227 const CargoSpec *cs = _sorted_cargo_specs[i];
228
229 _legend_linkstats[i].legend = cs->name;
230 _legend_linkstats[i].colour = cs->legend_colour;
231 _legend_linkstats[i].type = cs->Index();
232 _legend_linkstats[i].show_on_map = true;
233 }
234
235 _legend_linkstats[i].col_break = true;
237
239 _legend_linkstats[i].legend = STR_EMPTY;
241 _legend_linkstats[i].show_on_map = true;
242 }
243
244 _legend_linkstats[_smallmap_cargo_count].legend = STR_LINKGRAPH_LEGEND_UNUSED;
245 _legend_linkstats[i - 1].legend = STR_LINKGRAPH_LEGEND_OVERLOADED;
246 _legend_linkstats[(_smallmap_cargo_count + i - 1) / 2].legend = STR_LINKGRAPH_LEGEND_SATURATED;
247 _legend_linkstats[i].end = true;
248}
249
250static const LegendAndColour * const _legend_table[] = {
252 _legend_vehicles,
255 _legend_routes,
256 _legend_vegetation,
257 _legend_land_owners,
258};
259
260#define MKCOLOUR(x) TO_LE32(x)
261
262#define MKCOLOUR_XXXX(x) (MKCOLOUR(0x01010101) * (uint)(x.p))
263#define MKCOLOUR_0XX0(x) (MKCOLOUR(0x00010100) * (uint)(x.p))
264#define MKCOLOUR_X00X(x) (MKCOLOUR(0x01000001) * (uint)(x.p))
265
266#define MKCOLOUR_XYYX(x, y) (MKCOLOUR_X00X(x) | MKCOLOUR_0XX0(y))
267
268#define MKCOLOUR_0000 MKCOLOUR_XXXX(PixelColour{0x00})
269#define MKCOLOUR_F00F MKCOLOUR_X00X(PixelColour{0xFF})
270#define MKCOLOUR_FFFF MKCOLOUR_XXXX(PixelColour{0xFF})
271
273
276 std::vector<uint32_t> height_colours;
277 std::span<const uint32_t> height_colours_base;
278 uint32_t default_colour;
279};
280
283 {{}, _green_map_heights, MKCOLOUR_XXXX(PixelColour{0x54})},
284 {{}, _dark_green_map_heights, MKCOLOUR_XXXX(PixelColour{0x62})},
285 {{}, _violet_map_heights, MKCOLOUR_XXXX(PixelColour{0x81})},
286};
287
292{
293 /* The smallmap window has never been initialized, so no need to change the legend. */
294 if (_heightmap_schemes[0].height_colours.empty()) return;
295
296 /*
297 * The general idea of this function is to fill the legend with an appropriate evenly spaced
298 * selection of height levels. All entries with STR_TINY_BLACK_HEIGHT are reserved for this.
299 * At the moment there are twelve of these.
300 *
301 * The table below defines up to which height level a particular delta in the legend should be
302 * used. One could opt for just dividing the maximum height and use that as delta, but that
303 * creates many "ugly" legend labels, e.g. once every 950 meter. As a result, this table will
304 * reduce the number of deltas to 7: every 100m, 200m, 300m, 500m, 750m, 1000m and 1250m. The
305 * deltas are closer together at the lower numbers because going from 12 entries to just 4, as
306 * would happen when replacing 200m and 300m by 250m, would mean the legend would be short and
307 * that might not be considered appropriate.
308 *
309 * The current method yields at least 7 legend entries and at most 12. It can be increased to
310 * 8 by adding a 150m and 400m option, but especially 150m creates ugly heights.
311 *
312 * It tries to evenly space the legend items over the two columns that are there for the legend.
313 */
314
315 /* Table for delta; if max_height is less than the first column, use the second column as value. */
316 uint deltas[][2] = { { 24, 2 }, { 48, 4 }, { 72, 6 }, { 120, 10 }, { 180, 15 }, { 240, 20 }, { MAX_TILE_HEIGHT + 1, 25 }};
317 uint i = 0;
318 for (; _settings_game.construction.map_height_limit >= deltas[i][0]; i++) {
319 /* Nothing to do here. */
320 }
321 uint delta = deltas[i][1];
322
323 int total_entries = (_settings_game.construction.map_height_limit / delta) + 1;
324 int rows = CeilDiv(total_entries, 2);
325 int j = 0;
326
327 for (i = 0; i < lengthof(_legend_land_contours) - 1 && j < total_entries; i++) {
328 if (_legend_land_contours[i].legend != STR_TINY_BLACK_HEIGHT) continue;
329
330 _legend_land_contours[i].col_break = j % rows == 0;
331 _legend_land_contours[i].end = false;
332 _legend_land_contours[i].height = j * delta;
333 _legend_land_contours[i].colour = PixelColour{static_cast<uint8_t>(_heightmap_schemes[_settings_client.gui.smallmap_land_colour].height_colours[_legend_land_contours[i].height])};
334 j++;
335 }
336 _legend_land_contours[i].end = true;
337}
338
343{
344 _legend_land_owners[1].colour = PixelColour{static_cast<uint8_t>(_heightmap_schemes[_settings_client.gui.smallmap_land_colour].default_colour)};
345
347 for (const Company *c : Company::Iterate()) {
348 _legend_land_owners[i].colour = GetColourGradient(c->colour, SHADE_LIGHT);
349 _legend_land_owners[i].company = c->index;
350 _legend_land_owners[i].show_on_map = true;
351 _legend_land_owners[i].col_break = false;
352 _legend_land_owners[i].end = false;
353 _company_to_list_pos[c->index] = i;
354 i++;
355 }
356
357 /* Terminate the list */
358 _legend_land_owners[i].end = true;
359
360 /* Store maximum amount of owner legend entries. */
362}
363
364struct AndOr {
365 uint32_t mor;
366 uint32_t mand;
367};
368
369static inline uint32_t ApplyMask(uint32_t colour, const AndOr *mask)
370{
371 return (colour & mask->mand) | mask->mor;
372}
373
374
377 AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Clear
378 AndOr(MKCOLOUR_0XX0(PC_GREY), MKCOLOUR_F00F), // TileType::Railway
379 AndOr(MKCOLOUR_0XX0(PC_BLACK), MKCOLOUR_F00F), // TileType::Road
380 AndOr(MKCOLOUR_0XX0(PC_DARK_RED), MKCOLOUR_F00F), // TileType::House
381 AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Trees
382 AndOr(MKCOLOUR_XXXX(PC_LIGHT_BLUE), MKCOLOUR_0000), // TileType::Station
383 AndOr(MKCOLOUR_XXXX(PC_WATER), MKCOLOUR_0000), // TileType::Water
384 AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Void
385 AndOr(MKCOLOUR_XXXX(PC_DARK_RED), MKCOLOUR_0000), // TileType::Industry
386 AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::TunnelBridge
387 AndOr(MKCOLOUR_0XX0(PC_DARK_RED), MKCOLOUR_F00F), // TileType::Object
388 AndOr(MKCOLOUR_0XX0(PC_GREY), MKCOLOUR_F00F),
389};
390
393 AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Clear
394 AndOr(MKCOLOUR_0XX0(PC_BLACK), MKCOLOUR_F00F), // TileType::Railway
395 AndOr(MKCOLOUR_0XX0(PC_BLACK), MKCOLOUR_F00F), // TileType::Road
396 AndOr(MKCOLOUR_0XX0(PC_DARK_RED), MKCOLOUR_F00F), // TileType::House
397 AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Trees
398 AndOr(MKCOLOUR_0XX0(PC_BLACK), MKCOLOUR_F00F), // TileType::Station
399 AndOr(MKCOLOUR_XXXX(PC_WATER), MKCOLOUR_0000), // TileType::Water
400 AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Void
401 AndOr(MKCOLOUR_XXXX(PC_DARK_RED), MKCOLOUR_0000), // TileType::Industry
402 AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::TunnelBridge
403 AndOr(MKCOLOUR_0XX0(PC_DARK_RED), MKCOLOUR_F00F), // TileType::Object
404 AndOr(MKCOLOUR_0XX0(PC_BLACK), MKCOLOUR_F00F),
405};
406
409 2, // TileType::Clear
410 8, // TileType::Railway
411 7, // TileType::Road
412 5, // TileType::House
413 2, // TileType::Trees
414 9, // TileType::Station
415 2, // TileType::Water
416 1, // TileType::Void
417 6, // TileType::Industry
418 8, // TileType::TunnelBridge
419 2, // TileType::Object
420 0,
421};
422
423
430static inline uint32_t GetSmallMapContoursPixels(TileIndex tile, TileType t)
431{
432 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
433 return ApplyMask(cs->height_colours[TileHeight(tile)], &_smallmap_contours_andor[t]);
434}
435
442static inline uint32_t GetSmallMapVehiclesPixels(TileType t)
443{
444 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
445 return ApplyMask(cs->default_colour, &_smallmap_vehicles_andor[t]);
446}
447
455static inline uint32_t GetSmallMapIndustriesPixels(TileIndex tile, TileType t)
456{
457 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
459}
460
468static inline uint32_t GetSmallMapRoutesPixels(TileIndex tile, TileType t)
469{
470 switch (t) {
472 switch (GetStationType(tile)) {
473 case StationType::Rail: return MKCOLOUR_XXXX(PC_VERY_DARK_BROWN);
474 case StationType::Airport: return MKCOLOUR_XXXX(PC_RED);
475 case StationType::Truck: return MKCOLOUR_XXXX(PC_ORANGE);
476 case StationType::Bus: return MKCOLOUR_XXXX(PC_YELLOW);
477 case StationType::Dock: return MKCOLOUR_XXXX(PC_LIGHT_BLUE);
478 default: return MKCOLOUR_FFFF;
479 }
480
481 case TileType::Railway: {
482 AndOr andor = {
483 MKCOLOUR_0XX0(GetRailTypeInfo(GetRailType(tile))->map_colour),
485 };
486
487 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
488 return ApplyMask(cs->default_colour, &andor);
489 }
490
491 case TileType::Road: {
492 const RoadTypeInfo *rti = nullptr;
493 if (GetRoadTypeRoad(tile) != INVALID_ROADTYPE) {
494 rti = GetRoadTypeInfo(GetRoadTypeRoad(tile));
495 } else {
496 rti = GetRoadTypeInfo(GetRoadTypeTram(tile));
497 }
498 if (rti != nullptr) {
499 AndOr andor = {
500 MKCOLOUR_0XX0(rti->map_colour),
502 };
503
504 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
505 return ApplyMask(cs->default_colour, &andor);
506 }
507 [[fallthrough]];
508 }
509
510 default:
511 /* Ground colour */
512 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
513 return ApplyMask(cs->default_colour, &_smallmap_contours_andor[t]);
514 }
515}
516
524static inline uint32_t GetSmallMapLinkStatsPixels(TileIndex tile, TileType t)
525{
527}
528
531 MKCOLOUR_XXXX(PC_GRASS_LAND),
532 MKCOLOUR_XXXX(PC_ROUGH_LAND),
533 MKCOLOUR_XXXX(PC_GREY),
534 MKCOLOUR_XXXX(PC_FIELDS),
535 MKCOLOUR_XXXX(PC_GRASS_LAND),
536 MKCOLOUR_XXXX(PC_ORANGE),
537 MKCOLOUR_XXXX(PC_GRASS_LAND),
538 MKCOLOUR_XXXX(PC_GRASS_LAND),
539};
540
548static inline uint32_t GetSmallMapVegetationPixels(TileIndex tile, TileType t)
549{
550 switch (t) {
551 case TileType::Clear:
552 if (IsSnowTile(tile)) return MKCOLOUR_XXXX(PC_LIGHT_BLUE);
554 if (GetClearDensity(tile) < 3) return MKCOLOUR_XXXX(PC_BARE_LAND);
555 if (GetTropicZone(tile) == TROPICZONE_RAINFOREST) return MKCOLOUR_XXXX(PC_RAINFOREST);
556 }
558
560 return IsTileForestIndustry(tile) ? MKCOLOUR_XXXX(PC_GREEN) : MKCOLOUR_XXXX(PC_DARK_RED);
561
562 case TileType::Trees:
564 return (_settings_game.game_creation.landscape == LandscapeType::Arctic) ? MKCOLOUR_XYYX(PC_LIGHT_BLUE, PC_TREES) : MKCOLOUR_XYYX(PC_ORANGE, PC_TREES);
565 }
566 return (GetTropicZone(tile) == TROPICZONE_RAINFOREST) ? MKCOLOUR_XYYX(PC_RAINFOREST, PC_TREES) : MKCOLOUR_XYYX(PC_GRASS_LAND, PC_TREES);
567
568 default:
569 return ApplyMask(MKCOLOUR_XXXX(PC_GRASS_LAND), &_smallmap_vehicles_andor[t]);
570 }
571}
572
582uint32_t GetSmallMapOwnerPixels(TileIndex tile, TileType t, IncludeHeightmap include_heightmap)
583{
584 Owner o;
585
586 switch (t) {
587 case TileType::Void: return MKCOLOUR_XXXX(PC_BLACK);
588 case TileType::Industry: return MKCOLOUR_XXXX(PC_DARK_GREY);
589 case TileType::House: return MKCOLOUR_XXXX(PC_DARK_RED);
590 case TileType::Road:
591 o = GetRoadOwner(tile, HasRoadTypeRoad(tile) ? RTT_ROAD : RTT_TRAM);
592 break;
593
594 default:
595 o = GetTileOwner(tile);
596 break;
597 }
598
599 if ((o < MAX_COMPANIES && !_legend_land_owners[_company_to_list_pos[o]].show_on_map) || o == OWNER_NONE || o == OWNER_WATER) {
600 if (t == TileType::Water) return MKCOLOUR_XXXX(PC_WATER);
601 const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
602 return ((include_heightmap == IncludeHeightmap::IfEnabled && _smallmap_show_heightmap) || include_heightmap == IncludeHeightmap::Always)
603 ? cs->height_colours[TileHeight(tile)] : cs->default_colour;
604 } else if (o == OWNER_TOWN) {
605 return MKCOLOUR_XXXX(PC_DARK_RED);
606 }
607
608 return MKCOLOUR_XXXX(_legend_land_owners[_company_to_list_pos[o]].colour);
609}
610
615
617enum SmallMapType : uint8_t {
618 SMT_CONTOUR,
619 SMT_VEHICLES,
620 SMT_INDUSTRY,
621 SMT_LINKSTATS,
622 SMT_ROUTES,
623 SMT_VEGETATION,
624 SMT_OWNER,
625};
627
628
629class SmallMapWindow : public Window {
630protected:
637
639 static bool show_towns;
640 static bool show_ind_names;
641 static int map_height_limit;
642
643 static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS = 2;
644
647 uint column_width = 0;
648 uint legend_width = 0;
649
650 int32_t scroll_x = 0;
651 int32_t scroll_y = 0;
652 int32_t subscroll = 0;
653 int zoom = 0;
654
655 std::unique_ptr<LinkGraphOverlay> overlay{};
656
662
663 static inline Point SmallmapRemapCoords(int x, int y)
664 {
665 Point pt;
666 pt.x = (y - x) * 2;
667 pt.y = y + x;
668 return pt;
669 }
670
677 static inline void DrawVertMapIndicator(int x, int y, int y2)
678 {
679 GfxFillRect(x, y, x, y + 3, PC_VERY_LIGHT_YELLOW);
680 GfxFillRect(x, y2 - 3, x, y2, PC_VERY_LIGHT_YELLOW);
681 }
682
689 static inline void DrawHorizMapIndicator(int x, int x2, int y)
690 {
691 GfxFillRect(x, y, x + 3, y, PC_VERY_LIGHT_YELLOW);
692 GfxFillRect(x2 - 3, y, x2, y, PC_VERY_LIGHT_YELLOW);
693 }
694
699 inline uint GetMinLegendWidth() const
700 {
701 return WidgetDimensions::scaled.framerect.left + this->min_number_of_columns * this->column_width;
702 }
703
709 inline uint GetNumberColumnsLegend(uint width) const
710 {
711 return width / this->column_width;
712 }
713
719 inline uint GetLegendHeight(uint num_columns) const
720 {
721 return WidgetDimensions::scaled.framerect.Vertical() +
722 this->GetNumberRowsLegend(num_columns) * GetCharacterHeight(FS_SMALL);
723 }
724
734
739
741 const IntervalTimer<TimerWindow> refresh_interval = {std::chrono::milliseconds(930), [this](auto) {
742 ForceRefresh();
743 }};
744
749 {
750 /* Rebuild colour indices if necessary. */
751 if (SmallMapWindow::map_height_limit == _settings_game.construction.map_height_limit) return;
752
753 for (auto &heightmap_scheme : _heightmap_schemes) {
754 /* The heights go from 0 up to and including maximum. */
755 size_t heights = _settings_game.construction.map_height_limit + 1;
756 heightmap_scheme.height_colours.resize(heights);
757
758 for (size_t z = 0; z < heights; z++) {
759 size_t access_index = (heightmap_scheme.height_colours_base.size() * z) / heights;
760
761 /* Choose colour by mapping the range (0..max heightlevel) on the complete colour table. */
762 heightmap_scheme.height_colours[z] = heightmap_scheme.height_colours_base[access_index];
763 }
764 }
765
766 SmallMapWindow::map_height_limit = _settings_game.construction.map_height_limit;
768 }
769
778 uint GetNumberRowsLegend(uint columns) const
779 {
780 /* Reserve one column for link colours */
781 uint num_rows_linkstats = CeilDiv(_smallmap_cargo_count, columns - 1);
782 uint num_rows_others = CeilDiv(std::max(_smallmap_industry_count, _smallmap_company_count), columns);
783 return std::max({this->min_number_of_fixed_rows, num_rows_linkstats, num_rows_others});
784 }
785
797 void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item = 0)
798 {
799 if (_ctrl_pressed) {
800 /* Disable all, except the clicked one */
801 bool changes = false;
802 for (int i = begin_legend_item; i != end_legend_item; i++) {
803 bool new_state = (i == click_pos);
804 if (legend[i].show_on_map != new_state) {
805 changes = true;
806 legend[i].show_on_map = new_state;
807 }
808 }
809 if (!changes) {
810 /* Nothing changed? Then show all (again). */
811 for (int i = begin_legend_item; i != end_legend_item; i++) {
812 legend[i].show_on_map = true;
813 }
814 }
815 } else {
816 legend[click_pos].show_on_map = !legend[click_pos].show_on_map;
817 }
818
819 if (this->map_type == SMT_INDUSTRY) this->BreakIndustryChainLink();
820 }
821
827 {
828 this->RaiseWidget(WID_SM_CONTOUR + this->map_type);
829 this->map_type = map_type;
830 this->LowerWidget(WID_SM_CONTOUR + this->map_type);
831
832 this->SetupWidgetData();
833
834 if (map_type == SMT_LINKSTATS) this->overlay->SetDirty();
835 if (map_type != SMT_INDUSTRY) this->BreakIndustryChainLink();
836 this->ReInit();
837 }
838
846 void SetNewScroll(int sx, int sy, int sub)
847 {
849 Point hv = InverseRemapCoords(wi->current_x * ZOOM_BASE * TILE_SIZE / 2, wi->current_y * ZOOM_BASE * TILE_SIZE / 2);
850 hv.x *= this->zoom;
851 hv.y *= this->zoom;
852
853 if (sx < -hv.x) {
854 sx = -hv.x;
855 sub = 0;
856 }
857 if (sx > (int)(Map::MaxX() * TILE_SIZE) - hv.x) {
858 sx = Map::MaxX() * TILE_SIZE - hv.x;
859 sub = 0;
860 }
861 if (sy < -hv.y) {
862 sy = -hv.y;
863 sub = 0;
864 }
865 if (sy > (int)(Map::MaxY() * TILE_SIZE) - hv.y) {
866 sy = Map::MaxY() * TILE_SIZE - hv.y;
867 sub = 0;
868 }
869
870 this->scroll_x = sx;
871 this->scroll_y = sy;
872 this->subscroll = sub;
873 if (this->map_type == SMT_LINKSTATS) this->overlay->SetDirty();
874 }
875
879 void DrawMapIndicators() const
880 {
881 /* Find main viewport. */
882 const Viewport &vp = *GetMainWindow()->viewport;
883
884 Point upper_left_smallmap_coord = InverseRemapCoords2(vp.virtual_left, vp.virtual_top);
885 Point lower_right_smallmap_coord = InverseRemapCoords2(vp.virtual_left + vp.virtual_width - 1, vp.virtual_top + vp.virtual_height - 1);
886
887 Point upper_left = this->RemapTile(upper_left_smallmap_coord.x / (int)TILE_SIZE, upper_left_smallmap_coord.y / (int)TILE_SIZE);
888 upper_left.x -= this->subscroll;
889
890 Point lower_right = this->RemapTile(lower_right_smallmap_coord.x / (int)TILE_SIZE, lower_right_smallmap_coord.y / (int)TILE_SIZE);
891 lower_right.x -= this->subscroll;
892
893 SmallMapWindow::DrawVertMapIndicator(upper_left.x, upper_left.y, lower_right.y);
894 SmallMapWindow::DrawVertMapIndicator(lower_right.x, upper_left.y, lower_right.y);
895
896 SmallMapWindow::DrawHorizMapIndicator(upper_left.x, lower_right.x, upper_left.y);
897 SmallMapWindow::DrawHorizMapIndicator(upper_left.x, lower_right.x, lower_right.y);
898 }
899
913 void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const
914 {
915 void *dst_ptr_abs_end = blitter->MoveTo(_screen.dst_ptr, 0, _screen.height);
916 uint min_xy = _settings_game.construction.freeform_edges ? 1 : 0;
917
918 do {
919 /* Check if the tile (xc,yc) is within the map range */
920 if (xc >= Map::MaxX() || yc >= Map::MaxY()) continue;
921
922 /* Check if the dst pointer points to a pixel inside the screen buffer */
923 if (dst < _screen.dst_ptr) continue;
924 if (dst >= dst_ptr_abs_end) continue;
925
926 /* Construct tilearea covered by (xc, yc, xc + this->zoom, yc + this->zoom) such that it is within min_xy limits. */
927 TileArea ta;
928 if (min_xy == 1 && (xc == 0 || yc == 0)) {
929 if (this->zoom == 1) continue; // The tile area is empty, don't draw anything.
930
931 ta = TileArea(TileXY(std::max(min_xy, xc), std::max(min_xy, yc)), this->zoom - (xc == 0), this->zoom - (yc == 0));
932 } else {
933 ta = TileArea(TileXY(xc, yc), this->zoom, this->zoom);
934 }
935 ta.ClampToMap(); // Clamp to map boundaries (may contain TileType::Void tiles!).
936
937 uint32_t val = this->GetTileColours(ta);
938 uint8_t *val8 = (uint8_t *)&val;
939 int idx = std::max(0, -start_pos);
940 for (int pos = std::max(0, start_pos); pos < end_pos; pos++) {
941 blitter->SetPixel(dst, idx, 0, PixelColour{val8[idx]});
942 idx++;
943 }
944 /* Switch to next tile in the column */
945 } while (xc += this->zoom, yc += this->zoom, dst = blitter->MoveTo(dst, pitch, 0), --reps != 0);
946 }
947
953 void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
954 {
955 for (const Vehicle *v : Vehicle::Iterate()) {
956 if (v->type == VEH_EFFECT) continue;
957 if (v->vehstatus.Any({VehState::Hidden, VehState::Unclickable})) continue;
958
959 /* Remap into flat coordinates. */
960 Point pt = this->RemapTile(v->x_pos / (int)TILE_SIZE, v->y_pos / (int)TILE_SIZE);
961
962 int y = pt.y - dpi->top;
963 if (!IsInsideMM(y, 0, dpi->height)) continue; // y is out of bounds.
964
965 bool skip = false; // Default is to draw both pixels.
966 int x = pt.x - this->subscroll - 3 - dpi->left; // Offset X coordinate.
967 if (x < 0) {
968 /* if x+1 is 0, that means we're on the very left edge,
969 * and should thus only draw a single pixel */
970 if (++x != 0) continue;
971 skip = true;
972 } else if (x >= dpi->width - 1) {
973 /* Check if we're at the very right edge, and if so draw only a single pixel */
974 if (x != dpi->width - 1) continue;
975 skip = true;
976 }
977
978 /* Calculate pointer to pixel and the colour */
979 PixelColour colour = (this->map_type == SMT_VEHICLES) ? _vehicle_type_colours[v->type] : PC_WHITE;
980
981 /* And draw either one or two pixels depending on clipping */
982 blitter->SetPixel(dpi->dst_ptr, x, y, colour);
983 if (!skip) blitter->SetPixel(dpi->dst_ptr, x + 1, y, colour);
984 }
985 }
986
992 void DrawTowns(const DrawPixelInfo *dpi, const int vertical_padding) const
993 {
994 for (const Town *t : Town::Iterate()) {
995 /* Remap the town coordinate */
996 Point pt = this->RemapTile(TileX(t->xy), TileY(t->xy));
997 int x = pt.x - this->subscroll - (t->cache.sign.width_small >> 1);
998 int y = pt.y + vertical_padding;
999
1000 /* Check if the town sign is within bounds */
1001 if (x + t->cache.sign.width_small > dpi->left &&
1002 x < dpi->left + dpi->width &&
1003 y + GetCharacterHeight(FS_SMALL) > dpi->top &&
1004 y < dpi->top + dpi->height) {
1005 /* And draw it. */
1006 DrawString(x, x + t->cache.sign.width_small, y, GetString(STR_SMALLMAP_TOWN, t->index));
1007 }
1008 }
1009 }
1010
1016 void DrawIndustryNames(const DrawPixelInfo *dpi, const int vertical_padding) const
1017 {
1018 if (this->map_type != SMT_INDUSTRY) return;
1019
1020 for (const Industry *i : Industry::Iterate()) {
1022 if (!tbl.show_on_map) continue;
1023
1024 /* Industry names blink together with their blobs in the smallmap. */
1025 const bool is_blinking = i->type == _smallmap_industry_highlight && !_smallmap_industry_highlight_state;
1026 if (is_blinking) continue;
1027
1028 if (_industry_to_name_string_width[i->type] == 0) {
1030 }
1031 const uint16_t &legend_text_width = _industry_to_name_string_width[i->type];
1032
1033 /* Remap the industry coordinate */
1034 const TileIndex &tile = i->location.GetCenterTile();
1035 const Point pt = this->RemapTile(TileX(tile), TileY(tile));
1036 const int x = pt.x - this->subscroll - (legend_text_width / 2);
1037 const int y = pt.y + vertical_padding;
1038
1039 /* Check if the industry name is within bounds */
1040 if (x + legend_text_width > dpi->left &&
1041 x < dpi->left + dpi->width &&
1042 y + GetCharacterHeight(FS_SMALL) > dpi->top &&
1043 y < dpi->top + dpi->height) {
1044
1045 /* And draw it. */
1046 DrawString(x, x + legend_text_width, y, tbl.legend, TC_WHITE, SA_LEFT, false, FS_SMALL);
1047 }
1048 }
1049 }
1050
1063 {
1065 AutoRestoreBackup dpi_backup(_cur_dpi, dpi);
1066
1067 /* If freeform edges are off, draw infinite water off the edges of the map. */
1068 const PixelColour map_clear_color = (_settings_game.construction.freeform_edges ? PC_BLACK : PC_WATER);
1069 GfxFillRect(dpi->left, dpi->top, dpi->left + dpi->width - 1, dpi->top + dpi->height - 1, map_clear_color);
1070
1071 /* Which tile is displayed at (dpi->left, dpi->top)? */
1072 int dx;
1073 Point tile = this->PixelToTile(dpi->left, dpi->top, &dx);
1074 int tile_x = this->scroll_x / (int)TILE_SIZE + tile.x;
1075 int tile_y = this->scroll_y / (int)TILE_SIZE + tile.y;
1076
1077 void *ptr = blitter->MoveTo(dpi->dst_ptr, -dx - 4, 0);
1078 int x = - dx - 4;
1079 int y = 0;
1080
1081 for (;;) {
1082 /* Distance from left edge */
1083 if (x >= -3) {
1084 if (x >= dpi->width) break; // Exit the loop.
1085
1086 int end_pos = std::min(dpi->width, x + 4);
1087 int reps = (dpi->height - y + 1) / 2; // Number of lines.
1088 if (reps > 0) {
1089 this->DrawSmallMapColumn(ptr, tile_x, tile_y, dpi->pitch * 2, reps, x, end_pos, blitter);
1090 }
1091 }
1092
1093 if (y == 0) {
1094 tile_y += this->zoom;
1095 y++;
1096 ptr = blitter->MoveTo(ptr, 0, 1);
1097 } else {
1098 tile_x -= this->zoom;
1099 y--;
1100 ptr = blitter->MoveTo(ptr, 0, -1);
1101 }
1102 ptr = blitter->MoveTo(ptr, 2, 0);
1103 x += 2;
1104 }
1105
1106 /* Draw vehicles */
1107 if (this->map_type == SMT_CONTOUR || this->map_type == SMT_VEHICLES) this->DrawVehicles(dpi, blitter);
1108
1109 /* Draw link stat overlay */
1110 if (this->map_type == SMT_LINKSTATS) this->overlay->Draw(dpi);
1111
1112 const int map_labels_vertical_padding = ScaleGUITrad(2);
1113
1114 /* Draw town names */
1115 if (this->show_towns) this->DrawTowns(dpi, map_labels_vertical_padding);
1116
1117 /* Draw industry names */
1118 if (this->show_ind_names) this->DrawIndustryNames(dpi, map_labels_vertical_padding);
1119
1120 /* Draw map indicators */
1121 this->DrawMapIndicators();
1122 }
1123
1130 Point RemapTile(int tile_x, int tile_y) const
1131 {
1132 int x_offset = tile_x - this->scroll_x / (int)TILE_SIZE;
1133 int y_offset = tile_y - this->scroll_y / (int)TILE_SIZE;
1134
1135 if (this->zoom == 1) return SmallmapRemapCoords(x_offset, y_offset);
1136
1137 /* For negative offsets, round towards -inf. */
1138 if (x_offset < 0) x_offset -= this->zoom - 1;
1139 if (y_offset < 0) y_offset -= this->zoom - 1;
1140
1141 return SmallmapRemapCoords(x_offset / this->zoom, y_offset / this->zoom);
1142 }
1143
1154 Point PixelToTile(int px, int py, int *sub, bool add_sub = true) const
1155 {
1156 if (add_sub) px += this->subscroll; // Total horizontal offset.
1157
1158 /* For each two rows down, add a x and a y tile, and
1159 * For each four pixels to the right, move a tile to the right. */
1160 Point pt = {((py >> 1) - (px >> 2)) * this->zoom, ((py >> 1) + (px >> 2)) * this->zoom};
1161 px &= 3;
1162
1163 if (py & 1) { // Odd number of rows, handle the 2 pixel shift.
1164 if (px < 2) {
1165 pt.x += this->zoom;
1166 px += 2;
1167 } else {
1168 pt.y += this->zoom;
1169 px -= 2;
1170 }
1171 }
1172
1173 *sub = px;
1174 return pt;
1175 }
1176
1186 Point ComputeScroll(int tx, int ty, int x, int y, int *sub) const
1187 {
1188 assert(x >= 0 && y >= 0);
1189
1190 int new_sub;
1191 Point tile_xy = PixelToTile(x, y, &new_sub, false);
1192 tx -= tile_xy.x;
1193 ty -= tile_xy.y;
1194
1195 Point scroll;
1196 if (new_sub == 0) {
1197 *sub = 0;
1198 scroll.x = (tx + this->zoom) * TILE_SIZE;
1199 scroll.y = (ty - this->zoom) * TILE_SIZE;
1200 } else {
1201 *sub = 4 - new_sub;
1202 scroll.x = (tx + 2 * this->zoom) * TILE_SIZE;
1203 scroll.y = (ty - 2 * this->zoom) * TILE_SIZE;
1204 }
1205 return scroll;
1206 }
1207
1214 void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt)
1215 {
1216 static const int zoomlevels[] = {1, 2, 4, 6, 8}; // Available zoom levels. Bigger number means more zoom-out (further away).
1217 static const int MIN_ZOOM_INDEX = 0;
1218 static const int MAX_ZOOM_INDEX = lengthof(zoomlevels) - 1;
1219
1220 int new_index, cur_index, sub;
1221 Point tile;
1222 switch (change) {
1223 case ZLC_INITIALIZE:
1224 cur_index = - 1; // Definitely different from new_index.
1225 new_index = MIN_ZOOM_INDEX;
1226 tile.x = tile.y = 0;
1227 break;
1228
1229 case ZLC_ZOOM_IN:
1230 case ZLC_ZOOM_OUT:
1231 for (cur_index = MIN_ZOOM_INDEX; cur_index <= MAX_ZOOM_INDEX; cur_index++) {
1232 if (this->zoom == zoomlevels[cur_index]) break;
1233 }
1234 assert(cur_index <= MAX_ZOOM_INDEX);
1235
1236 tile = this->PixelToTile(zoom_pt->x, zoom_pt->y, &sub);
1237 new_index = Clamp(cur_index + ((change == ZLC_ZOOM_IN) ? -1 : 1), MIN_ZOOM_INDEX, MAX_ZOOM_INDEX);
1238 break;
1239
1240 default: NOT_REACHED();
1241 }
1242
1243 if (new_index != cur_index) {
1244 this->zoom = zoomlevels[new_index];
1245 if (cur_index >= 0) {
1246 Point new_tile = this->PixelToTile(zoom_pt->x, zoom_pt->y, &sub);
1247 this->SetNewScroll(this->scroll_x + (tile.x - new_tile.x) * TILE_SIZE,
1248 this->scroll_y + (tile.y - new_tile.y) * TILE_SIZE, sub);
1249 } else if (this->map_type == SMT_LINKSTATS) {
1250 this->overlay->SetDirty();
1251 }
1252 this->SetWidgetDisabledState(WID_SM_ZOOM_IN, this->zoom == zoomlevels[MIN_ZOOM_INDEX]);
1253 this->SetWidgetDisabledState(WID_SM_ZOOM_OUT, this->zoom == zoomlevels[MAX_ZOOM_INDEX]);
1254 this->SetDirty();
1255 }
1256 }
1257
1262 {
1263 CargoTypes cargo_mask = 0;
1264 for (int i = 0; i != _smallmap_cargo_count; ++i) {
1265 if (_legend_linkstats[i].show_on_map) SetBit(cargo_mask, _legend_linkstats[i].type);
1266 }
1267 this->overlay->SetCargoMask(cargo_mask);
1268 }
1269
1274 {
1275 StringID legend_tooltip;
1276 StringID enable_all_tooltip;
1277 StringID disable_all_tooltip;
1278 int industry_names_select_plane;
1279 int select_buttons_plane;
1280 switch (this->map_type) {
1281 case SMT_INDUSTRY:
1282 legend_tooltip = STR_SMALLMAP_TOOLTIP_INDUSTRY_SELECTION;
1283 enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_INDUSTRIES;
1284 disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_INDUSTRIES;
1285 industry_names_select_plane = 0;
1286 select_buttons_plane = 0;
1287 break;
1288
1289 case SMT_OWNER:
1290 legend_tooltip = STR_SMALLMAP_TOOLTIP_COMPANY_SELECTION;
1291 enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_COMPANIES;
1292 disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_COMPANIES;
1293 industry_names_select_plane = SZSP_NONE;
1294 select_buttons_plane = 0;
1295 break;
1296
1297 case SMT_LINKSTATS:
1298 legend_tooltip = STR_SMALLMAP_TOOLTIP_CARGO_SELECTION;
1299 enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_CARGOS;
1300 disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_CARGOS;
1301 industry_names_select_plane = SZSP_NONE;
1302 select_buttons_plane = 0;
1303 break;
1304
1305 default:
1306 legend_tooltip = STR_NULL;
1307 enable_all_tooltip = STR_NULL;
1308 disable_all_tooltip = STR_NULL;
1309 industry_names_select_plane = SZSP_NONE;
1310 select_buttons_plane = 1;
1311 break;
1312 }
1313
1314 this->GetWidget<NWidgetCore>(WID_SM_LEGEND)->SetToolTip(legend_tooltip);
1315 this->GetWidget<NWidgetCore>(WID_SM_ENABLE_ALL)->SetStringTip(STR_SMALLMAP_ENABLE_ALL, enable_all_tooltip);
1316 this->GetWidget<NWidgetCore>(WID_SM_DISABLE_ALL)->SetStringTip(STR_SMALLMAP_DISABLE_ALL, disable_all_tooltip);
1317 this->GetWidget<NWidgetStacked>(WID_SM_SHOW_IND_NAMES_SEL)->SetDisplayedPlane(industry_names_select_plane);
1318 this->GetWidget<NWidgetStacked>(WID_SM_SELECT_BUTTONS)->SetDisplayedPlane(select_buttons_plane);
1319 }
1320
1326 uint32_t GetTileColours(const TileArea &ta) const
1327 {
1328 int importance = 0;
1329 TileIndex tile = INVALID_TILE; // Position of the most important tile.
1330 TileType et = TileType::Void; // Effective tile type at that position.
1331
1332 for (TileIndex ti : ta) {
1333 TileType ttype = GetTileType(ti);
1334
1335 switch (ttype) {
1338
1339 switch (tt) {
1340 case TRANSPORT_RAIL: ttype = TileType::Railway; break;
1341 case TRANSPORT_ROAD: ttype = TileType::Road; break;
1342 default: ttype = TileType::Water; break;
1343 }
1344 break;
1345 }
1346
1347 case TileType::Industry:
1348 /* Special handling of industries while in "Industries" smallmap view. */
1349 if (this->map_type == SMT_INDUSTRY) {
1350 /* If industry is allowed to be seen, use its colour on the map.
1351 * This has the highest priority above any value in _tiletype_importance. */
1352 IndustryType type = Industry::GetByTile(ti)->type;
1353 if (_legend_from_industries[_industry_to_list_pos[type]].show_on_map) {
1354 if (type == _smallmap_industry_highlight) {
1355 if (_smallmap_industry_highlight_state) return MKCOLOUR_XXXX(PC_WHITE);
1356 } else {
1357 return GetIndustrySpec(type)->map_colour.p * 0x01010101;
1358 }
1359 }
1360 /* Otherwise make it disappear */
1362 }
1363 break;
1364
1365 default:
1366 break;
1367 }
1368
1369 if (_tiletype_importance[ttype] > importance) {
1370 importance = _tiletype_importance[ttype];
1371 tile = ti;
1372 et = ttype;
1373 }
1374 }
1375
1376 switch (this->map_type) {
1377 case SMT_CONTOUR:
1378 return GetSmallMapContoursPixels(tile, et);
1379
1380 case SMT_VEHICLES:
1381 return GetSmallMapVehiclesPixels(et);
1382
1383 case SMT_INDUSTRY:
1384 return GetSmallMapIndustriesPixels(tile, et);
1385
1386 case SMT_LINKSTATS:
1387 return GetSmallMapLinkStatsPixels(tile, et);
1388
1389 case SMT_ROUTES:
1390 return GetSmallMapRoutesPixels(tile, et);
1391
1392 case SMT_VEGETATION:
1393 return GetSmallMapVegetationPixels(tile, et);
1394
1395 case SMT_OWNER:
1397
1398 default: NOT_REACHED();
1399 }
1400 }
1401
1408 {
1410 uint line = (pt.y - wi->pos_y - WidgetDimensions::scaled.framerect.top) / GetCharacterHeight(FS_SMALL);
1411 uint columns = this->GetNumberColumnsLegend(wi->current_x);
1412 uint number_of_rows = this->GetNumberRowsLegend(columns);
1413 if (line >= number_of_rows) return -1;
1414
1415 bool rtl = _current_text_dir == TD_RTL;
1416 int x = pt.x - wi->pos_x;
1417 if (rtl) x = wi->current_x - x;
1418 uint column = (x - WidgetDimensions::scaled.framerect.left) / this->column_width;
1419
1420 return (column * number_of_rows) + line;
1421 }
1422
1425 {
1426 if (this->map_type == SMT_LINKSTATS) {
1427 CompanyMask company_mask = this->GetOverlayCompanyMask();
1428 if (this->overlay->GetCompanyMask() != company_mask) {
1429 this->overlay->SetCompanyMask(company_mask);
1430 } else {
1431 this->overlay->SetDirty();
1432 }
1433 }
1434 }
1435
1437 void Blink()
1438 {
1439 if (_smallmap_industry_highlight == IT_INVALID) return;
1440
1442
1443 this->UpdateLinks();
1444 this->SetDirty();
1445 }
1446
1449 {
1450 if (_smallmap_industry_highlight != IT_INVALID) return;
1451
1452 this->UpdateLinks();
1453 this->SetDirty();
1454 }
1455
1456public:
1457 friend class NWidgetSmallmapDisplay;
1458
1459 SmallMapWindow(WindowDesc &desc, int window_number) : Window(desc)
1460 {
1461 _smallmap_industry_highlight = IT_INVALID;
1462 this->overlay = std::make_unique<LinkGraphOverlay>(this, WID_SM_MAP, 0, this->GetOverlayCompanyMask(), 1);
1463 this->CreateNestedTree();
1464 this->LowerWidget(WID_SM_CONTOUR + this->map_type);
1465
1466 this->RebuildColourIndexIfNecessary();
1467
1468 this->SetWidgetLoweredState(WID_SM_SHOW_HEIGHT, _smallmap_show_heightmap);
1469
1470 this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME, this->show_towns);
1471 this->SetWidgetLoweredState(WID_SM_SHOW_IND_NAMES, this->show_ind_names);
1472
1473 this->SetupWidgetData();
1474 this->FinishInitNested(window_number);
1475
1476 this->SetZoomLevel(ZLC_INITIALIZE, nullptr);
1477 this->SmallMapCenterOnCurrentPos();
1478 this->SetOverlayCargoMask();
1479 }
1480
1485 {
1486 const Viewport &vp = *GetMainWindow()->viewport;
1487 Point viewport_center = InverseRemapCoords2(vp.virtual_left + vp.virtual_width / 2, vp.virtual_top + vp.virtual_height / 2);
1488
1489 int sub;
1490 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1491 Point sxy = this->ComputeScroll(viewport_center.x / (int)TILE_SIZE, viewport_center.y / (int)TILE_SIZE,
1492 std::max(0, (int)wid->current_x / 2 - 2), wid->current_y / 2, &sub);
1493 this->SetNewScroll(sxy.x, sxy.y, sub);
1494 this->SetDirty();
1495 }
1496
1503 {
1504 int x = CentreBounds(st->rect.left, st->rect.right, 0);
1505 int y = CentreBounds(st->rect.top, st->rect.bottom, 0);
1506 Point ret = this->RemapTile(x, y);
1507
1508 /* Same magic 3 as in DrawVehicles; that's where I got it from.
1509 * No idea what it is, but without it the result looks bad.
1510 */
1511 ret.x -= 3 + this->subscroll;
1512 return ret;
1513 }
1514
1515 void Close([[maybe_unused]] int data) override
1516 {
1517 this->BreakIndustryChainLink();
1518 this->Window::Close();
1519 }
1520
1521 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1522 {
1523 switch (widget) {
1524 case WID_SM_CAPTION:
1525 return GetString(STR_SMALLMAP_CAPTION, STR_SMALLMAP_TYPE_CONTOURS + this->map_type);
1526
1527 default:
1528 return this->Window::GetWidgetString(widget, stringid);
1529 }
1530 }
1531
1532 void OnInit() override
1533 {
1534 uint min_width = 0;
1535 this->min_number_of_columns = INDUSTRY_MIN_NUMBER_OF_COLUMNS;
1536 this->min_number_of_fixed_rows = lengthof(_linkstat_colours_in_legenda);
1537 for (uint i = 0; i < lengthof(_legend_table); i++) {
1538 uint height = 0;
1539 uint num_columns = 1;
1540 for (const LegendAndColour *tbl = _legend_table[i]; !tbl->end; ++tbl) {
1541 std::string str;
1542 if (i == SMT_INDUSTRY) {
1543 str = GetString(STR_SMALLMAP_INDUSTRY, tbl->legend, IndustryPool::MAX_SIZE);
1544 } else if (i == SMT_LINKSTATS) {
1545 str = GetString(STR_SMALLMAP_LINKSTATS, tbl->legend);
1546 } else if (i == SMT_OWNER) {
1547 if (tbl->company != CompanyID::Invalid()) {
1548 if (!Company::IsValidID(tbl->company)) {
1549 /* Rebuild the owner legend. */
1551 this->OnInit();
1552 return;
1553 }
1554 /* Non-fixed legend entries for the owner view. */
1555 str = GetString(STR_SMALLMAP_COMPANY, tbl->company);
1556 } else {
1557 str = GetString(tbl->legend);
1558 }
1559 } else {
1560 if (tbl->col_break) {
1561 this->min_number_of_fixed_rows = std::max(this->min_number_of_fixed_rows, height);
1562 height = 0;
1563 num_columns++;
1564 }
1565 height++;
1566 if (i == SMT_CONTOUR) {
1567 str = GetString(tbl->legend, tbl->height * TILE_HEIGHT_STEP);
1568 } else {
1569 str = GetString(tbl->legend);
1570 }
1571 }
1572 min_width = std::max(GetStringBoundingBox(str).width, min_width);
1573 }
1574 this->min_number_of_fixed_rows = std::max(this->min_number_of_fixed_rows, height);
1575 this->min_number_of_columns = std::max(this->min_number_of_columns, num_columns);
1576 }
1577
1578 /* Width of the legend blob. */
1579 this->legend_width = GetCharacterHeight(FS_SMALL) * 9 / 6;
1580
1581 /* The width of a column is the minimum width of all texts + the size of the blob + some spacing */
1582 this->column_width = min_width + WidgetDimensions::scaled.hsep_normal + this->legend_width + WidgetDimensions::scaled.framerect.Horizontal();
1583
1584 /* Cached string widths of industry names in the smallmap. Calculation is deferred to DrawIndustryNames(). */
1585 std::fill(std::begin(_industry_to_name_string_width), std::end(_industry_to_name_string_width), 0);
1586 }
1587
1588 void OnPaint() override
1589 {
1590 if (this->map_type == SMT_OWNER) {
1591 for (const LegendAndColour *tbl = _legend_table[this->map_type]; !tbl->end; ++tbl) {
1592 if (tbl->company != CompanyID::Invalid() && !Company::IsValidID(tbl->company)) {
1593 /* Rebuild the owner legend. */
1595 this->InvalidateData(1);
1596 break;
1597 }
1598 }
1599 }
1600
1601 this->DrawWidgets();
1602 }
1603
1604 void DrawWidget(const Rect &r, WidgetID widget) const override
1605 {
1606 switch (widget) {
1607 case WID_SM_MAP: {
1608 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1609 DrawPixelInfo new_dpi;
1610 if (!FillDrawPixelInfo(&new_dpi, ir)) return;
1611 this->DrawSmallMap(&new_dpi);
1612 break;
1613 }
1614
1615 case WID_SM_LEGEND: {
1616 uint columns = this->GetNumberColumnsLegend(r.Width());
1617 uint number_of_rows = this->GetNumberRowsLegend(columns);
1618 bool rtl = _current_text_dir == TD_RTL;
1619 uint i = 0; // Row counter for industry legend.
1620 uint row_height = GetCharacterHeight(FS_SMALL);
1621 int padding = ScaleGUITrad(1);
1622
1623 Rect origin = r.WithWidth(this->column_width, rtl).Shrink(WidgetDimensions::scaled.framerect).WithHeight(row_height);
1624 Rect text = origin.Indent(this->legend_width + WidgetDimensions::scaled.hsep_normal, rtl);
1625 Rect icon = origin.WithWidth(this->legend_width, rtl).Shrink(0, padding, 0, 0);
1626
1627 StringID string = STR_NULL;
1628 switch (this->map_type) {
1629 case SMT_INDUSTRY:
1630 string = STR_SMALLMAP_INDUSTRY;
1631 break;
1632 case SMT_LINKSTATS:
1633 string = STR_SMALLMAP_LINKSTATS;
1634 break;
1635 case SMT_OWNER:
1636 string = STR_SMALLMAP_COMPANY;
1637 break;
1638 default:
1639 break;
1640 }
1641
1642 for (const LegendAndColour *tbl = _legend_table[this->map_type]; !tbl->end; ++tbl) {
1643 if (tbl->col_break || ((this->map_type == SMT_INDUSTRY || this->map_type == SMT_OWNER || this->map_type == SMT_LINKSTATS) && i++ >= number_of_rows)) {
1644 /* Column break needed, continue at top, COLUMN_WIDTH pixels
1645 * (one "row") to the right. */
1646 int x = rtl ? -(int)this->column_width : this->column_width;
1647 int y = origin.top - text.top;
1648 text = text.Translate(x, y);
1649 icon = icon.Translate(x, y);
1650 i = 1;
1651 }
1652
1653 PixelColour legend_colour = tbl->colour;
1654
1655 std::array<StringParameter, 2> params{};
1656 switch (this->map_type) {
1657 case SMT_INDUSTRY:
1658 /* Industry name must be formatted, since it's not in tiny font in the specs.
1659 * So, draw with a parameter and use the STR_SMALLMAP_INDUSTRY string, which is tiny font */
1660 params[0] = tbl->legend;
1661 params[1] = Industry::GetIndustryTypeCount(tbl->type);
1662 if (tbl->show_on_map && tbl->type == _smallmap_industry_highlight) {
1664 }
1665 [[fallthrough]];
1666
1667 case SMT_LINKSTATS:
1668 params[0] = tbl->legend;
1669 [[fallthrough]];
1670
1671 case SMT_OWNER:
1672 if (this->map_type != SMT_OWNER || tbl->company != CompanyID::Invalid()) {
1673 if (this->map_type == SMT_OWNER) params[0] = tbl->company;
1674 if (!tbl->show_on_map) {
1675 /* Simply draw the string, not the black border of the legend colour.
1676 * This will enforce the idea of the disabled item */
1677 DrawString(text, GetStringWithArgs(string, params), TC_GREY);
1678 } else {
1679 DrawString(text, GetStringWithArgs(string, params), TC_BLACK);
1680 GfxFillRect(icon, PC_BLACK); // Outer border of the legend colour
1681 }
1682 break;
1683 }
1684 [[fallthrough]];
1685
1686 default:
1687 /* Anything that is not an industry or a company is using normal process */
1688 GfxFillRect(icon, PC_BLACK);
1689 if (this->map_type == SMT_CONTOUR) {
1690 DrawString(text, GetString(tbl->legend, tbl->height * TILE_HEIGHT_STEP));
1691 } else {
1692 DrawString(text, tbl->legend);
1693 }
1694 break;
1695 }
1696 GfxFillRect(icon.Shrink(WidgetDimensions::scaled.bevel), legend_colour); // Legend colour
1697
1698 text = text.Translate(0, row_height);
1699 icon = icon.Translate(0, row_height);
1700 }
1701 }
1702 }
1703 }
1704
1705 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1706 {
1707 switch (widget) {
1708 case WID_SM_MAP: { // Map window
1709 if (click_count > 0) this->mouse_capture_widget = widget;
1710
1711 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1712 Window *w = GetMainWindow();
1713 int sub;
1714 pt = this->PixelToTile(pt.x - wid->pos_x, pt.y - wid->pos_y, &sub);
1715 ScrollWindowTo(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, -1, w);
1716
1717 this->SetDirty();
1718 break;
1719 }
1720
1721 case WID_SM_ZOOM_IN:
1722 case WID_SM_ZOOM_OUT: {
1723 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1724 Point zoom_pt = { (int)wid->current_x / 2, (int)wid->current_y / 2};
1725 this->SetZoomLevel((widget == WID_SM_ZOOM_IN) ? ZLC_ZOOM_IN : ZLC_ZOOM_OUT, &zoom_pt);
1726 SndClickBeep();
1727 break;
1728 }
1729
1730 case WID_SM_CONTOUR: // Show land contours
1731 case WID_SM_VEHICLES: // Show vehicles
1732 case WID_SM_INDUSTRIES: // Show industries
1733 case WID_SM_LINKSTATS: // Show route map
1734 case WID_SM_ROUTES: // Show transport routes
1735 case WID_SM_VEGETATION: // Show vegetation
1736 case WID_SM_OWNERS: // Show land owners
1737 this->SwitchMapType((SmallMapType)(widget - WID_SM_CONTOUR));
1738 SndClickBeep();
1739 break;
1740
1741 case WID_SM_CENTERMAP: // Center the smallmap again
1744 break;
1745
1746 case WID_SM_TOGGLETOWNNAME: // Toggle town names
1747 this->show_towns = !this->show_towns;
1748 this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME, this->show_towns);
1749
1750 this->SetDirty();
1751 SndClickBeep();
1752 break;
1753
1754 case WID_SM_SHOW_IND_NAMES: // Toggle industry names
1755 this->show_ind_names = !this->show_ind_names;
1756 this->SetWidgetLoweredState(WID_SM_SHOW_IND_NAMES, this->show_ind_names);
1757
1758 this->SetDirty();
1759 SndClickBeep();
1760 break;
1761
1762 case WID_SM_LEGEND: // Legend
1763 if (this->map_type == SMT_INDUSTRY || this->map_type == SMT_LINKSTATS || this->map_type == SMT_OWNER) {
1764 int click_pos = this->GetPositionOnLegend(pt);
1765 if (click_pos < 0) break;
1766
1767 /* If industry type small map*/
1768 if (this->map_type == SMT_INDUSTRY) {
1769 /* If click on industries label, find right industry type and enable/disable it. */
1770 if (click_pos < _smallmap_industry_count) {
1772 }
1773 } else if (this->map_type == SMT_LINKSTATS) {
1774 if (click_pos < _smallmap_cargo_count) {
1776 this->SetOverlayCargoMask();
1777 }
1778 } else if (this->map_type == SMT_OWNER) {
1779 if (click_pos < _smallmap_company_count) {
1780 this->SelectLegendItem(click_pos, _legend_land_owners, _smallmap_company_count, NUM_NO_COMPANY_ENTRIES);
1781 }
1782 }
1783 this->SetDirty();
1784 }
1785 break;
1786
1787 case WID_SM_ENABLE_ALL:
1788 case WID_SM_DISABLE_ALL: {
1789 LegendAndColour *tbl = nullptr;
1790 switch (this->map_type) {
1791 case SMT_INDUSTRY:
1793 this->BreakIndustryChainLink();
1794 break;
1795 case SMT_OWNER:
1796 tbl = &(_legend_land_owners[NUM_NO_COMPANY_ENTRIES]);
1797 break;
1798 case SMT_LINKSTATS:
1799 tbl = _legend_linkstats;
1800 break;
1801 default:
1802 NOT_REACHED();
1803 }
1804 for (;!tbl->end && tbl->legend != STR_LINKGRAPH_LEGEND_UNUSED; ++tbl) {
1805 tbl->show_on_map = (widget == WID_SM_ENABLE_ALL);
1806 }
1807 if (this->map_type == SMT_LINKSTATS) this->SetOverlayCargoMask();
1808 this->SetDirty();
1809 break;
1810 }
1811
1812 case WID_SM_SHOW_HEIGHT: // Enable/disable showing of heightmap.
1815 this->SetDirty();
1816 break;
1817 }
1818 }
1819
1828 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1829 {
1830 if (!gui_scope) return;
1831
1832 switch (data) {
1833 case 1:
1834 /* The owner legend has already been rebuilt. */
1835 this->ReInit();
1836 break;
1837
1838 case 0: {
1839 extern std::bitset<NUM_INDUSTRYTYPES> _displayed_industries;
1840 if (this->map_type != SMT_INDUSTRY) this->SwitchMapType(SMT_INDUSTRY);
1841
1842 for (int i = 0; i != _smallmap_industry_count; i++) {
1844 }
1845 break;
1846 }
1847
1848 case 2:
1850 break;
1851
1852 default: NOT_REACHED();
1853 }
1854 this->SetDirty();
1855 }
1856
1857 bool OnRightClick(Point, WidgetID widget) override
1858 {
1859 if (widget != WID_SM_MAP || _scrolling_viewport) return false;
1860
1861 _scrolling_viewport = true;
1862 return true;
1863 }
1864
1865 void OnMouseWheel(int wheel, WidgetID widget) override
1866 {
1867 if (widget != WID_SM_MAP) return;
1868 if (_settings_client.gui.scrollwheel_scrolling != ScrollWheelScrolling::Off) {
1869 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1870 int cursor_x = _cursor.pos.x - this->left - wid->pos_x;
1871 int cursor_y = _cursor.pos.y - this->top - wid->pos_y;
1872 Point pt = {cursor_x, cursor_y};
1873 this->SetZoomLevel((wheel < 0) ? ZLC_ZOOM_IN : ZLC_ZOOM_OUT, &pt);
1874 }
1875 }
1876
1877 void OnScroll(Point delta) override
1878 {
1879 if (_settings_client.gui.scroll_mode == ViewportScrollMode::ViewportRMBFixed || _settings_client.gui.scroll_mode == ViewportScrollMode::MapRMBFixed) _cursor.fix_at = true;
1880
1881 /* While tile is at (delta.x, delta.y)? */
1882 int sub;
1883 Point pt = this->PixelToTile(delta.x, delta.y, &sub);
1884 this->SetNewScroll(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, sub);
1885
1886 this->SetDirty();
1887 }
1888
1889 void OnMouseOver([[maybe_unused]] Point pt, WidgetID widget) override
1890 {
1891 IndustryType new_highlight = IT_INVALID;
1892 if (widget == WID_SM_LEGEND && this->map_type == SMT_INDUSTRY) {
1893 int industry_pos = GetPositionOnLegend(pt);
1894 if (industry_pos >= 0 && industry_pos < _smallmap_industry_count) {
1895 new_highlight = _legend_from_industries[industry_pos].type;
1896 }
1897 }
1898 if (new_highlight != _smallmap_industry_highlight) {
1899 _smallmap_industry_highlight = new_highlight;
1901 this->SetDirty();
1902 }
1903 }
1904
1905};
1906
1908bool SmallMapWindow::show_towns = true;
1911
1920class NWidgetSmallmapDisplay : public NWidgetContainer {
1922public:
1923 NWidgetSmallmapDisplay() : NWidgetContainer(NWID_VERTICAL) {}
1924
1925 void SetupSmallestSize(Window *w) override
1926 {
1927 assert(this->children.size() == 2);
1928 NWidgetBase *display = this->children.front().get();
1929 NWidgetBase *bar = this->children.back().get();
1930
1931 display->SetupSmallestSize(w);
1932 bar->SetupSmallestSize(w);
1933
1934 this->smallmap_window = dynamic_cast<SmallMapWindow *>(w);
1935 assert(this->smallmap_window != nullptr);
1936 this->smallest_x = std::max(display->smallest_x, bar->smallest_x + smallmap_window->GetMinLegendWidth());
1937 this->smallest_y = display->smallest_y + std::max(bar->smallest_y, smallmap_window->GetLegendHeight(smallmap_window->min_number_of_columns));
1938 this->fill_x = std::max(display->fill_x, bar->fill_x);
1939 this->fill_y = (display->fill_y == 0 && bar->fill_y == 0) ? 0 : std::min(display->fill_y, bar->fill_y);
1940 this->resize_x = std::max(display->resize_x, bar->resize_x);
1941 this->resize_y = std::min(display->resize_y, bar->resize_y);
1942 this->ApplyAspectRatio();
1943 }
1944
1945 void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
1946 {
1947 this->pos_x = x;
1948 this->pos_y = y;
1949 this->current_x = given_width;
1950 this->current_y = given_height;
1951
1952 assert(this->children.size() == 2);
1953 NWidgetBase *display = this->children.front().get();
1954 NWidgetBase *bar = this->children.back().get();
1955
1956 if (sizing == ST_SMALLEST) {
1957 this->smallest_x = given_width;
1958 this->smallest_y = given_height;
1959 /* Make display and bar exactly equal to their minimal size. */
1960 display->AssignSizePosition(ST_SMALLEST, x, y, display->smallest_x, display->smallest_y, rtl);
1961 bar->AssignSizePosition(ST_SMALLEST, x, y + display->smallest_y, bar->smallest_x, bar->smallest_y, rtl);
1962 }
1963
1964 uint bar_height = std::max(bar->smallest_y, this->smallmap_window->GetLegendHeight(this->smallmap_window->GetNumberColumnsLegend(given_width - bar->smallest_x)));
1965 uint display_height = given_height - bar_height;
1966 display->AssignSizePosition(ST_RESIZE, x, y, given_width, display_height, rtl);
1967 bar->AssignSizePosition(ST_RESIZE, x, y + display_height, given_width, bar_height, rtl);
1968 }
1969};
1970
1972static constexpr std::initializer_list<NWidgetPart> _nested_smallmap_display = {
1973 NWidget(WWT_PANEL, COLOUR_BROWN, WID_SM_MAP_BORDER),
1974 NWidget(WWT_INSET, COLOUR_BROWN, WID_SM_MAP), SetMinimalSize(346, 140), SetResize(1, 1), SetPadding(2, 2, 2, 2), EndContainer(),
1975 EndContainer(),
1976};
1977
1979static constexpr std::initializer_list<NWidgetPart> _nested_smallmap_bar = {
1980 NWidget(WWT_PANEL, COLOUR_BROWN),
1982 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SM_LEGEND), SetResize(1, 1),
1984 /* Top button row. */
1986 NWidget(WWT_PUSHIMGBTN, COLOUR_BROWN, WID_SM_ZOOM_IN),
1987 SetSpriteTip(SPR_IMG_ZOOMIN, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_IN), SetFill(1, 1),
1988 NWidget(WWT_PUSHIMGBTN, COLOUR_BROWN, WID_SM_CENTERMAP),
1989 SetSpriteTip(SPR_IMG_SMALLMAP, STR_SMALLMAP_CENTER_TOOLTIP), SetFill(1, 1),
1990 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_BLANK),
1991 SetSpriteTip(SPR_EMPTY), SetFill(1, 1),
1992 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_CONTOUR),
1993 SetSpriteTip(SPR_IMG_SHOW_COUNTOURS, STR_SMALLMAP_TOOLTIP_SHOW_LAND_CONTOURS_ON_MAP), SetFill(1, 1),
1994 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_VEHICLES),
1995 SetSpriteTip(SPR_IMG_SHOW_VEHICLES, STR_SMALLMAP_TOOLTIP_SHOW_VEHICLES_ON_MAP), SetFill(1, 1),
1996 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_INDUSTRIES),
1997 SetSpriteTip(SPR_IMG_INDUSTRY, STR_SMALLMAP_TOOLTIP_SHOW_INDUSTRIES_ON_MAP), SetFill(1, 1),
1998 EndContainer(),
1999 /* Bottom button row. */
2001 NWidget(WWT_PUSHIMGBTN, COLOUR_BROWN, WID_SM_ZOOM_OUT),
2002 SetSpriteTip(SPR_IMG_ZOOMOUT, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_OUT), SetFill(1, 1),
2004 SetSpriteTip(SPR_IMG_TOWN, STR_SMALLMAP_TOOLTIP_TOGGLE_TOWN_NAMES_ON_OFF), SetFill(1, 1),
2005 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_LINKSTATS),
2006 SetSpriteTip(SPR_IMG_CARGOFLOW, STR_SMALLMAP_TOOLTIP_SHOW_LINK_STATS_ON_MAP), SetFill(1, 1),
2007 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_ROUTES),
2008 SetSpriteTip(SPR_IMG_SHOW_ROUTES, STR_SMALLMAP_TOOLTIP_SHOW_TRANSPORT_ROUTES_ON), SetFill(1, 1),
2009 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_VEGETATION),
2010 SetSpriteTip(SPR_IMG_PLANTTREES, STR_SMALLMAP_TOOLTIP_SHOW_VEGETATION_ON_MAP), SetFill(1, 1),
2011 NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_OWNERS),
2012 SetSpriteTip(SPR_IMG_COMPANY_GENERAL, STR_SMALLMAP_TOOLTIP_SHOW_LAND_OWNERS_ON_MAP), SetFill(1, 1),
2013 EndContainer(),
2015 EndContainer(),
2016 EndContainer(),
2017 EndContainer(),
2018};
2019
2020static std::unique_ptr<NWidgetBase> SmallMapDisplay()
2021{
2022 std::unique_ptr<NWidgetBase> map_display = std::make_unique<NWidgetSmallmapDisplay>();
2023
2024 map_display = MakeNWidgets(_nested_smallmap_display, std::move(map_display));
2025 map_display = MakeNWidgets(_nested_smallmap_bar, std::move(map_display));
2026 return map_display;
2027}
2028
2029static constexpr std::initializer_list<NWidgetPart> _nested_smallmap_widgets = {
2031 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
2032 NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SM_CAPTION),
2033 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
2034 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
2035 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
2036 EndContainer(),
2037 NWidgetFunction(SmallMapDisplay), // Smallmap display and legend bar + image buttons.
2038 /* Bottom button row and resize box. */
2042 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_SM_ENABLE_ALL), SetStringTip(STR_SMALLMAP_ENABLE_ALL),
2043 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_SM_DISABLE_ALL), SetStringTip(STR_SMALLMAP_DISABLE_ALL),
2044 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SM_SHOW_HEIGHT), SetStringTip(STR_SMALLMAP_SHOW_HEIGHT, STR_SMALLMAP_TOOLTIP_SHOW_HEIGHT),
2045
2046 /* 'show industry names' button and container. Only shown for the industry map type. */
2048 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SM_SHOW_IND_NAMES), SetStringTip(STR_SMALLMAP_SHOW_INDUSTRY_NAMES, STR_SMALLMAP_TOOLTIP_SHOW_INDUSTRY_NAMES),
2049 EndContainer(),
2050
2051 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 0), SetResize(1, 0),
2052 EndContainer(),
2053 EndContainer(),
2054 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 0), SetResize(1, 0),
2055 EndContainer(),
2056 EndContainer(),
2057 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
2058 EndContainer(),
2059};
2060
2061static WindowDesc _smallmap_desc(
2062 WDP_AUTO, "smallmap", 484, 314,
2064 {},
2065 _nested_smallmap_widgets
2066);
2067
2072{
2073 AllocateWindowDescFront<SmallMapWindow>(_smallmap_desc, 0);
2074}
2075
2084bool ScrollMainWindowTo(int x, int y, int z, bool instant)
2085{
2086 bool res = ScrollWindowTo(x, y, z, GetMainWindow(), instant);
2087
2088 /* If a user scrolls to a tile (via what way what so ever) and already is on
2089 * that tile (e.g.: pressed twice), move the smallmap to that location,
2090 * so you directly see where you are on the smallmap. */
2091
2092 if (res) return res;
2093
2095 if (w != nullptr) w->SmallMapCenterOnCurrentPos();
2096
2097 return res;
2098}
2099
2107{
2108 return static_cast<const SmallMapWindow *>(w)->GetStationMiddle(st);
2109}
Class for backupping variables and making sure they are restored later.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
static const CargoType NUM_CARGO
Maximum number of cargo types in a game.
Definition cargo_type.h:73
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
constexpr Timpl & Set()
Set all bits.
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition factory.hpp:139
How all blitters should look like.
Definition base.hpp:29
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...
virtual void SetPixel(void *video, int x, int y, PixelColour colour)=0
Draw a pixel with a given colour on the video-buffer.
A sort-of mixin that implements 'at(pos)' and 'operator[](pos)' only for a specific enum class.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
static const PixelColour LINK_COLOURS[][12]
Colours for the various "load" states of links.
Baseclass for nested widgets.
virtual void SetDirty(const Window *w) const
Mark the widget as 'dirty' (in need of repaint).
Definition widget.cpp:933
WidgetType type
Type of the widget / nested widget.
uint resize_x
Horizontal resize step (0 means not resizable).
uint fill_x
Horizontal fill stepsize (from initial size, 0 means not resizable).
virtual void SetupSmallestSize(Window *w)=0
Compute smallest size needed by the widget.
uint smallest_x
Smallest horizontal size of the widget in a filled window.
uint current_x
Current horizontal size (after resizing).
int pos_y
Vertical position of top-left corner of the widget in the window.
int pos_x
Horizontal position of top-left corner of the widget in the window.
virtual void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl)=0
Assign size and position to the widget.
uint smallest_y
Smallest vertical size of the widget in a filled window.
uint fill_y
Vertical fill stepsize (from initial size, 0 means not resizable).
uint resize_y
Vertical resize step (0 means not resizable).
RectPadding padding
Padding added to the widget. Managed by parent container widget. (parent container may swap left and ...
uint current_y
Current vertical size (after resizing).
std::vector< std::unique_ptr< NWidgetBase > > children
Child widgets in container.
Custom container class for displaying smallmap with a vertically resizing legend panel.
void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
Assign size and position to the widget.
void SetupSmallestSize(Window *w) override
Compute smallest size needed by the widget.
const SmallMapWindow * smallmap_window
Window manager instance.
PixelColour map_colour
Colour on mini-map.
Definition road.h:131
Class managing the smallmap window.
void SmallMapCenterOnCurrentPos()
Center the small map on the current center of the viewport.
void SetOverlayCargoMask()
Set the link graph overlay cargo mask from the legend.
void Close(int data) override
Hide the window and all its child windows, and mark them for a later deletion.
static SmallMapType map_type
Currently displayed legends.
uint GetNumberColumnsLegend(uint width) const
Return number of columns that can be displayed in width pixels.
uint column_width
Width of a column in the WID_SM_LEGEND widget.
uint min_number_of_fixed_rows
Minimal number of rows in the legends for the fixed layouts only (all except SMT_INDUSTRY).
void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item=0)
Select and toggle a legend item.
void SwitchMapType(SmallMapType map_type)
Select a new map type.
const IntervalTimer< TimerWindow > blink_interval
Blink the industries (if selected) on a regular interval.
void DrawSmallMap(DrawPixelInfo *dpi) const
Draws the small map.
Point ComputeScroll(int tx, int ty, int x, int y, int *sub) const
Compute base parameters of the smallmap such that tile (tx, ty) starts at pixel (x,...
Point GetStationMiddle(const Station *st) const
Get the center of the given station as point on the screen in the smallmap window.
void ForceRefresh()
Force a full refresh of the map.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
uint GetMinLegendWidth() const
Compute minimal required width of the legends.
static bool show_towns
Display town names in the smallmap.
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...
void Blink()
Blink the industries (if hover over an industry).
int32_t scroll_y
Vertical world coordinate of the base tile left of the top-left corner of the smallmap display.
int32_t scroll_x
Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display.
void DrawIndustryNames(const DrawPixelInfo *dpi, const int vertical_padding) const
Adds industry names to the smallmap.
static void DrawVertMapIndicator(int x, int y, int y2)
Draws vertical part of map indicator.
uint GetLegendHeight(uint num_columns) const
Compute height given a number of columns.
uint min_number_of_columns
Minimal number of columns in legends.
int32_t subscroll
Number of pixels (0..3) between the right end of the base tile and the pixel at the top-left corner o...
CompanyMask GetOverlayCompanyMask() const
Get a bitmask for company links to be displayed.
uint32_t GetTileColours(const TileArea &ta) const
Decide which colours to show to the user for a group of tiles.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void DrawTowns(const DrawPixelInfo *dpi, const int vertical_padding) const
Adds town names to the smallmap.
void OnPaint() override
The window must be repainted.
void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt)
Initialize or change the zoom level.
int GetPositionOnLegend(Point pt)
Determines the mouse position on the legend.
void OnMouseWheel(int wheel, WidgetID widget) override
The mouse wheel has been turned.
void OnMouseOver(Point pt, WidgetID widget) override
The mouse is currently moving over the window or has just moved outside of the window.
ZoomLevelChange
Available kinds of zoomlevel changes.
@ ZLC_ZOOM_IN
Zoom in.
@ ZLC_ZOOM_OUT
Zoom out.
@ ZLC_INITIALIZE
Initialize zoom level.
void SetupWidgetData()
Function to set up widgets depending on the information being shown on the smallmap.
static bool show_ind_names
Display industry names in the smallmap.
void RebuildColourIndexIfNecessary()
Rebuilds the colour indices used for fast access to the smallmap contour colours based on the heightl...
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,...
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
static int map_height_limit
Currently used/cached map height limit.
Point RemapTile(int tile_x, int tile_y) const
Remap tile to location on this smallmap.
static void DrawHorizMapIndicator(int x, int x2, int y)
Draws horizontal part of map indicator.
void OnInit() override
Notification that the nested widget tree gets initialized.
void UpdateLinks()
Update all the links on the map.
static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS
Minimal number of columns in the WID_SM_LEGEND widget for the SMT_INDUSTRY legend.
void OnScroll(Point delta) override
Handle the request for (viewport) scrolling.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
uint legend_width
Width of legend 'blob'.
int zoom
Zoom level. Bigger number means more zoom-out (further away).
void DrawMapIndicators() const
Adds map indicators to the smallmap.
bool OnRightClick(Point, WidgetID widget) override
A click with the right mouse button has been made on the window.
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...
uint GetNumberRowsLegend(uint columns) const
Get the number of rows in the legend from the number of columns.
const IntervalTimer< TimerWindow > refresh_interval
Update the whole map on a regular interval.
void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
Adds vehicles to the smallmap.
static void BreakIndustryChainLink()
Notify the industry chain window to stop sending newly selected industries.
A sort-of mixin that implements 'at(pos)' and 'operator[](pos)' only for a specific type.
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
Map accessors for 'clear' tiles.
bool IsClearGround(Tile t, ClearGround ct)
Set the type of clear tile.
Definition clear_map.h:65
@ MaxSize
The maximum possible number of clear ground types to be stored in map.
Definition clear_map.h:29
@ Grass
Plain grass with dirt transition (0-3).
Definition clear_map.h:22
ClearGround GetClearGround(Tile t)
Get the type of clear tile.
Definition clear_map.h:52
bool IsSnowTile(Tile t)
Test if a tile is covered with snow.
Definition clear_map.h:40
uint GetClearDensity(Tile t)
Get the density of a non-field clear tile.
Definition clear_map.h:77
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
static constexpr Owner OWNER_TOWN
A town owns the tile, or a town is expanding.
static constexpr Owner OWNER_NONE
The tile has no ownership.
static constexpr Owner OWNER_WATER
The tile/execution is done by "water".
Function to handling different endian machines.
Type (helpers) for enums.
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23).
Definition enum_type.hpp:21
#define DECLARE_ENUM_AS_ADDABLE(EnumType)
Operator that allows this enumeration to be added to any other enumeration.
Factory to 'query' all available blitters.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:87
int CentreBounds(int min, int max, int size)
Determine where to position a centred object.
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:900
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:669
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:39
void GfxFillRect(int left, int top, int right, int bottom, const std::variant< PixelColour, PaletteID > &colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition gfx.cpp:116
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:1573
@ FS_SMALL
Index of the small font in the font tables.
Definition gfx_type.h:250
@ SA_LEFT
Left align the text.
Definition gfx_type.h:388
constexpr NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
constexpr NWidgetPart SetSpriteTip(SpriteID sprite, StringID tip={})
Widget part function for setting the sprite and tooltip.
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
std::unique_ptr< NWidgetBase > MakeNWidgets(std::span< const NWidgetPart > nwid_parts, std::unique_ptr< NWidgetBase > &&container)
Construct a nested widget tree from an array of parts.
Definition widget.cpp:3379
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
void SetDirty() const
Mark entire window as dirty (in need of re-paint).
Definition window.cpp:980
The colour tables for heightmaps.
static const uint32_t _violet_map_heights[]
Height map colours for the violet colour scheme, ordered by height.
static const uint32_t _dark_green_map_heights[]
Height map colours for the dark green colour scheme, ordered by height.
static const uint32_t _green_map_heights[]
Height map colours for the green colour scheme, ordered by height.
Base of all industries.
bool IsTileForestIndustry(TileIndex tile)
Check whether the tile is a forest.
const IndustrySpec * GetIndustrySpec(IndustryType thistype)
Accessor for array _industry_specs.
std::array< IndustryType, NUM_INDUSTRYTYPES > _sorted_industry_types
Industry types sorted by name.
std::bitset< NUM_INDUSTRYTYPES > _displayed_industries
Communication from the industry chain window to the smallmap window about what industries to display.
static const IndustryType NUM_INDUSTRYTYPES
total number of industry types, new and old; limited to 240 because we need some special ids like IT_...
Point InverseRemapCoords2(int x, int y, bool clamp_to_map, bool *clamped)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Functions related to OTTD's landscape.
Point InverseRemapCoords(int x, int y)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Definition landscape.h:111
@ Arctic
Landscape with snow levels.
Declaration of linkgraph overlay GUI.
#define Point
Macro that prevents name conflicts between included headers.
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition map_func.h:376
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:429
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:419
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
PixelColour GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition palette.cpp:393
static constexpr PixelColour PC_TREES
Green palette colour for trees.
static constexpr PixelColour PC_VERY_LIGHT_YELLOW
Almost-white yellow palette colour.
static constexpr PixelColour PC_ROUGH_LAND
Dark green palette colour for rough land.
static constexpr PixelColour PC_YELLOW
Yellow palette colour.
static constexpr PixelColour PC_GREEN
Green palette colour.
static constexpr PixelColour PC_FIELDS
Light brown palette colour for fields.
static constexpr PixelColour PC_DARK_RED
Dark red palette colour.
static constexpr PixelColour PC_WATER
Dark blue palette colour for water.
static constexpr PixelColour PC_ORANGE
Orange palette colour.
static constexpr PixelColour PC_GRASS_LAND
Dark green palette colour for grass land.
static constexpr PixelColour PC_BARE_LAND
Brown palette colour for bare land.
static constexpr PixelColour PC_GREY
Grey palette colour.
static constexpr PixelColour PC_RED
Red palette colour.
static constexpr PixelColour PC_DARK_GREY
Dark grey palette colour.
static constexpr PixelColour PC_BLACK
Black palette colour.
static constexpr PixelColour PC_RAINFOREST
Pale green palette colour for rainforest.
static constexpr PixelColour PC_WHITE
White palette colour.
static constexpr PixelColour PC_VERY_DARK_BROWN
Almost-black brown palette colour.
static constexpr PixelColour PC_LIGHT_BLUE
Light blue palette colour.
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition rail.h:301
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition rail_map.h:115
const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition road.h:215
RoadType GetRoadTypeRoad(Tile t)
Get the road type for RoadTramType being RTT_ROAD.
Definition road_map.h:152
RoadType GetRoadTypeTram(Tile t)
Get the road type for RoadTramType being RTT_TRAM.
Definition road_map.h:163
Owner GetRoadOwner(Tile t, RoadTramType rtt)
Get the owner of a specific road type.
Definition road_map.h:244
bool HasRoadTypeRoad(Tile t)
Check if a tile has a road type when RoadTramType is RTT_ROAD.
Definition road_map.h:200
@ RTT_ROAD
Road road type.
Definition road_type.h:38
@ RTT_TRAM
Tram road type.
Definition road_type.h:39
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
@ MapRMBFixed
Map moves with mouse movement on holding right mouse button, cursor position is fixed.
@ ViewportRMBFixed
Viewport moves with mouse movement on holding right mouse button, cursor position is fixed.
@ Off
Scroll wheel has no effect.
#define MK(a, b)
Macro for ordinary entry of LegendAndColour.
void ShowSmallMap()
Show the smallmap window.
static uint32_t GetSmallMapLinkStatsPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "link stats".
static const EnumClassIndexContainer< std::array< AndOr, to_underlying(TileType::End)+1 >, TileType > _smallmap_contours_andor
Colour masks for "Contour" and "Routes" modes.
static uint32_t GetSmallMapContoursPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Contour".
void BuildLandLegend()
(Re)build the colour tables for the legends.
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...
#define MS(a, b)
Macro for break marker in arrays of LegendAndColour.
#define MC(col_break)
Macro for a height legend entry with configurable colour.
static const uint8_t _linkstat_colours_in_legenda[]
Link stat colours shown in legenda.
static uint _industry_to_list_pos[NUM_INDUSTRYTYPES]
For connecting industry type to position in industries list(small map legend).
static IndustryType _smallmap_industry_highlight
Highlight a specific industry type.
void BuildOwnerLegend()
Completes the array for the owned property legend.
static const int NUM_NO_COMPANY_ENTRIES
Number of entries in the owner legend that are not companies.
static int _smallmap_cargo_count
Number of cargos in the link stats legend.
uint32_t GetSmallMapOwnerPixels(TileIndex tile, TileType t, IncludeHeightmap include_heightmap)
Return the colour a tile would be displayed with in the small map in mode "Owner".
static int _smallmap_company_count
Number of entries in the owner legend.
static SmallMapColourScheme _heightmap_schemes[]
Available colour schemes for height maps.
static constexpr std::initializer_list< NWidgetPart > _nested_smallmap_display
Widget parts of the smallmap display.
static const PixelColour _vehicle_type_colours[6]
Vehicle colours in SMT_VEHICLES mode.
static uint32_t GetSmallMapVegetationPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the smallmap in mode "Vegetation".
static constexpr std::initializer_list< NWidgetPart > _nested_smallmap_bar
Widget parts of the smallmap legend bar + image buttons.
static uint32_t GetSmallMapIndustriesPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Industries".
static LegendAndColour _legend_land_contours[]
Legend text giving the colours to look for on the minimap.
static bool _smallmap_show_heightmap
Show heightmap in industry and owner mode of smallmap window.
static constexpr uint32_t _vegetation_clear_bits[to_underlying(ClearGround::MaxSize)]
Lookup table of minimap colours to use for each ClearGround type.
static const EnumClassIndexContainer< std::array< uint8_t, to_underlying(TileType::End)+1 >, TileType > _tiletype_importance
Mapping of tile type to importance of the tile (higher number means more interesting to show).
SmallMapType
Types of legends in the WID_SM_LEGEND widget.
static int _smallmap_industry_count
Number of used industries.
static bool _smallmap_industry_highlight_state
State of highlight blinking.
void BuildLinkStatsLegend()
Populate legend table for the link stat view.
static uint32_t GetSmallMapRoutesPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Routes".
static uint16_t _industry_to_name_string_width[NUM_INDUSTRYTYPES]
The string bounding box width for each industry type in the smallmap.
#define MKEND()
Macro for end of list marker in arrays of LegendAndColour.
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
static TypedIndexContainer< std::array< uint32_t, MAX_COMPANIES >, CompanyID > _company_to_list_pos
For connecting company ID to position in owner list (small map legend).
static const EnumClassIndexContainer< std::array< AndOr, to_underlying(TileType::End)+1 >, TileType > _smallmap_vehicles_andor
Colour masks for "Vehicles", "Industry", and "Vegetation" modes.
void BuildIndustriesLegend()
Fills an array for the industries legends.
#define MOEND()
Macro used for forcing a rebuild of the owner legend the first time it is used.
static LegendAndColour _legend_linkstats[NUM_CARGO+lengthof(_linkstat_colours_in_legenda)+1]
Legend entries for the link stats view.
#define MO(a, b)
Macro for non-company owned property entry of LegendAndColour.
Point GetSmallMapStationMiddle(const Window *w, const Station *st)
Determine the middle of a station in the smallmap window.
static uint32_t GetSmallMapVehiclesPixels(TileType t)
Return the colour a tile would be displayed with in the small map in mode "Vehicles".
Smallmap GUI functions.
IncludeHeightmap
Enum for how to include the heightmap pixels/colours in small map related functions.
@ Always
Always include the heightmap.
@ IfEnabled
Only include the heightmap if its enabled in the gui by the player.
Types related to the smallmap widgets.
@ WID_SM_OWNERS
Button to select the owners view.
@ WID_SM_VEHICLES
Button to select the vehicles view.
@ WID_SM_MAP_BORDER
Border around the smallmap.
@ WID_SM_CENTERMAP
Button to move smallmap center to main window center.
@ WID_SM_VEGETATION
Button to select the vegetation view.
@ WID_SM_TOGGLETOWNNAME
Toggle button to display town names.
@ WID_SM_CONTOUR
Button to select the contour view (height map).
@ WID_SM_ENABLE_ALL
Button to enable display of all legend entries.
@ WID_SM_SHOW_HEIGHT
Show heightmap toggle button.
@ WID_SM_ZOOM_OUT
Button to zoom out one step.
@ WID_SM_LEGEND
Bottom panel to display smallmap legends.
@ WID_SM_ZOOM_IN
Button to zoom in one step.
@ WID_SM_MAP
Panel containing the smallmap.
@ WID_SM_SHOW_IND_NAMES
Show industry names toggle button.
@ WID_SM_SELECT_BUTTONS
Selection widget for the buttons present in some smallmap modes.
@ WID_SM_BLANK
Empty button as placeholder.
@ WID_SM_LINKSTATS
Button to select the link stats view.
@ WID_SM_SHOW_IND_NAMES_SEL
Container for the 'show industry names' button, which can be hidden.
@ WID_SM_ROUTES
Button to select the routes view.
@ WID_SM_INDUSTRIES
Button to select the industries view.
@ WID_SM_CAPTION
Caption of the window.
@ WID_SM_DISABLE_ALL
Button to disable display of all legend entries.
void SndClickBeep()
Play a beep sound for a click event if enabled in settings.
Definition sound.cpp:253
Functions related to sound.
Maps accessors for stations.
StationType GetStationType(Tile t)
Get the station type of this tile.
Definition station_map.h:44
@ Dock
Ship port.
@ Rail
Railways/train station.
@ Bus
Road stop for busses.
@ Truck
Road stop for trucks.
@ Airport
Airports and heliports, excluding the ones on oil rigs.
Definition of base types and functions in a cross-platform compatible way.
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:271
void GetStringWithArgs(StringBuilder &builder, StringID string, StringParameters &args, uint case_index, bool game_script)
Get a parsed string with most special stringcodes replaced by the string parameters.
Definition strings.cpp:336
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:56
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
@ TD_RTL
Text is written right-to-left by default.
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
Specification of a cargo type.
Definition cargotype.h:74
CargoType Index() const
Determines index of this cargospec.
Definition cargotype.h:108
StringID name
Name of this type of cargo.
Definition cargotype.h:91
T y
Y coordinate.
T x
X coordinate.
Data about how and where to blit pixels.
Definition gfx_type.h:157
Defines the data structure for constructing industry.
StringID name
Displayed name of the industry.
bool enabled
entity still available (by default true).newgrf can disable it, though
PixelColour map_colour
colour used for the small map
Defines the internal data of a functional industry.
Definition industry.h:62
IndustryType type
type of industry.
Definition industry.h:115
static uint16_t GetIndustryTypeCount(IndustryType type)
Get the count of industries for this type.
Definition industry.h:265
static Industry * GetByTile(TileIndex tile)
Get the industry of the given tile.
Definition industry.h:251
Structure for holding relevant data for legends in small map.
PixelColour colour
Colour of the item on the map.
uint8_t height
Height in tiles. Only valid for height legend entries.
StringID legend
String corresponding to the coloured item.
bool show_on_map
For filtering industries, if true, industry is shown on the map in colour.
CompanyID company
Company to display. Only valid for company entries of the owner legend.
bool end
This is the end of the list.
bool col_break
Perform a column break and go further at the next column.
IndustryType type
Type of industry. Only valid for industry entries.
static uint MaxY()
Gets the maximum Y coordinate within the map, including TileType::Void.
Definition map_func.h:298
static uint MaxX()
Gets the maximum X coordinate within the map, including TileType::Void.
Definition map_func.h:289
void ClampToMap()
Clamp the tile area to map borders.
Definition tilearea.cpp:142
Colour for pixel/line drawing.
Definition gfx_type.h:405
uint8_t p
Palette index.
Definition gfx_type.h:406
static Pool::IterateWrapper< Company > Iterate(size_t from=0)
static constexpr size_t MAX_SIZE
Specification of a rectangle with absolute coordinates of all edges.
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
int Width() const
Get width of Rect.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Rect WithHeight(int height, bool end=false) const
Copy Rect and set its height.
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Rect Translate(int x, int y) const
Copy and translate Rect by x,y pixels.
Colour scheme of the smallmap.
std::vector< uint32_t > height_colours
Cached colours for each level in a map.
uint32_t default_colour
Default colour of the land.
std::span< const uint32_t > height_colours_base
Base table for determining the colours.
Station data structure.
Town data structure.
Definition town.h:63
Vehicle data structure.
Data structure for viewport, display of a part of the world.
int virtual_top
Virtual top coordinate.
int virtual_left
Virtual left coordinate.
int virtual_width
width << zoom
int virtual_height
height << zoom
High level window description.
Definition window_gui.h:168
Data structure for an opened window.
Definition window_gui.h:274
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:992
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1117
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:768
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
void RaiseWidget(WidgetID widget_index)
Marks a widget as raised.
Definition window_gui.h:470
std::unique_ptr< ViewportData > viewport
Pointer to viewport data, if present.
Definition window_gui.h:319
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:518
WidgetID mouse_capture_widget
ID of current mouse capture widget (e.g. dragged scrollbar). INVALID_WIDGET if no widget has mouse ca...
Definition window_gui.h:327
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:442
int left
x position of left edge of the window
Definition window_gui.h:310
int top
y position of top edge of the window
Definition window_gui.h:311
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition window.cpp:1845
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:990
void LowerWidget(WidgetID widget_index)
Marks a widget as lowered.
Definition window_gui.h:461
void HandleButtonClick(WidgetID widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition window.cpp:609
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:382
int height
Height of the window (number of pixels down in y direction).
Definition window_gui.h:313
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:312
static uint TileHeight(Tile tile)
Returns the height of a tile.
Definition tile_map.h:29
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition tile_map.h:178
TropicZone GetTropicZone(Tile tile)
Get the tropic zone.
Definition tile_map.h:238
static TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition tile_map.h:96
static constexpr uint MAX_TILE_HEIGHT
Maximum allowed tile height.
Definition tile_type.h:24
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
@ TROPICZONE_RAINFOREST
Rainforest tile.
Definition tile_type.h:84
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:100
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
TileType
The different types of tiles.
Definition tile_type.h:48
@ TunnelBridge
Tunnel entry/exit and bridge heads.
Definition tile_type.h:58
@ Water
Water tile.
Definition tile_type.h:55
@ Station
A tile of a station or airport.
Definition tile_type.h:54
@ Industry
Part of an industry.
Definition tile_type.h:57
@ Railway
A tile with railway.
Definition tile_type.h:50
@ Void
Invisible tiles at the SW and SE border.
Definition tile_type.h:56
@ End
End marker.
Definition tile_type.h:60
@ Trees
Tile with one or more trees.
Definition tile_type.h:53
@ House
A house by a town.
Definition tile_type.h:52
@ Road
A tile with road and/or tram tracks.
Definition tile_type.h:51
@ Clear
A tile without any structures, i.e. grass, rocks, farm fields etc.
Definition tile_type.h:49
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Definition of Interval and OneShot timers.
Definition of the Window system.
static constexpr std::chrono::milliseconds TIMER_BLINK_INTERVAL
Interval used by blinking interface elements.
Base of the town class.
TransportType
Available types of transport.
@ TRANSPORT_RAIL
Transport by train.
@ TRANSPORT_ROAD
Transport by road vehicle.
Map accessors for tree tiles.
TreeGround GetTreeGround(Tile t)
Returns the groundtype for tree tiles.
Definition tree_map.h:102
@ SnowOrDesert
Snow or desert, depending on landscape.
Definition tree_map.h:55
@ RoughSnow
A snow tile that is rough underneath.
Definition tree_map.h:57
Functions that have tunnels and bridges in common.
TransportType GetTunnelBridgeTransportType(Tile t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
Base class for all vehicles.
@ VEH_EFFECT
Effect vehicle type (smoke, explosions, sparks, bubbles).
bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Functions related to (drawing on) viewports.
static const int TILE_HEIGHT_STEP
One Z unit tile height difference is displayed as 50m.
bool IsTileOnWater(Tile t)
Tests if the tile was built on water.
Definition water_map.h:138
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition widget.cpp:49
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
@ WWT_INSET
Pressed (inset) panel, most commonly used as combo box text area.
Definition widget_type.h:40
@ WWT_IMGBTN
(Toggle) Button with image
Definition widget_type.h:41
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
@ NWID_SPACER
Invisible widget that takes some space.
Definition widget_type.h:70
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:44
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:39
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX).
Definition widget_type.h:57
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX).
Definition widget_type.h:55
@ WWT_CAPTION
Window caption (window title between closebox and stickybox).
Definition widget_type.h:52
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:68
@ WWT_CLOSEBOX
Close box (at top-left of a window).
Definition widget_type.h:60
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition widget_type.h:37
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window).
Definition widget_type.h:59
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX).
Definition widget_type.h:56
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:71
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
@ EqualSize
Containers should keep all their (resizing) children equally large.
SizingType
Different forms of sizing nested widgets, using NWidgetBase::AssignSizePosition().
@ ST_RESIZE
Resize the nested widget tree.
@ ST_SMALLEST
Initialize nested widget tree to smallest size. Also updates current_x and current_y.
Window * GetMainWindow()
Get the main window, i.e.
Definition window.cpp:1195
bool _scrolling_viewport
A viewport is being scrolled with the mouse.
Definition window.cpp:93
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1166
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
Window functions not directly related to making/drawing windows.
Twindow * AllocateWindowDescFront(WindowDesc &desc, WindowNumber window_number, Targs... extra_arguments)
Open a new window.
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:144
int WidgetID
Widget ID.
Definition window_type.h:20
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:50
@ WC_INDUSTRY_CARGOES
Industry cargoes chain; Window numbers:
@ WC_SMALLMAP
Small map; Window numbers:
Functions related to zooming.