smallmap_gui.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "core/backup_type.hpp"
#include "clear_map.h"
#include "industry.h"
#include "station_map.h"
#include "landscape.h"
#include "tree_map.h"
#include "viewport_func.h"
#include "town.h"
#include "tunnelbridge_map.h"
#include "core/endian_func.hpp"
#include "vehicle_base.h"
#include "sound_func.h"
#include "window_func.h"
#include "company_base.h"
#include "zoom_func.h"
#include "strings_func.h"
#include "blitter/factory.hpp"
#include "linkgraph/linkgraph_gui.h"
#include "timer/timer.h"
#include "timer/timer_window.h"
#include "smallmap_gui.h"
#include "core/enum_type.hpp"
 
#include "widgets/smallmap_widget.h"
 
#include "table/strings.h"
 
#include <bitset>
 
#include "safeguards.h"
 
static int _smallmap_industry_count; 
static int _smallmap_company_count;  
static int _smallmap_cargo_count;    

struct LegendAndColour {
  StringID legend; 
  PixelColour colour; 
  IndustryType type;         
  uint8_t height;            
  CompanyID company;         
  bool show_on_map;          
  bool end;                  
  bool col_break;            
};

static const uint8_t _linkstat_colours_in_legenda[] = {0, 1, 3, 5, 7, 9, 11};
 
static const int NUM_NO_COMPANY_ENTRIES = 4; 

#define MK(a, b) {b, a, IT_INVALID, 0, CompanyID::Invalid(), true, false, false}

#define MC(col_break) {STR_TINY_BLACK_HEIGHT, {}, IT_INVALID, 0, CompanyID::Invalid(), true, false, col_break}

#define MO(a, b) {b, a, IT_INVALID, 0, CompanyID::Invalid(), true, false, false}

#define MOEND() {STR_NULL, {}, IT_INVALID, 0, OWNER_NONE, true, true, false}

#define MKEND() {STR_NULL, {}, IT_INVALID, 0, CompanyID::Invalid(), true, true, false}

#define MS(a, b) {b, a, IT_INVALID, 0, CompanyID::Invalid(), true, false, true}

