OpenTTD Source  20240917-master-g9ab0a47812
smallmap_gui.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "stdafx.h"
11 #include "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 
34 
35 #include "table/strings.h"
36 
37 #include <bitset>
38 
39 #include "safeguards.h"
40 
44 
47  uint8_t colour;
49  IndustryType type;
50  uint8_t height;
52  bool show_on_map;
53  bool end;
54  bool col_break;
55 };
56 
58 static uint8_t _linkstat_colours_in_legenda[] = {0, 1, 3, 5, 7, 9, 11};
59 
60 static const int NUM_NO_COMPANY_ENTRIES = 4;
61 
63 #define MK(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, false}
64 
66 #define MC(col_break) {0, STR_TINY_BLACK_HEIGHT, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, col_break}
67 
69 #define MO(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, false}
70 
72 #define MOEND() {0, 0, INVALID_INDUSTRYTYPE, 0, OWNER_NONE, true, true, false}
73 
75 #define MKEND() {0, STR_NULL, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, true, false}
76 
81 #define MS(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, true}
82 
85  MK(PC_BLACK, STR_SMALLMAP_LEGENDA_ROADS),
86  MK(PC_GREY, STR_SMALLMAP_LEGENDA_RAILROADS),
87  MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_STATIONS_AIRPORTS_DOCKS),
88  MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
89  MK(PC_WHITE, STR_SMALLMAP_LEGENDA_VEHICLES),
90 
91  /* Placeholders for the colours and heights of the legend.
92  * The following values are set at BuildLandLegend() based
93  * on each colour scheme and the maximum map height. */
94  MC(true),
95  MC(false),
96  MC(false),
97  MC(false),
98  MC(false),
99  MC(false),
100  MC(true),
101  MC(false),
102  MC(false),
103  MC(false),
104  MC(false),
105  MC(false),
106  MKEND()
107 };
108 
109 static const LegendAndColour _legend_vehicles[] = {
110  MK(PC_RED, STR_SMALLMAP_LEGENDA_TRAINS),
111  MK(PC_YELLOW, STR_SMALLMAP_LEGENDA_ROAD_VEHICLES),
112  MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_SHIPS),
113  MK(PC_WHITE, STR_SMALLMAP_LEGENDA_AIRCRAFT),
114 
115  MS(PC_BLACK, STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES),
116  MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
117  MKEND()
118 };
119 
120 static const LegendAndColour _legend_routes[] = {
121  MK(PC_BLACK, STR_SMALLMAP_LEGENDA_ROADS),
122  MK(PC_GREY, STR_SMALLMAP_LEGENDA_RAILROADS),
123  MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
124 
125  MS(PC_VERY_DARK_BROWN, STR_SMALLMAP_LEGENDA_RAILROAD_STATION),
126  MK(PC_ORANGE, STR_SMALLMAP_LEGENDA_TRUCK_LOADING_BAY),
127  MK(PC_YELLOW, STR_SMALLMAP_LEGENDA_BUS_STATION),
128  MK(PC_RED, STR_SMALLMAP_LEGENDA_AIRPORT_HELIPORT),
129  MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_DOCK),
130  MKEND()
131 };
132 
133 static const LegendAndColour _legend_vegetation[] = {
134  MK(PC_ROUGH_LAND, STR_SMALLMAP_LEGENDA_ROUGH_LAND),
135  MK(PC_GRASS_LAND, STR_SMALLMAP_LEGENDA_GRASS_LAND),
136  MK(PC_BARE_LAND, STR_SMALLMAP_LEGENDA_BARE_LAND),
137  MK(PC_RAINFOREST, STR_SMALLMAP_LEGENDA_RAINFOREST),
138  MK(PC_FIELDS, STR_SMALLMAP_LEGENDA_FIELDS),
139  MK(PC_TREES, STR_SMALLMAP_LEGENDA_TREES),
140 
141  MS(PC_GREEN, STR_SMALLMAP_LEGENDA_FOREST),
142  MK(PC_GREY, STR_SMALLMAP_LEGENDA_ROCKS),
143  MK(PC_ORANGE, STR_SMALLMAP_LEGENDA_DESERT),
144  MK(PC_LIGHT_BLUE, STR_SMALLMAP_LEGENDA_SNOW),
145  MK(PC_BLACK, STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES),
146  MK(PC_DARK_RED, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
147  MKEND()
148 };
149 
150 static LegendAndColour _legend_land_owners[NUM_NO_COMPANY_ENTRIES + MAX_COMPANIES + 1] = {
151  MO(PC_WATER, STR_SMALLMAP_LEGENDA_WATER),
152  MO(0x00, STR_SMALLMAP_LEGENDA_NO_OWNER), // This colour will vary depending on settings.
153  MO(PC_DARK_RED, STR_SMALLMAP_LEGENDA_TOWNS),
154  MO(PC_DARK_GREY, STR_SMALLMAP_LEGENDA_INDUSTRIES),
155  /* The legend will be terminated the first time it is used. */
156  MOEND(),
157 };
158 
159 #undef MK
160 #undef MC
161 #undef MS
162 #undef MO
163 #undef MOEND
164 #undef MKEND
165 
178 static bool _smallmap_show_heightmap = false;
185 
190 {
191  uint j = 0;
192 
193  /* Add each name */
194  for (IndustryType ind : _sorted_industry_types) {
195  const IndustrySpec *indsp = GetIndustrySpec(ind);
196  if (indsp->enabled) {
197  _legend_from_industries[j].legend = indsp->name;
199  _legend_from_industries[j].type = ind;
202  _legend_from_industries[j].end = false;
203 
204  /* Store widget number for this industry type. */
205  _industry_to_list_pos[ind] = j;
206  j++;
207  }
208  }
209  /* Terminate the list */
210  _legend_from_industries[j].end = true;
211 
212  /* Store number of enabled industries */
214 }
215 
220 {
221  /* Clear the legend */
222  memset(_legend_linkstats, 0, sizeof(_legend_linkstats));
223 
224  uint i = 0;
225  for (; i < _sorted_cargo_specs.size(); ++i) {
226  const CargoSpec *cs = _sorted_cargo_specs[i];
227 
228  _legend_linkstats[i].legend = cs->name;
229  _legend_linkstats[i].colour = cs->legend_colour;
230  _legend_linkstats[i].type = cs->Index();
231  _legend_linkstats[i].show_on_map = true;
232  }
233 
234  _legend_linkstats[i].col_break = true;
236 
238  _legend_linkstats[i].legend = STR_EMPTY;
240  _legend_linkstats[i].show_on_map = true;
241  }
242 
243  _legend_linkstats[_smallmap_cargo_count].legend = STR_LINKGRAPH_LEGEND_UNUSED;
244  _legend_linkstats[i - 1].legend = STR_LINKGRAPH_LEGEND_OVERLOADED;
245  _legend_linkstats[(_smallmap_cargo_count + i - 1) / 2].legend = STR_LINKGRAPH_LEGEND_SATURATED;
246  _legend_linkstats[i].end = true;
247 }
248 
249 static const LegendAndColour * const _legend_table[] = {
251  _legend_vehicles,
254  _legend_routes,
255  _legend_vegetation,
256  _legend_land_owners,
257 };
258 
259 #define MKCOLOUR(x) TO_LE32X(x)
260 
261 #define MKCOLOUR_XXXX(x) (MKCOLOUR(0x01010101) * (uint)(x))
262 #define MKCOLOUR_X0X0(x) (MKCOLOUR(0x01000100) * (uint)(x))
263 #define MKCOLOUR_0X0X(x) (MKCOLOUR(0x00010001) * (uint)(x))
264 #define MKCOLOUR_0XX0(x) (MKCOLOUR(0x00010100) * (uint)(x))
265 #define MKCOLOUR_X00X(x) (MKCOLOUR(0x01000001) * (uint)(x))
266 
267 #define MKCOLOUR_XYXY(x, y) (MKCOLOUR_X0X0(x) | MKCOLOUR_0X0X(y))
268 #define MKCOLOUR_XYYX(x, y) (MKCOLOUR_X00X(x) | MKCOLOUR_0XX0(y))
269 
270 #define MKCOLOUR_0000 MKCOLOUR_XXXX(0x00)
271 #define MKCOLOUR_0FF0 MKCOLOUR_0XX0(0xFF)
272 #define MKCOLOUR_F00F MKCOLOUR_X00X(0xFF)
273 #define MKCOLOUR_FFFF MKCOLOUR_XXXX(0xFF)
274 
275 #include "table/heightmap_colours.h"
276 
279  std::vector<uint32_t> height_colours;
280  std::span<const uint32_t> height_colours_base;
281  uint32_t default_colour;
282 };
283 
286  {{}, _green_map_heights, MKCOLOUR_XXXX(0x54)},
287  {{}, _dark_green_map_heights, MKCOLOUR_XXXX(0x62)},
288  {{}, _violet_map_heights, MKCOLOUR_XXXX(0x81)},
289 };
290 
295 {
296  /* The smallmap window has never been initialized, so no need to change the legend. */
297  if (_heightmap_schemes[0].height_colours.empty()) return;
298 
299  /*
300  * The general idea of this function is to fill the legend with an appropriate evenly spaced
301  * selection of height levels. All entries with STR_TINY_BLACK_HEIGHT are reserved for this.
302  * At the moment there are twelve of these.
303  *
304  * The table below defines up to which height level a particular delta in the legend should be
305  * used. One could opt for just dividing the maximum height and use that as delta, but that
306  * creates many "ugly" legend labels, e.g. once every 950 meter. As a result, this table will
307  * reduce the number of deltas to 7: every 100m, 200m, 300m, 500m, 750m, 1000m and 1250m. The
308  * deltas are closer together at the lower numbers because going from 12 entries to just 4, as
309  * would happen when replacing 200m and 300m by 250m, would mean the legend would be short and
310  * that might not be considered appropriate.
311  *
312  * The current method yields at least 7 legend entries and at most 12. It can be increased to
313  * 8 by adding a 150m and 400m option, but especially 150m creates ugly heights.
314  *
315  * It tries to evenly space the legend items over the two columns that are there for the legend.
316  */
317 
318  /* Table for delta; if max_height is less than the first column, use the second column as value. */
319  uint deltas[][2] = { { 24, 2 }, { 48, 4 }, { 72, 6 }, { 120, 10 }, { 180, 15 }, { 240, 20 }, { MAX_TILE_HEIGHT + 1, 25 }};
320  uint i = 0;
321  for (; _settings_game.construction.map_height_limit >= deltas[i][0]; i++) {
322  /* Nothing to do here. */
323  }
324  uint delta = deltas[i][1];
325 
326  int total_entries = (_settings_game.construction.map_height_limit / delta) + 1;
327  int rows = CeilDiv(total_entries, 2);
328  int j = 0;
329 
330  for (i = 0; i < lengthof(_legend_land_contours) - 1 && j < total_entries; i++) {
331  if (_legend_land_contours[i].legend != STR_TINY_BLACK_HEIGHT) continue;
332 
333  _legend_land_contours[i].col_break = j % rows == 0;
334  _legend_land_contours[i].end = false;
335  _legend_land_contours[i].height = j * delta;
337  j++;
338  }
339  _legend_land_contours[i].end = true;
340 }
341 
346 {
348 
349  int i = NUM_NO_COMPANY_ENTRIES;
350  for (const Company *c : Company::Iterate()) {
351  _legend_land_owners[i].colour = GetColourGradient(c->colour, SHADE_LIGHT);
352  _legend_land_owners[i].company = c->index;
353  _legend_land_owners[i].show_on_map = true;
354  _legend_land_owners[i].col_break = false;
355  _legend_land_owners[i].end = false;
356  _company_to_list_pos[c->index] = i;
357  i++;
358  }
359 
360  /* Terminate the list */
361  _legend_land_owners[i].end = true;
362 
363  /* Store maximum amount of owner legend entries. */
365 }
366 
367 struct AndOr {
368  uint32_t mor;
369  uint32_t mand;
370 };
371 
372 static inline uint32_t ApplyMask(uint32_t colour, const AndOr *mask)
373 {
374  return (colour & mask->mand) | mask->mor;
375 }
376 
377 
379 static const AndOr _smallmap_contours_andor[] = {
380  {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_CLEAR
381  {MKCOLOUR_0XX0(PC_GREY ), MKCOLOUR_F00F}, // MP_RAILWAY
382  {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F}, // MP_ROAD
383  {MKCOLOUR_0XX0(PC_DARK_RED ), MKCOLOUR_F00F}, // MP_HOUSE
384  {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_TREES
385  {MKCOLOUR_XXXX(PC_LIGHT_BLUE), MKCOLOUR_0000}, // MP_STATION
386  {MKCOLOUR_XXXX(PC_WATER ), MKCOLOUR_0000}, // MP_WATER
387  {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_VOID
388  {MKCOLOUR_XXXX(PC_DARK_RED ), MKCOLOUR_0000}, // MP_INDUSTRY
389  {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_TUNNELBRIDGE
390  {MKCOLOUR_0XX0(PC_DARK_RED ), MKCOLOUR_F00F}, // MP_OBJECT
391  {MKCOLOUR_0XX0(PC_GREY ), MKCOLOUR_F00F},
392 };
393 
395 static const AndOr _smallmap_vehicles_andor[] = {
396  {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_CLEAR
397  {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F}, // MP_RAILWAY
398  {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F}, // MP_ROAD
399  {MKCOLOUR_0XX0(PC_DARK_RED ), MKCOLOUR_F00F}, // MP_HOUSE
400  {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_TREES
401  {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F}, // MP_STATION
402  {MKCOLOUR_XXXX(PC_WATER ), MKCOLOUR_0000}, // MP_WATER
403  {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_VOID
404  {MKCOLOUR_XXXX(PC_DARK_RED ), MKCOLOUR_0000}, // MP_INDUSTRY
405  {MKCOLOUR_0000 , MKCOLOUR_FFFF}, // MP_TUNNELBRIDGE
406  {MKCOLOUR_0XX0(PC_DARK_RED ), MKCOLOUR_F00F}, // MP_OBJECT
407  {MKCOLOUR_0XX0(PC_BLACK ), MKCOLOUR_F00F},
408 };
409 
411 static const uint8_t _tiletype_importance[] = {
412  2, // MP_CLEAR
413  8, // MP_RAILWAY
414  7, // MP_ROAD
415  5, // MP_HOUSE
416  2, // MP_TREES
417  9, // MP_STATION
418  2, // MP_WATER
419  1, // MP_VOID
420  6, // MP_INDUSTRY
421  8, // MP_TUNNELBRIDGE
422  2, // MP_OBJECT
423  0,
424 };
425 
426 
433 static inline uint32_t GetSmallMapContoursPixels(TileIndex tile, TileType t)
434 {
436  return ApplyMask(cs->height_colours[TileHeight(tile)], &_smallmap_contours_andor[t]);
437 }
438 
446 static inline uint32_t GetSmallMapVehiclesPixels(TileIndex, TileType t)
447 {
449  return ApplyMask(cs->default_colour, &_smallmap_vehicles_andor[t]);
450 }
451 
459 static inline uint32_t GetSmallMapIndustriesPixels(TileIndex tile, TileType t)
460 {
463 }
464 
472 static inline uint32_t GetSmallMapRoutesPixels(TileIndex tile, TileType t)
473 {
474  switch (t) {
475  case MP_STATION:
476  switch (GetStationType(tile)) {
477  case STATION_RAIL: return MKCOLOUR_XXXX(PC_VERY_DARK_BROWN);
478  case STATION_AIRPORT: return MKCOLOUR_XXXX(PC_RED);
479  case STATION_TRUCK: return MKCOLOUR_XXXX(PC_ORANGE);
480  case STATION_BUS: return MKCOLOUR_XXXX(PC_YELLOW);
481  case STATION_DOCK: return MKCOLOUR_XXXX(PC_LIGHT_BLUE);
482  default: return MKCOLOUR_FFFF;
483  }
484 
485  case MP_RAILWAY: {
486  AndOr andor = {
487  MKCOLOUR_0XX0(GetRailTypeInfo(GetRailType(tile))->map_colour),
489  };
490 
492  return ApplyMask(cs->default_colour, &andor);
493  }
494 
495  case MP_ROAD: {
496  const RoadTypeInfo *rti = nullptr;
497  if (GetRoadTypeRoad(tile) != INVALID_ROADTYPE) {
498  rti = GetRoadTypeInfo(GetRoadTypeRoad(tile));
499  } else {
500  rti = GetRoadTypeInfo(GetRoadTypeTram(tile));
501  }
502  if (rti != nullptr) {
503  AndOr andor = {
504  MKCOLOUR_0XX0(rti->map_colour),
506  };
507 
509  return ApplyMask(cs->default_colour, &andor);
510  }
511  [[fallthrough]];
512  }
513 
514  default:
515  /* Ground colour */
517  return ApplyMask(cs->default_colour, &_smallmap_contours_andor[t]);
518  }
519 }
520 
528 static inline uint32_t GetSmallMapLinkStatsPixels(TileIndex tile, TileType t)
529 {
531 }
532 
533 static const uint32_t _vegetation_clear_bits[] = {
534  MKCOLOUR_XXXX(PC_GRASS_LAND),
535  MKCOLOUR_XXXX(PC_ROUGH_LAND),
536  MKCOLOUR_XXXX(PC_GREY),
537  MKCOLOUR_XXXX(PC_FIELDS),
538  MKCOLOUR_XXXX(PC_LIGHT_BLUE),
539  MKCOLOUR_XXXX(PC_ORANGE),
540  MKCOLOUR_XXXX(PC_GRASS_LAND),
541  MKCOLOUR_XXXX(PC_GRASS_LAND),
542 };
543 
551 static inline uint32_t GetSmallMapVegetationPixels(TileIndex tile, TileType t)
552 {
553  switch (t) {
554  case MP_CLEAR:
555  if (IsClearGround(tile, CLEAR_GRASS)) {
556  if (GetClearDensity(tile) < 3) return MKCOLOUR_XXXX(PC_BARE_LAND);
557  if (GetTropicZone(tile) == TROPICZONE_RAINFOREST) return MKCOLOUR_XXXX(PC_RAINFOREST);
558  }
559  return _vegetation_clear_bits[GetClearGround(tile)];
560 
561  case MP_INDUSTRY:
562  return IsTileForestIndustry(tile) ? MKCOLOUR_XXXX(PC_GREEN) : MKCOLOUR_XXXX(PC_DARK_RED);
563 
564  case MP_TREES:
566  return (_settings_game.game_creation.landscape == LT_ARCTIC) ? MKCOLOUR_XYYX(PC_LIGHT_BLUE, PC_TREES) : MKCOLOUR_XYYX(PC_ORANGE, PC_TREES);
567  }
568  return (GetTropicZone(tile) == TROPICZONE_RAINFOREST) ? MKCOLOUR_XYYX(PC_RAINFOREST, PC_TREES) : MKCOLOUR_XYYX(PC_GRASS_LAND, PC_TREES);
569 
570  default:
571  return ApplyMask(MKCOLOUR_XXXX(PC_GRASS_LAND), &_smallmap_vehicles_andor[t]);
572  }
573 }
574 
584 uint32_t GetSmallMapOwnerPixels(TileIndex tile, TileType t, IncludeHeightmap include_heightmap)
585 {
586  Owner o;
587 
588  switch (t) {
589  case MP_VOID: return MKCOLOUR_XXXX(PC_BLACK);
590  case MP_INDUSTRY: return MKCOLOUR_XXXX(PC_DARK_GREY);
591  case MP_HOUSE: return MKCOLOUR_XXXX(PC_DARK_RED);
592  default: o = GetTileOwner(tile); break;
593  /* FIXME: For MP_ROAD there are multiple owners.
594  * GetTileOwner returns the rail owner (level crossing) resp. the owner of ROADTYPE_ROAD (normal road),
595  * even if there are no ROADTYPE_ROAD bits on the tile.
596  */
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 == MP_WATER) return MKCOLOUR_XXXX(PC_WATER);
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 
612 static const uint8_t _vehicle_type_colours[6] = {
614 };
615 
617 enum 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 
629 class SmallMapWindow : public Window {
630 protected:
636  };
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 
649 
650  int32_t scroll_x;
651  int32_t scroll_y;
652  int32_t subscroll;
653  int zoom;
654 
655  std::unique_ptr<LinkGraphOverlay> overlay;
656 
659  {
661  }
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 
708  inline uint GetNumberColumnsLegend(uint width) const
709  {
710  return width / this->column_width;
711  }
712 
718  inline uint GetLegendHeight(uint num_columns) const
719  {
721  this->GetNumberRowsLegend(num_columns) * GetCharacterHeight(FS_SMALL);
722  }
723 
729  inline CompanyMask GetOverlayCompanyMask() const
730  {
731  return Company::IsValidID(_local_company) ? 1U << _local_company : MAX_UVALUE(CompanyMask);
732  }
733 
735  IntervalTimer<TimerWindow> blink_interval = {std::chrono::milliseconds(450), [this](auto) {
736  Blink();
737  }};
738 
740  IntervalTimer<TimerWindow> refresh_interval = {std::chrono::milliseconds(930), [this](auto) {
741  ForceRefresh();
742  }};
743 
748  {
749  /* Rebuild colour indices if necessary. */
751 
752  for (auto &heightmap_scheme : _heightmap_schemes) {
753  /* The heights go from 0 up to and including maximum. */
754  size_t heights = _settings_game.construction.map_height_limit + 1;
755  heightmap_scheme.height_colours.resize(heights);
756 
757  for (size_t z = 0; z < heights; z++) {
758  size_t access_index = (heightmap_scheme.height_colours_base.size() * z) / heights;
759 
760  /* Choose colour by mapping the range (0..max heightlevel) on the complete colour table. */
761  heightmap_scheme.height_colours[z] = heightmap_scheme.height_colours_base[access_index];
762  }
763  }
764 
766  BuildLandLegend();
767  }
768 
777  uint GetNumberRowsLegend(uint columns) const
778  {
779  /* Reserve one column for link colours */
780  uint num_rows_linkstats = CeilDiv(_smallmap_cargo_count, columns - 1);
781  uint num_rows_others = CeilDiv(std::max(_smallmap_industry_count, _smallmap_company_count), columns);
782  return std::max({this->min_number_of_fixed_rows, num_rows_linkstats, num_rows_others});
783  }
784 
796  void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item = 0)
797  {
798  if (_ctrl_pressed) {
799  /* Disable all, except the clicked one */
800  bool changes = false;
801  for (int i = begin_legend_item; i != end_legend_item; i++) {
802  bool new_state = (i == click_pos);
803  if (legend[i].show_on_map != new_state) {
804  changes = true;
805  legend[i].show_on_map = new_state;
806  }
807  }
808  if (!changes) {
809  /* Nothing changed? Then show all (again). */
810  for (int i = begin_legend_item; i != end_legend_item; i++) {
811  legend[i].show_on_map = true;
812  }
813  }
814  } else {
815  legend[click_pos].show_on_map = !legend[click_pos].show_on_map;
816  }
817 
818  if (this->map_type == SMT_INDUSTRY) this->BreakIndustryChainLink();
819  }
820 
826  {
827  this->RaiseWidget(WID_SM_CONTOUR + this->map_type);
828  this->map_type = map_type;
829  this->LowerWidget(WID_SM_CONTOUR + this->map_type);
830 
831  this->SetupWidgetData();
832 
833  if (map_type == SMT_LINKSTATS) this->overlay->SetDirty();
834  if (map_type != SMT_INDUSTRY) this->BreakIndustryChainLink();
835  this->ReInit();
836  }
837 
845  void SetNewScroll(int sx, int sy, int sub)
846  {
847  const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_MAP);
848  Point hv = InverseRemapCoords(wi->current_x * ZOOM_BASE * TILE_SIZE / 2, wi->current_y * ZOOM_BASE * TILE_SIZE / 2);
849  hv.x *= this->zoom;
850  hv.y *= this->zoom;
851 
852  if (sx < -hv.x) {
853  sx = -hv.x;
854  sub = 0;
855  }
856  if (sx > (int)(Map::MaxX() * TILE_SIZE) - hv.x) {
857  sx = Map::MaxX() * TILE_SIZE - hv.x;
858  sub = 0;
859  }
860  if (sy < -hv.y) {
861  sy = -hv.y;
862  sub = 0;
863  }
864  if (sy > (int)(Map::MaxY() * TILE_SIZE) - hv.y) {
865  sy = Map::MaxY() * TILE_SIZE - hv.y;
866  sub = 0;
867  }
868 
869  this->scroll_x = sx;
870  this->scroll_y = sy;
871  this->subscroll = sub;
872  if (this->map_type == SMT_LINKSTATS) this->overlay->SetDirty();
873  }
874 
878  void DrawMapIndicators() const
879  {
880  /* Find main viewport. */
881  const Viewport *vp = GetMainWindow()->viewport;
882 
883  Point upper_left_smallmap_coord = InverseRemapCoords2(vp->virtual_left, vp->virtual_top);
884  Point lower_right_smallmap_coord = InverseRemapCoords2(vp->virtual_left + vp->virtual_width - 1, vp->virtual_top + vp->virtual_height - 1);
885 
886  Point upper_left = this->RemapTile(upper_left_smallmap_coord.x / (int)TILE_SIZE, upper_left_smallmap_coord.y / (int)TILE_SIZE);
887  upper_left.x -= this->subscroll;
888 
889  Point lower_right = this->RemapTile(lower_right_smallmap_coord.x / (int)TILE_SIZE, lower_right_smallmap_coord.y / (int)TILE_SIZE);
890  lower_right.x -= this->subscroll;
891 
892  SmallMapWindow::DrawVertMapIndicator(upper_left.x, upper_left.y, lower_right.y);
893  SmallMapWindow::DrawVertMapIndicator(lower_right.x, upper_left.y, lower_right.y);
894 
895  SmallMapWindow::DrawHorizMapIndicator(upper_left.x, lower_right.x, upper_left.y);
896  SmallMapWindow::DrawHorizMapIndicator(upper_left.x, lower_right.x, lower_right.y);
897  }
898 
912  void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const
913  {
914  void *dst_ptr_abs_end = blitter->MoveTo(_screen.dst_ptr, 0, _screen.height);
915  uint min_xy = _settings_game.construction.freeform_edges ? 1 : 0;
916 
917  do {
918  /* Check if the tile (xc,yc) is within the map range */
919  if (xc >= Map::MaxX() || yc >= Map::MaxY()) continue;
920 
921  /* Check if the dst pointer points to a pixel inside the screen buffer */
922  if (dst < _screen.dst_ptr) continue;
923  if (dst >= dst_ptr_abs_end) continue;
924 
925  /* Construct tilearea covered by (xc, yc, xc + this->zoom, yc + this->zoom) such that it is within min_xy limits. */
926  TileArea ta;
927  if (min_xy == 1 && (xc == 0 || yc == 0)) {
928  if (this->zoom == 1) continue; // The tile area is empty, don't draw anything.
929 
930  ta = TileArea(TileXY(std::max(min_xy, xc), std::max(min_xy, yc)), this->zoom - (xc == 0), this->zoom - (yc == 0));
931  } else {
932  ta = TileArea(TileXY(xc, yc), this->zoom, this->zoom);
933  }
934  ta.ClampToMap(); // Clamp to map boundaries (may contain MP_VOID tiles!).
935 
936  uint32_t val = this->GetTileColours(ta);
937  uint8_t *val8 = (uint8_t *)&val;
938  int idx = std::max(0, -start_pos);
939  for (int pos = std::max(0, start_pos); pos < end_pos; pos++) {
940  blitter->SetPixel(dst, idx, 0, val8[idx]);
941  idx++;
942  }
943  /* Switch to next tile in the column */
944  } while (xc += this->zoom, yc += this->zoom, dst = blitter->MoveTo(dst, pitch, 0), --reps != 0);
945  }
946 
952  void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
953  {
954  for (const Vehicle *v : Vehicle::Iterate()) {
955  if (v->type == VEH_EFFECT) continue;
956  if (v->vehstatus & (VS_HIDDEN | VS_UNCLICKABLE)) continue;
957 
958  /* Remap into flat coordinates. */
959  Point pt = this->RemapTile(v->x_pos / (int)TILE_SIZE, v->y_pos / (int)TILE_SIZE);
960 
961  int y = pt.y - dpi->top;
962  if (!IsInsideMM(y, 0, dpi->height)) continue; // y is out of bounds.
963 
964  bool skip = false; // Default is to draw both pixels.
965  int x = pt.x - this->subscroll - 3 - dpi->left; // Offset X coordinate.
966  if (x < 0) {
967  /* if x+1 is 0, that means we're on the very left edge,
968  * and should thus only draw a single pixel */
969  if (++x != 0) continue;
970  skip = true;
971  } else if (x >= dpi->width - 1) {
972  /* Check if we're at the very right edge, and if so draw only a single pixel */
973  if (x != dpi->width - 1) continue;
974  skip = true;
975  }
976 
977  /* Calculate pointer to pixel and the colour */
978  uint8_t colour = (this->map_type == SMT_VEHICLES) ? _vehicle_type_colours[v->type] : PC_WHITE;
979 
980  /* And draw either one or two pixels depending on clipping */
981  blitter->SetPixel(dpi->dst_ptr, x, y, colour);
982  if (!skip) blitter->SetPixel(dpi->dst_ptr, x + 1, y, colour);
983  }
984  }
985 
990  void DrawTowns(const DrawPixelInfo *dpi, const int vertical_padding) const
991  {
992  for (const Town *t : Town::Iterate()) {
993  /* Remap the town coordinate */
994  Point pt = this->RemapTile(TileX(t->xy), TileY(t->xy));
995  int x = pt.x - this->subscroll - (t->cache.sign.width_small >> 1);
996  int y = pt.y + vertical_padding;
997 
998  /* Check if the town sign is within bounds */
999  if (x + t->cache.sign.width_small > dpi->left &&
1000  x < dpi->left + dpi->width &&
1001  y + GetCharacterHeight(FS_SMALL) > dpi->top &&
1002  y < dpi->top + dpi->height) {
1003  /* And draw it. */
1004  SetDParam(0, t->index);
1005  DrawString(x, x + t->cache.sign.width_small, y, STR_SMALLMAP_TOWN);
1006  }
1007  }
1008  }
1009 
1014  void DrawIndustryNames(const DrawPixelInfo *dpi, const int vertical_padding) const
1015  {
1016  if (this->map_type != SMT_INDUSTRY) return;
1017 
1018  for (const Industry *i : Industry::Iterate()) {
1020  if (!tbl.show_on_map) continue;
1021 
1022  /* Industry names blink together with their blobs in the smallmap. */
1023  const bool is_blinking = i->type == _smallmap_industry_highlight && !_smallmap_industry_highlight_state;
1024  if (is_blinking) continue;
1025 
1026  if (_industry_to_name_string_width[i->type] == 0) {
1028  }
1029  const uint16_t &legend_text_width = _industry_to_name_string_width[i->type];
1030 
1031  /* Remap the industry coordinate */
1032  const TileIndex &tile = i->location.GetCenterTile();
1033  const Point pt = this->RemapTile(TileX(tile), TileY(tile));
1034  const int x = pt.x - this->subscroll - (legend_text_width / 2);
1035  const int y = pt.y + vertical_padding;
1036 
1037  /* Check if the industry name is within bounds */
1038  if (x + legend_text_width > dpi->left &&
1039  x < dpi->left + dpi->width &&
1040  y + GetCharacterHeight(FS_SMALL) > dpi->top &&
1041  y < dpi->top + dpi->height) {
1042 
1043  /* And draw it. */
1044  DrawString(x, x + legend_text_width, y, tbl.legend, TC_WHITE, SA_LEFT, false, FS_SMALL);
1045  }
1046  }
1047  }
1048 
1060  void DrawSmallMap(DrawPixelInfo *dpi) const
1061  {
1063  AutoRestoreBackup dpi_backup(_cur_dpi, dpi);
1064 
1065  /* Clear it */
1066  GfxFillRect(dpi->left, dpi->top, dpi->left + dpi->width - 1, dpi->top + dpi->height - 1, PC_BLACK);
1067 
1068  /* Which tile is displayed at (dpi->left, dpi->top)? */
1069  int dx;
1070  Point tile = this->PixelToTile(dpi->left, dpi->top, &dx);
1071  int tile_x = this->scroll_x / (int)TILE_SIZE + tile.x;
1072  int tile_y = this->scroll_y / (int)TILE_SIZE + tile.y;
1073 
1074  void *ptr = blitter->MoveTo(dpi->dst_ptr, -dx - 4, 0);
1075  int x = - dx - 4;
1076  int y = 0;
1077 
1078  for (;;) {
1079  /* Distance from left edge */
1080  if (x >= -3) {
1081  if (x >= dpi->width) break; // Exit the loop.
1082 
1083  int end_pos = std::min(dpi->width, x + 4);
1084  int reps = (dpi->height - y + 1) / 2; // Number of lines.
1085  if (reps > 0) {
1086  this->DrawSmallMapColumn(ptr, tile_x, tile_y, dpi->pitch * 2, reps, x, end_pos, blitter);
1087  }
1088  }
1089 
1090  if (y == 0) {
1091  tile_y += this->zoom;
1092  y++;
1093  ptr = blitter->MoveTo(ptr, 0, 1);
1094  } else {
1095  tile_x -= this->zoom;
1096  y--;
1097  ptr = blitter->MoveTo(ptr, 0, -1);
1098  }
1099  ptr = blitter->MoveTo(ptr, 2, 0);
1100  x += 2;
1101  }
1102 
1103  /* Draw vehicles */
1104  if (this->map_type == SMT_CONTOUR || this->map_type == SMT_VEHICLES) this->DrawVehicles(dpi, blitter);
1105 
1106  /* Draw link stat overlay */
1107  if (this->map_type == SMT_LINKSTATS) this->overlay->Draw(dpi);
1108 
1109  const int map_labels_vertical_padding = ScaleGUITrad(2);
1110 
1111  /* Draw town names */
1112  if (this->show_towns) this->DrawTowns(dpi, map_labels_vertical_padding);
1113 
1114  /* Draw industry names */
1115  if (this->show_ind_names) this->DrawIndustryNames(dpi, map_labels_vertical_padding);
1116 
1117  /* Draw map indicators */
1118  this->DrawMapIndicators();
1119  }
1120 
1127  Point RemapTile(int tile_x, int tile_y) const
1128  {
1129  int x_offset = tile_x - this->scroll_x / (int)TILE_SIZE;
1130  int y_offset = tile_y - this->scroll_y / (int)TILE_SIZE;
1131 
1132  if (this->zoom == 1) return SmallmapRemapCoords(x_offset, y_offset);
1133 
1134  /* For negative offsets, round towards -inf. */
1135  if (x_offset < 0) x_offset -= this->zoom - 1;
1136  if (y_offset < 0) y_offset -= this->zoom - 1;
1137 
1138  return SmallmapRemapCoords(x_offset / this->zoom, y_offset / this->zoom);
1139  }
1140 
1151  Point PixelToTile(int px, int py, int *sub, bool add_sub = true) const
1152  {
1153  if (add_sub) px += this->subscroll; // Total horizontal offset.
1154 
1155  /* For each two rows down, add a x and a y tile, and
1156  * For each four pixels to the right, move a tile to the right. */
1157  Point pt = {((py >> 1) - (px >> 2)) * this->zoom, ((py >> 1) + (px >> 2)) * this->zoom};
1158  px &= 3;
1159 
1160  if (py & 1) { // Odd number of rows, handle the 2 pixel shift.
1161  if (px < 2) {
1162  pt.x += this->zoom;
1163  px += 2;
1164  } else {
1165  pt.y += this->zoom;
1166  px -= 2;
1167  }
1168  }
1169 
1170  *sub = px;
1171  return pt;
1172  }
1173 
1183  Point ComputeScroll(int tx, int ty, int x, int y, int *sub) const
1184  {
1185  assert(x >= 0 && y >= 0);
1186 
1187  int new_sub;
1188  Point tile_xy = PixelToTile(x, y, &new_sub, false);
1189  tx -= tile_xy.x;
1190  ty -= tile_xy.y;
1191 
1192  Point scroll;
1193  if (new_sub == 0) {
1194  *sub = 0;
1195  scroll.x = (tx + this->zoom) * TILE_SIZE;
1196  scroll.y = (ty - this->zoom) * TILE_SIZE;
1197  } else {
1198  *sub = 4 - new_sub;
1199  scroll.x = (tx + 2 * this->zoom) * TILE_SIZE;
1200  scroll.y = (ty - 2 * this->zoom) * TILE_SIZE;
1201  }
1202  return scroll;
1203  }
1204 
1211  void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt)
1212  {
1213  static const int zoomlevels[] = {1, 2, 4, 6, 8}; // Available zoom levels. Bigger number means more zoom-out (further away).
1214  static const int MIN_ZOOM_INDEX = 0;
1215  static const int MAX_ZOOM_INDEX = lengthof(zoomlevels) - 1;
1216 
1217  int new_index, cur_index, sub;
1218  Point tile;
1219  switch (change) {
1220  case ZLC_INITIALIZE:
1221  cur_index = - 1; // Definitely different from new_index.
1222  new_index = MIN_ZOOM_INDEX;
1223  tile.x = tile.y = 0;
1224  break;
1225 
1226  case ZLC_ZOOM_IN:
1227  case ZLC_ZOOM_OUT:
1228  for (cur_index = MIN_ZOOM_INDEX; cur_index <= MAX_ZOOM_INDEX; cur_index++) {
1229  if (this->zoom == zoomlevels[cur_index]) break;
1230  }
1231  assert(cur_index <= MAX_ZOOM_INDEX);
1232 
1233  tile = this->PixelToTile(zoom_pt->x, zoom_pt->y, &sub);
1234  new_index = Clamp(cur_index + ((change == ZLC_ZOOM_IN) ? -1 : 1), MIN_ZOOM_INDEX, MAX_ZOOM_INDEX);
1235  break;
1236 
1237  default: NOT_REACHED();
1238  }
1239 
1240  if (new_index != cur_index) {
1241  this->zoom = zoomlevels[new_index];
1242  if (cur_index >= 0) {
1243  Point new_tile = this->PixelToTile(zoom_pt->x, zoom_pt->y, &sub);
1244  this->SetNewScroll(this->scroll_x + (tile.x - new_tile.x) * TILE_SIZE,
1245  this->scroll_y + (tile.y - new_tile.y) * TILE_SIZE, sub);
1246  } else if (this->map_type == SMT_LINKSTATS) {
1247  this->overlay->SetDirty();
1248  }
1249  this->SetWidgetDisabledState(WID_SM_ZOOM_IN, this->zoom == zoomlevels[MIN_ZOOM_INDEX]);
1250  this->SetWidgetDisabledState(WID_SM_ZOOM_OUT, this->zoom == zoomlevels[MAX_ZOOM_INDEX]);
1251  this->SetDirty();
1252  }
1253  }
1254 
1259  {
1260  CargoTypes cargo_mask = 0;
1261  for (int i = 0; i != _smallmap_cargo_count; ++i) {
1262  if (_legend_linkstats[i].show_on_map) SetBit(cargo_mask, _legend_linkstats[i].type);
1263  }
1264  this->overlay->SetCargoMask(cargo_mask);
1265  }
1266 
1271  {
1272  StringID legend_tooltip;
1273  StringID enable_all_tooltip;
1274  StringID disable_all_tooltip;
1275  int industry_names_select_plane;
1276  int select_buttons_plane;
1277  switch (this->map_type) {
1278  case SMT_INDUSTRY:
1279  legend_tooltip = STR_SMALLMAP_TOOLTIP_INDUSTRY_SELECTION;
1280  enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_INDUSTRIES;
1281  disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_INDUSTRIES;
1282  industry_names_select_plane = 0;
1283  select_buttons_plane = 0;
1284  break;
1285 
1286  case SMT_OWNER:
1287  legend_tooltip = STR_SMALLMAP_TOOLTIP_COMPANY_SELECTION;
1288  enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_COMPANIES;
1289  disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_COMPANIES;
1290  industry_names_select_plane = SZSP_NONE;
1291  select_buttons_plane = 0;
1292  break;
1293 
1294  case SMT_LINKSTATS:
1295  legend_tooltip = STR_SMALLMAP_TOOLTIP_CARGO_SELECTION;
1296  enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_CARGOS;
1297  disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_CARGOS;
1298  industry_names_select_plane = SZSP_NONE;
1299  select_buttons_plane = 0;
1300  break;
1301 
1302  default:
1303  legend_tooltip = STR_NULL;
1304  enable_all_tooltip = STR_NULL;
1305  disable_all_tooltip = STR_NULL;
1306  industry_names_select_plane = SZSP_NONE;
1307  select_buttons_plane = 1;
1308  break;
1309  }
1310 
1311  this->GetWidget<NWidgetCore>(WID_SM_LEGEND)->SetDataTip(STR_NULL, legend_tooltip);
1312  this->GetWidget<NWidgetCore>(WID_SM_ENABLE_ALL)->SetDataTip(STR_SMALLMAP_ENABLE_ALL, enable_all_tooltip);
1313  this->GetWidget<NWidgetCore>(WID_SM_DISABLE_ALL)->SetDataTip(STR_SMALLMAP_DISABLE_ALL, disable_all_tooltip);
1314  this->GetWidget<NWidgetStacked>(WID_SM_SHOW_IND_NAMES_SEL)->SetDisplayedPlane(industry_names_select_plane);
1315  this->GetWidget<NWidgetStacked>(WID_SM_SELECT_BUTTONS)->SetDisplayedPlane(select_buttons_plane);
1316  }
1317 
1323  uint32_t GetTileColours(const TileArea &ta) const
1324  {
1325  int importance = 0;
1326  TileIndex tile = INVALID_TILE; // Position of the most important tile.
1327  TileType et = MP_VOID; // Effective tile type at that position.
1328 
1329  for (TileIndex ti : ta) {
1330  TileType ttype = GetTileType(ti);
1331 
1332  switch (ttype) {
1333  case MP_TUNNELBRIDGE: {
1335 
1336  switch (tt) {
1337  case TRANSPORT_RAIL: ttype = MP_RAILWAY; break;
1338  case TRANSPORT_ROAD: ttype = MP_ROAD; break;
1339  default: ttype = MP_WATER; break;
1340  }
1341  break;
1342  }
1343 
1344  case MP_INDUSTRY:
1345  /* Special handling of industries while in "Industries" smallmap view. */
1346  if (this->map_type == SMT_INDUSTRY) {
1347  /* If industry is allowed to be seen, use its colour on the map.
1348  * This has the highest priority above any value in _tiletype_importance. */
1349  IndustryType type = Industry::GetByTile(ti)->type;
1350  if (_legend_from_industries[_industry_to_list_pos[type]].show_on_map) {
1351  if (type == _smallmap_industry_highlight) {
1352  if (_smallmap_industry_highlight_state) return MKCOLOUR_XXXX(PC_WHITE);
1353  } else {
1354  return GetIndustrySpec(type)->map_colour * 0x01010101;
1355  }
1356  }
1357  /* Otherwise make it disappear */
1358  ttype = IsTileOnWater(ti) ? MP_WATER : MP_CLEAR;
1359  }
1360  break;
1361 
1362  default:
1363  break;
1364  }
1365 
1366  if (_tiletype_importance[ttype] > importance) {
1367  importance = _tiletype_importance[ttype];
1368  tile = ti;
1369  et = ttype;
1370  }
1371  }
1372 
1373  switch (this->map_type) {
1374  case SMT_CONTOUR:
1375  return GetSmallMapContoursPixels(tile, et);
1376 
1377  case SMT_VEHICLES:
1378  return GetSmallMapVehiclesPixels(tile, et);
1379 
1380  case SMT_INDUSTRY:
1381  return GetSmallMapIndustriesPixels(tile, et);
1382 
1383  case SMT_LINKSTATS:
1384  return GetSmallMapLinkStatsPixels(tile, et);
1385 
1386  case SMT_ROUTES:
1387  return GetSmallMapRoutesPixels(tile, et);
1388 
1389  case SMT_VEGETATION:
1390  return GetSmallMapVegetationPixels(tile, et);
1391 
1392  case SMT_OWNER:
1394 
1395  default: NOT_REACHED();
1396  }
1397  }
1398 
1405  {
1406  const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_LEGEND);
1407  uint line = (pt.y - wi->pos_y - WidgetDimensions::scaled.framerect.top) / GetCharacterHeight(FS_SMALL);
1408  uint columns = this->GetNumberColumnsLegend(wi->current_x);
1409  uint number_of_rows = this->GetNumberRowsLegend(columns);
1410  if (line >= number_of_rows) return -1;
1411 
1412  bool rtl = _current_text_dir == TD_RTL;
1413  int x = pt.x - wi->pos_x;
1414  if (rtl) x = wi->current_x - x;
1415  uint column = (x - WidgetDimensions::scaled.framerect.left) / this->column_width;
1416 
1417  return (column * number_of_rows) + line;
1418  }
1419 
1422  {
1423  if (this->map_type == SMT_LINKSTATS) {
1424  CompanyMask company_mask = this->GetOverlayCompanyMask();
1425  if (this->overlay->GetCompanyMask() != company_mask) {
1426  this->overlay->SetCompanyMask(company_mask);
1427  } else {
1428  this->overlay->SetDirty();
1429  }
1430  }
1431  }
1432 
1434  void Blink()
1435  {
1437 
1439 
1440  this->UpdateLinks();
1441  this->SetDirty();
1442  }
1443 
1446  {
1448 
1449  this->UpdateLinks();
1450  this->SetDirty();
1451  }
1452 
1453 public:
1454  friend class NWidgetSmallmapDisplay;
1455 
1456  SmallMapWindow(WindowDesc &desc, int window_number) : Window(desc)
1457  {
1459  this->overlay = std::make_unique<LinkGraphOverlay>(this, WID_SM_MAP, 0, this->GetOverlayCompanyMask(), 1);
1460  this->CreateNestedTree();
1461  this->LowerWidget(WID_SM_CONTOUR + this->map_type);
1462 
1463  this->RebuildColourIndexIfNecessary();
1464 
1465  this->SetWidgetLoweredState(WID_SM_SHOW_HEIGHT, _smallmap_show_heightmap);
1466 
1467  this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME, this->show_towns);
1468  this->SetWidgetLoweredState(WID_SM_SHOW_IND_NAMES, this->show_ind_names);
1469 
1470  this->SetupWidgetData();
1471  this->FinishInitNested(window_number);
1472 
1473  this->SetZoomLevel(ZLC_INITIALIZE, nullptr);
1474  this->SmallMapCenterOnCurrentPos();
1475  this->SetOverlayCargoMask();
1476  }
1477 
1482  {
1483  const Viewport *vp = GetMainWindow()->viewport;
1484  Point viewport_center = InverseRemapCoords2(vp->virtual_left + vp->virtual_width / 2, vp->virtual_top + vp->virtual_height / 2);
1485 
1486  int sub;
1487  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1488  Point sxy = this->ComputeScroll(viewport_center.x / (int)TILE_SIZE, viewport_center.y / (int)TILE_SIZE,
1489  std::max(0, (int)wid->current_x / 2 - 2), wid->current_y / 2, &sub);
1490  this->SetNewScroll(sxy.x, sxy.y, sub);
1491  this->SetDirty();
1492  }
1493 
1499  Point GetStationMiddle(const Station *st) const
1500  {
1501  int x = CenterBounds(st->rect.left, st->rect.right, 0);
1502  int y = CenterBounds(st->rect.top, st->rect.bottom, 0);
1503  Point ret = this->RemapTile(x, y);
1504 
1505  /* Same magic 3 as in DrawVehicles; that's where I got it from.
1506  * No idea what it is, but without it the result looks bad.
1507  */
1508  ret.x -= 3 + this->subscroll;
1509  return ret;
1510  }
1511 
1512  void Close([[maybe_unused]] int data) override
1513  {
1514  this->BreakIndustryChainLink();
1515  this->Window::Close();
1516  }
1517 
1518  void SetStringParameters(WidgetID widget) const override
1519  {
1520  switch (widget) {
1521  case WID_SM_CAPTION:
1522  SetDParam(0, STR_SMALLMAP_TYPE_CONTOURS + this->map_type);
1523  break;
1524  }
1525  }
1526 
1527  void OnInit() override
1528  {
1529  uint min_width = 0;
1530  this->min_number_of_columns = INDUSTRY_MIN_NUMBER_OF_COLUMNS;
1531  this->min_number_of_fixed_rows = lengthof(_linkstat_colours_in_legenda);
1532  for (uint i = 0; i < lengthof(_legend_table); i++) {
1533  uint height = 0;
1534  uint num_columns = 1;
1535  for (const LegendAndColour *tbl = _legend_table[i]; !tbl->end; ++tbl) {
1536  StringID str;
1537  if (i == SMT_INDUSTRY) {
1538  SetDParam(0, tbl->legend);
1540  str = STR_SMALLMAP_INDUSTRY;
1541  } else if (i == SMT_LINKSTATS) {
1542  SetDParam(0, tbl->legend);
1543  str = STR_SMALLMAP_LINKSTATS;
1544  } else if (i == SMT_OWNER) {
1545  if (tbl->company != INVALID_COMPANY) {
1546  if (!Company::IsValidID(tbl->company)) {
1547  /* Rebuild the owner legend. */
1548  BuildOwnerLegend();
1549  this->OnInit();
1550  return;
1551  }
1552  /* Non-fixed legend entries for the owner view. */
1553  SetDParam(0, tbl->company);
1554  str = STR_SMALLMAP_COMPANY;
1555  } else {
1556  str = tbl->legend;
1557  }
1558  } else {
1559  if (tbl->col_break) {
1560  this->min_number_of_fixed_rows = std::max(this->min_number_of_fixed_rows, height);
1561  height = 0;
1562  num_columns++;
1563  }
1564  height++;
1565  str = tbl->legend;
1566  }
1567  min_width = std::max(GetStringBoundingBox(str).width, min_width);
1568  }
1569  this->min_number_of_fixed_rows = std::max(this->min_number_of_fixed_rows, height);
1570  this->min_number_of_columns = std::max(this->min_number_of_columns, num_columns);
1571  }
1572 
1573  /* Width of the legend blob. */
1574  this->legend_width = GetCharacterHeight(FS_SMALL) * 9 / 6;
1575 
1576  /* The width of a column is the minimum width of all texts + the size of the blob + some spacing */
1577  this->column_width = min_width + WidgetDimensions::scaled.hsep_normal + this->legend_width + WidgetDimensions::scaled.framerect.Horizontal();
1578 
1579  /* Cached string widths of industry names in the smallmap. Calculation is deferred to DrawIndustryNames(). */
1580  std::fill(std::begin(_industry_to_name_string_width), std::end(_industry_to_name_string_width), 0);
1581  }
1582 
1583  void OnPaint() override
1584  {
1585  if (this->map_type == SMT_OWNER) {
1586  for (const LegendAndColour *tbl = _legend_table[this->map_type]; !tbl->end; ++tbl) {
1587  if (tbl->company != INVALID_COMPANY && !Company::IsValidID(tbl->company)) {
1588  /* Rebuild the owner legend. */
1589  BuildOwnerLegend();
1590  this->InvalidateData(1);
1591  break;
1592  }
1593  }
1594  }
1595 
1596  this->DrawWidgets();
1597  }
1598 
1599  void DrawWidget(const Rect &r, WidgetID widget) const override
1600  {
1601  switch (widget) {
1602  case WID_SM_MAP: {
1603  Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1604  DrawPixelInfo new_dpi;
1605  if (!FillDrawPixelInfo(&new_dpi, ir)) return;
1606  this->DrawSmallMap(&new_dpi);
1607  break;
1608  }
1609 
1610  case WID_SM_LEGEND: {
1611  uint columns = this->GetNumberColumnsLegend(r.Width());
1612  uint number_of_rows = this->GetNumberRowsLegend(columns);
1613  bool rtl = _current_text_dir == TD_RTL;
1614  uint i = 0; // Row counter for industry legend.
1615  uint row_height = GetCharacterHeight(FS_SMALL);
1616  int padding = ScaleGUITrad(1);
1617 
1618  Rect origin = r.WithWidth(this->column_width, rtl).Shrink(WidgetDimensions::scaled.framerect).WithHeight(row_height);
1619  Rect text = origin.Indent(this->legend_width + WidgetDimensions::scaled.hsep_normal, rtl);
1620  Rect icon = origin.WithWidth(this->legend_width, rtl).Shrink(0, padding, 0, 0);
1621 
1622  StringID string = STR_NULL;
1623  switch (this->map_type) {
1624  case SMT_INDUSTRY:
1625  string = STR_SMALLMAP_INDUSTRY;
1626  break;
1627  case SMT_LINKSTATS:
1628  string = STR_SMALLMAP_LINKSTATS;
1629  break;
1630  case SMT_OWNER:
1631  string = STR_SMALLMAP_COMPANY;
1632  break;
1633  default:
1634  break;
1635  }
1636 
1637  for (const LegendAndColour *tbl = _legend_table[this->map_type]; !tbl->end; ++tbl) {
1638  if (tbl->col_break || ((this->map_type == SMT_INDUSTRY || this->map_type == SMT_OWNER || this->map_type == SMT_LINKSTATS) && i++ >= number_of_rows)) {
1639  /* Column break needed, continue at top, COLUMN_WIDTH pixels
1640  * (one "row") to the right. */
1641  int x = rtl ? -(int)this->column_width : this->column_width;
1642  int y = origin.top - text.top;
1643  text = text.Translate(x, y);
1644  icon = icon.Translate(x, y);
1645  i = 1;
1646  }
1647 
1648  uint8_t legend_colour = tbl->colour;
1649 
1650  switch (this->map_type) {
1651  case SMT_INDUSTRY:
1652  /* Industry name must be formatted, since it's not in tiny font in the specs.
1653  * So, draw with a parameter and use the STR_SMALLMAP_INDUSTRY string, which is tiny font */
1654  SetDParam(0, tbl->legend);
1656  if (tbl->show_on_map && tbl->type == _smallmap_industry_highlight) {
1658  }
1659  [[fallthrough]];
1660 
1661  case SMT_LINKSTATS:
1662  SetDParam(0, tbl->legend);
1663  [[fallthrough]];
1664 
1665  case SMT_OWNER:
1666  if (this->map_type != SMT_OWNER || tbl->company != INVALID_COMPANY) {
1667  if (this->map_type == SMT_OWNER) SetDParam(0, tbl->company);
1668  if (!tbl->show_on_map) {
1669  /* Simply draw the string, not the black border of the legend colour.
1670  * This will enforce the idea of the disabled item */
1671  DrawString(text, string, TC_GREY);
1672  } else {
1673  DrawString(text, string, TC_BLACK);
1674  GfxFillRect(icon, PC_BLACK); // Outer border of the legend colour
1675  }
1676  break;
1677  }
1678  [[fallthrough]];
1679 
1680  default:
1681  if (this->map_type == SMT_CONTOUR) SetDParam(0, tbl->height * TILE_HEIGHT_STEP);
1682  /* Anything that is not an industry or a company is using normal process */
1683  GfxFillRect(icon, PC_BLACK);
1684  DrawString(text, tbl->legend);
1685  break;
1686  }
1687  GfxFillRect(icon.Shrink(WidgetDimensions::scaled.bevel), legend_colour); // Legend colour
1688 
1689  text = text.Translate(0, row_height);
1690  icon = icon.Translate(0, row_height);
1691  }
1692  }
1693  }
1694  }
1695 
1696  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1697  {
1698  switch (widget) {
1699  case WID_SM_MAP: { // Map window
1700  if (click_count > 0) this->mouse_capture_widget = widget;
1701 
1702  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1703  Window *w = GetMainWindow();
1704  int sub;
1705  pt = this->PixelToTile(pt.x - wid->pos_x, pt.y - wid->pos_y, &sub);
1706  ScrollWindowTo(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, -1, w);
1707 
1708  this->SetDirty();
1709  break;
1710  }
1711 
1712  case WID_SM_ZOOM_IN:
1713  case WID_SM_ZOOM_OUT: {
1714  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1715  Point zoom_pt = { (int)wid->current_x / 2, (int)wid->current_y / 2};
1716  this->SetZoomLevel((widget == WID_SM_ZOOM_IN) ? ZLC_ZOOM_IN : ZLC_ZOOM_OUT, &zoom_pt);
1717  if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
1718  break;
1719  }
1720 
1721  case WID_SM_CONTOUR: // Show land contours
1722  case WID_SM_VEHICLES: // Show vehicles
1723  case WID_SM_INDUSTRIES: // Show industries
1724  case WID_SM_LINKSTATS: // Show route map
1725  case WID_SM_ROUTES: // Show transport routes
1726  case WID_SM_VEGETATION: // Show vegetation
1727  case WID_SM_OWNERS: // Show land owners
1728  this->SwitchMapType((SmallMapType)(widget - WID_SM_CONTOUR));
1729  if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
1730  break;
1731 
1732  case WID_SM_CENTERMAP: // Center the smallmap again
1733  this->SmallMapCenterOnCurrentPos();
1734  this->HandleButtonClick(WID_SM_CENTERMAP);
1735  if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
1736  break;
1737 
1738  case WID_SM_TOGGLETOWNNAME: // Toggle town names
1739  this->show_towns = !this->show_towns;
1740  this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME, this->show_towns);
1741 
1742  this->SetDirty();
1743  if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
1744  break;
1745 
1746  case WID_SM_SHOW_IND_NAMES: // Toggle industry names
1747  this->show_ind_names = !this->show_ind_names;
1748  this->SetWidgetLoweredState(WID_SM_SHOW_IND_NAMES, this->show_ind_names);
1749 
1750  this->SetDirty();
1751  if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
1752  break;
1753 
1754  case WID_SM_LEGEND: // Legend
1755  if (this->map_type == SMT_INDUSTRY || this->map_type == SMT_LINKSTATS || this->map_type == SMT_OWNER) {
1756  int click_pos = this->GetPositionOnLegend(pt);
1757  if (click_pos < 0) break;
1758 
1759  /* If industry type small map*/
1760  if (this->map_type == SMT_INDUSTRY) {
1761  /* If click on industries label, find right industry type and enable/disable it. */
1762  if (click_pos < _smallmap_industry_count) {
1763  this->SelectLegendItem(click_pos, _legend_from_industries, _smallmap_industry_count);
1764  }
1765  } else if (this->map_type == SMT_LINKSTATS) {
1766  if (click_pos < _smallmap_cargo_count) {
1767  this->SelectLegendItem(click_pos, _legend_linkstats, _smallmap_cargo_count);
1768  this->SetOverlayCargoMask();
1769  }
1770  } else if (this->map_type == SMT_OWNER) {
1771  if (click_pos < _smallmap_company_count) {
1772  this->SelectLegendItem(click_pos, _legend_land_owners, _smallmap_company_count, NUM_NO_COMPANY_ENTRIES);
1773  }
1774  }
1775  this->SetDirty();
1776  }
1777  break;
1778 
1779  case WID_SM_ENABLE_ALL:
1780  case WID_SM_DISABLE_ALL: {
1781  LegendAndColour *tbl = nullptr;
1782  switch (this->map_type) {
1783  case SMT_INDUSTRY:
1785  this->BreakIndustryChainLink();
1786  break;
1787  case SMT_OWNER:
1788  tbl = &(_legend_land_owners[NUM_NO_COMPANY_ENTRIES]);
1789  break;
1790  case SMT_LINKSTATS:
1791  tbl = _legend_linkstats;
1792  break;
1793  default:
1794  NOT_REACHED();
1795  }
1796  for (;!tbl->end && tbl->legend != STR_LINKGRAPH_LEGEND_UNUSED; ++tbl) {
1797  tbl->show_on_map = (widget == WID_SM_ENABLE_ALL);
1798  }
1799  if (this->map_type == SMT_LINKSTATS) this->SetOverlayCargoMask();
1800  this->SetDirty();
1801  break;
1802  }
1803 
1804  case WID_SM_SHOW_HEIGHT: // Enable/disable showing of heightmap.
1806  this->SetWidgetLoweredState(WID_SM_SHOW_HEIGHT, _smallmap_show_heightmap);
1807  this->SetDirty();
1808  break;
1809  }
1810  }
1811 
1820  void OnInvalidateData(int data = 0, bool gui_scope = true) override
1821  {
1822  if (!gui_scope) return;
1823 
1824  switch (data) {
1825  case 1:
1826  /* The owner legend has already been rebuilt. */
1827  this->ReInit();
1828  break;
1829 
1830  case 0: {
1831  extern std::bitset<NUM_INDUSTRYTYPES> _displayed_industries;
1832  if (this->map_type != SMT_INDUSTRY) this->SwitchMapType(SMT_INDUSTRY);
1833 
1834  for (int i = 0; i != _smallmap_industry_count; i++) {
1836  }
1837  break;
1838  }
1839 
1840  case 2:
1841  this->RebuildColourIndexIfNecessary();
1842  break;
1843 
1844  default: NOT_REACHED();
1845  }
1846  this->SetDirty();
1847  }
1848 
1849  bool OnRightClick(Point, WidgetID widget) override
1850  {
1851  if (widget != WID_SM_MAP || _scrolling_viewport) return false;
1852 
1853  _scrolling_viewport = true;
1854  return true;
1855  }
1856 
1857  void OnMouseWheel(int wheel) override
1858  {
1860  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
1861  int cursor_x = _cursor.pos.x - this->left - wid->pos_x;
1862  int cursor_y = _cursor.pos.y - this->top - wid->pos_y;
1863  if (IsInsideMM(cursor_x, 0, wid->current_x) && IsInsideMM(cursor_y, 0, wid->current_y)) {
1864  Point pt = {cursor_x, cursor_y};
1865  this->SetZoomLevel((wheel < 0) ? ZLC_ZOOM_IN : ZLC_ZOOM_OUT, &pt);
1866  }
1867  }
1868  }
1869 
1870  void OnScroll(Point delta) override
1871  {
1873 
1874  /* While tile is at (delta.x, delta.y)? */
1875  int sub;
1876  Point pt = this->PixelToTile(delta.x, delta.y, &sub);
1877  this->SetNewScroll(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, sub);
1878 
1879  this->SetDirty();
1880  }
1881 
1882  void OnMouseOver([[maybe_unused]] Point pt, WidgetID widget) override
1883  {
1884  IndustryType new_highlight = INVALID_INDUSTRYTYPE;
1885  if (widget == WID_SM_LEGEND && this->map_type == SMT_INDUSTRY) {
1886  int industry_pos = GetPositionOnLegend(pt);
1887  if (industry_pos >= 0 && industry_pos < _smallmap_industry_count) {
1888  new_highlight = _legend_from_industries[industry_pos].type;
1889  }
1890  }
1891  if (new_highlight != _smallmap_industry_highlight) {
1892  _smallmap_industry_highlight = new_highlight;
1894  this->SetDirty();
1895  }
1896  }
1897 
1898 };
1899 
1901 bool SmallMapWindow::show_towns = true;
1902 bool SmallMapWindow::show_ind_names = false;
1904 
1915 public:
1917  {
1918  this->smallmap_window = nullptr;
1919  }
1920 
1921  void SetupSmallestSize(Window *w) override
1922  {
1923  assert(this->children.size() == 2);
1924  NWidgetBase *display = this->children.front().get();
1925  NWidgetBase *bar = this->children.back().get();
1926 
1927  display->SetupSmallestSize(w);
1928  bar->SetupSmallestSize(w);
1929 
1930  this->smallmap_window = dynamic_cast<SmallMapWindow *>(w);
1931  assert(this->smallmap_window != nullptr);
1932  this->smallest_x = std::max(display->smallest_x, bar->smallest_x + smallmap_window->GetMinLegendWidth());
1934  this->fill_x = std::max(display->fill_x, bar->fill_x);
1935  this->fill_y = (display->fill_y == 0 && bar->fill_y == 0) ? 0 : std::min(display->fill_y, bar->fill_y);
1936  this->resize_x = std::max(display->resize_x, bar->resize_x);
1937  this->resize_y = std::min(display->resize_y, bar->resize_y);
1938  this->ApplyAspectRatio();
1939  }
1940 
1941  void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
1942  {
1943  this->pos_x = x;
1944  this->pos_y = y;
1945  this->current_x = given_width;
1946  this->current_y = given_height;
1947 
1948  assert(this->children.size() == 2);
1949  NWidgetBase *display = this->children.front().get();
1950  NWidgetBase *bar = this->children.back().get();
1951 
1952  if (sizing == ST_SMALLEST) {
1953  this->smallest_x = given_width;
1954  this->smallest_y = given_height;
1955  /* Make display and bar exactly equal to their minimal size. */
1956  display->AssignSizePosition(ST_SMALLEST, x, y, display->smallest_x, display->smallest_y, rtl);
1957  bar->AssignSizePosition(ST_SMALLEST, x, y + display->smallest_y, bar->smallest_x, bar->smallest_y, rtl);
1958  }
1959 
1960  uint bar_height = std::max(bar->smallest_y, this->smallmap_window->GetLegendHeight(this->smallmap_window->GetNumberColumnsLegend(given_width - bar->smallest_x)));
1961  uint display_height = given_height - bar_height;
1962  display->AssignSizePosition(ST_RESIZE, x, y, given_width, display_height, rtl);
1963  bar->AssignSizePosition(ST_RESIZE, x, y + display_height, given_width, bar_height, rtl);
1964  }
1965 };
1966 
1969  NWidget(WWT_PANEL, COLOUR_BROWN, WID_SM_MAP_BORDER),
1970  NWidget(WWT_INSET, COLOUR_BROWN, WID_SM_MAP), SetMinimalSize(346, 140), SetResize(1, 1), SetPadding(2, 2, 2, 2), EndContainer(),
1971  EndContainer(),
1972 };
1973 
1975 static constexpr NWidgetPart _nested_smallmap_bar[] = {
1976  NWidget(WWT_PANEL, COLOUR_BROWN),
1978  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SM_LEGEND), SetResize(1, 1),
1980  /* Top button row. */
1982  NWidget(WWT_PUSHIMGBTN, COLOUR_BROWN, WID_SM_ZOOM_IN),
1983  SetDataTip(SPR_IMG_ZOOMIN, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_IN), SetFill(1, 1),
1984  NWidget(WWT_PUSHIMGBTN, COLOUR_BROWN, WID_SM_CENTERMAP),
1985  SetDataTip(SPR_IMG_SMALLMAP, STR_SMALLMAP_CENTER), SetFill(1, 1),
1986  NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_BLANK),
1987  SetDataTip(SPR_EMPTY, STR_NULL), SetFill(1, 1),
1988  NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_CONTOUR),
1989  SetDataTip(SPR_IMG_SHOW_COUNTOURS, STR_SMALLMAP_TOOLTIP_SHOW_LAND_CONTOURS_ON_MAP), SetFill(1, 1),
1990  NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_VEHICLES),
1991  SetDataTip(SPR_IMG_SHOW_VEHICLES, STR_SMALLMAP_TOOLTIP_SHOW_VEHICLES_ON_MAP), SetFill(1, 1),
1992  NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_INDUSTRIES),
1993  SetDataTip(SPR_IMG_INDUSTRY, STR_SMALLMAP_TOOLTIP_SHOW_INDUSTRIES_ON_MAP), SetFill(1, 1),
1994  EndContainer(),
1995  /* Bottom button row. */
1997  NWidget(WWT_PUSHIMGBTN, COLOUR_BROWN, WID_SM_ZOOM_OUT),
1998  SetDataTip(SPR_IMG_ZOOMOUT, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_OUT), SetFill(1, 1),
1999  NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_TOGGLETOWNNAME),
2000  SetDataTip(SPR_IMG_TOWN, STR_SMALLMAP_TOOLTIP_TOGGLE_TOWN_NAMES_ON_OFF), SetFill(1, 1),
2001  NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_LINKSTATS),
2002  SetDataTip(SPR_IMG_CARGOFLOW, STR_SMALLMAP_TOOLTIP_SHOW_LINK_STATS_ON_MAP), SetFill(1, 1),
2003  NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_ROUTES),
2004  SetDataTip(SPR_IMG_SHOW_ROUTES, STR_SMALLMAP_TOOLTIP_SHOW_TRANSPORT_ROUTES_ON), SetFill(1, 1),
2005  NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_VEGETATION),
2006  SetDataTip(SPR_IMG_PLANTTREES, STR_SMALLMAP_TOOLTIP_SHOW_VEGETATION_ON_MAP), SetFill(1, 1),
2007  NWidget(WWT_IMGBTN, COLOUR_BROWN, WID_SM_OWNERS),
2008  SetDataTip(SPR_IMG_COMPANY_GENERAL, STR_SMALLMAP_TOOLTIP_SHOW_LAND_OWNERS_ON_MAP), SetFill(1, 1),
2009  EndContainer(),
2010  NWidget(NWID_SPACER), SetResize(0, 1),
2011  EndContainer(),
2012  EndContainer(),
2013  EndContainer(),
2014 };
2015 
2016 static std::unique_ptr<NWidgetBase> SmallMapDisplay()
2017 {
2018  std::unique_ptr<NWidgetBase> map_display = std::make_unique<NWidgetSmallmapDisplay>();
2019 
2020  map_display = MakeNWidgets(_nested_smallmap_display, std::move(map_display));
2021  map_display = MakeNWidgets(_nested_smallmap_bar, std::move(map_display));
2022  return map_display;
2023 }
2024 
2025 static constexpr NWidgetPart _nested_smallmap_widgets[] = {
2027  NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
2028  NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SM_CAPTION), SetDataTip(STR_SMALLMAP_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2029  NWidget(WWT_SHADEBOX, COLOUR_BROWN),
2030  NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
2031  NWidget(WWT_STICKYBOX, COLOUR_BROWN),
2032  EndContainer(),
2033  NWidgetFunction(SmallMapDisplay), // Smallmap display and legend bar + image buttons.
2034  /* Bottom button row and resize box. */
2036  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_SM_SELECT_BUTTONS),
2038  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_SM_ENABLE_ALL), SetDataTip(STR_SMALLMAP_ENABLE_ALL, STR_NULL),
2039  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_SM_DISABLE_ALL), SetDataTip(STR_SMALLMAP_DISABLE_ALL, STR_NULL),
2040  NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SM_SHOW_HEIGHT), SetDataTip(STR_SMALLMAP_SHOW_HEIGHT, STR_SMALLMAP_TOOLTIP_SHOW_HEIGHT),
2041 
2042  /* 'show industry names' button and container. Only shown for the industry map type. */
2044  NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SM_SHOW_IND_NAMES), SetDataTip(STR_SMALLMAP_SHOW_INDUSTRY_NAMES, STR_SMALLMAP_TOOLTIP_SHOW_INDUSTRY_NAMES),
2045  EndContainer(),
2046 
2047  NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 0), SetResize(1, 0),
2048  EndContainer(),
2049  EndContainer(),
2050  NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 0), SetResize(1, 0),
2051  EndContainer(),
2052  EndContainer(),
2053  NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
2054  EndContainer(),
2055 };
2056 
2057 static WindowDesc _smallmap_desc(
2058  WDP_AUTO, "smallmap", 484, 314,
2060  0,
2061  _nested_smallmap_widgets
2062 );
2063 
2068 {
2069  AllocateWindowDescFront<SmallMapWindow>(_smallmap_desc, 0);
2070 }
2071 
2080 bool ScrollMainWindowTo(int x, int y, int z, bool instant)
2081 {
2082  bool res = ScrollWindowTo(x, y, z, GetMainWindow(), instant);
2083 
2084  /* If a user scrolls to a tile (via what way what so ever) and already is on
2085  * that tile (e.g.: pressed twice), move the smallmap to that location,
2086  * so you directly see where you are on the smallmap. */
2087 
2088  if (res) return res;
2089 
2090  SmallMapWindow *w = dynamic_cast<SmallMapWindow*>(FindWindowById(WC_SMALLMAP, 0));
2091  if (w != nullptr) w->SmallMapCenterOnCurrentPos();
2092 
2093  return res;
2094 }
2095 
2102 {
2103  return static_cast<const SmallMapWindow *>(w)->GetStationMiddle(st);
2104 }
SZSP_NONE
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
Definition: widget_type.h:485
_sorted_industry_types
std::array< IndustryType, NUM_INDUSTRYTYPES > _sorted_industry_types
Industry types sorted by name.
Definition: industry_gui.cpp:223
TileY
static debug_inline uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:437
SmallMapColourScheme::default_colour
uint32_t default_colour
Default colour of the land.
Definition: smallmap_gui.cpp:281
MP_CLEAR
@ MP_CLEAR
A tile without any structures, i.e. grass, rocks, farm fields etc.
Definition: tile_type.h:48
MP_HOUSE
@ MP_HOUSE
A house by a town.
Definition: tile_type.h:51
SetFill
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1183
GetColourGradient
uint8_t GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition: palette.cpp:314
NWidgetContainer::children
std::vector< std::unique_ptr< NWidgetBase > > children
Child widgets in contaier.
Definition: widget_type.h:478
BuildOwnerLegend
void BuildOwnerLegend()
Completes the array for the owned property legend.
Definition: smallmap_gui.cpp:345
WID_SM_OWNERS
@ WID_SM_OWNERS
Button to select the owners view.
Definition: smallmap_widget.h:28
LegendAndColour::type
IndustryType type
Type of industry. Only valid for industry entries.
Definition: smallmap_gui.cpp:49
GetSmallMapVehiclesPixels
static uint32_t GetSmallMapVehiclesPixels(TileIndex, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Vehicles".
Definition: smallmap_gui.cpp:446
RoadTypeInfo
Definition: road.h:78
sound_func.h
factory.hpp
NUM_INDUSTRYTYPES
static const IndustryType NUM_INDUSTRYTYPES
total number of industry types, new and old; limited to 240 because we need some special ids like INV...
Definition: industry_type.h:26
SmallMapWindow::min_number_of_fixed_rows
uint min_number_of_fixed_rows
Minimal number of rows in the legends for the fixed layouts only (all except #SMT_INDUSTRY).
Definition: smallmap_gui.cpp:646
IsClearGround
bool IsClearGround(Tile t, ClearGround ct)
Set the type of clear tile.
Definition: clear_map.h:71
SetBit
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
_smallmap_show_heightmap
static bool _smallmap_show_heightmap
Show heightmap in industry and owner mode of smallmap window.
Definition: smallmap_gui.cpp:178
WC_INDUSTRY_CARGOES
@ WC_INDUSTRY_CARGOES
Industry cargoes chain; Window numbers:
Definition: window_type.h:515
PC_VERY_DARK_BROWN
static const uint8_t PC_VERY_DARK_BROWN
Almost-black brown palette colour.
Definition: palette_func.h:76
RoadTypeInfo::map_colour
uint8_t map_colour
Colour on mini-map.
Definition: road.h:157
ScrollWindowTo
bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2466
SmallMapWindow::BreakIndustryChainLink
static void BreakIndustryChainLink()
Notify the industry chain window to stop sending newly selected industries.
Definition: smallmap_gui.cpp:658
NWidgetBase::AssignSizePosition
virtual void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl)=0
IsInsideMM
constexpr bool IsInsideMM(const T x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
Definition: math_func.hpp:268
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
endian_func.hpp
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:68
GetTreeGround
TreeGround GetTreeGround(Tile t)
Returns the groundtype for tree tiles.
Definition: tree_map.h:102
PC_RAINFOREST
static const uint8_t PC_RAINFOREST
Pale green palette colour for rainforest.
Definition: palette_func.h:93
GetRailTypeInfo
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:307
Rect::Shrink
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Definition: geometry_type.hpp:98
smallmap_gui.h
Map::MaxX
static debug_inline uint MaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition: map_func.h:297
_sorted_cargo_specs
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:168
MOEND
#define MOEND()
Macro used for forcing a rebuild of the owner legend the first time it is used.
Definition: smallmap_gui.cpp:72
company_base.h
SmallMapWindow::ZLC_ZOOM_IN
@ ZLC_ZOOM_IN
Zoom in.
Definition: smallmap_gui.cpp:635
tunnelbridge_map.h
SmallMapWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: smallmap_gui.cpp:1583
Blitter
How all blitters should look like.
Definition: base.hpp:29
_smallmap_cargo_count
static int _smallmap_cargo_count
Number of cargos in the link stats legend.
Definition: smallmap_gui.cpp:43
WID_SM_SHOW_IND_NAMES
@ WID_SM_SHOW_IND_NAMES
Show industry names toggle button.
Definition: smallmap_widget.h:35
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:63
Station
Station data structure.
Definition: station_base.h:439
INVALID_COMPANY
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
SmallMapWindow::SmallMapCenterOnCurrentPos
void SmallMapCenterOnCurrentPos()
Center the small map on the current center of the viewport.
Definition: smallmap_gui.cpp:1481
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
WWT_IMGBTN
@ WWT_IMGBTN
(Toggle) Button with image
Definition: widget_type.h:54
PC_WHITE
static const uint8_t PC_WHITE
White palette colour.
Definition: palette_func.h:70
Window::viewport
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:321
SmallMapWindow::DrawHorizMapIndicator
static void DrawHorizMapIndicator(int x, int x2, int y)
Draws horizontal part of map indicator.
Definition: smallmap_gui.cpp:689
LegendAndColour::company
CompanyID company
Company to display. Only valid for company entries of the owner legend.
Definition: smallmap_gui.cpp:51
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:67
MS
#define MS(a, b)
Macro for break marker in arrays of LegendAndColour.
Definition: smallmap_gui.cpp:81
IntervalTimer< TimerWindow >
WID_SM_SHOW_IND_NAMES_SEL
@ WID_SM_SHOW_IND_NAMES_SEL
Container for the 'show industry names' button, which can be hidden.
Definition: smallmap_widget.h:36
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:77
SmallMapWindow::scroll_x
int32_t scroll_x
Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display.
Definition: smallmap_gui.cpp:650
TROPICZONE_RAINFOREST
@ TROPICZONE_RAINFOREST
Rainforest tile.
Definition: tile_type.h:79
Blitter::SetPixel
virtual void SetPixel(void *video, int x, int y, uint8_t colour)=0
Draw a pixel with a given colour on the video-buffer.
Window::Close
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1047
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1098
SmallMapWindow::subscroll
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...
Definition: smallmap_gui.cpp:652
GUISettings::smallmap_land_colour
uint8_t smallmap_land_colour
colour used for land and heightmap at the smallmap
Definition: settings_type.h:151
INVALID_TILE
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:95
CLEAR_GRASS
@ CLEAR_GRASS
0-3
Definition: clear_map.h:20
EndContainer
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1193
SmallMapWindow::SetupWidgetData
void SetupWidgetData()
Function to set up widgets depending on the information being shown on the smallmap.
Definition: smallmap_gui.cpp:1270
SmallMapWindow::GetOverlayCompanyMask
CompanyMask GetOverlayCompanyMask() const
Get a bitmask for company links to be displayed.
Definition: smallmap_gui.cpp:729
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:38
MP_RAILWAY
@ MP_RAILWAY
A railway.
Definition: tile_type.h:49
SND_15_BEEP
@ SND_15_BEEP
19 == 0x13 GUI button click
Definition: sound_type.h:58
vehicle_base.h
zoom_func.h
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:15
CeilDiv
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:320
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:56
CargoSpec
Specification of a cargo type.
Definition: cargotype.h:71
VSM_VIEWPORT_RMB_FIXED
@ VSM_VIEWPORT_RMB_FIXED
Viewport moves with mouse movement on holding right mouse button, cursor position is fixed.
Definition: settings_type.h:122
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition: widget_type.h:50
MP_INDUSTRY
@ MP_INDUSTRY
Part of an industry.
Definition: tile_type.h:56
town.h
RectPadding::Vertical
constexpr uint Vertical() const
Get total vertical padding of RectPadding.
Definition: geometry_type.hpp:69
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
_tiletype_importance
static const uint8_t _tiletype_importance[]
Mapping of tile type to importance of the tile (higher number means more interesting to show).
Definition: smallmap_gui.cpp:411
_smallmap_industry_count
static int _smallmap_industry_count
Number of used industries.
Definition: smallmap_gui.cpp:41
SmallMapWindow::zoom
int zoom
Zoom level. Bigger number means more zoom-out (further away).
Definition: smallmap_gui.cpp:653
MAX_TILE_HEIGHT
static const uint MAX_TILE_HEIGHT
Maximum allowed tile height.
Definition: tile_type.h:24
clear_map.h
NWidgetFunction
constexpr NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
Definition: widget_type.h:1332
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:244
Industry
Defines the internal data of a functional industry.
Definition: industry.h:68
GetRailType
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition: rail_map.h:115
SmallMapWindow::scroll_y
int32_t scroll_y
Vertical world coordinate of the base tile left of the top-left corner of the smallmap display.
Definition: smallmap_gui.cpp:651
SmallMapWindow::DrawIndustryNames
void DrawIndustryNames(const DrawPixelInfo *dpi, const int vertical_padding) const
Adds industry names to the smallmap.
Definition: smallmap_gui.cpp:1014
Viewport::virtual_top
int virtual_top
Virtual top coordinate.
Definition: viewport_type.h:29
SmallMapWindow::SwitchMapType
void SwitchMapType(SmallMapType map_type)
Select a new map type.
Definition: smallmap_gui.cpp:825
NWidgetBase::smallest_y
uint smallest_y
Smallest vertical size of the widget in a filled window.
Definition: widget_type.h:243
NWidgetSmallmapDisplay
Custom container class for displaying smallmap with a vertically resizing legend panel.
Definition: smallmap_gui.cpp:1913
GameCreationSettings::landscape
uint8_t landscape
the landscape we're currently in
Definition: settings_type.h:368
SmallMapWindow::UpdateLinks
void UpdateLinks()
Update all the links on the map.
Definition: smallmap_gui.cpp:1421
MP_ROAD
@ MP_ROAD
A tile with road (or tram tracks)
Definition: tile_type.h:50
Rect::WithHeight
Rect WithHeight(int height, bool end=false) const
Copy Rect and set its height.
Definition: geometry_type.hpp:211
SmallMapWindow::OnInit
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: smallmap_gui.cpp:1527
SmallMapWindow::column_width
uint column_width
Width of a column in the WID_SM_LEGEND widget.
Definition: smallmap_gui.cpp:647
SmallMapWindow::min_number_of_columns
uint min_number_of_columns
Minimal number of columns in legends.
Definition: smallmap_gui.cpp:645
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:1077
WID_SM_ENABLE_ALL
@ WID_SM_ENABLE_ALL
Button to enable display of all legend entries.
Definition: smallmap_widget.h:32
SmallMapWindow
Class managing the smallmap window.
Definition: smallmap_gui.cpp:629
PC_FIELDS
static const uint8_t PC_FIELDS
Light brown palette colour for fields.
Definition: palette_func.h:94
SmallMapWindow::show_towns
static bool show_towns
Display town names in the smallmap.
Definition: smallmap_gui.cpp:639
WID_SM_VEGETATION
@ WID_SM_VEGETATION
Button to select the vegetation view.
Definition: smallmap_widget.h:27
IncludeHeightmap::IfEnabled
@ IfEnabled
Only include the heightmap if its enabled in the gui by the player.
_linkstat_colours_in_legenda
static uint8_t _linkstat_colours_in_legenda[]
Link stat colours shown in legenda.
Definition: smallmap_gui.cpp:58
WID_SM_CENTERMAP
@ WID_SM_CENTERMAP
Button to move smallmap center to main window center.
Definition: smallmap_widget.h:29
WID_SM_ZOOM_OUT
@ WID_SM_ZOOM_OUT
Button to zoom out one step.
Definition: smallmap_widget.h:21
SmallMapWindow::GetNumberColumnsLegend
uint GetNumberColumnsLegend(uint width) const
Return number of columns that can be displayed in width pixels.
Definition: smallmap_gui.cpp:708
SmallMapWindow::DrawSmallMap
void DrawSmallMap(DrawPixelInfo *dpi) const
Draws the small map.
Definition: smallmap_gui.cpp:1060
GameSettings::game_creation
GameCreationSettings game_creation
settings used during the creation of a game (map)
Definition: settings_type.h:594
IndustrySpec::map_colour
uint8_t map_colour
colour used for the small map
Definition: industrytype.h:122
TRANSPORT_ROAD
@ TRANSPORT_ROAD
Transport by road vehicle.
Definition: transport_type.h:28
SmallMapWindow::GetStationMiddle
Point GetStationMiddle(const Station *st) const
Get the center of the given station as point on the screen in the smallmap window.
Definition: smallmap_gui.cpp:1499
SmallMapWindow::SetZoomLevel
void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt)
Initialize or change the zoom level.
Definition: smallmap_gui.cpp:1211
GetTileType
static debug_inline TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition: tile_map.h:96
WID_SM_CONTOUR
@ WID_SM_CONTOUR
Button to select the contour view (height map).
Definition: smallmap_widget.h:22
_smallmap_industry_highlight_state
static bool _smallmap_industry_highlight_state
State of highlight blinking.
Definition: smallmap_gui.cpp:182
WindowDesc
High level window description.
Definition: window_gui.h:162
WidgetID
int WidgetID
Widget ID.
Definition: window_type.h:18
RectPadding::Horizontal
constexpr uint Horizontal() const
Get total horizontal padding of RectPadding.
Definition: geometry_type.hpp:63
Pool::MAX_SIZE
static constexpr size_t MAX_SIZE
Make template parameter accessible from outside.
Definition: pool_type.hpp:84
ScaleGUITrad
int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:117
WID_SM_ROUTES
@ WID_SM_ROUTES
Button to select the routes view.
Definition: smallmap_widget.h:26
_dark_green_map_heights
static const uint32_t _dark_green_map_heights[]
Height map colours for the dark green colour scheme, ordered by height.
Definition: heightmap_colours.h:132
TransportType
TransportType
Available types of transport.
Definition: transport_type.h:19
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:526
SetPadding
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.
Definition: widget_type.h:1230
SmallMapWindow::GetMinLegendWidth
uint GetMinLegendWidth() const
Compute minimal required width of the legends.
Definition: smallmap_gui.cpp:699
VS_HIDDEN
@ VS_HIDDEN
Vehicle is not visible.
Definition: vehicle_base.h:33
CargoSpec::Index
CargoID Index() const
Determines index of this cargospec.
Definition: cargotype.h:105
PC_GREEN
static const uint8_t PC_GREEN
Green palette colour.
Definition: palette_func.h:84
Viewport
Data structure for viewport, display of a part of the world.
Definition: viewport_type.h:22
SetResize
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
Definition: widget_type.h:1128
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:150
SmallMapWindow::ZoomLevelChange
ZoomLevelChange
Available kinds of zoomlevel changes.
Definition: smallmap_gui.cpp:632
SmallMapWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: smallmap_gui.cpp:1820
SmallMapWindow::GetNumberRowsLegend
uint GetNumberRowsLegend(uint columns) const
Get the number of rows in the legend from the number of columns.
Definition: smallmap_gui.cpp:777
smallmap_widget.h
SmallMapWindow::ZLC_ZOOM_OUT
@ ZLC_ZOOM_OUT
Zoom out.
Definition: smallmap_gui.cpp:634
ST_SMALLEST
@ ST_SMALLEST
Initialize nested widget tree to smallest size. Also updates current_x and current_y.
Definition: widget_type.h:122
SmallMapWindow::DrawVehicles
void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
Adds vehicles to the smallmap.
Definition: smallmap_gui.cpp:952
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:614
Rect::Translate
Rect Translate(int x, int y) const
Copy and translate Rect by x,y pixels.
Definition: geometry_type.hpp:174
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
WID_SM_BLANK
@ WID_SM_BLANK
Empty button as placeholder.
Definition: smallmap_widget.h:19
Industry::GetByTile
static Industry * GetByTile(TileIndex tile)
Get the industry of the given tile.
Definition: industry.h:240
NWidgetBase::type
WidgetType type
Type of the widget / nested widget.
Definition: widget_type.h:234
SmallMapWindow::DrawVertMapIndicator
static void DrawVertMapIndicator(int x, int y, int y2)
Draws vertical part of map indicator.
Definition: smallmap_gui.cpp:677
Viewport::virtual_left
int virtual_left
Virtual left coordinate.
Definition: viewport_type.h:28
Industry::type
IndustryType type
type of industry.
Definition: industry.h:104
BaseStation::rect
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
Definition: base_station_base.h:85
LegendAndColour::col_break
bool col_break
Perform a column break and go further at the next column.
Definition: smallmap_gui.cpp:54
GetSmallMapVegetationPixels
static uint32_t GetSmallMapVegetationPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the smallmap in mode "Vegetation".
Definition: smallmap_gui.cpp:551
WID_SM_MAP_BORDER
@ WID_SM_MAP_BORDER
Border around the smallmap.
Definition: smallmap_widget.h:16
NWidgetBase::smallest_x
uint smallest_x
Smallest horizontal size of the widget in a filled window.
Definition: widget_type.h:242
ConstructionSettings::map_height_limit
uint8_t map_height_limit
the maximum allowed heightlevel
Definition: settings_type.h:382
_legend_land_contours
static LegendAndColour _legend_land_contours[]
Legend text giving the colours to look for on the minimap.
Definition: smallmap_gui.cpp:84
FS_SMALL
@ FS_SMALL
Index of the small font in the font tables.
Definition: gfx_type.h:210
SmallMapWindow::DrawMapIndicators
void DrawMapIndicators() const
Adds map indicators to the smallmap.
Definition: smallmap_gui.cpp:878
heightmap_colours.h
WID_SM_INDUSTRIES
@ WID_SM_INDUSTRIES
Button to select the industries view.
Definition: smallmap_widget.h:24
MP_WATER
@ MP_WATER
Water tile.
Definition: tile_type.h:54
_smallmap_contours_andor
static const AndOr _smallmap_contours_andor[]
Colour masks for "Contour" and "Routes" modes.
Definition: smallmap_gui.cpp:379
GetSmallMapRoutesPixels
static uint32_t GetSmallMapRoutesPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Routes".
Definition: smallmap_gui.cpp:472
SmallMapColourScheme
Colour scheme of the smallmap.
Definition: smallmap_gui.cpp:278
GetClearGround
ClearGround GetClearGround(Tile t)
Get the type of clear tile.
Definition: clear_map.h:59
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:114
SmallMapWindow::show_ind_names
static bool show_ind_names
Display industry names in the smallmap.
Definition: smallmap_gui.cpp:640
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:146
_smallmap_company_count
static int _smallmap_company_count
Number of entries in the owner legend.
Definition: smallmap_gui.cpp:42
_legend_from_industries
static LegendAndColour _legend_from_industries[NUM_INDUSTRYTYPES+1]
Allow room for all industries, plus a terminator entry This is required in order to have the industry...
Definition: smallmap_gui.cpp:172
_smallmap_industry_highlight
static IndustryType _smallmap_industry_highlight
Highlight a specific industry type.
Definition: smallmap_gui.cpp:180
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:18
WID_SM_SHOW_HEIGHT
@ WID_SM_SHOW_HEIGHT
Show heightmap toggle button.
Definition: smallmap_widget.h:34
MC
#define MC(col_break)
Macro for a height legend entry with configurable colour.
Definition: smallmap_gui.cpp:66
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:57
linkgraph_gui.h
BlitterFactory::GetCurrentBlitter
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:138
IsTileOnWater
bool IsTileOnWater(Tile t)
Tests if the tile was built on water.
Definition: water_map.h:139
SmallMapWindow::GetPositionOnLegend
int GetPositionOnLegend(Point pt)
Determines the mouse position on the legend.
Definition: smallmap_gui.cpp:1404
LegendAndColour::legend
StringID legend
String corresponding to the coloured item.
Definition: smallmap_gui.cpp:48
GUISettings::linkgraph_colours
uint8_t linkgraph_colours
linkgraph overlay colours
Definition: settings_type.h:152
GetSmallMapStationMiddle
Point GetSmallMapStationMiddle(const Window *w, const Station *st)
Determine the middle of a station in the smallmap window.
Definition: smallmap_gui.cpp:2101
NWidget
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1311
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:52
industry.h
safeguards.h
timer.h
lengthof
#define lengthof(array)
Return the length of an fixed size array.
Definition: stdafx.h:280
_vehicle_type_colours
static const uint8_t _vehicle_type_colours[6]
Vehicle colours in #SMT_VEHICLES mode.
Definition: smallmap_gui.cpp:612
ConstructionSettings::freeform_edges
bool freeform_edges
allow terraforming the tiles at the map edges
Definition: settings_type.h:395
Rect::Indent
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Definition: geometry_type.hpp:198
CursorVars::fix_at
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition: gfx_type.h:128
_industry_to_list_pos
static uint _industry_to_list_pos[NUM_INDUSTRYTYPES]
For connecting industry type to position in industries list(small map legend)
Definition: smallmap_gui.cpp:174
_displayed_industries
std::bitset< NUM_INDUSTRYTYPES > _displayed_industries
Communication from the industry chain window to the smallmap window about what industries to display.
Definition: industry_gui.cpp:57
LegendAndColour::colour
uint8_t colour
Colour of the item on the map.
Definition: smallmap_gui.cpp:47
Rect::WithWidth
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
Definition: geometry_type.hpp:185
GetTileOwner
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition: tile_map.h:178
PC_GRASS_LAND
static const uint8_t PC_GRASS_LAND
Dark green palette colour for grass land.
Definition: palette_func.h:91
_smallmap_vehicles_andor
static const AndOr _smallmap_vehicles_andor[]
Colour masks for "Vehicles", "Industry", and "Vegetation" modes.
Definition: smallmap_gui.cpp:395
MP_TUNNELBRIDGE
@ MP_TUNNELBRIDGE
Tunnel entry/exit and bridge heads.
Definition: tile_type.h:57
INVALID_ROADTYPE
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition: road_type.h:30
_heightmap_schemes
static SmallMapColourScheme _heightmap_schemes[]
Available colour schemes for height maps.
Definition: smallmap_gui.cpp:285
VSM_MAP_RMB_FIXED
@ VSM_MAP_RMB_FIXED
Map moves with mouse movement on holding right mouse button, cursor position is fixed.
Definition: settings_type.h:123
PC_VERY_LIGHT_YELLOW
static const uint8_t PC_VERY_LIGHT_YELLOW
Almost-white yellow palette colour.
Definition: palette_func.h:82
Viewport::virtual_width
int virtual_width
width << zoom
Definition: viewport_type.h:30
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
ScrollMainWindowTo
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
Definition: smallmap_gui.cpp:2080
WID_SM_TOGGLETOWNNAME
@ WID_SM_TOGGLETOWNNAME
Toggle button to display town names.
Definition: smallmap_widget.h:30
SmallMapWindow::legend_width
uint legend_width
Width of legend 'blob'.
Definition: smallmap_gui.cpp:648
IncludeHeightmap::Always
@ Always
Always include the heightmap.
CenterBounds
int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition: gfx_func.h:166
SmallMapWindow::ForceRefresh
void ForceRefresh()
Force a full refresh of the map.
Definition: smallmap_gui.cpp:1445
MakeNWidgets
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:3210
GUISettings::scroll_mode
uint8_t scroll_mode
viewport scroll mode
Definition: settings_type.h:153
stdafx.h
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:114
landscape.h
_nested_smallmap_display
static constexpr NWidgetPart _nested_smallmap_display[]
Widget parts of the smallmap display.
Definition: smallmap_gui.cpp:1968
IndustrySpec
Defines the data structure for constructing industry.
Definition: industrytype.h:101
SmallMapWindow::DrawSmallMapColumn
void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const
Draws one column of tiles of the small map in a certain mode onto the screen buffer,...
Definition: smallmap_gui.cpp:912
viewport_func.h
NWidgetBase::current_y
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:246
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:45
GetStationType
StationType GetStationType(Tile t)
Get the station type of this tile.
Definition: station_map.h:44
InverseRemapCoords2
Point InverseRemapCoords2(int x, int y, bool clamp_to_map, bool *clamped)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Definition: landscape.cpp:111
OWNER_TOWN
@ OWNER_TOWN
A town owns the tile, or a town is expanding.
Definition: company_type.h:24
DECLARE_ENUM_AS_ADDABLE
#define DECLARE_ENUM_AS_ADDABLE(EnumType)
Operator that allows this enumeration to be added to any other enumeration.
Definition: enum_type.hpp:41
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:79
FillDrawPixelInfo
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition: gfx.cpp:1548
BuildIndustriesLegend
void BuildIndustriesLegend()
Fills an array for the industries legends.
Definition: smallmap_gui.cpp:189
IsTileForestIndustry
bool IsTileForestIndustry(TileIndex tile)
Check whether the tile is a forest.
Definition: industry_cmd.cpp:975
SmallMapType
SmallMapType
Types of legends in the WID_SM_LEGEND widget.
Definition: smallmap_gui.cpp:617
SmallMapColourScheme::height_colours_base
std::span< const uint32_t > height_colours_base
Base table for determining the colours.
Definition: smallmap_gui.cpp:280
MP_TREES
@ MP_TREES
Tile got trees.
Definition: tile_type.h:52
GetRoadTypeInfo
const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition: road.h:227
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:71
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:70
MK
#define MK(a, b)
Macro for ordinary entry of LegendAndColour.
Definition: smallmap_gui.cpp:63
IndustrySpec::enabled
bool enabled
entity still available (by default true).newgrf can disable it, though
Definition: industrytype.h:133
MKEND
#define MKEND()
Macro for end of list marker in arrays of LegendAndColour.
Definition: smallmap_gui.cpp:75
PC_YELLOW
static const uint8_t PC_YELLOW
Yellow palette colour.
Definition: palette_func.h:80
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:115
NWidgetBase::fill_y
uint fill_y
Vertical fill stepsize (from initial size, 0 means not resizable).
Definition: widget_type.h:236
NWidgetSmallmapDisplay::AssignSizePosition
void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
Definition: smallmap_gui.cpp:1941
_industry_to_name_string_width
static uint16_t _industry_to_name_string_width[NUM_INDUSTRYTYPES]
The string bounding box width for each industry type in the smallmap.
Definition: smallmap_gui.cpp:176
PC_DARK_RED
static const uint8_t PC_DARK_RED
Dark red palette colour.
Definition: palette_func.h:73
Pool::PoolItem<&_company_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:388
Map::MaxY
static uint MaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition: map_func.h:306
strings_func.h
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:250
MP_VOID
@ MP_VOID
Invisible tiles at the SW and SE border.
Definition: tile_type.h:55
ST_RESIZE
@ ST_RESIZE
Resize the nested widget tree.
Definition: widget_type.h:123
Blitter::MoveTo
virtual void * MoveTo(void *video, int x, int y)=0
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
PC_TREES
static const uint8_t PC_TREES
Green palette colour for trees.
Definition: palette_func.h:95
INVALID_INDUSTRYTYPE
static const IndustryType INVALID_INDUSTRYTYPE
one above amount is considered invalid
Definition: industry_type.h:27
SmallMapWindow::SetOverlayCargoMask
void SetOverlayCargoMask()
Set the link graph overlay cargo mask from the legend.
Definition: smallmap_gui.cpp:1258
SmallMapWindow::SetNewScroll
void SetNewScroll(int sx, int sy, int sub)
Set new scroll_x, scroll_y, and subscroll values after limiting them such that the center of the smal...
Definition: smallmap_gui.cpp:845
TRANSPORT_RAIL
@ TRANSPORT_RAIL
Transport by train.
Definition: transport_type.h:27
TileType
TileType
The different types of tiles.
Definition: tile_type.h:47
WID_SM_VEHICLES
@ WID_SM_VEHICLES
Button to select the vehicles view.
Definition: smallmap_widget.h:23
WID_SM_MAP
@ WID_SM_MAP
Panel containing the smallmap.
Definition: smallmap_widget.h:17
SetDParam
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
NWidgetBase::fill_x
uint fill_x
Horizontal fill stepsize (from initial size, 0 means not resizable).
Definition: widget_type.h:235
GetMainWindow
Window * GetMainWindow()
Get the main window, i.e.
Definition: window.cpp:1127
PC_ORANGE
static const uint8_t PC_ORANGE
Orange palette colour.
Definition: palette_func.h:78
InvalidateWindowClassesData
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3225
OWNER_WATER
@ OWNER_WATER
The tile/execution is done by "water".
Definition: company_type.h:26
NWidgetBase::SetupSmallestSize
virtual void SetupSmallestSize(Window *w)=0
tree_map.h
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:52
WID_SM_DISABLE_ALL
@ WID_SM_DISABLE_ALL
Button to disable display of all legend entries.
Definition: smallmap_widget.h:33
AutoRestoreBackup
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
Definition: backup_type.hpp:150
NWidgetBase::resize_y
uint resize_y
Vertical resize step (0 means not resizable).
Definition: widget_type.h:238
ShowSmallMap
void ShowSmallMap()
Show the smallmap window.
Definition: smallmap_gui.cpp:2067
MP_STATION
@ MP_STATION
A tile of a station.
Definition: tile_type.h:53
LegendAndColour::show_on_map
bool show_on_map
For filtering industries, if true, industry is shown on the map in colour.
Definition: smallmap_gui.cpp:52
Industry::GetIndustryTypeCount
static uint16_t GetIndustryTypeCount(IndustryType type)
Get the count of industries for this type.
Definition: industry.h:275
GetTunnelBridgeTransportType
TransportType GetTunnelBridgeTransportType(Tile t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
Definition: tunnelbridge_map.h:39
PC_GREY
static const uint8_t PC_GREY
Grey palette colour.
Definition: palette_func.h:69
MAX_UVALUE
#define MAX_UVALUE(type)
The largest value that can be entered in a variable.
Definition: stdafx.h:343
_company_to_list_pos
static uint _company_to_list_pos[MAX_COMPANIES]
For connecting company ID to position in owner list (small map legend)
Definition: smallmap_gui.cpp:184
PC_WATER
static const uint8_t PC_WATER
Dark blue palette colour for water.
Definition: palette_func.h:96
GUISettings::scrollwheel_scrolling
uint8_t scrollwheel_scrolling
scrolling using the scroll wheel?
Definition: settings_type.h:177
CargoSpec::name
StringID name
Name of this type of cargo.
Definition: cargotype.h:88
PC_BLACK
static const uint8_t PC_BLACK
Black palette colour.
Definition: palette_func.h:67
SmallMapWindow::map_type
static SmallMapType map_type
Currently displayed legends.
Definition: smallmap_gui.cpp:638
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:81
WWT_INSET
@ WWT_INSET
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:53
NWidgetContainer
Baseclass for container widgets.
Definition: widget_type.h:461
TileArea
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Definition: tilearea_type.h:102
SA_LEFT
@ SA_LEFT
Left align the text.
Definition: gfx_type.h:345
SmallMapWindow::RemapTile
Point RemapTile(int tile_x, int tile_y) const
Remap tile to location on this smallmap.
Definition: smallmap_gui.cpp:1127
NWidgetBase::SetDirty
virtual void SetDirty(const Window *w) const
Mark the widget as 'dirty' (in need of repaint).
Definition: widget.cpp:903
_violet_map_heights
static const uint32_t _violet_map_heights[]
Height map colours for the violet colour scheme, ordered by height.
Definition: heightmap_colours.h:235
SmallMapWindow::Blink
void Blink()
Blink the industries (if hover over an industry).
Definition: smallmap_gui.cpp:1434
VS_UNCLICKABLE
@ VS_UNCLICKABLE
Vehicle is not clickable by the user (shadow vehicles).
Definition: vehicle_base.h:35
station_map.h
window_func.h
_legend_linkstats
static LegendAndColour _legend_linkstats[NUM_CARGO+lengthof(_linkstat_colours_in_legenda)+1]
Legend entries for the link stats view.
Definition: smallmap_gui.cpp:167
SoundSettings::click_beep
bool click_beep
Beep on a random selection of buttons.
Definition: settings_type.h:249
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:77
Town
Town data structure.
Definition: town.h:54
SetMinimalSize
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1139
TileXY
static debug_inline TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition: map_func.h:385
SmallMapWindow::GetTileColours
uint32_t GetTileColours(const TileArea &ta) const
Decide which colours to show to the user for a group of tiles.
Definition: smallmap_gui.cpp:1323
_green_map_heights
static const uint32_t _green_map_heights[]
Height map colours for the green colour scheme, ordered by height.
Definition: heightmap_colours.h:13
PC_ROUGH_LAND
static const uint8_t PC_ROUGH_LAND
Dark green palette colour for rough land.
Definition: palette_func.h:90
TileHeight
static debug_inline uint TileHeight(Tile tile)
Returns the height of a tile.
Definition: tile_map.h:29
GetSmallMapIndustriesPixels
static uint32_t GetSmallMapIndustriesPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Industries".
Definition: smallmap_gui.cpp:459
NWidgetBase::pos_y
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:251
DrawString
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:657
SmallMapWindow::DrawTowns
void DrawTowns(const DrawPixelInfo *dpi, const int vertical_padding) const
Adds town names to the smallmap.
Definition: smallmap_gui.cpp:990
timer_window.h
VEH_EFFECT
@ VEH_EFFECT
Effect vehicle type (smoke, explosions, sparks, bubbles)
Definition: vehicle_type.h:31
TILE_HEIGHT_STEP
static const int TILE_HEIGHT_STEP
One Z unit tile height difference is displayed as 50m.
Definition: viewport_func.h:20
NWidgetSmallmapDisplay::SetupSmallestSize
void SetupSmallestSize(Window *w) override
Definition: smallmap_gui.cpp:1921
GetSmallMapLinkStatsPixels
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".
Definition: smallmap_gui.cpp:528
WidgetDimensions::bevel
RectPadding bevel
Bevel thickness, affected by "scaled bevels" game option.
Definition: window_gui.h:40
TREE_GROUND_SNOW_DESERT
@ TREE_GROUND_SNOW_DESERT
a desert or snow tile, depend on landscape
Definition: tree_map.h:55
AndOr
Definition: smallmap_gui.cpp:367
IncludeHeightmap
IncludeHeightmap
Enum for how to include the heightmap pixels/colours in small map related functions.
Definition: smallmap_gui.h:27
GameSettings::construction
ConstructionSettings construction
construction of things in-game
Definition: settings_type.h:595
GetIndustrySpec
const IndustrySpec * GetIndustrySpec(IndustryType thistype)
Accessor for array _industry_specs.
Definition: industry_cmd.cpp:123
Window
Data structure for an opened window.
Definition: window_gui.h:276
SizingType
SizingType
Different forms of sizing nested widgets, using NWidgetBase::AssignSizePosition()
Definition: widget_type.h:121
MAX_COMPANIES
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
WID_SM_LINKSTATS
@ WID_SM_LINKSTATS
Button to select the link stats view.
Definition: smallmap_widget.h:25
IndustrySpec::name
StringID name
Displayed name of the industry.
Definition: industrytype.h:123
SWS_OFF
@ SWS_OFF
Scroll wheel has no effect.
Definition: settings_type.h:133
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:328
WID_SM_LEGEND
@ WID_SM_LEGEND
Bottom panel to display smallmap legends.
Definition: smallmap_widget.h:18
PC_RED
static const uint8_t PC_RED
Red palette colour.
Definition: palette_func.h:74
SmallMapWindow::SelectLegendItem
void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item=0)
Select and toggle a legend item.
Definition: smallmap_gui.cpp:796
PC_DARK_GREY
static const uint8_t PC_DARK_GREY
Dark grey palette colour.
Definition: palette_func.h:68
Clamp
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:79
SmallMapWindow::RebuildColourIndexIfNecessary
void RebuildColourIndexIfNecessary()
Rebuilds the colour indices used for fast access to the smallmap contour colours based on the heightl...
Definition: smallmap_gui.cpp:747
TileX
static debug_inline uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:427
WID_SM_SELECT_BUTTONS
@ WID_SM_SELECT_BUTTONS
Selection widget for the buttons present in some smallmap modes.
Definition: smallmap_widget.h:31
Viewport::virtual_height
int virtual_height
height << zoom
Definition: viewport_type.h:31
NUM_CARGO
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
Definition: cargo_type.h:74
SmallMapWindow::map_height_limit
static int map_height_limit
Currently used/cached map height limit.
Definition: smallmap_gui.cpp:641
SmallMapWindow::ZLC_INITIALIZE
@ ZLC_INITIALIZE
Initialize zoom level.
Definition: smallmap_gui.cpp:633
SetDataTip
constexpr NWidgetPart SetDataTip(uint32_t data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1204
InverseRemapCoords
Point InverseRemapCoords(int x, int y)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Definition: landscape.h:109
Rect::Width
int Width() const
Get width of Rect.
Definition: geometry_type.hpp:85
NWID_SELECTION
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition: widget_type.h:82
OrthogonalTileArea::ClampToMap
void ClampToMap()
Clamp the tile area to map borders.
Definition: tilearea.cpp:142
SmallMapWindow::ComputeScroll
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,...
Definition: smallmap_gui.cpp:1183
MO
#define MO(a, b)
Macro for non-company owned property entry of LegendAndColour.
Definition: smallmap_gui.cpp:69
LegendAndColour
Structure for holding relevant data for legends in small map.
Definition: smallmap_gui.cpp:46
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:75
CursorVars::pos
Point pos
logical mouse position
Definition: gfx_type.h:125
Company
Definition: company_base.h:133
WID_SM_ZOOM_IN
@ WID_SM_ZOOM_IN
Button to zoom in one step.
Definition: smallmap_widget.h:20
LinkGraphOverlay::LINK_COLOURS
static const uint8_t LINK_COLOURS[][12]
Colours for the various "load" states of links.
Definition: linkgraph_gui.h:47
LegendAndColour::end
bool end
This is the end of the list.
Definition: smallmap_gui.cpp:53
NWidgetBase::resize_x
uint resize_x
Horizontal resize step (0 means not resizable).
Definition: widget_type.h:237
GetSmallMapContoursPixels
static uint32_t GetSmallMapContoursPixels(TileIndex tile, TileType t)
Return the colour a tile would be displayed with in the small map in mode "Contour".
Definition: smallmap_gui.cpp:433
GetTropicZone
TropicZone GetTropicZone(Tile tile)
Get the tropic zone.
Definition: tile_map.h:238
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:245
_nested_smallmap_bar
static constexpr NWidgetPart _nested_smallmap_bar[]
Widget parts of the smallmap legend bar + image buttons.
Definition: smallmap_gui.cpp:1975
WidgetDimensions::framerect
RectPadding framerect
Standard padding inside many panels.
Definition: window_gui.h:42
BuildLinkStatsLegend
void BuildLinkStatsLegend()
Populate legend table for the link stat view.
Definition: smallmap_gui.cpp:219
WidgetDimensions::hsep_normal
int hsep_normal
Normal horizontal spacing.
Definition: window_gui.h:63
GetSmallMapOwnerPixels
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".
Definition: smallmap_gui.cpp:584
_scrolling_viewport
bool _scrolling_viewport
A viewport is being scrolled with the mouse.
Definition: window.cpp:90
WC_SMALLMAP
@ WC_SMALLMAP
Small map; Window numbers:
Definition: window_type.h:104
SmallMapWindow::PixelToTile
Point PixelToTile(int px, int py, int *sub, bool add_sub=true) const
Determine the tile relative to the base tile of the smallmap, and the pixel position at that tile for...
Definition: smallmap_gui.cpp:1151
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:56
SmallMapColourScheme::height_colours
std::vector< uint32_t > height_colours
Cached colours for each level in a map.
Definition: smallmap_gui.cpp:279
GetClearDensity
uint GetClearDensity(Tile t)
Get the density of a non-field clear tile.
Definition: clear_map.h:83
PC_LIGHT_BLUE
static const uint8_t PC_LIGHT_BLUE
Light blue palette colour.
Definition: palette_func.h:88
NUM_NO_COMPANY_ENTRIES
static const int NUM_NO_COMPANY_ENTRIES
Number of entries in the owner legend that are not companies.
Definition: smallmap_gui.cpp:60
GetStringBoundingBox
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:851
NWidgetBase::padding
RectPadding padding
Padding added to the widget. Managed by parent container widget. (parent container may swap left and ...
Definition: widget_type.h:253
WID_SM_CAPTION
@ WID_SM_CAPTION
Caption of the window.
Definition: smallmap_widget.h:15
SmallMapWindow::GetLegendHeight
uint GetLegendHeight(uint num_columns) const
Compute height given a number of columns.
Definition: smallmap_gui.cpp:718
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:57
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:611
LegendAndColour::height
uint8_t height
Height in tiles. Only valid for height legend entries.
Definition: smallmap_gui.cpp:50
BuildLandLegend
void BuildLandLegend()
(Re)build the colour tables for the legends.
Definition: smallmap_gui.cpp:294
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:157
NWidgetSmallmapDisplay::smallmap_window
const SmallMapWindow * smallmap_window
Window manager instance.
Definition: smallmap_gui.cpp:1914
PC_BARE_LAND
static const uint8_t PC_BARE_LAND
Brown palette colour for bare land.
Definition: palette_func.h:92
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:66
backup_type.hpp
TREE_GROUND_ROUGH_SNOW
@ TREE_GROUND_ROUGH_SNOW
A snow tile that is rough underneath.
Definition: tree_map.h:57