static LegendAndColour _legend_land_contours[] = {
  MK(PC_BLACK,           STR_SMALLMAP_LEGENDA_ROADS),
  MK(PC_GREY,            STR_SMALLMAP_LEGENDA_RAILROADS),
  MK(PC_LIGHT_BLUE,      STR_SMALLMAP_LEGENDA_STATIONS_AIRPORTS_DOCKS),
  MK(PC_DARK_RED,        STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
  MK(PC_WHITE,           STR_SMALLMAP_LEGENDA_VEHICLES),
 
  /* Placeholders for the colours and heights of the legend.
   * The following values are set at BuildLandLegend() based
   * on each colour scheme and the maximum map height. */
  MC(true),
  MC(false),
  MC(false),
  MC(false),
  MC(false),
  MC(false),
  MC(true),
  MC(false),
  MC(false),
  MC(false),
  MC(false),
  MC(false),
  MKEND()
};
 
static const LegendAndColour _legend_vehicles[] = {
  MK(PC_RED,             STR_SMALLMAP_LEGENDA_TRAINS),
  MK(PC_YELLOW,          STR_SMALLMAP_LEGENDA_ROAD_VEHICLES),
  MK(PC_LIGHT_BLUE,      STR_SMALLMAP_LEGENDA_SHIPS),
  MK(PC_WHITE,           STR_SMALLMAP_LEGENDA_AIRCRAFT),
 
  MS(PC_BLACK,           STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES),
  MK(PC_DARK_RED,        STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
  MKEND()
};
 
static const LegendAndColour _legend_routes[] = {
  MK(PC_BLACK,           STR_SMALLMAP_LEGENDA_ROADS),
  MK(PC_GREY,            STR_SMALLMAP_LEGENDA_RAILROADS),
  MK(PC_DARK_RED,        STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
 
  MS(PC_VERY_DARK_BROWN, STR_SMALLMAP_LEGENDA_RAILROAD_STATION),
  MK(PC_ORANGE,          STR_SMALLMAP_LEGENDA_TRUCK_LOADING_BAY),
  MK(PC_YELLOW,          STR_SMALLMAP_LEGENDA_BUS_STATION),
  MK(PC_RED,             STR_SMALLMAP_LEGENDA_AIRPORT_HELIPORT),
  MK(PC_LIGHT_BLUE,      STR_SMALLMAP_LEGENDA_DOCK),
  MKEND()
};
 
static const LegendAndColour _legend_vegetation[] = {
  MK(PC_ROUGH_LAND,      STR_SMALLMAP_LEGENDA_ROUGH_LAND),
  MK(PC_GRASS_LAND,      STR_SMALLMAP_LEGENDA_GRASS_LAND),
  MK(PC_BARE_LAND,       STR_SMALLMAP_LEGENDA_BARE_LAND),
  MK(PC_RAINFOREST,      STR_SMALLMAP_LEGENDA_RAINFOREST),
  MK(PC_FIELDS,          STR_SMALLMAP_LEGENDA_FIELDS),
  MK(PC_TREES,           STR_SMALLMAP_LEGENDA_TREES),
 
  MS(PC_GREEN,           STR_SMALLMAP_LEGENDA_FOREST),
  MK(PC_GREY,            STR_SMALLMAP_LEGENDA_ROCKS),
  MK(PC_ORANGE,          STR_SMALLMAP_LEGENDA_DESERT),
  MK(PC_LIGHT_BLUE,      STR_SMALLMAP_LEGENDA_SNOW),
  MK(PC_BLACK,           STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES),
  MK(PC_DARK_RED,        STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES),
  MKEND()
};
 
static LegendAndColour _legend_land_owners[NUM_NO_COMPANY_ENTRIES + MAX_COMPANIES + 1] = {
  MO(PC_WATER,           STR_SMALLMAP_LEGENDA_WATER),
  MO({},                 STR_SMALLMAP_LEGENDA_NO_OWNER), // This colour will vary depending on settings.
  MO(PC_DARK_RED,        STR_SMALLMAP_LEGENDA_TOWNS),
  MO(PC_DARK_GREY,       STR_SMALLMAP_LEGENDA_INDUSTRIES),
  /* The legend will be terminated the first time it is used. */
  MOEND(),
};
 
#undef MK
#undef MC
#undef MS
#undef MO
#undef MOEND
#undef MKEND

static LegendAndColour _legend_linkstats[NUM_CARGO + lengthof(_linkstat_colours_in_legenda) + 1];
static LegendAndColour _legend_from_industries[NUM_INDUSTRYTYPES + 1];
static uint _industry_to_list_pos[NUM_INDUSTRYTYPES];
static uint16_t _industry_to_name_string_width[NUM_INDUSTRYTYPES];
static bool _smallmap_show_heightmap = false;
static IndustryType _smallmap_industry_highlight = IT_INVALID;
static bool _smallmap_industry_highlight_state;
static TypedIndexContainer<std::array<uint32_t, MAX_COMPANIES>, CompanyID> _company_to_list_pos;

void BuildIndustriesLegend()
{
  uint j = 0;
 
  /* Add each name */
  for (IndustryType ind : _sorted_industry_types) {
    const IndustrySpec *indsp = GetIndustrySpec(ind);
    if (indsp->enabled) {
      _legend_from_industries[j].legend = indsp->name;
      _legend_from_industries[j].colour = indsp->map_colour;
      _legend_from_industries[j].type = ind;
      _legend_from_industries[j].show_on_map = true;
      _legend_from_industries[j].col_break = false;
      _legend_from_industries[j].end = false;
 
      /* Store widget number for this industry type. */
      _industry_to_list_pos[ind] = j;
      j++;
    }
  }
  /* Terminate the list */
  _legend_from_industries[j].end = true;
 
  /* Store number of enabled industries */
  _smallmap_industry_count = j;
}

void BuildLinkStatsLegend()
{
  /* Clear the legend */
  std::fill(std::begin(_legend_linkstats), std::end(_legend_linkstats), LegendAndColour{});
 
  uint i = 0;
  for (; i < _sorted_cargo_specs.size(); ++i) {
    const CargoSpec *cs = _sorted_cargo_specs[i];
 
    _legend_linkstats[i].legend = cs->name;
    _legend_linkstats[i].colour = cs->legend_colour;
    _legend_linkstats[i].type = cs->Index();
    _legend_linkstats[i].show_on_map = true;
  }
 
  _legend_linkstats[i].col_break = true;
  _smallmap_cargo_count = i;
 
  for (; i < _smallmap_cargo_count + lengthof(_linkstat_colours_in_legenda); ++i) {
    _legend_linkstats[i].legend = STR_EMPTY;
    _legend_linkstats[i].colour = LinkGraphOverlay::LINK_COLOURS[_settings_client.gui.linkgraph_colours][_linkstat_colours_in_legenda[i - _smallmap_cargo_count]];
    _legend_linkstats[i].show_on_map = true;
  }
 
  _legend_linkstats[_smallmap_cargo_count].legend = STR_LINKGRAPH_LEGEND_UNUSED;
  _legend_linkstats[i - 1].legend = STR_LINKGRAPH_LEGEND_OVERLOADED;
  _legend_linkstats[(_smallmap_cargo_count + i - 1) / 2].legend = STR_LINKGRAPH_LEGEND_SATURATED;
  _legend_linkstats[i].end = true;
}

enum class SmallMapType : uint8_t {
  Contour, 
  Vehicles, 
  Industries, 
  LinkStats, 
  Routes, 
  Vegetation, 
  Owners, 
  End, 
};

static const EnumIndexArray<std::span<const LegendAndColour>, SmallMapType, SmallMapType::End> _legend_table{
  _legend_land_contours,
  _legend_vehicles,
  _legend_from_industries,
  _legend_linkstats,
  _legend_routes,
  _legend_vegetation,
  _legend_land_owners,
};
 
#define MKCOLOUR(x)         TO_LE32(x)
 
#define MKCOLOUR_XXXX(x)    (MKCOLOUR(0x01010101) * (uint)(x.p))
#define MKCOLOUR_0XX0(x)    (MKCOLOUR(0x00010100) * (uint)(x.p))
#define MKCOLOUR_X00X(x)    (MKCOLOUR(0x01000001) * (uint)(x.p))
 
#define MKCOLOUR_XYYX(x, y) (MKCOLOUR_X00X(x) | MKCOLOUR_0XX0(y))
 
#define MKCOLOUR_0000       MKCOLOUR_XXXX(PixelColour{0x00})
#define MKCOLOUR_F00F       MKCOLOUR_X00X(PixelColour{0xFF})
#define MKCOLOUR_FFFF       MKCOLOUR_XXXX(PixelColour{0xFF})
 
#include "table/heightmap_colours.h"

struct SmallMapColourScheme {
  std::vector<uint32_t> height_colours; 
  std::span<const uint32_t> height_colours_base; 
  uint32_t default_colour;             
};

static SmallMapColourScheme _heightmap_schemes[] = {
  {{}, _green_map_heights,      MKCOLOUR_XXXX(PixelColour{0x54})}, 
  {{}, _dark_green_map_heights, MKCOLOUR_XXXX(PixelColour{0x62})}, 
  {{}, _violet_map_heights,     MKCOLOUR_XXXX(PixelColour{0x81})}, 
};

void BuildLandLegend()
{
  /* The smallmap window has never been initialized, so no need to change the legend. */
  if (_heightmap_schemes[0].height_colours.empty()) return;
 
  /*
   * The general idea of this function is to fill the legend with an appropriate evenly spaced
   * selection of height levels. All entries with STR_TINY_BLACK_HEIGHT are reserved for this.
   * At the moment there are twelve of these.
   *
   * The table below defines up to which height level a particular delta in the legend should be
   * used. One could opt for just dividing the maximum height and use that as delta, but that
   * creates many "ugly" legend labels, e.g. once every 950 meter. As a result, this table will
   * reduce the number of deltas to 7: every 100m, 200m, 300m, 500m, 750m, 1000m and 1250m. The
   * deltas are closer together at the lower numbers because going from 12 entries to just 4, as
   * would happen when replacing 200m and 300m by 250m, would mean the legend would be short and
   * that might not be considered appropriate.
   *
   * The current method yields at least 7 legend entries and at most 12. It can be increased to
   * 8 by adding a 150m and 400m option, but especially 150m creates ugly heights.
   *
   * It tries to evenly space the legend items over the two columns that are there for the legend.
   */
 
  /* Table for delta; if max_height is less than the first column, use the second column as value. */
  uint deltas[][2] = { { 24, 2 }, { 48, 4 }, { 72, 6 }, { 120, 10 }, { 180, 15 }, { 240, 20 }, { MAX_TILE_HEIGHT + 1, 25 }};
  uint i = 0;
  for (; _settings_game.construction.map_height_limit >= deltas[i][0]; i++) {
    /* Nothing to do here. */
  }
  uint delta = deltas[i][1];
 
  int total_entries = (_settings_game.construction.map_height_limit / delta) + 1;
  int rows = CeilDiv(total_entries, 2);
  int j = 0;
 
  for (i = 0; i < lengthof(_legend_land_contours) - 1 && j < total_entries; i++) {
    if (_legend_land_contours[i].legend != STR_TINY_BLACK_HEIGHT) continue;
 
    _legend_land_contours[i].col_break = j % rows == 0;
    _legend_land_contours[i].end = false;
    _legend_land_contours[i].height = j * delta;
    _legend_land_contours[i].colour = PixelColour{static_cast<uint8_t>(_heightmap_schemes[_settings_client.gui.smallmap_land_colour].height_colours[_legend_land_contours[i].height])};
    j++;
  }
  _legend_land_contours[i].end = true;
}

void BuildOwnerLegend()
{
  _legend_land_owners[1].colour = PixelColour{static_cast<uint8_t>(_heightmap_schemes[_settings_client.gui.smallmap_land_colour].default_colour)};
 
  int i = NUM_NO_COMPANY_ENTRIES;
  for (const Company *c : Company::Iterate()) {
    _legend_land_owners[i].colour = GetColourGradient(c->colour, Shade::Light);
    _legend_land_owners[i].company = c->index;
    _legend_land_owners[i].show_on_map = true;
    _legend_land_owners[i].col_break = false;
    _legend_land_owners[i].end = false;
    _company_to_list_pos[c->index] = i;
    i++;
  }
 
  /* Terminate the list */
  _legend_land_owners[i].end = true;
 
  /* Store maximum amount of owner legend entries. */
  _smallmap_company_count = i;
}
 
struct AndOr {
  uint32_t mor;
  uint32_t mand;
};

static inline uint32_t ApplyMask(uint32_t colour, const AndOr &mask)
{
  return (colour & mask.mand) | mask.mor;
}
 

static const EnumIndexArray<AndOr, TileType, TileType::MaxSize> _smallmap_contours_andor = {
  AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Clear
  AndOr(MKCOLOUR_0XX0(PC_GREY), MKCOLOUR_F00F), // TileType::Railway
  AndOr(MKCOLOUR_0XX0(PC_BLACK), MKCOLOUR_F00F), // TileType::Road
  AndOr(MKCOLOUR_0XX0(PC_DARK_RED), MKCOLOUR_F00F), // TileType::House
  AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Trees
  AndOr(MKCOLOUR_XXXX(PC_LIGHT_BLUE), MKCOLOUR_0000), // TileType::Station
  AndOr(MKCOLOUR_XXXX(PC_WATER), MKCOLOUR_0000), // TileType::Water
  AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Void
  AndOr(MKCOLOUR_XXXX(PC_DARK_RED), MKCOLOUR_0000), // TileType::Industry
  AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::TunnelBridge
  AndOr(MKCOLOUR_0XX0(PC_DARK_RED), MKCOLOUR_F00F), // TileType::Object
};

static const EnumIndexArray<AndOr, TileType, TileType::MaxSize> _smallmap_vehicles_andor = {
  AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Clear
  AndOr(MKCOLOUR_0XX0(PC_BLACK), MKCOLOUR_F00F), // TileType::Railway
  AndOr(MKCOLOUR_0XX0(PC_BLACK), MKCOLOUR_F00F), // TileType::Road
  AndOr(MKCOLOUR_0XX0(PC_DARK_RED), MKCOLOUR_F00F), // TileType::House
  AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Trees
  AndOr(MKCOLOUR_0XX0(PC_BLACK), MKCOLOUR_F00F), // TileType::Station
  AndOr(MKCOLOUR_XXXX(PC_WATER), MKCOLOUR_0000), // TileType::Water
  AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::Void
  AndOr(MKCOLOUR_XXXX(PC_DARK_RED), MKCOLOUR_0000), // TileType::Industry
  AndOr(MKCOLOUR_0000, MKCOLOUR_FFFF), // TileType::TunnelBridge
  AndOr(MKCOLOUR_0XX0(PC_DARK_RED), MKCOLOUR_F00F), // TileType::Object
};

static const EnumIndexArray<uint8_t, TileType, TileType::MaxSize> _tiletype_importance = {
  2, // TileType::Clear
  8, // TileType::Railway
  7, // TileType::Road
  5, // TileType::House
  2, // TileType::Trees
  9, // TileType::Station
  2, // TileType::Water
  1, // TileType::Void
  6, // TileType::Industry
  8, // TileType::TunnelBridge
  2, // TileType::Object
};

static bool IsDryCoast(TileIndex tile)
{
  return IsCoastTile(tile) && !IsSlopeWithOneCornerRaised(GetTileSlope(tile));
}

static const AndOr &GetMaskPixelsForTileType(TileIndex tile, TileType t, const EnumIndexArray<AndOr, TileType, TileType::MaxSize> &table)
{
  if (IsDryCoast(tile)) return table[TileType::Clear];
  return table[t];
}

static inline uint32_t GetSmallMapContoursPixels(TileIndex tile, TileType t)
{
  const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
  return ApplyMask(cs->height_colours[TileHeight(tile)], GetMaskPixelsForTileType(tile, t, _smallmap_contours_andor));
}

static inline uint32_t GetSmallMapVehiclesPixels(TileIndex tile, TileType t)
{
  const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
  return ApplyMask(cs->default_colour, GetMaskPixelsForTileType(tile, t, _smallmap_vehicles_andor));
}

static inline uint32_t GetSmallMapIndustriesPixels(TileIndex tile, TileType t)
{
  const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
  return ApplyMask(_smallmap_show_heightmap ? cs->height_colours[TileHeight(tile)] : cs->default_colour, GetMaskPixelsForTileType(tile, t, _smallmap_vehicles_andor));
}

static inline uint32_t GetSmallMapRoutesPixels(TileIndex tile, TileType t)
{
  switch (t) {
    case TileType::Station:
      switch (GetStationType(tile)) {
        case StationType::Rail:    return MKCOLOUR_XXXX(PC_VERY_DARK_BROWN);
        case StationType::Airport: return MKCOLOUR_XXXX(PC_RED);
        case StationType::Truck:   return MKCOLOUR_XXXX(PC_ORANGE);
        case StationType::Bus:     return MKCOLOUR_XXXX(PC_YELLOW);
        case StationType::Dock:    return MKCOLOUR_XXXX(PC_LIGHT_BLUE);
        default:              return MKCOLOUR_FFFF;
      }
 
    case TileType::Railway: {
      AndOr andor = {
        MKCOLOUR_0XX0(GetRailTypeInfo(GetRailType(tile))->map_colour),
        _smallmap_contours_andor[t].mand
      };
 
      const SmallMapColourScheme &cs = _heightmap_schemes[_settings_client.gui.smallmap_land_colour];
      return ApplyMask(cs.default_colour, andor);
    }
 
    case TileType::Road: {
      const RoadTypeInfo *rti = nullptr;
      if (GetRoadTypeRoad(tile) != INVALID_ROADTYPE) {
        rti = GetRoadTypeInfo(GetRoadTypeRoad(tile));
      } else {
        rti = GetRoadTypeInfo(GetRoadTypeTram(tile));
      }
      if (rti != nullptr) {
        AndOr andor = {
          MKCOLOUR_0XX0(rti->map_colour),
          _smallmap_contours_andor[t].mand
        };
 
        const SmallMapColourScheme &cs = _heightmap_schemes[_settings_client.gui.smallmap_land_colour];
        return ApplyMask(cs.default_colour, andor);
      }
      [[fallthrough]];
    }
 
    default:
      /* Ground colour */
      const SmallMapColourScheme &cs = _heightmap_schemes[_settings_client.gui.smallmap_land_colour];
      return ApplyMask(cs.default_colour, GetMaskPixelsForTileType(tile, t, _smallmap_contours_andor));
  }
}

static inline uint32_t GetSmallMapLinkStatsPixels(TileIndex tile, TileType t)
{
  return _smallmap_show_heightmap ? GetSmallMapContoursPixels(tile, t) : GetSmallMapRoutesPixels(tile, t);
}

static constexpr EnumIndexArray<uint32_t, ClearGround, ClearGround::MaxSize> _vegetation_clear_bits = {
  MKCOLOUR_XXXX(PC_GRASS_LAND), 
  MKCOLOUR_XXXX(PC_ROUGH_LAND), 
  MKCOLOUR_XXXX(PC_GREY),       
  MKCOLOUR_XXXX(PC_FIELDS),     
  MKCOLOUR_XXXX(PC_GRASS_LAND), 
  MKCOLOUR_XXXX(PC_ORANGE),     
  MKCOLOUR_XXXX(PC_GRASS_LAND), 
  MKCOLOUR_XXXX(PC_GRASS_LAND), 
};

static inline uint32_t GetSmallMapVegetationPixels(TileIndex tile, TileType t)
{
  switch (t) {
    case TileType::Clear:
      if (IsSnowTile(tile)) return MKCOLOUR_XXXX(PC_LIGHT_BLUE);
      if (IsClearGround(tile, ClearGround::Grass)) {
        if (GetClearDensity(tile) < 3) return MKCOLOUR_XXXX(PC_BARE_LAND);
        if (GetTropicZone(tile) == TropicZone::Rainforest) return MKCOLOUR_XXXX(PC_RAINFOREST);
      }
      return _vegetation_clear_bits[GetClearGround(tile)];
 
    case TileType::Water:
      if (IsDryCoast(tile)) return (GetTropicZone(tile) == TropicZone::Rainforest) ? MKCOLOUR_XXXX(PC_RAINFOREST) : MKCOLOUR_XXXX(PC_GRASS_LAND);
      return ApplyMask(MKCOLOUR_XXXX(PC_GRASS_LAND), _smallmap_vehicles_andor[t]);
 
    case TileType::Industry:
      return IsTileForestIndustry(tile) ? MKCOLOUR_XXXX(PC_GREEN) : MKCOLOUR_XXXX(PC_DARK_RED);
 
    case TileType::Trees:
      if (GetTreeGround(tile) == TreeGround::SnowOrDesert || GetTreeGround(tile) == TreeGround::RoughSnow) {
        return (_settings_game.game_creation.landscape == LandscapeType::Arctic) ? MKCOLOUR_XYYX(PC_LIGHT_BLUE, PC_TREES) : MKCOLOUR_XYYX(PC_ORANGE, PC_TREES);
      }
      return (GetTropicZone(tile) == TropicZone::Rainforest) ? MKCOLOUR_XYYX(PC_RAINFOREST, PC_TREES) : MKCOLOUR_XYYX(PC_GRASS_LAND, PC_TREES);
 
    default:
      return ApplyMask(MKCOLOUR_XXXX(PC_GRASS_LAND), GetMaskPixelsForTileType(tile, t, _smallmap_vehicles_andor));
  }
}

uint32_t GetSmallMapOwnerPixels(TileIndex tile, TileType t, IncludeHeightmap include_heightmap)
{
  Owner o;
 
  switch (t) {
    case TileType::Void:     return MKCOLOUR_XXXX(PC_BLACK);
    case TileType::Industry: return MKCOLOUR_XXXX(PC_DARK_GREY);
    case TileType::House:    return MKCOLOUR_XXXX(PC_DARK_RED);
    case TileType::Road:
      o = GetRoadOwner(tile, HasRoadTypeRoad(tile) ? RoadTramType::Road : RoadTramType::Tram);
      break;
 
    default:
      o = GetTileOwner(tile);
      break;
  }
 
  if ((o < MAX_COMPANIES && !_legend_land_owners[_company_to_list_pos[o]].show_on_map) || o == OWNER_NONE || o == OWNER_WATER) {
    if (t == TileType::Water && !IsDryCoast(tile)) return MKCOLOUR_XXXX(PC_WATER);
    const SmallMapColourScheme *cs = &_heightmap_schemes[_settings_client.gui.smallmap_land_colour];
    return ((include_heightmap == IncludeHeightmap::IfEnabled && _smallmap_show_heightmap) || include_heightmap == IncludeHeightmap::Always)
      ? cs->height_colours[TileHeight(tile)] : cs->default_colour;
  } else if (o == OWNER_TOWN) {
    return MKCOLOUR_XXXX(PC_DARK_RED);
  }
 
  return MKCOLOUR_XXXX(_legend_land_owners[_company_to_list_pos[o]].colour);
}

static constexpr VehicleTypeIndexArray<PixelColour, VehicleType::End> _vehicle_type_colours = {
  PC_RED, PC_YELLOW, PC_LIGHT_BLUE, PC_WHITE, PC_BLACK, PC_RED
};

class SmallMapWindow : public Window {
protected:
  enum class ZoomLevelChange : uint8_t {
    Init, 
    ZoomOut, 
    ZoomIn, 
  };
 
  static SmallMapType map_type; 
  static bool show_towns;       
  static bool show_ind_names;   
  static int map_height_limit;  
 
  static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS = 2; 
 
  uint min_number_of_columns = 0; 
  uint min_number_of_fixed_rows = 0; 
  uint column_width = 0; 
  uint legend_width = 0; 
 
  int32_t scroll_x = 0; 
  int32_t scroll_y = 0; 
  int32_t subscroll = 0; 
  int zoom = 0; 
 
  std::unique_ptr<LinkGraphOverlay> overlay{};

  static void BreakIndustryChainLink()
  {
    InvalidateWindowClassesData(WindowClass::IndustryCargoes, NUM_INDUSTRYTYPES);
  }
 
  static inline Point SmallmapRemapCoords(int x, int y)
  {
    Point pt;
    pt.x = (y - x) * 2;
    pt.y = y + x;
    return pt;
  }

  static inline void DrawVertMapIndicator(int x, int y, int y2)
  {
    GfxFillRect(x, y,      x, y + 3, PC_VERY_LIGHT_YELLOW);
    GfxFillRect(x, y2 - 3, x, y2,    PC_VERY_LIGHT_YELLOW);
  }

  static inline void DrawHorizMapIndicator(int x, int x2, int y)
  {
    GfxFillRect(x,      y, x + 3, y, PC_VERY_LIGHT_YELLOW);
    GfxFillRect(x2 - 3, y, x2,    y, PC_VERY_LIGHT_YELLOW);
  }

  inline uint GetMinLegendWidth() const
  {
    return WidgetDimensions::scaled.framerect.left + this->min_number_of_columns * this->column_width;
  }

  inline uint GetNumberColumnsLegend(uint width) const
  {
    return width / this->column_width;
  }

  inline uint GetLegendHeight(uint num_columns) const
  {
    return WidgetDimensions::scaled.framerect.Vertical() +
        this->GetNumberRowsLegend(num_columns) * GetCharacterHeight(FontSize::Small);
  }

  inline CompanyMask GetOverlayCompanyMask() const
  {
    return Company::IsValidID(_local_company) ? CompanyMask{}.Set(_local_company) : CompanyMask{}.Set();
  }

  const IntervalTimer<TimerWindow> blink_interval = {TIMER_BLINK_INTERVAL, [this](auto) {
    Blink();
  }};

  const IntervalTimer<TimerWindow> refresh_interval = {std::chrono::milliseconds(930), [this](auto) {
    ForceRefresh();
  }};

  void RebuildColourIndexIfNecessary()
  {
    /* Rebuild colour indices if necessary. */
    if (SmallMapWindow::map_height_limit == _settings_game.construction.map_height_limit) return;
 
    for (auto &heightmap_scheme : _heightmap_schemes) {
      /* The heights go from 0 up to and including maximum. */
      size_t heights = _settings_game.construction.map_height_limit + 1;
      heightmap_scheme.height_colours.resize(heights);
 
      for (size_t z = 0; z < heights; z++) {
        size_t access_index = (heightmap_scheme.height_colours_base.size() * z) / heights;
 
        /* Choose colour by mapping the range (0..max heightlevel) on the complete colour table. */
        heightmap_scheme.height_colours[z] = heightmap_scheme.height_colours_base[access_index];
      }
    }
 
    SmallMapWindow::map_height_limit = _settings_game.construction.map_height_limit;
    BuildLandLegend();
  }

  uint GetNumberRowsLegend(uint columns) const
  {
    /* Reserve one column for link colours */
    uint num_rows_linkstats = CeilDiv(_smallmap_cargo_count, columns - 1);
    uint num_rows_others = CeilDiv(std::max(_smallmap_industry_count, _smallmap_company_count), columns);
    return std::max({this->min_number_of_fixed_rows, num_rows_linkstats, num_rows_others});
  }

  void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item = 0)
  {
    if (_ctrl_pressed) {
      /* Disable all, except the clicked one */
      bool changes = false;
      for (int i = begin_legend_item; i != end_legend_item; i++) {
        bool new_state = (i == click_pos);
        if (legend[i].show_on_map != new_state) {
          changes = true;
          legend[i].show_on_map = new_state;
        }
      }
      if (!changes) {
        /* Nothing changed? Then show all (again). */
        for (int i = begin_legend_item; i != end_legend_item; i++) {
          legend[i].show_on_map = true;
        }
      }
    } else {
      legend[click_pos].show_on_map = !legend[click_pos].show_on_map;
    }
 
    if (this->map_type == SmallMapType::Industries) this->BreakIndustryChainLink();
  }

  void SwitchMapType(SmallMapType map_type)
  {
    this->RaiseWidget(WID_SM_CONTOUR + to_underlying(this->map_type));
    this->map_type = map_type;
    this->LowerWidget(WID_SM_CONTOUR + to_underlying(this->map_type));
 
    this->SetupWidgetData();
 
    if (map_type == SmallMapType::LinkStats) this->overlay->SetDirty();
    if (map_type != SmallMapType::Industries) this->BreakIndustryChainLink();
    this->ReInit();
  }

  void SetNewScroll(int sx, int sy, int sub)
  {
    const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_MAP);
    Point hv = InverseRemapCoords(wi->current_x * ZOOM_BASE * TILE_SIZE / 2, wi->current_y * ZOOM_BASE * TILE_SIZE / 2);
    hv.x *= this->zoom;
    hv.y *= this->zoom;
 
    if (sx < -hv.x) {
      sx = -hv.x;
      sub = 0;
    }
    if (sx > (int)(Map::MaxX() * TILE_SIZE) - hv.x) {
      sx = Map::MaxX() * TILE_SIZE - hv.x;
      sub = 0;
    }
    if (sy < -hv.y) {
      sy = -hv.y;
      sub = 0;
    }
    if (sy > (int)(Map::MaxY() * TILE_SIZE) - hv.y) {
      sy = Map::MaxY() * TILE_SIZE - hv.y;
      sub = 0;
    }
 
    this->scroll_x = sx;
    this->scroll_y = sy;
    this->subscroll = sub;
    if (this->map_type == SmallMapType::LinkStats) this->overlay->SetDirty();
  }

  void DrawMapIndicators() const
  {
    /* Find main viewport. */
    const Viewport &vp = *GetMainWindow()->viewport;
 
    Point upper_left_smallmap_coord  = InverseRemapCoords2(vp.virtual_left, vp.virtual_top);
    Point lower_right_smallmap_coord = InverseRemapCoords2(vp.virtual_left + vp.virtual_width - 1, vp.virtual_top + vp.virtual_height - 1);
 
    Point upper_left = this->RemapTile(upper_left_smallmap_coord.x / (int)TILE_SIZE, upper_left_smallmap_coord.y / (int)TILE_SIZE);
    upper_left.x -= this->subscroll;
 
    Point lower_right = this->RemapTile(lower_right_smallmap_coord.x / (int)TILE_SIZE, lower_right_smallmap_coord.y / (int)TILE_SIZE);
    lower_right.x -= this->subscroll;
 
    SmallMapWindow::DrawVertMapIndicator(upper_left.x, upper_left.y, lower_right.y);
    SmallMapWindow::DrawVertMapIndicator(lower_right.x, upper_left.y, lower_right.y);
 
    SmallMapWindow::DrawHorizMapIndicator(upper_left.x, lower_right.x, upper_left.y);
    SmallMapWindow::DrawHorizMapIndicator(upper_left.x, lower_right.x, lower_right.y);
  }

  void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const
  {
    void *dst_ptr_abs_end = blitter->MoveTo(_screen.dst_ptr, 0, _screen.height);
    uint min_xy = _settings_game.construction.freeform_edges ? 1 : 0;
 
    do {
      /* Check if the tile (xc,yc) is within the map range */
      if (xc >= Map::MaxX() || yc >= Map::MaxY()) continue;
 
      /* Check if the dst pointer points to a pixel inside the screen buffer */
      if (dst < _screen.dst_ptr) continue;
      if (dst >= dst_ptr_abs_end) continue;
 
      /* Construct tilearea covered by (xc, yc, xc + this->zoom, yc + this->zoom) such that it is within min_xy limits. */
      TileArea ta;
      if (min_xy == 1 && (xc == 0 || yc == 0)) {
        if (this->zoom == 1) continue; // The tile area is empty, don't draw anything.
 
        ta = TileArea(TileXY(std::max(min_xy, xc), std::max(min_xy, yc)), this->zoom - (xc == 0), this->zoom - (yc == 0));
      } else {
        ta = TileArea(TileXY(xc, yc), this->zoom, this->zoom);
      }
      ta.ClampToMap(); // Clamp to map boundaries (may contain TileType::Void tiles!).
 
      uint32_t val = this->GetTileColours(ta);
      uint8_t *val8 = (uint8_t *)&val;
      int idx = std::max(0, -start_pos);
      for (int pos = std::max(0, start_pos); pos < end_pos; pos++) {
        blitter->SetPixel(dst, idx, 0, PixelColour{val8[idx]});
        idx++;
      }
    /* Switch to next tile in the column */
    } while (xc += this->zoom, yc += this->zoom, dst = blitter->MoveTo(dst, pitch, 0), --reps != 0);
  }

  void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
  {
    for (const Vehicle *v : Vehicle::Iterate()) {
      if (v->type == VehicleType::Effect) continue;
      if (v->vehstatus.Any({VehState::Hidden, VehState::Unclickable})) continue;
 
      /* Remap into flat coordinates. */
      Point pt = this->RemapTile(v->x_pos / (int)TILE_SIZE, v->y_pos / (int)TILE_SIZE);
 
      int y = pt.y - dpi->top;
      if (!IsInsideMM(y, 0, dpi->height)) continue; // y is out of bounds.
 
      bool skip = false; // Default is to draw both pixels.
      int x = pt.x - this->subscroll - 3 - dpi->left; // Offset X coordinate.
      if (x < 0) {
        /* if x+1 is 0, that means we're on the very left edge,
         * and should thus only draw a single pixel */
        if (++x != 0) continue;
        skip = true;
      } else if (x >= dpi->width - 1) {
        /* Check if we're at the very right edge, and if so draw only a single pixel */
        if (x != dpi->width - 1) continue;
        skip = true;
      }
 
      /* Calculate pointer to pixel and the colour */
      PixelColour colour = (this->map_type == SmallMapType::Vehicles) ? _vehicle_type_colours[v->type] : PC_WHITE;
 
      /* And draw either one or two pixels depending on clipping */
      blitter->SetPixel(dpi->dst_ptr, x, y, colour);
      if (!skip) blitter->SetPixel(dpi->dst_ptr, x + 1, y, colour);
    }
  }

  void DrawTowns(const DrawPixelInfo *dpi, const int vertical_padding) const
  {
    for (const Town *t : Town::Iterate()) {
      /* Remap the town coordinate */
      Point pt = this->RemapTile(TileX(t->xy), TileY(t->xy));
      int x = pt.x - this->subscroll - (t->cache.sign.width_small >> 1);
      int y = pt.y + vertical_padding;
 
      /* Check if the town sign is within bounds */
      if (x + t->cache.sign.width_small > dpi->left &&
          x < dpi->left + dpi->width &&
          y + GetCharacterHeight(FontSize::Small) > dpi->top &&
          y < dpi->top + dpi->height) {
        /* And draw it. */
        DrawString(x, x + t->cache.sign.width_small, y, GetString(STR_SMALLMAP_TOWN, t->index));
      }
    }
  }

  void DrawIndustryNames(const DrawPixelInfo *dpi, const int vertical_padding) const
  {
    if (this->map_type != SmallMapType::Industries) return;
 
    for (const Industry *i : Industry::Iterate()) {
      const LegendAndColour &tbl = _legend_from_industries[_industry_to_list_pos[i->type]];
      if (!tbl.show_on_map) continue;
 
      /* Industry names blink together with their blobs in the smallmap. */
      const bool is_blinking = i->type == _smallmap_industry_highlight && !_smallmap_industry_highlight_state;
      if (is_blinking) continue;
 
      if (_industry_to_name_string_width[i->type] == 0) {
        _industry_to_name_string_width[i->type] = GetStringBoundingBox(tbl.legend, FontSize::Small).width;
      }
      const uint16_t &legend_text_width = _industry_to_name_string_width[i->type];
 
      /* Remap the industry coordinate */
      const TileIndex &tile = i->location.GetCenterTile();
      const Point pt = this->RemapTile(TileX(tile), TileY(tile));
      const int x = pt.x - this->subscroll - (legend_text_width / 2);
      const int y = pt.y + vertical_padding;
 
      /* Check if the industry name is within bounds */
      if (x + legend_text_width > dpi->left &&
          x < dpi->left + dpi->width &&
          y + GetCharacterHeight(FontSize::Small) > dpi->top &&
          y < dpi->top + dpi->height) {
 
        /* And draw it. */
        DrawString(x, x + legend_text_width, y, tbl.legend, TextColour::White, AlignmentH::Start, false, FontSize::Small);
      }
    }
  }

  void DrawSmallMap(DrawPixelInfo *dpi) const
  {
    Blitter *blitter = BlitterFactory::GetCurrentBlitter();
    AutoRestoreBackup dpi_backup(_cur_dpi, dpi);
 
    /* If freeform edges are off, draw infinite water off the edges of the map. */
    const PixelColour map_clear_color = (_settings_game.construction.freeform_edges ? PC_BLACK : PC_WATER);
    GfxFillRect(dpi->left, dpi->top, dpi->left + dpi->width - 1, dpi->top + dpi->height - 1, map_clear_color);
 
    /* Which tile is displayed at (dpi->left, dpi->top)? */
    int dx;
    Point tile = this->PixelToTile(dpi->left, dpi->top, &dx);
    int tile_x = this->scroll_x / (int)TILE_SIZE + tile.x;
    int tile_y = this->scroll_y / (int)TILE_SIZE + tile.y;
 
    void *ptr = blitter->MoveTo(dpi->dst_ptr, -dx - 4, 0);
    int x = - dx - 4;
    int y = 0;
 
    for (;;) {
      /* Distance from left edge */
      if (x >= -3) {
        if (x >= dpi->width) break; // Exit the loop.
 
        int end_pos = std::min(dpi->width, x + 4);
        int reps = (dpi->height - y + 1) / 2; // Number of lines.
        if (reps > 0) {
          this->DrawSmallMapColumn(ptr, tile_x, tile_y, dpi->pitch * 2, reps, x, end_pos, blitter);
        }
      }
 
      if (y == 0) {
        tile_y += this->zoom;
        y++;
        ptr = blitter->MoveTo(ptr, 0, 1);
      } else {
        tile_x -= this->zoom;
        y--;
        ptr = blitter->MoveTo(ptr, 0, -1);
      }
      ptr = blitter->MoveTo(ptr, 2, 0);
      x += 2;
    }
 
    /* Draw vehicles */
    if (this->map_type == SmallMapType::Contour || this->map_type == SmallMapType::Vehicles) this->DrawVehicles(dpi, blitter);
 
    /* Draw link stat overlay */
    if (this->map_type == SmallMapType::LinkStats) this->overlay->Draw(dpi);
 
    const int map_labels_vertical_padding = ScaleGUITrad(2);
 
    /* Draw town names */
    if (this->show_towns) this->DrawTowns(dpi, map_labels_vertical_padding);
 
    /* Draw industry names */
    if (this->show_ind_names) this->DrawIndustryNames(dpi, map_labels_vertical_padding);
 
    /* Draw map indicators */
    this->DrawMapIndicators();
  }

  Point RemapTile(int tile_x, int tile_y) const
  {
    int x_offset = tile_x - this->scroll_x / (int)TILE_SIZE;
    int y_offset = tile_y - this->scroll_y / (int)TILE_SIZE;
 
    if (this->zoom == 1) return SmallmapRemapCoords(x_offset, y_offset);
 
    /* For negative offsets, round towards -inf. */
    if (x_offset < 0) x_offset -= this->zoom - 1;
    if (y_offset < 0) y_offset -= this->zoom - 1;
 
    return SmallmapRemapCoords(x_offset / this->zoom, y_offset / this->zoom);
  }

  Point PixelToTile(int px, int py, int *sub, bool add_sub = true) const
  {
    if (add_sub) px += this->subscroll;  // Total horizontal offset.
 
    /* For each two rows down, add a x and a y tile, and
     * For each four pixels to the right, move a tile to the right. */
    Point pt = {((py >> 1) - (px >> 2)) * this->zoom, ((py >> 1) + (px >> 2)) * this->zoom};
    px &= 3;
 
    if (py & 1) { // Odd number of rows, handle the 2 pixel shift.
      if (px < 2) {
        pt.x += this->zoom;
        px += 2;
      } else {
        pt.y += this->zoom;
        px -= 2;
      }
    }
 
    *sub = px;
    return pt;
  }

  Point ComputeScroll(int tx, int ty, int x, int y, int *sub) const
  {
    assert(x >= 0 && y >= 0);
 
    int new_sub;
    Point tile_xy = PixelToTile(x, y, &new_sub, false);
    tx -= tile_xy.x;
    ty -= tile_xy.y;
 
    Point scroll;
    if (new_sub == 0) {
      *sub = 0;
      scroll.x = (tx + this->zoom) * TILE_SIZE;
      scroll.y = (ty - this->zoom) * TILE_SIZE;
    } else {
      *sub = 4 - new_sub;
      scroll.x = (tx + 2 * this->zoom) * TILE_SIZE;
      scroll.y = (ty - 2 * this->zoom) * TILE_SIZE;
    }
    return scroll;
  }

  void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt)
  {
    static const int zoomlevels[] = {1, 2, 4, 6, 8}; // Available zoom levels. Bigger number means more zoom-out (further away).
    static const int MIN_ZOOM_INDEX = 0;
    static const int MAX_ZOOM_INDEX = lengthof(zoomlevels) - 1;
 
    int new_index, cur_index, sub;
    Point tile;
    switch (change) {
      case ZoomLevelChange::Init:
        cur_index = - 1; // Definitely different from new_index.
        new_index = MIN_ZOOM_INDEX;
        tile.x = tile.y = 0;
        break;
 
      case ZoomLevelChange::ZoomIn:
      case ZoomLevelChange::ZoomOut:
        for (cur_index = MIN_ZOOM_INDEX; cur_index <= MAX_ZOOM_INDEX; cur_index++) {
          if (this->zoom == zoomlevels[cur_index]) break;
        }
        assert(cur_index <= MAX_ZOOM_INDEX);
 
        tile = this->PixelToTile(zoom_pt->x, zoom_pt->y, &sub);
        new_index = Clamp(cur_index + ((change == ZoomLevelChange::ZoomIn) ? -1 : 1), MIN_ZOOM_INDEX, MAX_ZOOM_INDEX);
        break;
 
      default: NOT_REACHED();
    }
 
    if (new_index != cur_index) {
      this->zoom = zoomlevels[new_index];
      if (cur_index >= 0) {
        Point new_tile = this->PixelToTile(zoom_pt->x, zoom_pt->y, &sub);
        this->SetNewScroll(this->scroll_x + (tile.x - new_tile.x) * TILE_SIZE,
            this->scroll_y + (tile.y - new_tile.y) * TILE_SIZE, sub);
      } else if (this->map_type == SmallMapType::LinkStats) {
        this->overlay->SetDirty();
      }
      this->SetWidgetDisabledState(WID_SM_ZOOM_IN,  this->zoom == zoomlevels[MIN_ZOOM_INDEX]);
      this->SetWidgetDisabledState(WID_SM_ZOOM_OUT, this->zoom == zoomlevels[MAX_ZOOM_INDEX]);
      this->SetDirty();
    }
  }

  void SetOverlayCargoMask()
  {
    CargoTypes cargo_mask{};
    for (int i = 0; i != _smallmap_cargo_count; ++i) {
      if (_legend_linkstats[i].show_on_map) cargo_mask.Set(static_cast<CargoType>(_legend_linkstats[i].type));
    }
    this->overlay->SetCargoMask(cargo_mask);
  }

  void SetupWidgetData()
  {
    StringID legend_tooltip;
    StringID enable_all_tooltip;
    StringID disable_all_tooltip;
    int industry_names_select_plane;
    int select_buttons_plane;
    switch (this->map_type) {
      case SmallMapType::Industries:
        legend_tooltip = STR_SMALLMAP_TOOLTIP_INDUSTRY_SELECTION;
        enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_INDUSTRIES;
        disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_INDUSTRIES;
        industry_names_select_plane = 0;
        select_buttons_plane = 0;
        break;
 
      case SmallMapType::Owners:
        legend_tooltip = STR_SMALLMAP_TOOLTIP_COMPANY_SELECTION;
        enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_COMPANIES;
        disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_COMPANIES;
        industry_names_select_plane = SZSP_NONE;
        select_buttons_plane = 0;
        break;
 
      case SmallMapType::LinkStats:
        legend_tooltip = STR_SMALLMAP_TOOLTIP_CARGO_SELECTION;
        enable_all_tooltip = STR_SMALLMAP_TOOLTIP_ENABLE_ALL_CARGOS;
        disable_all_tooltip = STR_SMALLMAP_TOOLTIP_DISABLE_ALL_CARGOS;
        industry_names_select_plane = SZSP_NONE;
        select_buttons_plane = 0;
        break;
 
      default:
        legend_tooltip = STR_NULL;
        enable_all_tooltip = STR_NULL;
        disable_all_tooltip = STR_NULL;
        industry_names_select_plane = SZSP_NONE;
        select_buttons_plane = 1;
        break;
    }
 
    this->GetWidget<NWidgetCore>(WID_SM_LEGEND)->SetToolTip(legend_tooltip);
    this->GetWidget<NWidgetCore>(WID_SM_ENABLE_ALL)->SetStringTip(STR_SMALLMAP_ENABLE_ALL, enable_all_tooltip);
    this->GetWidget<NWidgetCore>(WID_SM_DISABLE_ALL)->SetStringTip(STR_SMALLMAP_DISABLE_ALL, disable_all_tooltip);
    this->GetWidget<NWidgetStacked>(WID_SM_SHOW_IND_NAMES_SEL)->SetDisplayedPlane(industry_names_select_plane);
    this->GetWidget<NWidgetStacked>(WID_SM_SELECT_BUTTONS)->SetDisplayedPlane(select_buttons_plane);
  }

  uint32_t GetTileColours(const TileArea &ta) const
  {
    int importance = 0;
    TileIndex tile = INVALID_TILE; // Position of the most important tile.
    TileType et = TileType::Void;         // Effective tile type at that position.
 
    for (TileIndex ti : ta) {
      TileType ttype = GetTileType(ti);
 
      switch (ttype) {
        case TileType::TunnelBridge: {
          TransportType tt = GetTunnelBridgeTransportType(ti);
 
          switch (tt) {
            case TransportType::Rail: ttype = TileType::Railway; break;
            case TransportType::Road: ttype = TileType::Road; break;
            default: ttype = TileType::Water; break;
          }
          break;
        }
 
        case TileType::Industry:
          /* Special handling of industries while in "Industries" smallmap view. */
          if (this->map_type == SmallMapType::Industries) {
            /* If industry is allowed to be seen, use its colour on the map.
             * This has the highest priority above any value in _tiletype_importance. */
            IndustryType type = Industry::GetByTile(ti)->type;
            if (_legend_from_industries[_industry_to_list_pos[type]].show_on_map) {
              if (type == _smallmap_industry_highlight) {
                if (_smallmap_industry_highlight_state) return MKCOLOUR_XXXX(PC_WHITE);
              } else {
                return GetIndustrySpec(type)->map_colour.p * 0x01010101;
              }
            }
            /* Otherwise make it disappear */
            ttype = IsTileOnWater(ti) ? TileType::Water : TileType::Clear;
          }
          break;
 
        default:
          break;
      }
 
      if (_tiletype_importance[ttype] > importance) {
        importance = _tiletype_importance[ttype];
        tile = ti;
        et = ttype;
      }
    }
 
    switch (this->map_type) {
      case SmallMapType::Contour:
        return GetSmallMapContoursPixels(tile, et);
 
      case SmallMapType::Vehicles:
        return GetSmallMapVehiclesPixels(tile, et);
 
      case SmallMapType::Industries:
        return GetSmallMapIndustriesPixels(tile, et);
 
      case SmallMapType::LinkStats:
        return GetSmallMapLinkStatsPixels(tile, et);
 
      case SmallMapType::Routes:
        return GetSmallMapRoutesPixels(tile, et);
 
      case SmallMapType::Vegetation:
        return GetSmallMapVegetationPixels(tile, et);
 
      case SmallMapType::Owners:
        return GetSmallMapOwnerPixels(tile, et, IncludeHeightmap::IfEnabled);
 
      default: NOT_REACHED();
    }
  }

  int GetPositionOnLegend(Point pt)
  {
    const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_LEGEND);
    uint line = (pt.y - wi->pos_y - WidgetDimensions::scaled.framerect.top) / GetCharacterHeight(FontSize::Small);
    uint columns = this->GetNumberColumnsLegend(wi->current_x);
    uint number_of_rows = this->GetNumberRowsLegend(columns);
    if (line >= number_of_rows) return -1;
 
    bool rtl = _current_text_dir == TD_RTL;
    int x = pt.x - wi->pos_x;
    if (rtl) x = wi->current_x - x;
    uint column = (x - WidgetDimensions::scaled.framerect.left) / this->column_width;
 
    return (column * number_of_rows) + line;
  }

  void UpdateLinks()
  {
    if (this->map_type == SmallMapType::LinkStats) {
      CompanyMask company_mask = this->GetOverlayCompanyMask();
      if (this->overlay->GetCompanyMask() != company_mask) {
        this->overlay->SetCompanyMask(company_mask);
      } else {
        this->overlay->SetDirty();
      }
    }
  }

  void Blink()
  {
    if (_smallmap_industry_highlight == IT_INVALID) return;
 
    _smallmap_industry_highlight_state = !_smallmap_industry_highlight_state;
 
    this->UpdateLinks();
    this->SetDirty();
  }

  void ForceRefresh()
  {
    if (_smallmap_industry_highlight != IT_INVALID) return;
 
    this->UpdateLinks();
    this->SetDirty();
  }
 
public:
  friend class NWidgetSmallmapDisplay;
 
  SmallMapWindow(WindowDesc &desc, int window_number) : Window(desc)
  {
    _smallmap_industry_highlight = IT_INVALID;
    this->overlay = std::make_unique<LinkGraphOverlay>(this, WID_SM_MAP, CargoTypes{}, this->GetOverlayCompanyMask(), 1);
    this->CreateNestedTree();
    this->LowerWidget(WID_SM_CONTOUR + to_underlying(this->map_type));
 
    this->RebuildColourIndexIfNecessary();
 
    this->SetWidgetLoweredState(WID_SM_SHOW_HEIGHT, _smallmap_show_heightmap);
 
    this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME, this->show_towns);
    this->SetWidgetLoweredState(WID_SM_SHOW_IND_NAMES, this->show_ind_names);
 
    this->SetupWidgetData();
    this->FinishInitNested(window_number);
 
    this->SetZoomLevel(ZoomLevelChange::Init, nullptr);
    this->SmallMapCenterOnCurrentPos();
    this->SetOverlayCargoMask();
  }

  void SmallMapCenterOnCurrentPos()
  {
    const Viewport &vp = *GetMainWindow()->viewport;
    Point viewport_center = InverseRemapCoords2(vp.virtual_left + vp.virtual_width / 2, vp.virtual_top + vp.virtual_height / 2);
 
    int sub;
    const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
    Point sxy = this->ComputeScroll(viewport_center.x / (int)TILE_SIZE, viewport_center.y / (int)TILE_SIZE,
        std::max(0, (int)wid->current_x / 2 - 2), wid->current_y / 2, &sub);
    this->SetNewScroll(sxy.x, sxy.y, sub);
    this->SetDirty();
  }

  Point GetStationMiddle(const Station *st) const
  {
    int x = CentreBounds(st->rect.left, st->rect.right, 0);
    int y = CentreBounds(st->rect.top, st->rect.bottom, 0);
    Point ret = this->RemapTile(x, y);
 
    /* Same magic 3 as in DrawVehicles; that's where I got it from.
     * No idea what it is, but without it the result looks bad.
     */
    ret.x -= 3 + this->subscroll;
    return ret;
  }
 
  void Close([[maybe_unused]] int data) override
  {
    this->BreakIndustryChainLink();
    this->Window::Close();
  }
 
  std::string GetWidgetString(WidgetID widget, StringID stringid) const override
  {
    switch (widget) {
      case WID_SM_CAPTION:
        return GetString(STR_SMALLMAP_CAPTION, STR_SMALLMAP_TYPE_CONTOURS + to_underlying(this->map_type));
 
      default:
        return this->Window::GetWidgetString(widget, stringid);
    }
  }
 
  void OnInit() override
  {
    uint min_width = 0;
    this->min_number_of_columns = INDUSTRY_MIN_NUMBER_OF_COLUMNS;
    this->min_number_of_fixed_rows = lengthof(_linkstat_colours_in_legenda);
    for (SmallMapType i : EnumRange(SmallMapType::End)) {
      uint height = 0;
      uint num_columns = 1;
      for (const LegendAndColour &tbl : _legend_table[i]) {
        if (tbl.end) break;
        std::string str;
        if (i == SmallMapType::Industries) {
          str = GetString(STR_SMALLMAP_INDUSTRY, tbl.legend, IndustryPool::MAX_SIZE);
        } else if (i == SmallMapType::LinkStats) {
          str = GetString(STR_SMALLMAP_LINKSTATS, tbl.legend);
        } else if (i == SmallMapType::Owners) {
          if (tbl.company != CompanyID::Invalid()) {
            if (!Company::IsValidID(tbl.company)) {
              /* Rebuild the owner legend. */
              BuildOwnerLegend();
              this->OnInit();
              return;
            }
            /* Non-fixed legend entries for the owner view. */
            str = GetString(STR_SMALLMAP_COMPANY, tbl.company);
          } else {
            str = GetString(tbl.legend);
          }
        } else {
          if (tbl.col_break) {
            this->min_number_of_fixed_rows = std::max(this->min_number_of_fixed_rows, height);
            height = 0;
            num_columns++;
          }
          height++;
          if (i == SmallMapType::Contour) {
            str = GetString(tbl.legend, tbl.height * TILE_HEIGHT_STEP);
          } else {
            str = GetString(tbl.legend);
          }
        }
        min_width = std::max(GetStringBoundingBox(str).width, min_width);
      }
      this->min_number_of_fixed_rows = std::max(this->min_number_of_fixed_rows, height);
      this->min_number_of_columns = std::max(this->min_number_of_columns, num_columns);
    }
 
    /* Width of the legend blob. */
    this->legend_width = GetCharacterHeight(FontSize::Small) * 9 / 6;
 
    /* The width of a column is the minimum width of all texts + the size of the blob + some spacing */
    this->column_width = min_width + WidgetDimensions::scaled.hsep_normal + this->legend_width + WidgetDimensions::scaled.framerect.Horizontal();
 
    /* Cached string widths of industry names in the smallmap. Calculation is deferred to DrawIndustryNames(). */
    std::fill(std::begin(_industry_to_name_string_width), std::end(_industry_to_name_string_width), 0);
  }
 
  void OnPaint() override
  {
    if (this->map_type == SmallMapType::Owners) {
      for (const LegendAndColour &tbl : _legend_table[this->map_type]) {
        if (tbl.end) break;
        if (tbl.company != CompanyID::Invalid() && !Company::IsValidID(tbl.company)) {
          /* Rebuild the owner legend. */
          BuildOwnerLegend();
          this->InvalidateData(1);
          break;
        }
      }
    }
 
    this->DrawWidgets();
  }

  void DrawLegend(const Rect &text, const Rect &icon, bool highlight, std::string_view string) const
  {
    if (!highlight) {
      /* Simply draw the string, not the black border of the legend colour.
       * This will enforce the idea of the disabled item */
      DrawString(text, string, TextColour::Grey);
    } else {
      DrawString(text, string, TextColour::Black);
      GfxFillRect(icon, PC_BLACK); // Outer border of the legend colour
    }
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    switch (widget) {
      case WID_SM_MAP: {
        Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
        DrawPixelInfo new_dpi;
        if (!FillDrawPixelInfo(&new_dpi, ir)) return;
        this->DrawSmallMap(&new_dpi);
        break;
      }
 
      case WID_SM_LEGEND: {
        uint columns = this->GetNumberColumnsLegend(r.Width());
        uint number_of_rows = this->GetNumberRowsLegend(columns);
        bool rtl = _current_text_dir == TD_RTL;
        uint i = 0; // Row counter for industry legend.
        uint row_height = GetCharacterHeight(FontSize::Small);
        int padding = ScaleGUITrad(1);
 
        Rect origin = r.WithWidth(this->column_width, rtl).Shrink(WidgetDimensions::scaled.framerect).WithHeight(row_height);
        Rect text = origin.Indent(this->legend_width + WidgetDimensions::scaled.hsep_normal, rtl);
        Rect icon = origin.WithWidth(this->legend_width, rtl).Shrink(0, padding, 0, 0);
 
        for (const LegendAndColour &tbl : _legend_table[this->map_type]) {
          if (tbl.end) break;
          if (tbl.col_break || ((this->map_type == SmallMapType::Industries || this->map_type == SmallMapType::Owners || this->map_type == SmallMapType::LinkStats) && i++ >= number_of_rows)) {
            /* Column break needed, continue at top, COLUMN_WIDTH pixels
             * (one "row") to the right. */
            int x = rtl ? -(int)this->column_width : this->column_width;
            int y = origin.top - text.top;
            text = text.Translate(x, y);
            icon = icon.Translate(x, y);
            i = 1;
          }
 
          PixelColour legend_colour = tbl.colour;
 
          switch (this->map_type) {
            case SmallMapType::Industries:
              /* Industry name must be formatted, since it's not in tiny font in the specs.
               * So, draw with a parameter and use the STR_SMALLMAP_INDUSTRY string, which is tiny font */
              if (tbl.show_on_map && tbl.type == _smallmap_industry_highlight) {
                legend_colour = _smallmap_industry_highlight_state ? PC_WHITE : PC_BLACK;
              }
              this->DrawLegend(text, icon, tbl.show_on_map, GetString(STR_SMALLMAP_INDUSTRY, tbl.legend, Industry::GetIndustryTypeCount(tbl.type)));
              break;
 
            case SmallMapType::LinkStats:
              this->DrawLegend(text, icon, tbl.show_on_map, GetString(STR_SMALLMAP_LINKSTATS, tbl.legend));
              break;
 
            case SmallMapType::Owners:
              if (tbl.company != CompanyID::Invalid()) {
                this->DrawLegend(text, icon, tbl.show_on_map, GetString(STR_SMALLMAP_COMPANY, tbl.company));
                break;
              }
              [[fallthrough]];
 
            default:
              /* Anything that is not an industry or a company is using normal process */
              GfxFillRect(icon, PC_BLACK);
              if (this->map_type == SmallMapType::Contour) {
                DrawString(text, GetString(tbl.legend, tbl.height * TILE_HEIGHT_STEP));
              } else {
                DrawString(text, tbl.legend);
              }
              break;
          }
          GfxFillRect(icon.Shrink(WidgetDimensions::scaled.bevel), legend_colour); // Legend colour
 
          text = text.Translate(0, row_height);
          icon = icon.Translate(0, row_height);
        }
      }
    }
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    switch (widget) {
      case WID_SM_MAP: { // Map window
        if (click_count > 0) this->mouse_capture_widget = widget;
 
        const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
        Window *w = GetMainWindow();
        int sub;
        pt = this->PixelToTile(pt.x - wid->pos_x, pt.y - wid->pos_y, &sub);
        ScrollWindowTo(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, -1, w);
 
        this->SetDirty();
        break;
      }
 
      case WID_SM_ZOOM_IN:
      case WID_SM_ZOOM_OUT: {
        const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
        Point zoom_pt = { (int)wid->current_x / 2, (int)wid->current_y / 2};
        this->SetZoomLevel((widget == WID_SM_ZOOM_IN) ? ZoomLevelChange::ZoomIn : ZoomLevelChange::ZoomOut, &zoom_pt);
        SndClickBeep();
        break;
      }
 
      case WID_SM_CONTOUR:    // Show land contours
      case WID_SM_VEHICLES:   // Show vehicles
      case WID_SM_INDUSTRIES: // Show industries
      case WID_SM_LINKSTATS:  // Show route map
      case WID_SM_ROUTES:     // Show transport routes
      case WID_SM_VEGETATION: // Show vegetation
      case WID_SM_OWNERS:     // Show land owners
        this->SwitchMapType(static_cast<SmallMapType>(widget - WID_SM_CONTOUR));
        SndClickBeep();
        break;
 
      case WID_SM_CENTERMAP: // Center the smallmap again
        this->SmallMapCenterOnCurrentPos();
        this->HandleButtonClick(WID_SM_CENTERMAP);
        break;
 
      case WID_SM_TOGGLETOWNNAME: // Toggle town names
        this->show_towns = !this->show_towns;
        this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME, this->show_towns);
 
        this->SetDirty();
        SndClickBeep();
        break;
 
      case WID_SM_SHOW_IND_NAMES: // Toggle industry names
        this->show_ind_names = !this->show_ind_names;
        this->SetWidgetLoweredState(WID_SM_SHOW_IND_NAMES, this->show_ind_names);
 
        this->SetDirty();
        SndClickBeep();
        break;
 
      case WID_SM_LEGEND: // Legend
        if (this->map_type == SmallMapType::Industries || this->map_type == SmallMapType::LinkStats || this->map_type == SmallMapType::Owners) {
          int click_pos = this->GetPositionOnLegend(pt);
          if (click_pos < 0) break;
 
          /* If industry type small map*/
          if (this->map_type == SmallMapType::Industries) {
            /* If click on industries label, find right industry type and enable/disable it. */
            if (click_pos < _smallmap_industry_count) {
              this->SelectLegendItem(click_pos, _legend_from_industries, _smallmap_industry_count);
            }
          } else if (this->map_type == SmallMapType::LinkStats) {
            if (click_pos < _smallmap_cargo_count) {
              this->SelectLegendItem(click_pos, _legend_linkstats, _smallmap_cargo_count);
              this->SetOverlayCargoMask();
            }
          } else if (this->map_type == SmallMapType::Owners) {
            if (click_pos < _smallmap_company_count) {
              this->SelectLegendItem(click_pos, _legend_land_owners, _smallmap_company_count, NUM_NO_COMPANY_ENTRIES);
            }
          }
          this->SetDirty();
        }
        break;
 
      case WID_SM_ENABLE_ALL:
      case WID_SM_DISABLE_ALL: {
        LegendAndColour *tbl = nullptr;
        switch (this->map_type) {
          case SmallMapType::Industries:
            tbl = _legend_from_industries;
            this->BreakIndustryChainLink();
            break;
          case SmallMapType::Owners:
            tbl = &(_legend_land_owners[NUM_NO_COMPANY_ENTRIES]);
            break;
          case SmallMapType::LinkStats:
            tbl = _legend_linkstats;
            break;
          default:
            NOT_REACHED();
        }
        for (;!tbl->end && tbl->legend != STR_LINKGRAPH_LEGEND_UNUSED; ++tbl) {
          tbl->show_on_map = (widget == WID_SM_ENABLE_ALL);
        }
        if (this->map_type == SmallMapType::LinkStats) this->SetOverlayCargoMask();
        this->SetDirty();
        break;
      }
 
      case WID_SM_SHOW_HEIGHT: // Enable/disable showing of heightmap.
        _smallmap_show_heightmap = !_smallmap_show_heightmap;
        this->SetWidgetLoweredState(WID_SM_SHOW_HEIGHT, _smallmap_show_heightmap);
        this->SetDirty();
        break;
    }
  }

  void OnInvalidateData(int data = 0, bool gui_scope = true) override
  {
    if (!gui_scope) return;
 
    switch (data) {
      case 1:
        /* The owner legend has already been rebuilt. */
        this->ReInit();
        break;
 
      case 0: {
        extern std::bitset<NUM_INDUSTRYTYPES> _displayed_industries;
        if (this->map_type != SmallMapType::Industries) this->SwitchMapType(SmallMapType::Industries);
 
        for (int i = 0; i != _smallmap_industry_count; i++) {
          _legend_from_industries[i].show_on_map = _displayed_industries.test(_legend_from_industries[i].type);
        }
        break;
      }
 
      case 2:
        this->RebuildColourIndexIfNecessary();
        break;
 
      default: NOT_REACHED();
    }
    this->SetDirty();
  }
 
  bool OnRightClick(Point, WidgetID widget) override
  {
    if (widget != WID_SM_MAP || _scrolling_viewport) return false;
 
    _scrolling_viewport = true;
    return true;
  }
 
  void OnMouseWheel(int wheel, WidgetID widget) override
  {
    if (widget != WID_SM_MAP) return;
    if (_settings_client.gui.scrollwheel_scrolling != ScrollWheelScrolling::Off) {
      const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
      int cursor_x = _cursor.pos.x - this->left - wid->pos_x;
      int cursor_y = _cursor.pos.y - this->top  - wid->pos_y;
      Point pt = {cursor_x, cursor_y};
      this->SetZoomLevel((wheel < 0) ? ZoomLevelChange::ZoomIn : ZoomLevelChange::ZoomOut, &pt);
    }
  }
 
  void OnScroll(Point delta) override
  {
    if (_settings_client.gui.scroll_mode == ViewportScrollMode::ViewportRMBFixed || _settings_client.gui.scroll_mode == ViewportScrollMode::MapRMBFixed) _cursor.fix_at = true;
 
    /* While tile is at (delta.x, delta.y)? */
    int sub;
    Point pt = this->PixelToTile(delta.x, delta.y, &sub);
    this->SetNewScroll(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, sub);
 
    this->SetDirty();
  }
 
  void OnMouseOver([[maybe_unused]] Point pt, WidgetID widget) override
  {
    IndustryType new_highlight = IT_INVALID;
    if (widget == WID_SM_LEGEND && this->map_type == SmallMapType::Industries) {
      int industry_pos = GetPositionOnLegend(pt);
      if (industry_pos >= 0 && industry_pos < _smallmap_industry_count) {
        new_highlight = _legend_from_industries[industry_pos].type;
      }
    }
    if (new_highlight != _smallmap_industry_highlight) {
      _smallmap_industry_highlight = new_highlight;
      _smallmap_industry_highlight_state = true;
      this->SetDirty();
    }
  }
 
};
 
SmallMapType SmallMapWindow::map_type = SmallMapType::Contour;
bool SmallMapWindow::show_towns = true;
bool SmallMapWindow::show_ind_names = false;
int SmallMapWindow::map_height_limit = -1;

class NWidgetSmallmapButtons : public NWidgetContainer {
  static constexpr std::tuple<WidgetID, WidgetType, SpriteID, StringID> buttons[] = {
    {WID_SM_ZOOM_IN, WWT_PUSHIMGBTN, SPR_IMG_ZOOMIN, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_IN},
    {WID_SM_ZOOM_OUT, WWT_PUSHIMGBTN, SPR_IMG_ZOOMOUT, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_OUT},
    {WID_SM_CENTERMAP, WWT_PUSHIMGBTN, SPR_IMG_SMALLMAP, STR_SMALLMAP_CENTER_TOOLTIP},
    {WID_SM_TOGGLETOWNNAME, WWT_IMGBTN, SPR_IMG_TOWN, STR_SMALLMAP_TOOLTIP_TOGGLE_TOWN_NAMES_ON_OFF},
    {INVALID_WIDGET, WWT_PANEL, SPR_EMPTY, STR_NULL}, // Resizable spacer between top and bottom halves.
    {WID_SM_BLANK, WWT_IMGBTN, SPR_EMPTY, STR_NULL}, // Optional spacer in 2-column layout only.
    {WID_SM_LINKSTATS, WWT_IMGBTN, SPR_IMG_CARGOFLOW, STR_SMALLMAP_TOOLTIP_SHOW_LINK_STATS_ON_MAP},
    {WID_SM_ROUTES, WWT_IMGBTN, SPR_IMG_SHOW_ROUTES, STR_SMALLMAP_TOOLTIP_SHOW_TRANSPORT_ROUTES_ON},
    {WID_SM_VEGETATION, WWT_IMGBTN, SPR_IMG_PLANTTREES, STR_SMALLMAP_TOOLTIP_SHOW_VEGETATION_ON_MAP},
    {WID_SM_OWNERS, WWT_IMGBTN, SPR_IMG_COMPANY_GENERAL, STR_SMALLMAP_TOOLTIP_SHOW_LAND_OWNERS_ON_MAP},
    {WID_SM_CONTOUR, WWT_IMGBTN, SPR_IMG_SHOW_COUNTOURS, STR_SMALLMAP_TOOLTIP_SHOW_LAND_CONTOURS_ON_MAP},
    {WID_SM_VEHICLES, WWT_IMGBTN, SPR_IMG_SHOW_VEHICLES, STR_SMALLMAP_TOOLTIP_SHOW_VEHICLES_ON_MAP},
    {WID_SM_INDUSTRIES, WWT_IMGBTN, SPR_IMG_INDUSTRY, STR_SMALLMAP_TOOLTIP_SHOW_INDUSTRIES_ON_MAP},
  };
 
  uint num_buttons; 
  Dimension button; 
 
public:
  NWidgetSmallmapButtons() : NWidgetContainer(NWID_VERTICAL)
  {
    for (const auto &[widget, tp, sprite, string] : buttons) {
      if (widget == INVALID_WIDGET) {
        auto leaf = std::make_unique<NWidgetBackground>(WWT_PANEL, Colours::Brown, widget);
        this->Add(std::move(leaf));
      } else {
        auto leaf = std::make_unique<NWidgetLeaf>(tp, Colours::Brown, widget, WidgetData{.sprite = sprite}, string);
        leaf->SetToolbarMinimalSize(1);
        this->Add(std::move(leaf));
      }
    }
  }
 
  void SetupSmallestSize(Window *w) override
  {
    this->button.width = 0;
    this->button.height = 0;
 
    this->num_buttons = 0;
    for (const auto &child_wid : this->children) {
      child_wid->SetupSmallestSize(w);
      this->button.width = std::max(this->button.width, child_wid->smallest_y + child_wid->padding.Vertical());
      this->button.height = std::max(this->button.height, child_wid->smallest_x + child_wid->padding.Horizontal());
      WidgetID index = child_wid->GetIndex();
      if (index != INVALID_WIDGET && index != WID_SM_BLANK) ++this->num_buttons;
    }
 
    this->smallest_x = this->button.width * 2;
    this->smallest_y = this->button.height * CeilDiv(this->num_buttons, 2);
    this->fill_x = 0;
    this->fill_y = 1;
    this->resize_x = 0;
    this->resize_y = 1;
  }
 
  std::pair<uint, uint> GetPreferredSizeForSize(uint given_width, uint given_height) override
  {
    if (given_height >= this->num_buttons * this->button.height) return {this->button.width, given_height};
    return {given_width, given_height};
  }
 
  void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
  {
    assert(given_width >= this->button.width && given_height >= this->smallest_y);
 
    this->pos_x = x;
    this->pos_y = y;
    this->current_x = given_width;
    this->current_y = given_height;
 
    uint child_x = 0;
    uint child_y = 0;
    uint remaining = CeilDiv(this->num_buttons, this->smallest_x == this->current_x ? 2 : 1);
 
    for (auto &child : this->children) {
      if (child->type == WWT_PANEL) {
        /* Spacer widget needs to fill the remaining space. */
        uint height = given_height - child_y - (remaining * this->button.height);
        child->AssignSizePosition(sizing, x, y + child_y, given_width, height, rtl);
        child_y += height;
      } else if (given_width == this->button.width && child->GetIndex() == WID_SM_BLANK) {
        /* Blank button only appears in 2-column layout. */
        child->AssignSizePosition(sizing, x + child_x, y + child_y, 0, 0, rtl);
      } else {
        child->AssignSizePosition(sizing, x + child_x, y + child_y, child->smallest_x, child->smallest_y, rtl);
        child_x += child->current_x;
        if (child_x >= given_width) {
          child_x = 0;
          child_y += child->current_y;
          --remaining;
        }
      }
    }
  }

  static std::unique_ptr<NWidgetBase> Make()
  {
    return std::make_unique<NWidgetSmallmapButtons>();
  }
};

class NWidgetSmallmapDisplay : public NWidgetContainer {
  const SmallMapWindow *smallmap_window = nullptr; 
public:
  NWidgetSmallmapDisplay() : NWidgetContainer(NWID_CUSTOM) {}
 
  void SetupSmallestSize(Window *w) override
  {
    assert(this->children.size() == 2);
    NWidgetBase *display = this->children.front().get();
    NWidgetBase *bar = this->children.back().get();
 
    display->SetupSmallestSize(w);
    bar->SetupSmallestSize(w);
 
    this->smallmap_window = dynamic_cast<SmallMapWindow *>(w);
    assert(this->smallmap_window != nullptr);
    this->smallest_x = std::max(display->smallest_x, bar->smallest_x + smallmap_window->GetMinLegendWidth());
    this->smallest_y = display->smallest_y + std::max(bar->smallest_y, smallmap_window->GetLegendHeight(smallmap_window->min_number_of_columns));
    this->fill_x = std::max(display->fill_x, bar->fill_x);
    this->fill_y = (display->fill_y == 0 && bar->fill_y == 0) ? 0 : std::min(display->fill_y, bar->fill_y);
    this->resize_x = std::max(display->resize_x, bar->resize_x);
    this->resize_y = std::min(display->resize_y, bar->resize_y);
    this->ApplyAspectRatio();
  }
 
  void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
  {
    this->pos_x = x;
    this->pos_y = y;
    this->current_x = given_width;
    this->current_y = given_height;
 
    assert(this->children.size() == 2);
    NWidgetBase *display = this->children.front().get();
    NWidgetBase *bar = this->children.back().get();
 
    if (sizing == SizingType::Smallest) {
      this->smallest_x = given_width;
      this->smallest_y = given_height;
      /* Make display and bar exactly equal to their minimal size. */
      display->AssignSizePosition(SizingType::Smallest, x, y, display->smallest_x, display->smallest_y, rtl);
      bar->AssignSizePosition(SizingType::Smallest, x, y + display->smallest_y, bar->smallest_x, bar->smallest_y, rtl);
    }
 
    uint bar_height = std::max(bar->smallest_y, this->smallmap_window->GetLegendHeight(this->smallmap_window->GetNumberColumnsLegend(given_width - bar->smallest_x)));
    uint display_height = given_height - bar_height;
    display->AssignSizePosition(SizingType::Resize, x, y, given_width, display_height, rtl);
    bar->AssignSizePosition(SizingType::Resize, x, y + display_height, given_width, bar_height, rtl);
  }
};

static constexpr std::initializer_list<NWidgetPart> _nested_smallmap_display = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, Colours::Brown, WID_SM_MAP_BORDER),
      NWidget(WWT_INSET, Colours::Brown, WID_SM_MAP), SetFill(1, 1), SetResize(1, 1), SetPadding(2, 2, 2, 2), EndContainer(),
    EndContainer(),
    NWidgetFunction(NWidgetSmallmapButtons::Make),
  EndContainer(),
};

static constexpr std::initializer_list<NWidgetPart> _nested_smallmap_bar = {
  NWidget(WWT_PANEL, Colours::Brown, WID_SM_LEGEND), SetFill(1, 0), SetResize(1, 1),
  EndContainer(),
};
 
static std::unique_ptr<NWidgetBase> SmallMapDisplay()
{
  std::unique_ptr<NWidgetBase> map_display = std::make_unique<NWidgetSmallmapDisplay>();
 
  map_display = MakeNWidgets(_nested_smallmap_display, std::move(map_display));
  map_display = MakeNWidgets(_nested_smallmap_bar, std::move(map_display));
  return map_display;
}
 
static constexpr std::initializer_list<NWidgetPart> _nested_smallmap_widgets = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, Colours::Brown),
    NWidget(WWT_CAPTION, Colours::Brown, WID_SM_CAPTION),
    NWidget(WWT_SHADEBOX, Colours::Brown),
    NWidget(WWT_DEFSIZEBOX, Colours::Brown),
    NWidget(WWT_STICKYBOX, Colours::Brown),
  EndContainer(),
  NWidgetFunction(SmallMapDisplay), // Smallmap display and legend bar + image buttons.
  /* Bottom button row and resize box. */
  NWidget(NWID_HORIZONTAL),
    NWidget(NWID_SELECTION, Colours::Invalid, WID_SM_SELECT_BUTTONS),
      NWidget(NWID_HORIZONTAL),
        NWidget(WWT_PUSHTXTBTN, Colours::Brown, WID_SM_ENABLE_ALL), SetStringTip(STR_SMALLMAP_ENABLE_ALL),
        NWidget(WWT_PUSHTXTBTN, Colours::Brown, WID_SM_DISABLE_ALL), SetStringTip(STR_SMALLMAP_DISABLE_ALL),
        NWidget(WWT_TEXTBTN, Colours::Brown, WID_SM_SHOW_HEIGHT), SetStringTip(STR_SMALLMAP_SHOW_HEIGHT, STR_SMALLMAP_TOOLTIP_SHOW_HEIGHT),
 
        /* 'show industry names' button and container. Only shown for the industry map type. */
        NWidget(NWID_SELECTION, Colours::Invalid, WID_SM_SHOW_IND_NAMES_SEL),
          NWidget(WWT_TEXTBTN, Colours::Brown, WID_SM_SHOW_IND_NAMES), SetStringTip(STR_SMALLMAP_SHOW_INDUSTRY_NAMES, STR_SMALLMAP_TOOLTIP_SHOW_INDUSTRY_NAMES),
        EndContainer(),
 
        NWidget(WWT_PANEL, Colours::Brown), SetFill(1, 0), SetResize(1, 0),
        EndContainer(),
      EndContainer(),
      NWidget(WWT_PANEL, Colours::Brown), SetFill(1, 0), SetResize(1, 0),
      EndContainer(),
    EndContainer(),
    NWidget(WWT_RESIZEBOX, Colours::Brown),
  EndContainer(),
};

static WindowDesc _smallmap_desc(
  WindowPosition::Automatic, "smallmap", 0, 0,
  WindowClass::SmallMap, WindowClass::None,
  {},
  _nested_smallmap_widgets
);

void ShowSmallMap()
{
  AllocateWindowDescFront<SmallMapWindow>(_smallmap_desc, 0);
}

bool ScrollMainWindowTo(int x, int y, int z, bool instant)
{
  bool res = ScrollWindowTo(x, y, z, GetMainWindow(), instant);
 
  /* If a user scrolls to a tile (via what way what so ever) and already is on
   * that tile (e.g.: pressed twice), move the smallmap to that location,
   * so you directly see where you are on the smallmap. */
 
  if (res) return res;
 
  SmallMapWindow *w = dynamic_cast<SmallMapWindow*>(FindWindowById(WindowClass::SmallMap, 0));
  if (w != nullptr) w->SmallMapCenterOnCurrentPos();
 
  return res;
}

Point GetSmallMapStationMiddle(const Window *w, const Station *st)
{
  return static_cast<const SmallMapWindow *>(w)->GetStationMiddle(st);
}