4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
10 /** @file smallmap_gui.cpp GUI that shows a small map of the world with metadata like owner or height. */
13 #include "clear_map.h"
15 #include "station_map.h"
16 #include "landscape.h"
18 #include "viewport_func.h"
20 #include "tunnelbridge_map.h"
21 #include "core/endian_func.hpp"
22 #include "vehicle_base.h"
23 #include "sound_func.h"
24 #include "window_func.h"
25 #include "company_base.h"
27 #include "smallmap_gui.h"
29 #include "table/strings.h"
33 #include "safeguards.h"
35 static int _smallmap_industry_count
; ///< Number of used industries
36 static int _smallmap_company_count
; ///< Number of entries in the owner legend.
37 static int _smallmap_cargo_count
; ///< Number of cargos in the link stats legend.
39 /** Link stat colours shown in legenda. */
40 static uint8 _linkstat_colours_in_legenda
[] = {0, 1, 3, 5, 7, 9, 11};
42 static const int NUM_NO_COMPANY_ENTRIES
= 4; ///< Number of entries in the owner legend that are not companies.
44 static const uint8 PC_ROUGH_LAND
= 0x52; ///< Dark green palette colour for rough land.
45 static const uint8 PC_GRASS_LAND
= 0x54; ///< Dark green palette colour for grass land.
46 static const uint8 PC_BARE_LAND
= 0x37; ///< Brown palette colour for bare land.
47 static const uint8 PC_FIELDS
= 0x25; ///< Light brown palette colour for fields.
48 static const uint8 PC_TREES
= 0x57; ///< Green palette colour for trees.
49 static const uint8 PC_WATER
= 0xCA; ///< Dark blue palette colour for water.
51 /** Macro for ordinary entry of LegendAndColour */
52 #define MK(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, false}
54 /** Macro for a height legend entry with configurable colour. */
55 #define MC(col_break) {0, STR_TINY_BLACK_HEIGHT, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, col_break}
57 /** Macro for non-company owned property entry of LegendAndColour */
58 #define MO(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, false}
60 /** Macro used for forcing a rebuild of the owner legend the first time it is used. */
61 #define MOEND() {0, 0, INVALID_INDUSTRYTYPE, 0, OWNER_NONE, true, true, false}
63 /** Macro for end of list marker in arrays of LegendAndColour */
64 #define MKEND() {0, STR_NULL, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, true, false}
67 * Macro for break marker in arrays of LegendAndColour.
68 * It will have valid data, though
70 #define MS(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, true}
72 /** Legend text giving the colours to look for on the minimap */
73 static LegendAndColour _legend_land_contours
[] = {
74 MK(PC_BLACK
, STR_SMALLMAP_LEGENDA_ROADS
),
75 MK(PC_GREY
, STR_SMALLMAP_LEGENDA_RAILROADS
),
76 MK(PC_LIGHT_BLUE
, STR_SMALLMAP_LEGENDA_STATIONS_AIRPORTS_DOCKS
),
77 MK(PC_DARK_RED
, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES
),
78 MK(PC_WHITE
, STR_SMALLMAP_LEGENDA_VEHICLES
),
80 /* Placeholders for the colours and heights of the legend.
81 * The following values are set at BuildLandLegend() based
82 * on each colour scheme and the maximum map height. */
98 static const LegendAndColour _legend_vehicles
[] = {
99 MK(PC_RED
, STR_SMALLMAP_LEGENDA_TRAINS
),
100 MK(PC_YELLOW
, STR_SMALLMAP_LEGENDA_ROAD_VEHICLES
),
101 MK(PC_LIGHT_BLUE
, STR_SMALLMAP_LEGENDA_SHIPS
),
102 MK(PC_WHITE
, STR_SMALLMAP_LEGENDA_AIRCRAFT
),
104 MS(PC_BLACK
, STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES
),
105 MK(PC_DARK_RED
, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES
),
109 static const LegendAndColour _legend_routes
[] = {
110 MK(PC_BLACK
, STR_SMALLMAP_LEGENDA_ROADS
),
111 MK(PC_GREY
, STR_SMALLMAP_LEGENDA_RAILROADS
),
112 MK(PC_DARK_RED
, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES
),
114 MS(PC_VERY_DARK_BROWN
, STR_SMALLMAP_LEGENDA_RAILROAD_STATION
),
115 MK(PC_ORANGE
, STR_SMALLMAP_LEGENDA_TRUCK_LOADING_BAY
),
116 MK(PC_YELLOW
, STR_SMALLMAP_LEGENDA_BUS_STATION
),
117 MK(PC_RED
, STR_SMALLMAP_LEGENDA_AIRPORT_HELIPORT
),
118 MK(PC_LIGHT_BLUE
, STR_SMALLMAP_LEGENDA_DOCK
),
122 static const LegendAndColour _legend_vegetation
[] = {
123 MK(PC_ROUGH_LAND
, STR_SMALLMAP_LEGENDA_ROUGH_LAND
),
124 MK(PC_GRASS_LAND
, STR_SMALLMAP_LEGENDA_GRASS_LAND
),
125 MK(PC_BARE_LAND
, STR_SMALLMAP_LEGENDA_BARE_LAND
),
126 MK(PC_FIELDS
, STR_SMALLMAP_LEGENDA_FIELDS
),
127 MK(PC_TREES
, STR_SMALLMAP_LEGENDA_TREES
),
128 MK(PC_GREEN
, STR_SMALLMAP_LEGENDA_FOREST
),
130 MS(PC_GREY
, STR_SMALLMAP_LEGENDA_ROCKS
),
131 MK(PC_ORANGE
, STR_SMALLMAP_LEGENDA_DESERT
),
132 MK(PC_LIGHT_BLUE
, STR_SMALLMAP_LEGENDA_SNOW
),
133 MK(PC_BLACK
, STR_SMALLMAP_LEGENDA_TRANSPORT_ROUTES
),
134 MK(PC_DARK_RED
, STR_SMALLMAP_LEGENDA_BUILDINGS_INDUSTRIES
),
138 static LegendAndColour _legend_land_owners
[NUM_NO_COMPANY_ENTRIES
+ MAX_COMPANIES
+ 1] = {
139 MO(PC_WATER
, STR_SMALLMAP_LEGENDA_WATER
),
140 MO(0x00, STR_SMALLMAP_LEGENDA_NO_OWNER
), // This colour will vary depending on settings.
141 MO(PC_DARK_RED
, STR_SMALLMAP_LEGENDA_TOWNS
),
142 MO(PC_DARK_GREY
, STR_SMALLMAP_LEGENDA_INDUSTRIES
),
143 /* The legend will be terminated the first time it is used. */
154 /** Legend entries for the link stats view. */
155 static LegendAndColour _legend_linkstats
[NUM_CARGO
+ lengthof(_linkstat_colours_in_legenda
) + 1];
157 * Allow room for all industries, plus a terminator entry
158 * This is required in order to have the industry slots all filled up
160 static LegendAndColour _legend_from_industries
[NUM_INDUSTRYTYPES
+ 1];
161 /** For connecting industry type to position in industries list(small map legend) */
162 static uint _industry_to_list_pos
[NUM_INDUSTRYTYPES
];
163 /** Show heightmap in industry and owner mode of smallmap window. */
164 static bool _smallmap_show_heightmap
= false;
165 /** Highlight a specific industry type */
166 static IndustryType _smallmap_industry_highlight
= INVALID_INDUSTRYTYPE
;
167 /** State of highlight blinking */
168 static bool _smallmap_industry_highlight_state
;
169 /** For connecting company ID to position in owner list (small map legend) */
170 static uint _company_to_list_pos
[MAX_COMPANIES
];
173 * Fills an array for the industries legends.
175 void BuildIndustriesLegend()
180 for (uint i
= 0; i
< NUM_INDUSTRYTYPES
; i
++) {
181 IndustryType ind
= _sorted_industry_types
[i
];
182 const IndustrySpec
*indsp
= GetIndustrySpec(ind
);
183 if (indsp
->enabled
) {
184 _legend_from_industries
[j
].legend
= indsp
->name
;
185 _legend_from_industries
[j
].colour
= indsp
->map_colour
;
186 _legend_from_industries
[j
].type
= ind
;
187 _legend_from_industries
[j
].show_on_map
= true;
188 _legend_from_industries
[j
].col_break
= false;
189 _legend_from_industries
[j
].end
= false;
191 /* Store widget number for this industry type. */
192 _industry_to_list_pos
[ind
] = j
;
196 /* Terminate the list */
197 _legend_from_industries
[j
].end
= true;
199 /* Store number of enabled industries */
200 _smallmap_industry_count
= j
;
204 * Populate legend table for the link stat view.
206 void BuildLinkStatsLegend()
208 /* Clear the legend */
209 memset(_legend_linkstats
, 0, sizeof(_legend_linkstats
));
212 for (; i
< _sorted_cargo_specs_size
; ++i
) {
213 const CargoSpec
*cs
= _sorted_cargo_specs
[i
];
215 _legend_linkstats
[i
].legend
= cs
->name
;
216 _legend_linkstats
[i
].colour
= cs
->legend_colour
;
217 _legend_linkstats
[i
].type
= cs
->Index();
218 _legend_linkstats
[i
].show_on_map
= true;
221 _legend_linkstats
[i
].col_break
= true;
222 _smallmap_cargo_count
= i
;
224 for (; i
< _smallmap_cargo_count
+ lengthof(_linkstat_colours_in_legenda
); ++i
) {
225 _legend_linkstats
[i
].legend
= STR_EMPTY
;
226 _legend_linkstats
[i
].colour
= LinkGraphOverlay::LINK_COLOURS
[_linkstat_colours_in_legenda
[i
- _smallmap_cargo_count
]];
227 _legend_linkstats
[i
].show_on_map
= true;
230 _legend_linkstats
[_smallmap_cargo_count
].legend
= STR_LINKGRAPH_LEGEND_UNUSED
;
231 _legend_linkstats
[i
- 1].legend
= STR_LINKGRAPH_LEGEND_OVERLOADED
;
232 _legend_linkstats
[(_smallmap_cargo_count
+ i
- 1) / 2].legend
= STR_LINKGRAPH_LEGEND_SATURATED
;
233 _legend_linkstats
[i
].end
= true;
236 static const LegendAndColour
* const _legend_table
[] = {
237 _legend_land_contours
,
239 _legend_from_industries
,
246 #define MKCOLOUR(x) TO_LE32X(x)
248 #define MKCOLOUR_XXXX(x) (MKCOLOUR(0x01010101) * (uint)(x))
249 #define MKCOLOUR_X0X0(x) (MKCOLOUR(0x01000100) * (uint)(x))
250 #define MKCOLOUR_0X0X(x) (MKCOLOUR(0x00010001) * (uint)(x))
251 #define MKCOLOUR_0XX0(x) (MKCOLOUR(0x00010100) * (uint)(x))
252 #define MKCOLOUR_X00X(x) (MKCOLOUR(0x01000001) * (uint)(x))
254 #define MKCOLOUR_XYXY(x, y) (MKCOLOUR_X0X0(x) | MKCOLOUR_0X0X(y))
255 #define MKCOLOUR_XYYX(x, y) (MKCOLOUR_X00X(x) | MKCOLOUR_0XX0(y))
257 #define MKCOLOUR_0000 MKCOLOUR_XXXX(0x00)
258 #define MKCOLOUR_0FF0 MKCOLOUR_0XX0(0xFF)
259 #define MKCOLOUR_F00F MKCOLOUR_X00X(0xFF)
260 #define MKCOLOUR_FFFF MKCOLOUR_XXXX(0xFF)
262 #include "table/heightmap_colours.h"
264 /** Colour scheme of the smallmap. */
265 struct SmallMapColourScheme
{
266 uint32
*height_colours
; ///< Cached colours for each level in a map.
267 const uint32
*height_colours_base
; ///< Base table for determining the colours
268 size_t colour_count
; ///< The number of colours.
269 uint32 default_colour
; ///< Default colour of the land.
272 /** Available colour schemes for height maps. */
273 static SmallMapColourScheme _heightmap_schemes
[] = {
274 {NULL
, _green_map_heights
, lengthof(_green_map_heights
), MKCOLOUR_XXXX(0x54)}, ///< Green colour scheme.
275 {NULL
, _dark_green_map_heights
, lengthof(_dark_green_map_heights
), MKCOLOUR_XXXX(0x62)}, ///< Dark green colour scheme.
276 {NULL
, _violet_map_heights
, lengthof(_violet_map_heights
), MKCOLOUR_XXXX(0x82)}, ///< Violet colour scheme.
280 * (Re)build the colour tables for the legends.
282 void BuildLandLegend()
284 /* The smallmap window has never been initialized, so no need to change the legend. */
285 if (_heightmap_schemes
[0].height_colours
== NULL
) return;
288 * The general idea of this function is to fill the legend with an appropriate evenly spaced
289 * selection of height levels. All entries with STR_TINY_BLACK_HEIGHT are reserved for this.
290 * At the moment there are twelve of these.
292 * The table below defines up to which height level a particular delta in the legend should be
293 * used. One could opt for just dividing the maximum height and use that as delta, but that
294 * creates many "ugly" legend labels, e.g. once every 950 meter. As a result, this table will
295 * reduce the number of deltas to 7: every 100m, 200m, 300m, 500m, 750m, 1000m and 1250m. The
296 * deltas are closer together at the lower numbers because going from 12 entries to just 4, as
297 * would happen when replacing 200m and 300m by 250m, would mean the legend would be short and
298 * that might not be considered appropriate.
300 * The current method yields at least 7 legend entries and at most 12. It can be increased to
301 * 8 by adding a 150m and 400m option, but especially 150m creates ugly heights.
303 * It tries to evenly space the legend items over the two columns that are there for the legend.
306 /* Table for delta; if max_height is less than the first column, use the second column as value. */
307 uint deltas
[][2] = { { 24, 2 }, { 48, 4 }, { 72, 6 }, { 120, 10 }, { 180, 15 }, { 240, 20 }, { MAX_TILE_HEIGHT
+ 1, 25 }};
309 for (; _settings_game
.construction
.max_heightlevel
>= deltas
[i
][0]; i
++) {
310 /* Nothing to do here. */
312 uint delta
= deltas
[i
][1];
314 int total_entries
= (_settings_game
.construction
.max_heightlevel
/ delta
) + 1;
315 int rows
= CeilDiv(total_entries
, 2);
318 for (i
= 0; i
< lengthof(_legend_land_contours
) - 1 && j
< total_entries
; i
++) {
319 if (_legend_land_contours
[i
].legend
!= STR_TINY_BLACK_HEIGHT
) continue;
321 _legend_land_contours
[i
].col_break
= j
% rows
== 0;
322 _legend_land_contours
[i
].end
= false;
323 _legend_land_contours
[i
].height
= j
* delta
;
324 _legend_land_contours
[i
].colour
= _heightmap_schemes
[_settings_client
.gui
.smallmap_land_colour
].height_colours
[j
* delta
];
327 _legend_land_contours
[i
].end
= true;
331 * Completes the array for the owned property legend.
333 void BuildOwnerLegend()
335 _legend_land_owners
[1].colour
= _heightmap_schemes
[_settings_client
.gui
.smallmap_land_colour
].default_colour
;
337 int i
= NUM_NO_COMPANY_ENTRIES
;
339 FOR_ALL_COMPANIES(c
) {
340 _legend_land_owners
[i
].colour
= _colour_gradient
[c
->colour
][5];
341 _legend_land_owners
[i
].company
= c
->index
;
342 _legend_land_owners
[i
].show_on_map
= true;
343 _legend_land_owners
[i
].col_break
= false;
344 _legend_land_owners
[i
].end
= false;
345 _company_to_list_pos
[c
->index
] = i
;
349 /* Terminate the list */
350 _legend_land_owners
[i
].end
= true;
352 /* Store maximum amount of owner legend entries. */
353 _smallmap_company_count
= i
;
361 static inline uint32
ApplyMask(uint32 colour
, const AndOr
*mask
)
363 return (colour
& mask
->mand
) | mask
->mor
;
367 /** Colour masks for "Contour" and "Routes" modes. */
368 static const AndOr _smallmap_contours_andor
[] = {
369 {MKCOLOUR_0000
, MKCOLOUR_FFFF
}, // MP_CLEAR
370 {MKCOLOUR_0XX0(PC_GREY
), MKCOLOUR_F00F
}, // MP_RAILWAY
371 {MKCOLOUR_0XX0(PC_BLACK
), MKCOLOUR_F00F
}, // MP_ROAD
372 {MKCOLOUR_0XX0(PC_DARK_RED
), MKCOLOUR_F00F
}, // MP_HOUSE
373 {MKCOLOUR_0000
, MKCOLOUR_FFFF
}, // MP_TREES
374 {MKCOLOUR_XXXX(PC_LIGHT_BLUE
), MKCOLOUR_0000
}, // MP_STATION
375 {MKCOLOUR_XXXX(PC_WATER
), MKCOLOUR_0000
}, // MP_WATER
376 {MKCOLOUR_0000
, MKCOLOUR_FFFF
}, // MP_VOID
377 {MKCOLOUR_XXXX(PC_DARK_RED
), MKCOLOUR_0000
}, // MP_INDUSTRY
378 {MKCOLOUR_0000
, MKCOLOUR_FFFF
}, // MP_TUNNELBRIDGE
379 {MKCOLOUR_0XX0(PC_DARK_RED
), MKCOLOUR_F00F
}, // MP_OBJECT
380 {MKCOLOUR_0XX0(PC_GREY
), MKCOLOUR_F00F
},
383 /** Colour masks for "Vehicles", "Industry", and "Vegetation" modes. */
384 static const AndOr _smallmap_vehicles_andor
[] = {
385 {MKCOLOUR_0000
, MKCOLOUR_FFFF
}, // MP_CLEAR
386 {MKCOLOUR_0XX0(PC_BLACK
), MKCOLOUR_F00F
}, // MP_RAILWAY
387 {MKCOLOUR_0XX0(PC_BLACK
), MKCOLOUR_F00F
}, // MP_ROAD
388 {MKCOLOUR_0XX0(PC_DARK_RED
), MKCOLOUR_F00F
}, // MP_HOUSE
389 {MKCOLOUR_0000
, MKCOLOUR_FFFF
}, // MP_TREES
390 {MKCOLOUR_0XX0(PC_BLACK
), MKCOLOUR_F00F
}, // MP_STATION
391 {MKCOLOUR_XXXX(PC_WATER
), MKCOLOUR_0000
}, // MP_WATER
392 {MKCOLOUR_0000
, MKCOLOUR_FFFF
}, // MP_VOID
393 {MKCOLOUR_XXXX(PC_DARK_RED
), MKCOLOUR_0000
}, // MP_INDUSTRY
394 {MKCOLOUR_0000
, MKCOLOUR_FFFF
}, // MP_TUNNELBRIDGE
395 {MKCOLOUR_0XX0(PC_DARK_RED
), MKCOLOUR_F00F
}, // MP_OBJECT
396 {MKCOLOUR_0XX0(PC_BLACK
), MKCOLOUR_F00F
},
399 /** Mapping of tile type to importance of the tile (higher number means more interesting to show). */
400 static const byte _tiletype_importance
[] = {
410 8, // MP_TUNNELBRIDGE
417 * Return the colour a tile would be displayed with in the small map in mode "Contour".
418 * @param tile The tile of which we would like to get the colour.
419 * @param t Effective tile type of the tile (see #GetTileColours).
420 * @return The colour of tile in the small map in mode "Contour"
422 static inline uint32
GetSmallMapContoursPixels(TileIndex tile
, TileType t
)
424 const SmallMapColourScheme
*cs
= &_heightmap_schemes
[_settings_client
.gui
.smallmap_land_colour
];
425 return ApplyMask(cs
->height_colours
[TileHeight(tile
)], &_smallmap_contours_andor
[t
]);
429 * Return the colour a tile would be displayed with in the small map in mode "Vehicles".
431 * @param tile The tile of which we would like to get the colour.
432 * @param t Effective tile type of the tile (see #GetTileColours).
433 * @return The colour of tile in the small map in mode "Vehicles"
435 static inline uint32
GetSmallMapVehiclesPixels(TileIndex tile
, TileType t
)
437 const SmallMapColourScheme
*cs
= &_heightmap_schemes
[_settings_client
.gui
.smallmap_land_colour
];
438 return ApplyMask(cs
->default_colour
, &_smallmap_vehicles_andor
[t
]);
442 * Return the colour a tile would be displayed with in the small map in mode "Industries".
444 * @param tile The tile of which we would like to get the colour.
445 * @param t Effective tile type of the tile (see #GetTileColours).
446 * @return The colour of tile in the small map in mode "Industries"
448 static inline uint32
GetSmallMapIndustriesPixels(TileIndex tile
, TileType t
)
450 const SmallMapColourScheme
*cs
= &_heightmap_schemes
[_settings_client
.gui
.smallmap_land_colour
];
451 return ApplyMask(_smallmap_show_heightmap
? cs
->height_colours
[TileHeight(tile
)] : cs
->default_colour
, &_smallmap_vehicles_andor
[t
]);
455 * Return the colour a tile would be displayed with in the small map in mode "Routes".
457 * @param tile The tile of which we would like to get the colour.
458 * @param t Effective tile type of the tile (see #GetTileColours).
459 * @return The colour of tile in the small map in mode "Routes"
461 static inline uint32
GetSmallMapRoutesPixels(TileIndex tile
, TileType t
)
463 if (t
== MP_STATION
) {
464 switch (GetStationType(tile
)) {
465 case STATION_RAIL
: return MKCOLOUR_XXXX(PC_VERY_DARK_BROWN
);
466 case STATION_AIRPORT
: return MKCOLOUR_XXXX(PC_RED
);
467 case STATION_TRUCK
: return MKCOLOUR_XXXX(PC_ORANGE
);
468 case STATION_BUS
: return MKCOLOUR_XXXX(PC_YELLOW
);
469 case STATION_DOCK
: return MKCOLOUR_XXXX(PC_LIGHT_BLUE
);
470 default: return MKCOLOUR_FFFF
;
472 } else if (t
== MP_RAILWAY
) {
474 MKCOLOUR_0XX0(GetRailTypeInfo(GetRailType(tile
))->map_colour
),
475 _smallmap_contours_andor
[t
].mand
478 const SmallMapColourScheme
*cs
= &_heightmap_schemes
[_settings_client
.gui
.smallmap_land_colour
];
479 return ApplyMask(cs
->default_colour
, &andor
);
483 const SmallMapColourScheme
*cs
= &_heightmap_schemes
[_settings_client
.gui
.smallmap_land_colour
];
484 return ApplyMask(cs
->default_colour
, &_smallmap_contours_andor
[t
]);
488 * Return the colour a tile would be displayed with in the small map in mode "link stats".
490 * @param tile The tile of which we would like to get the colour.
491 * @param t Effective tile type of the tile (see #GetTileColours).
492 * @return The colour of tile in the small map in mode "link stats"
494 static inline uint32
GetSmallMapLinkStatsPixels(TileIndex tile
, TileType t
)
496 return _smallmap_show_heightmap
? GetSmallMapContoursPixels(tile
, t
) : GetSmallMapRoutesPixels(tile
, t
);
499 static const uint32 _vegetation_clear_bits
[] = {
500 MKCOLOUR_XXXX(PC_GRASS_LAND
), ///< full grass
501 MKCOLOUR_XXXX(PC_ROUGH_LAND
), ///< rough land
502 MKCOLOUR_XXXX(PC_GREY
), ///< rocks
503 MKCOLOUR_XXXX(PC_FIELDS
), ///< fields
504 MKCOLOUR_XXXX(PC_LIGHT_BLUE
), ///< snow
505 MKCOLOUR_XXXX(PC_ORANGE
), ///< desert
506 MKCOLOUR_XXXX(PC_GRASS_LAND
), ///< unused
507 MKCOLOUR_XXXX(PC_GRASS_LAND
), ///< unused
511 * Return the colour a tile would be displayed with in the smallmap in mode "Vegetation".
513 * @param tile The tile of which we would like to get the colour.
514 * @param t Effective tile type of the tile (see #GetTileColours).
515 * @return The colour of tile in the smallmap in mode "Vegetation"
517 static inline uint32
GetSmallMapVegetationPixels(TileIndex tile
, TileType t
)
521 return (IsClearGround(tile
, CLEAR_GRASS
) && GetClearDensity(tile
) < 3) ? MKCOLOUR_XXXX(PC_BARE_LAND
) : _vegetation_clear_bits
[GetClearGround(tile
)];
524 return IsTileForestIndustry(tile
) ? MKCOLOUR_XXXX(PC_GREEN
) : MKCOLOUR_XXXX(PC_DARK_RED
);
527 if (GetTreeGround(tile
) == TREE_GROUND_SNOW_DESERT
|| GetTreeGround(tile
) == TREE_GROUND_ROUGH_SNOW
) {
528 return (_settings_game
.game_creation
.landscape
== LT_ARCTIC
) ? MKCOLOUR_XYYX(PC_LIGHT_BLUE
, PC_TREES
) : MKCOLOUR_XYYX(PC_ORANGE
, PC_TREES
);
530 return MKCOLOUR_XYYX(PC_GRASS_LAND
, PC_TREES
);
533 return ApplyMask(MKCOLOUR_XXXX(PC_GRASS_LAND
), &_smallmap_vehicles_andor
[t
]);
538 * Return the colour a tile would be displayed with in the small map in mode "Owner".
540 * @param tile The tile of which we would like to get the colour.
541 * @param t Effective tile type of the tile (see #GetTileColours).
542 * @return The colour of tile in the small map in mode "Owner"
544 static inline uint32
GetSmallMapOwnerPixels(TileIndex tile
, TileType t
)
549 case MP_INDUSTRY
: return MKCOLOUR_XXXX(PC_DARK_GREY
);
550 case MP_HOUSE
: return MKCOLOUR_XXXX(PC_DARK_RED
);
551 default: o
= GetTileOwner(tile
); break;
552 /* FIXME: For MP_ROAD there are multiple owners.
553 * GetTileOwner returns the rail owner (level crossing) resp. the owner of ROADTYPE_ROAD (normal road),
554 * even if there are no ROADTYPE_ROAD bits on the tile.
558 if ((o
< MAX_COMPANIES
&& !_legend_land_owners
[_company_to_list_pos
[o
]].show_on_map
) || o
== OWNER_NONE
|| o
== OWNER_WATER
) {
559 if (t
== MP_WATER
) return MKCOLOUR_XXXX(PC_WATER
);
560 const SmallMapColourScheme
*cs
= &_heightmap_schemes
[_settings_client
.gui
.smallmap_land_colour
];
561 return _smallmap_show_heightmap
? cs
->height_colours
[TileHeight(tile
)] : cs
->default_colour
;
562 } else if (o
== OWNER_TOWN
) {
563 return MKCOLOUR_XXXX(PC_DARK_RED
);
566 return MKCOLOUR_XXXX(_legend_land_owners
[_company_to_list_pos
[o
]].colour
);
569 /** Vehicle colours in #SMT_VEHICLES mode. Indexed by #VehicleTypeByte. */
570 static const byte _vehicle_type_colours
[6] = {
571 PC_RED
, PC_YELLOW
, PC_LIGHT_BLUE
, PC_WHITE
, PC_BLACK
, PC_RED
575 /** Notify the industry chain window to stop sending newly selected industries. */
576 /* static */ void SmallMapWindow::BreakIndustryChainLink()
578 InvalidateWindowClassesData(WC_INDUSTRY_CARGOES
, NUM_INDUSTRYTYPES
);
581 inline Point
SmallMapWindow::SmallmapRemapCoords(int x
, int y
) const
590 * Remap tile to location on this smallmap.
591 * @param tile_x X coordinate of the tile.
592 * @param tile_y Y coordinate of the tile.
593 * @return Position to draw on.
595 inline Point
SmallMapWindow::RemapTile(int tile_x
, int tile_y
) const
597 int x_offset
= tile_x
- this->scroll_x
/ (int)TILE_SIZE
;
598 int y_offset
= tile_y
- this->scroll_y
/ (int)TILE_SIZE
;
600 if (this->zoom
== 1) return SmallmapRemapCoords(x_offset
, y_offset
);
602 /* For negative offsets, round towards -inf. */
603 if (x_offset
< 0) x_offset
-= this->zoom
- 1;
604 if (y_offset
< 0) y_offset
-= this->zoom
- 1;
606 return SmallmapRemapCoords(x_offset
/ this->zoom
, y_offset
/ this->zoom
);
610 * Determine the tile relative to the base tile of the smallmap, and the pixel position at
611 * that tile for a point in the smallmap.
612 * @param px Horizontal coordinate of the pixel.
613 * @param py Vertical coordinate of the pixel.
614 * @param sub[out] Pixel position at the tile (0..3).
615 * @param add_sub Add current #subscroll to the position.
616 * @return Tile being displayed at the given position relative to #scroll_x and #scroll_y.
617 * @note The #subscroll offset is already accounted for.
619 inline Point
SmallMapWindow::PixelToTile(int px
, int py
, int *sub
, bool add_sub
) const
621 if (add_sub
) px
+= this->subscroll
; // Total horizontal offset.
623 /* For each two rows down, add a x and a y tile, and
624 * For each four pixels to the right, move a tile to the right. */
625 Point pt
= {((py
>> 1) - (px
>> 2)) * this->zoom
, ((py
>> 1) + (px
>> 2)) * this->zoom
};
628 if (py
& 1) { // Odd number of rows, handle the 2 pixel shift.
643 * Compute base parameters of the smallmap such that tile (\a tx, \a ty) starts at pixel (\a x, \a y).
644 * @param tx Tile x coordinate.
645 * @param ty Tile y coordinate.
646 * @param x Non-negative horizontal position in the display where the tile starts.
647 * @param y Non-negative vertical position in the display where the tile starts.
648 * @param sub [out] Value of #subscroll needed.
649 * @return #scroll_x, #scroll_y values.
651 Point
SmallMapWindow::ComputeScroll(int tx
, int ty
, int x
, int y
, int *sub
)
653 assert(x
>= 0 && y
>= 0);
656 Point tile_xy
= PixelToTile(x
, y
, &new_sub
, false);
663 scroll
.x
= (tx
+ this->zoom
) * TILE_SIZE
;
664 scroll
.y
= (ty
- this->zoom
) * TILE_SIZE
;
667 scroll
.x
= (tx
+ 2 * this->zoom
) * TILE_SIZE
;
668 scroll
.y
= (ty
- 2 * this->zoom
) * TILE_SIZE
;
674 * Initialize or change the zoom level.
675 * @param change Way to change the zoom level.
676 * @param zoom_pt Position to keep fixed while zooming.
677 * @pre \c *zoom_pt should contain a point in the smallmap display when zooming in or out.
679 void SmallMapWindow::SetZoomLevel(ZoomLevelChange change
, const Point
*zoom_pt
)
681 static const int zoomlevels
[] = {1, 2, 4, 6, 8}; // Available zoom levels. Bigger number means more zoom-out (further away).
682 static const int MIN_ZOOM_INDEX
= 0;
683 static const int MAX_ZOOM_INDEX
= lengthof(zoomlevels
) - 1;
685 int new_index
, cur_index
, sub
;
689 cur_index
= - 1; // Definitely different from new_index.
690 new_index
= MIN_ZOOM_INDEX
;
696 for (cur_index
= MIN_ZOOM_INDEX
; cur_index
<= MAX_ZOOM_INDEX
; cur_index
++) {
697 if (this->zoom
== zoomlevels
[cur_index
]) break;
699 assert(cur_index
<= MAX_ZOOM_INDEX
);
701 tile
= this->PixelToTile(zoom_pt
->x
, zoom_pt
->y
, &sub
);
702 new_index
= Clamp(cur_index
+ ((change
== ZLC_ZOOM_IN
) ? -1 : 1), MIN_ZOOM_INDEX
, MAX_ZOOM_INDEX
);
705 default: NOT_REACHED();
708 if (new_index
!= cur_index
) {
709 this->zoom
= zoomlevels
[new_index
];
710 if (cur_index
>= 0) {
711 Point new_tile
= this->PixelToTile(zoom_pt
->x
, zoom_pt
->y
, &sub
);
712 this->SetNewScroll(this->scroll_x
+ (tile
.x
- new_tile
.x
) * TILE_SIZE
,
713 this->scroll_y
+ (tile
.y
- new_tile
.y
) * TILE_SIZE
, sub
);
714 } else if (this->map_type
== SMT_LINKSTATS
) {
715 this->overlay
->RebuildCache();
717 this->SetWidgetDisabledState(WID_SM_ZOOM_IN
, this->zoom
== zoomlevels
[MIN_ZOOM_INDEX
]);
718 this->SetWidgetDisabledState(WID_SM_ZOOM_OUT
, this->zoom
== zoomlevels
[MAX_ZOOM_INDEX
]);
724 * Decide which colours to show to the user for a group of tiles.
725 * @param ta Tile area to investigate.
726 * @return Colours to display.
728 inline uint32
SmallMapWindow::GetTileColours(const TileArea
&ta
) const
731 TileIndex tile
= INVALID_TILE
; // Position of the most important tile.
732 TileType et
= MP_VOID
; // Effective tile type at that position.
734 TILE_AREA_LOOP(ti
, ta
) {
735 TileType ttype
= GetTileType(ti
);
738 case MP_TUNNELBRIDGE
: {
739 TransportType tt
= GetTunnelBridgeTransportType(ti
);
742 case TRANSPORT_RAIL
: ttype
= MP_RAILWAY
; break;
743 case TRANSPORT_ROAD
: ttype
= MP_ROAD
; break;
744 default: ttype
= MP_WATER
; break;
750 /* Special handling of industries while in "Industries" smallmap view. */
751 if (this->map_type
== SMT_INDUSTRY
) {
752 /* If industry is allowed to be seen, use its colour on the map.
753 * This has the highest priority above any value in _tiletype_importance. */
754 IndustryType type
= Industry::GetByTile(ti
)->type
;
755 if (_legend_from_industries
[_industry_to_list_pos
[type
]].show_on_map
) {
756 if (type
== _smallmap_industry_highlight
) {
757 if (_smallmap_industry_highlight_state
) return MKCOLOUR_XXXX(PC_WHITE
);
759 return GetIndustrySpec(type
)->map_colour
* 0x01010101;
762 /* Otherwise make it disappear */
763 ttype
= IsTileOnWater(ti
) ? MP_WATER
: MP_CLEAR
;
771 if (_tiletype_importance
[ttype
] > importance
) {
772 importance
= _tiletype_importance
[ttype
];
778 switch (this->map_type
) {
780 return GetSmallMapContoursPixels(tile
, et
);
783 return GetSmallMapVehiclesPixels(tile
, et
);
786 return GetSmallMapIndustriesPixels(tile
, et
);
789 return GetSmallMapLinkStatsPixels(tile
, et
);
792 return GetSmallMapRoutesPixels(tile
, et
);
795 return GetSmallMapVegetationPixels(tile
, et
);
798 return GetSmallMapOwnerPixels(tile
, et
);
800 default: NOT_REACHED();
805 * Draws one column of tiles of the small map in a certain mode onto the screen buffer, skipping the shifted rows in between.
807 * @param dst Pointer to a part of the screen buffer to write to.
808 * @param xc The X coordinate of the first tile in the column.
809 * @param yc The Y coordinate of the first tile in the column
810 * @param pitch Number of pixels to advance in the screen buffer each time a pixel is written.
811 * @param reps Number of lines to draw
812 * @param start_pos Position of first pixel to draw.
813 * @param end_pos Position of last pixel to draw (exclusive).
814 * @param blitter current blitter
815 * @note If pixel position is below \c 0, skip drawing.
817 void SmallMapWindow::DrawSmallMapColumn(void *dst
, uint xc
, uint yc
, int pitch
, int reps
, int start_pos
, int end_pos
, Blitter
*blitter
) const
819 void *dst_ptr_abs_end
= blitter
->MoveTo(_screen
.dst_ptr
, 0, _screen
.height
);
820 uint min_xy
= _settings_game
.construction
.freeform_edges
? 1 : 0;
823 /* Check if the tile (xc,yc) is within the map range */
824 if (xc
>= MapMaxX() || yc
>= MapMaxY()) continue;
826 /* Check if the dst pointer points to a pixel inside the screen buffer */
827 if (dst
< _screen
.dst_ptr
) continue;
828 if (dst
>= dst_ptr_abs_end
) continue;
830 /* Construct tilearea covered by (xc, yc, xc + this->zoom, yc + this->zoom) such that it is within min_xy limits. */
832 if (min_xy
== 1 && (xc
== 0 || yc
== 0)) {
833 if (this->zoom
== 1) continue; // The tile area is empty, don't draw anything.
835 ta
= TileArea(TileXY(max(min_xy
, xc
), max(min_xy
, yc
)), this->zoom
- (xc
== 0), this->zoom
- (yc
== 0));
837 ta
= TileArea(TileXY(xc
, yc
), this->zoom
, this->zoom
);
839 ta
.ClampToMap(); // Clamp to map boundaries (may contain MP_VOID tiles!).
841 uint32 val
= this->GetTileColours(ta
);
842 uint8
*val8
= (uint8
*)&val
;
843 int idx
= max(0, -start_pos
);
844 for (int pos
= max(0, start_pos
); pos
< end_pos
; pos
++) {
845 blitter
->SetPixel(dst
, idx
, 0, val8
[idx
]);
848 /* Switch to next tile in the column */
849 } while (xc
+= this->zoom
, yc
+= this->zoom
, dst
= blitter
->MoveTo(dst
, pitch
, 0), --reps
!= 0);
853 * Adds vehicles to the smallmap.
854 * @param dpi the part of the smallmap to be drawn into
855 * @param blitter current blitter
857 void SmallMapWindow::DrawVehicles(const DrawPixelInfo
*dpi
, Blitter
*blitter
) const
860 FOR_ALL_VEHICLES(v
) {
861 if (v
->type
== VEH_EFFECT
) continue;
862 if (v
->vehstatus
& (VS_HIDDEN
| VS_UNCLICKABLE
)) continue;
864 /* Remap into flat coordinates. */
865 Point pt
= this->RemapTile(v
->x_pos
/ (int)TILE_SIZE
, v
->y_pos
/ (int)TILE_SIZE
);
867 int y
= pt
.y
- dpi
->top
;
868 if (!IsInsideMM(y
, 0, dpi
->height
)) continue; // y is out of bounds.
870 bool skip
= false; // Default is to draw both pixels.
871 int x
= pt
.x
- this->subscroll
- 3 - dpi
->left
; // Offset X coordinate.
873 /* if x+1 is 0, that means we're on the very left edge,
874 * and should thus only draw a single pixel */
875 if (++x
!= 0) continue;
877 } else if (x
>= dpi
->width
- 1) {
878 /* Check if we're at the very right edge, and if so draw only a single pixel */
879 if (x
!= dpi
->width
- 1) continue;
883 /* Calculate pointer to pixel and the colour */
884 byte colour
= (this->map_type
== SMT_VEHICLES
) ? _vehicle_type_colours
[v
->type
] : PC_WHITE
;
886 /* And draw either one or two pixels depending on clipping */
887 blitter
->SetPixel(dpi
->dst_ptr
, x
, y
, colour
);
888 if (!skip
) blitter
->SetPixel(dpi
->dst_ptr
, x
+ 1, y
, colour
);
893 * Adds town names to the smallmap.
894 * @param dpi the part of the smallmap to be drawn into
896 void SmallMapWindow::DrawTowns(const DrawPixelInfo
*dpi
) const
900 /* Remap the town coordinate */
901 Point pt
= this->RemapTile(TileX(t
->xy
), TileY(t
->xy
));
902 int x
= pt
.x
- this->subscroll
- (t
->cache
.sign
.width_small
>> 1);
905 /* Check if the town sign is within bounds */
906 if (x
+ t
->cache
.sign
.width_small
> dpi
->left
&&
907 x
< dpi
->left
+ dpi
->width
&&
908 y
+ FONT_HEIGHT_SMALL
> dpi
->top
&&
909 y
< dpi
->top
+ dpi
->height
) {
911 SetDParam(0, t
->index
);
912 DrawString(x
, x
+ t
->cache
.sign
.width_small
, y
, STR_SMALLMAP_TOWN
);
918 * Adds map indicators to the smallmap.
920 void SmallMapWindow::DrawMapIndicators() const
922 /* Find main viewport. */
923 const ViewPort
*vp
= FindWindowById(WC_MAIN_WINDOW
, 0)->viewport
;
925 Point upper_left_smallmap_coord
= TranslateXYToTileCoord(vp
, vp
->left
, vp
->top
, false);
926 Point lower_right_smallmap_coord
= TranslateXYToTileCoord(vp
, vp
->left
+ vp
->width
- 1, vp
->top
+ vp
->height
- 1, false);
928 Point upper_left
= this->RemapTile(upper_left_smallmap_coord
.x
/ (int)TILE_SIZE
, upper_left_smallmap_coord
.y
/ (int)TILE_SIZE
);
929 upper_left
.x
-= this->subscroll
;
931 Point lower_right
= this->RemapTile(lower_right_smallmap_coord
.x
/ (int)TILE_SIZE
, lower_right_smallmap_coord
.y
/ (int)TILE_SIZE
);
932 lower_right
.x
-= this->subscroll
;
934 SmallMapWindow::DrawVertMapIndicator(upper_left
.x
, upper_left
.y
, lower_right
.y
);
935 SmallMapWindow::DrawVertMapIndicator(lower_right
.x
, upper_left
.y
, lower_right
.y
);
937 SmallMapWindow::DrawHorizMapIndicator(upper_left
.x
, lower_right
.x
, upper_left
.y
);
938 SmallMapWindow::DrawHorizMapIndicator(upper_left
.x
, lower_right
.x
, lower_right
.y
);
942 * Draws the small map.
944 * Basically, the small map is draw column of pixels by column of pixels. The pixels
945 * are drawn directly into the screen buffer. The final map is drawn in multiple passes.
947 * <ol><li>The colours of tiles in the different modes.</li>
948 * <li>Town names (optional)</li></ol>
950 * @param dpi pointer to pixel to write onto
952 void SmallMapWindow::DrawSmallMap(DrawPixelInfo
*dpi
) const
954 Blitter
*blitter
= BlitterFactory::GetCurrentBlitter();
955 DrawPixelInfo
*old_dpi
;
961 GfxFillRect(dpi
->left
, dpi
->top
, dpi
->left
+ dpi
->width
- 1, dpi
->top
+ dpi
->height
- 1, PC_BLACK
);
963 /* Which tile is displayed at (dpi->left, dpi->top)? */
965 Point tile
= this->PixelToTile(dpi
->left
, dpi
->top
, &dx
);
966 int tile_x
= this->scroll_x
/ (int)TILE_SIZE
+ tile
.x
;
967 int tile_y
= this->scroll_y
/ (int)TILE_SIZE
+ tile
.y
;
969 void *ptr
= blitter
->MoveTo(dpi
->dst_ptr
, -dx
- 4, 0);
974 /* Distance from left edge */
976 if (x
>= dpi
->width
) break; // Exit the loop.
978 int end_pos
= min(dpi
->width
, x
+ 4);
979 int reps
= (dpi
->height
- y
+ 1) / 2; // Number of lines.
981 this->DrawSmallMapColumn(ptr
, tile_x
, tile_y
, dpi
->pitch
* 2, reps
, x
, end_pos
, blitter
);
986 tile_y
+= this->zoom
;
988 ptr
= blitter
->MoveTo(ptr
, 0, 1);
990 tile_x
-= this->zoom
;
992 ptr
= blitter
->MoveTo(ptr
, 0, -1);
994 ptr
= blitter
->MoveTo(ptr
, 2, 0);
999 if (this->map_type
== SMT_CONTOUR
|| this->map_type
== SMT_VEHICLES
) this->DrawVehicles(dpi
, blitter
);
1001 /* Draw link stat overlay */
1002 if (this->map_type
== SMT_LINKSTATS
) this->overlay
->Draw(dpi
);
1004 /* Draw town names */
1005 if (this->show_towns
) this->DrawTowns(dpi
);
1007 /* Draw map indicators */
1008 this->DrawMapIndicators();
1014 * Function to set up widgets depending on the information being shown on the smallmap.
1016 void SmallMapWindow::SetupWidgetData()
1018 StringID legend_tooltip
;
1019 StringID enable_all_tooltip
;
1020 StringID disable_all_tooltip
;
1022 switch (this->map_type
) {
1024 legend_tooltip
= STR_SMALLMAP_TOOLTIP_INDUSTRY_SELECTION
;
1025 enable_all_tooltip
= STR_SMALLMAP_TOOLTIP_ENABLE_ALL_INDUSTRIES
;
1026 disable_all_tooltip
= STR_SMALLMAP_TOOLTIP_DISABLE_ALL_INDUSTRIES
;
1031 legend_tooltip
= STR_SMALLMAP_TOOLTIP_COMPANY_SELECTION
;
1032 enable_all_tooltip
= STR_SMALLMAP_TOOLTIP_ENABLE_ALL_COMPANIES
;
1033 disable_all_tooltip
= STR_SMALLMAP_TOOLTIP_DISABLE_ALL_COMPANIES
;
1038 legend_tooltip
= STR_SMALLMAP_TOOLTIP_CARGO_SELECTION
;
1039 enable_all_tooltip
= STR_SMALLMAP_TOOLTIP_ENABLE_ALL_CARGOS
;
1040 disable_all_tooltip
= STR_SMALLMAP_TOOLTIP_DISABLE_ALL_CARGOS
;
1045 legend_tooltip
= STR_NULL
;
1046 enable_all_tooltip
= STR_NULL
;
1047 disable_all_tooltip
= STR_NULL
;
1052 this->GetWidget
<NWidgetCore
>(WID_SM_LEGEND
)->SetDataTip(STR_NULL
, legend_tooltip
);
1053 this->GetWidget
<NWidgetCore
>(WID_SM_ENABLE_ALL
)->SetDataTip(STR_SMALLMAP_ENABLE_ALL
, enable_all_tooltip
);
1054 this->GetWidget
<NWidgetCore
>(WID_SM_DISABLE_ALL
)->SetDataTip(STR_SMALLMAP_DISABLE_ALL
, disable_all_tooltip
);
1055 this->GetWidget
<NWidgetStacked
>(WID_SM_SELECT_BUTTONS
)->SetDisplayedPlane(plane
);
1058 SmallMapWindow::SmallMapWindow(WindowDesc
*desc
, int window_number
) : Window(desc
), refresh(FORCE_REFRESH_PERIOD
)
1060 _smallmap_industry_highlight
= INVALID_INDUSTRYTYPE
;
1061 this->overlay
= new LinkGraphOverlay(this, WID_SM_MAP
, 0, this->GetOverlayCompanyMask(), 1);
1062 this->InitNested(window_number
);
1063 this->LowerWidget(this->map_type
+ WID_SM_CONTOUR
);
1065 this->RebuildColourIndexIfNecessary();
1067 this->SetWidgetLoweredState(WID_SM_SHOW_HEIGHT
, _smallmap_show_heightmap
);
1069 this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME
, this->show_towns
);
1071 this->SetupWidgetData();
1073 this->SetZoomLevel(ZLC_INITIALIZE
, NULL
);
1074 this->SmallMapCenterOnCurrentPos();
1075 this->SetOverlayCargoMask();
1078 SmallMapWindow::~SmallMapWindow()
1080 delete this->overlay
;
1081 this->BreakIndustryChainLink();
1085 * Rebuilds the colour indices used for fast access to the smallmap contour colours based on the heightlevel.
1087 void SmallMapWindow::RebuildColourIndexIfNecessary()
1089 /* Rebuild colour indices if necessary. */
1090 if (SmallMapWindow::max_heightlevel
== _settings_game
.construction
.max_heightlevel
) return;
1092 for (uint n
= 0; n
< lengthof(_heightmap_schemes
); n
++) {
1093 /* The heights go from 0 up to and including maximum. */
1094 int heights
= _settings_game
.construction
.max_heightlevel
+ 1;
1095 _heightmap_schemes
[n
].height_colours
= ReallocT
<uint32
>(_heightmap_schemes
[n
].height_colours
, heights
);
1097 for (int z
= 0; z
< heights
; z
++) {
1098 size_t access_index
= (_heightmap_schemes
[n
].colour_count
* z
) / heights
;
1100 /* Choose colour by mapping the range (0..max heightlevel) on the complete colour table. */
1101 _heightmap_schemes
[n
].height_colours
[z
] = _heightmap_schemes
[n
].height_colours_base
[access_index
];
1105 SmallMapWindow::max_heightlevel
= _settings_game
.construction
.max_heightlevel
;
1109 /* virtual */ void SmallMapWindow::SetStringParameters(int widget
) const
1112 case WID_SM_CAPTION
:
1113 SetDParam(0, STR_SMALLMAP_TYPE_CONTOURS
+ this->map_type
);
1118 /* virtual */ void SmallMapWindow::OnInit()
1121 this->min_number_of_columns
= INDUSTRY_MIN_NUMBER_OF_COLUMNS
;
1122 this->min_number_of_fixed_rows
= lengthof(_linkstat_colours_in_legenda
);
1123 for (uint i
= 0; i
< lengthof(_legend_table
); i
++) {
1125 uint num_columns
= 1;
1126 for (const LegendAndColour
*tbl
= _legend_table
[i
]; !tbl
->end
; ++tbl
) {
1128 if (i
== SMT_INDUSTRY
) {
1129 SetDParam(0, tbl
->legend
);
1130 SetDParam(1, IndustryPool::MAX_SIZE
);
1131 str
= STR_SMALLMAP_INDUSTRY
;
1132 } else if (i
== SMT_LINKSTATS
) {
1133 SetDParam(0, tbl
->legend
);
1134 str
= STR_SMALLMAP_LINKSTATS
;
1135 } else if (i
== SMT_OWNER
) {
1136 if (tbl
->company
!= INVALID_COMPANY
) {
1137 if (!Company::IsValidID(tbl
->company
)) {
1138 /* Rebuild the owner legend. */
1143 /* Non-fixed legend entries for the owner view. */
1144 SetDParam(0, tbl
->company
);
1145 str
= STR_SMALLMAP_COMPANY
;
1150 if (tbl
->col_break
) {
1151 this->min_number_of_fixed_rows
= max(this->min_number_of_fixed_rows
, height
);
1158 min_width
= max(GetStringBoundingBox(str
).width
, min_width
);
1160 this->min_number_of_fixed_rows
= max(this->min_number_of_fixed_rows
, height
);
1161 this->min_number_of_columns
= max(this->min_number_of_columns
, num_columns
);
1164 /* The width of a column is the minimum width of all texts + the size of the blob + some spacing */
1165 this->column_width
= min_width
+ LEGEND_BLOB_WIDTH
+ WD_FRAMERECT_LEFT
+ WD_FRAMERECT_RIGHT
;
1168 /* virtual */ void SmallMapWindow::OnPaint()
1170 if (this->map_type
== SMT_OWNER
) {
1171 for (const LegendAndColour
*tbl
= _legend_table
[this->map_type
]; !tbl
->end
; ++tbl
) {
1172 if (tbl
->company
!= INVALID_COMPANY
&& !Company::IsValidID(tbl
->company
)) {
1173 /* Rebuild the owner legend. */
1175 this->InvalidateData(1);
1181 this->DrawWidgets();
1184 /* virtual */ void SmallMapWindow::DrawWidget(const Rect
&r
, int widget
) const
1188 DrawPixelInfo new_dpi
;
1189 if (!FillDrawPixelInfo(&new_dpi
, r
.left
+ 1, r
.top
+ 1, r
.right
- r
.left
- 1, r
.bottom
- r
.top
- 1)) return;
1190 this->DrawSmallMap(&new_dpi
);
1194 case WID_SM_LEGEND
: {
1195 uint columns
= this->GetNumberColumnsLegend(r
.right
- r
.left
+ 1);
1196 uint number_of_rows
= this->GetNumberRowsLegend(columns
);
1197 bool rtl
= _current_text_dir
== TD_RTL
;
1198 uint y_org
= r
.top
+ WD_FRAMERECT_TOP
;
1199 uint x
= rtl
? r
.right
- this->column_width
- WD_FRAMERECT_RIGHT
: r
.left
+ WD_FRAMERECT_LEFT
;
1201 uint i
= 0; // Row counter for industry legend.
1202 uint row_height
= FONT_HEIGHT_SMALL
;
1204 uint text_left
= rtl
? 0 : LEGEND_BLOB_WIDTH
+ WD_FRAMERECT_LEFT
;
1205 uint text_right
= this->column_width
- 1 - (rtl
? LEGEND_BLOB_WIDTH
+ WD_FRAMERECT_RIGHT
: 0);
1206 uint blob_left
= rtl
? this->column_width
- 1 - LEGEND_BLOB_WIDTH
: 0;
1207 uint blob_right
= rtl
? this->column_width
- 1 : LEGEND_BLOB_WIDTH
;
1209 StringID string
= STR_NULL
;
1210 switch (this->map_type
) {
1212 string
= STR_SMALLMAP_INDUSTRY
;
1215 string
= STR_SMALLMAP_LINKSTATS
;
1218 string
= STR_SMALLMAP_COMPANY
;
1224 for (const LegendAndColour
*tbl
= _legend_table
[this->map_type
]; !tbl
->end
; ++tbl
) {
1225 if (tbl
->col_break
|| ((this->map_type
== SMT_INDUSTRY
|| this->map_type
== SMT_OWNER
|| this->map_type
== SMT_LINKSTATS
) && i
++ >= number_of_rows
)) {
1226 /* Column break needed, continue at top, COLUMN_WIDTH pixels
1227 * (one "row") to the right. */
1228 x
+= rtl
? -(int)this->column_width
: this->column_width
;
1233 uint8 legend_colour
= tbl
->colour
;
1235 switch (this->map_type
) {
1237 /* Industry name must be formatted, since it's not in tiny font in the specs.
1238 * So, draw with a parameter and use the STR_SMALLMAP_INDUSTRY string, which is tiny font */
1239 SetDParam(0, tbl
->legend
);
1240 SetDParam(1, Industry::GetIndustryTypeCount(tbl
->type
));
1241 if (tbl
->show_on_map
&& tbl
->type
== _smallmap_industry_highlight
) {
1242 legend_colour
= _smallmap_industry_highlight_state
? PC_WHITE
: PC_BLACK
;
1247 SetDParam(0, tbl
->legend
);
1251 if (this->map_type
!= SMT_OWNER
|| tbl
->company
!= INVALID_COMPANY
) {
1252 if (this->map_type
== SMT_OWNER
) SetDParam(0, tbl
->company
);
1253 if (!tbl
->show_on_map
) {
1254 /* Simply draw the string, not the black border of the legend colour.
1255 * This will enforce the idea of the disabled item */
1256 DrawString(x
+ text_left
, x
+ text_right
, y
, string
, TC_GREY
);
1258 DrawString(x
+ text_left
, x
+ text_right
, y
, string
, TC_BLACK
);
1259 GfxFillRect(x
+ blob_left
, y
+ 1, x
+ blob_right
, y
+ row_height
- 1, PC_BLACK
); // Outer border of the legend colour
1266 if (this->map_type
== SMT_CONTOUR
) SetDParam(0, tbl
->height
* TILE_HEIGHT_STEP
);
1267 /* Anything that is not an industry or a company is using normal process */
1268 GfxFillRect(x
+ blob_left
, y
+ 1, x
+ blob_right
, y
+ row_height
- 1, PC_BLACK
);
1269 DrawString(x
+ text_left
, x
+ text_right
, y
, tbl
->legend
);
1272 GfxFillRect(x
+ blob_left
+ 1, y
+ 2, x
+ blob_right
- 1, y
+ row_height
- 2, legend_colour
); // Legend colour
1281 * Select a new map type.
1282 * @param map_type New map type.
1284 void SmallMapWindow::SwitchMapType(SmallMapType map_type
)
1286 this->RaiseWidget(this->map_type
+ WID_SM_CONTOUR
);
1287 this->map_type
= map_type
;
1288 this->LowerWidget(this->map_type
+ WID_SM_CONTOUR
);
1290 this->SetupWidgetData();
1292 if (map_type
== SMT_LINKSTATS
) this->overlay
->RebuildCache();
1293 if (map_type
!= SMT_INDUSTRY
) this->BreakIndustryChainLink();
1298 * Get the number of rows in the legend from the number of columns. Those
1299 * are at least min_number_of_fixed_rows and possibly more if there are so
1300 * many cargoes, industry types or companies that they won't fit in the
1302 * @param columns Number of columns in the legend.
1303 * @return Number of rows needed for everything to fit in.
1305 inline uint
SmallMapWindow::GetNumberRowsLegend(uint columns
) const
1307 /* Reserve one column for link colours */
1308 uint num_rows_linkstats
= CeilDiv(_smallmap_cargo_count
, columns
- 1);
1309 uint num_rows_others
= CeilDiv(max(_smallmap_industry_count
, _smallmap_company_count
), columns
);
1310 return max(this->min_number_of_fixed_rows
, max(num_rows_linkstats
, num_rows_others
));
1314 * Select and toggle a legend item. When CTRL is pressed, disable all other
1315 * items in the group defined by begin_legend_item and end_legend_item and
1316 * keep the clicked one enabled even if it was already enabled before. If
1317 * the other items in the group are all disabled already and CTRL is pressed
1318 * enable them instead.
1319 * @param click_pos the index of the item being selected
1320 * @param legend the legend from which we select
1321 * @param end_legend_item index one past the last item in the group to be inverted
1322 * @param begin_legend_item index of the first item in the group to be inverted
1324 void SmallMapWindow::SelectLegendItem(int click_pos
, LegendAndColour
*legend
, int end_legend_item
, int begin_legend_item
)
1326 if (_ctrl_pressed
) {
1327 /* Disable all, except the clicked one */
1328 bool changes
= false;
1329 for (int i
= begin_legend_item
; i
!= end_legend_item
; i
++) {
1330 bool new_state
= (i
== click_pos
);
1331 if (legend
[i
].show_on_map
!= new_state
) {
1333 legend
[i
].show_on_map
= new_state
;
1337 /* Nothing changed? Then show all (again). */
1338 for (int i
= begin_legend_item
; i
!= end_legend_item
; i
++) {
1339 legend
[i
].show_on_map
= true;
1343 legend
[click_pos
].show_on_map
= !legend
[click_pos
].show_on_map
;
1346 if (this->map_type
== SMT_INDUSTRY
) this->BreakIndustryChainLink();
1350 * Set the link graph overlay cargo mask from the legend.
1352 void SmallMapWindow::SetOverlayCargoMask()
1354 uint32 cargo_mask
= 0;
1355 for (int i
= 0; i
!= _smallmap_cargo_count
; ++i
) {
1356 if (_legend_linkstats
[i
].show_on_map
) SetBit(cargo_mask
, _legend_linkstats
[i
].type
);
1358 this->overlay
->SetCargoMask(cargo_mask
);
1362 * Determines the mouse position on the legend.
1363 * @param pt Mouse position.
1364 * @return Legend item under the mouse.
1366 int SmallMapWindow::GetPositionOnLegend(Point pt
)
1368 const NWidgetBase
*wi
= this->GetWidget
<NWidgetBase
>(WID_SM_LEGEND
);
1369 uint line
= (pt
.y
- wi
->pos_y
- WD_FRAMERECT_TOP
) / FONT_HEIGHT_SMALL
;
1370 uint columns
= this->GetNumberColumnsLegend(wi
->current_x
);
1371 uint number_of_rows
= this->GetNumberRowsLegend(columns
);
1372 if (line
>= number_of_rows
) return -1;
1374 bool rtl
= _current_text_dir
== TD_RTL
;
1375 int x
= pt
.x
- wi
->pos_x
;
1376 if (rtl
) x
= wi
->current_x
- x
;
1377 uint column
= (x
- WD_FRAMERECT_LEFT
) / this->column_width
;
1379 return (column
* number_of_rows
) + line
;
1382 /* virtual */ void SmallMapWindow::OnMouseOver(Point pt
, int widget
)
1384 IndustryType new_highlight
= INVALID_INDUSTRYTYPE
;
1385 if (widget
== WID_SM_LEGEND
&& this->map_type
== SMT_INDUSTRY
) {
1386 int industry_pos
= GetPositionOnLegend(pt
);
1387 if (industry_pos
>= 0 && industry_pos
< _smallmap_industry_count
) {
1388 new_highlight
= _legend_from_industries
[industry_pos
].type
;
1391 if (new_highlight
!= _smallmap_industry_highlight
) {
1392 _smallmap_industry_highlight
= new_highlight
;
1393 this->refresh
= _smallmap_industry_highlight
!= INVALID_INDUSTRYTYPE
? BLINK_PERIOD
: FORCE_REFRESH_PERIOD
;
1394 _smallmap_industry_highlight_state
= true;
1399 /* virtual */ void SmallMapWindow::OnClick(Point pt
, int widget
, int click_count
)
1402 case WID_SM_MAP
: { // Map window
1404 * XXX: scrolling with the left mouse button is done by subsequently
1405 * clicking with the left mouse button; clicking once centers the
1406 * large map at the selected point. So by unclicking the left mouse
1407 * button here, it gets reclicked during the next inputloop, which
1408 * would make it look like the mouse is being dragged, while it is
1409 * actually being (virtually) clicked every inputloop.
1411 _left_button_clicked
= false;
1413 const NWidgetBase
*wid
= this->GetWidget
<NWidgetBase
>(WID_SM_MAP
);
1414 Window
*w
= FindWindowById(WC_MAIN_WINDOW
, 0);
1416 pt
= this->PixelToTile(pt
.x
- wid
->pos_x
, pt
.y
- wid
->pos_y
, &sub
);
1417 ScrollWindowTo(this->scroll_x
+ pt
.x
* TILE_SIZE
, this->scroll_y
+ pt
.y
* TILE_SIZE
, -1, w
);
1423 case WID_SM_ZOOM_IN
:
1424 case WID_SM_ZOOM_OUT
: {
1425 const NWidgetBase
*wid
= this->GetWidget
<NWidgetBase
>(WID_SM_MAP
);
1426 Point pt
= { (int)wid
->current_x
/ 2, (int)wid
->current_y
/ 2};
1427 this->SetZoomLevel((widget
== WID_SM_ZOOM_IN
) ? ZLC_ZOOM_IN
: ZLC_ZOOM_OUT
, &pt
);
1428 if (_settings_client
.sound
.click_beep
) SndPlayFx(SND_15_BEEP
);
1432 case WID_SM_CONTOUR
: // Show land contours
1433 case WID_SM_VEHICLES
: // Show vehicles
1434 case WID_SM_INDUSTRIES
: // Show industries
1435 case WID_SM_LINKSTATS
: // Show route map
1436 case WID_SM_ROUTES
: // Show transport routes
1437 case WID_SM_VEGETATION
: // Show vegetation
1438 case WID_SM_OWNERS
: // Show land owners
1439 this->SwitchMapType((SmallMapType
)(widget
- WID_SM_CONTOUR
));
1440 if (_settings_client
.sound
.click_beep
) SndPlayFx(SND_15_BEEP
);
1443 case WID_SM_CENTERMAP
: // Center the smallmap again
1444 this->SmallMapCenterOnCurrentPos();
1445 this->HandleButtonClick(WID_SM_CENTERMAP
);
1446 if (_settings_client
.sound
.click_beep
) SndPlayFx(SND_15_BEEP
);
1449 case WID_SM_TOGGLETOWNNAME
: // Toggle town names
1450 this->show_towns
= !this->show_towns
;
1451 this->SetWidgetLoweredState(WID_SM_TOGGLETOWNNAME
, this->show_towns
);
1454 if (_settings_client
.sound
.click_beep
) SndPlayFx(SND_15_BEEP
);
1457 case WID_SM_LEGEND
: // Legend
1458 if (this->map_type
== SMT_INDUSTRY
|| this->map_type
== SMT_LINKSTATS
|| this->map_type
== SMT_OWNER
) {
1459 int click_pos
= this->GetPositionOnLegend(pt
);
1460 if (click_pos
< 0) break;
1462 /* If industry type small map*/
1463 if (this->map_type
== SMT_INDUSTRY
) {
1464 /* If click on industries label, find right industry type and enable/disable it. */
1465 if (click_pos
< _smallmap_industry_count
) {
1466 this->SelectLegendItem(click_pos
, _legend_from_industries
, _smallmap_industry_count
);
1468 } else if (this->map_type
== SMT_LINKSTATS
) {
1469 if (click_pos
< _smallmap_cargo_count
) {
1470 this->SelectLegendItem(click_pos
, _legend_linkstats
, _smallmap_cargo_count
);
1471 this->SetOverlayCargoMask();
1473 } else if (this->map_type
== SMT_OWNER
) {
1474 if (click_pos
< _smallmap_company_count
) {
1475 this->SelectLegendItem(click_pos
, _legend_land_owners
, _smallmap_company_count
, NUM_NO_COMPANY_ENTRIES
);
1482 case WID_SM_ENABLE_ALL
:
1483 case WID_SM_DISABLE_ALL
: {
1484 LegendAndColour
*tbl
= NULL
;
1485 switch (this->map_type
) {
1487 tbl
= _legend_from_industries
;
1488 this->BreakIndustryChainLink();
1491 tbl
= &(_legend_land_owners
[NUM_NO_COMPANY_ENTRIES
]);
1494 tbl
= _legend_linkstats
;
1499 for (;!tbl
->end
&& tbl
->legend
!= STR_LINKGRAPH_LEGEND_UNUSED
; ++tbl
) {
1500 tbl
->show_on_map
= (widget
== WID_SM_ENABLE_ALL
);
1502 if (this->map_type
== SMT_LINKSTATS
) this->SetOverlayCargoMask();
1507 case WID_SM_SHOW_HEIGHT
: // Enable/disable showing of heightmap.
1508 _smallmap_show_heightmap
= !_smallmap_show_heightmap
;
1509 this->SetWidgetLoweredState(WID_SM_SHOW_HEIGHT
, _smallmap_show_heightmap
);
1516 * Some data on this window has become invalid.
1517 * @param data Information about the changed data.
1518 * - data = 0: Displayed industries at the industry chain window have changed.
1519 * - data = 1: Companies have changed.
1520 * - data = 2: Cheat changing the maximum heightlevel has been used, rebuild our heightlevel-to-colour index
1521 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
1523 /* virtual */ void SmallMapWindow::OnInvalidateData(int data
, bool gui_scope
)
1525 if (!gui_scope
) return;
1529 /* The owner legend has already been rebuilt. */
1534 extern std::bitset
<NUM_INDUSTRYTYPES
> _displayed_industries
;
1535 if (this->map_type
!= SMT_INDUSTRY
) this->SwitchMapType(SMT_INDUSTRY
);
1537 for (int i
= 0; i
!= _smallmap_industry_count
; i
++) {
1538 _legend_from_industries
[i
].show_on_map
= _displayed_industries
.test(_legend_from_industries
[i
].type
);
1544 this->RebuildColourIndexIfNecessary();
1547 default: NOT_REACHED();
1552 /* virtual */ bool SmallMapWindow::OnRightClick(Point pt
, int widget
)
1554 if (widget
!= WID_SM_MAP
|| _scrolling_viewport
) return false;
1556 _scrolling_viewport
= true;
1560 /* virtual */ void SmallMapWindow::OnMouseWheel(int wheel
)
1562 if (_settings_client
.gui
.scrollwheel_scrolling
== 0) {
1563 const NWidgetBase
*wid
= this->GetWidget
<NWidgetBase
>(WID_SM_MAP
);
1564 int cursor_x
= _cursor
.pos
.x
- this->left
- wid
->pos_x
;
1565 int cursor_y
= _cursor
.pos
.y
- this->top
- wid
->pos_y
;
1566 if (IsInsideMM(cursor_x
, 0, wid
->current_x
) && IsInsideMM(cursor_y
, 0, wid
->current_y
)) {
1567 Point pt
= {cursor_x
, cursor_y
};
1568 this->SetZoomLevel((wheel
< 0) ? ZLC_ZOOM_IN
: ZLC_ZOOM_OUT
, &pt
);
1573 /* virtual */ void SmallMapWindow::OnTick()
1575 /* Update the window every now and then */
1576 if (--this->refresh
!= 0) return;
1578 if (this->map_type
== SMT_LINKSTATS
) {
1579 uint32 company_mask
= this->GetOverlayCompanyMask();
1580 if (this->overlay
->GetCompanyMask() != company_mask
) {
1581 this->overlay
->SetCompanyMask(company_mask
);
1583 this->overlay
->RebuildCache();
1586 _smallmap_industry_highlight_state
= !_smallmap_industry_highlight_state
;
1588 this->refresh
= _smallmap_industry_highlight
!= INVALID_INDUSTRYTYPE
? BLINK_PERIOD
: FORCE_REFRESH_PERIOD
;
1593 * Set new #scroll_x, #scroll_y, and #subscroll values after limiting them such that the center
1594 * of the smallmap always contains a part of the map.
1595 * @param sx Proposed new #scroll_x
1596 * @param sy Proposed new #scroll_y
1597 * @param sub Proposed new #subscroll
1599 void SmallMapWindow::SetNewScroll(int sx
, int sy
, int sub
)
1601 const NWidgetBase
*wi
= this->GetWidget
<NWidgetBase
>(WID_SM_MAP
);
1602 Point hv
= InverseRemapCoords(wi
->current_x
* ZOOM_LVL_BASE
* TILE_SIZE
/ 2, wi
->current_y
* ZOOM_LVL_BASE
* TILE_SIZE
/ 2);
1610 if (sx
> (int)(MapMaxX() * TILE_SIZE
) - hv
.x
) {
1611 sx
= MapMaxX() * TILE_SIZE
- hv
.x
;
1618 if (sy
> (int)(MapMaxY() * TILE_SIZE
) - hv
.y
) {
1619 sy
= MapMaxY() * TILE_SIZE
- hv
.y
;
1623 this->scroll_x
= sx
;
1624 this->scroll_y
= sy
;
1625 this->subscroll
= sub
;
1626 if (this->map_type
== SMT_LINKSTATS
) this->overlay
->RebuildCache();
1629 /* virtual */ void SmallMapWindow::OnScroll(Point delta
)
1631 _cursor
.fix_at
= true;
1633 /* While tile is at (delta.x, delta.y)? */
1635 Point pt
= this->PixelToTile(delta
.x
, delta
.y
, &sub
);
1636 this->SetNewScroll(this->scroll_x
+ pt
.x
* TILE_SIZE
, this->scroll_y
+ pt
.y
* TILE_SIZE
, sub
);
1642 * Center the small map on the current center of the viewport.
1644 void SmallMapWindow::SmallMapCenterOnCurrentPos()
1646 const ViewPort
*vp
= FindWindowById(WC_MAIN_WINDOW
, 0)->viewport
;
1647 Point viewport_center
= TranslateXYToTileCoord(vp
, vp
->left
+ vp
->width
/ 2, vp
->top
+ vp
->height
/ 2);
1650 const NWidgetBase
*wid
= this->GetWidget
<NWidgetBase
>(WID_SM_MAP
);
1651 Point sxy
= this->ComputeScroll(viewport_center
.x
/ (int)TILE_SIZE
, viewport_center
.y
/ (int)TILE_SIZE
,
1652 max(0, (int)wid
->current_x
/ 2 - 2), wid
->current_y
/ 2, &sub
);
1653 this->SetNewScroll(sxy
.x
, sxy
.y
, sub
);
1658 * Get the center of the given station as point on the screen in the smallmap window.
1659 * @param st Station to find in the smallmap.
1660 * @return Point with coordinates of the station.
1662 Point
SmallMapWindow::GetStationMiddle(const Station
*st
) const
1664 int x
= (st
->rect
.right
+ st
->rect
.left
+ 1) / 2;
1665 int y
= (st
->rect
.bottom
+ st
->rect
.top
+ 1) / 2;
1666 Point ret
= this->RemapTile(x
, y
);
1668 /* Same magic 3 as in DrawVehicles; that's where I got it from.
1669 * No idea what it is, but without it the result looks bad.
1671 ret
.x
-= 3 + this->subscroll
;
1675 SmallMapWindow::SmallMapType
SmallMapWindow::map_type
= SMT_CONTOUR
;
1676 bool SmallMapWindow::show_towns
= true;
1677 int SmallMapWindow::max_heightlevel
= -1;
1680 * Custom container class for displaying smallmap with a vertically resizing legend panel.
1681 * The legend panel has a smallest height that depends on its width. Standard containers cannot handle this case.
1683 * @note The container assumes it has two children, the first is the display, the second is the bar with legends and selection image buttons.
1684 * Both children should be both horizontally and vertically resizable and horizontally fillable.
1685 * The bar should have a minimal size with a zero-size legends display. Child padding is not supported.
1687 class NWidgetSmallmapDisplay
: public NWidgetContainer
{
1688 const SmallMapWindow
*smallmap_window
; ///< Window manager instance.
1690 NWidgetSmallmapDisplay() : NWidgetContainer(NWID_VERTICAL
)
1692 this->smallmap_window
= NULL
;
1695 virtual void SetupSmallestSize(Window
*w
, bool init_array
)
1697 NWidgetBase
*display
= this->head
;
1698 NWidgetBase
*bar
= display
->next
;
1700 display
->SetupSmallestSize(w
, init_array
);
1701 bar
->SetupSmallestSize(w
, init_array
);
1703 this->smallmap_window
= dynamic_cast<SmallMapWindow
*>(w
);
1704 assert(this->smallmap_window
!= NULL
);
1705 this->smallest_x
= max(display
->smallest_x
, bar
->smallest_x
+ smallmap_window
->GetMinLegendWidth());
1706 this->smallest_y
= display
->smallest_y
+ max(bar
->smallest_y
, smallmap_window
->GetLegendHeight(smallmap_window
->min_number_of_columns
));
1707 this->fill_x
= max(display
->fill_x
, bar
->fill_x
);
1708 this->fill_y
= (display
->fill_y
== 0 && bar
->fill_y
== 0) ? 0 : min(display
->fill_y
, bar
->fill_y
);
1709 this->resize_x
= max(display
->resize_x
, bar
->resize_x
);
1710 this->resize_y
= min(display
->resize_y
, bar
->resize_y
);
1713 virtual void AssignSizePosition(SizingType sizing
, uint x
, uint y
, uint given_width
, uint given_height
, bool rtl
)
1717 this->current_x
= given_width
;
1718 this->current_y
= given_height
;
1720 NWidgetBase
*display
= this->head
;
1721 NWidgetBase
*bar
= display
->next
;
1723 if (sizing
== ST_SMALLEST
) {
1724 this->smallest_x
= given_width
;
1725 this->smallest_y
= given_height
;
1726 /* Make display and bar exactly equal to their minimal size. */
1727 display
->AssignSizePosition(ST_SMALLEST
, x
, y
, display
->smallest_x
, display
->smallest_y
, rtl
);
1728 bar
->AssignSizePosition(ST_SMALLEST
, x
, y
+ display
->smallest_y
, bar
->smallest_x
, bar
->smallest_y
, rtl
);
1731 uint bar_height
= max(bar
->smallest_y
, this->smallmap_window
->GetLegendHeight(this->smallmap_window
->GetNumberColumnsLegend(given_width
- bar
->smallest_x
)));
1732 uint display_height
= given_height
- bar_height
;
1733 display
->AssignSizePosition(ST_RESIZE
, x
, y
, given_width
, display_height
, rtl
);
1734 bar
->AssignSizePosition(ST_RESIZE
, x
, y
+ display_height
, given_width
, bar_height
, rtl
);
1737 virtual NWidgetCore
*GetWidgetFromPos(int x
, int y
)
1739 if (!IsInsideBS(x
, this->pos_x
, this->current_x
) || !IsInsideBS(y
, this->pos_y
, this->current_y
)) return NULL
;
1740 for (NWidgetBase
*child_wid
= this->head
; child_wid
!= NULL
; child_wid
= child_wid
->next
) {
1741 NWidgetCore
*widget
= child_wid
->GetWidgetFromPos(x
, y
);
1742 if (widget
!= NULL
) return widget
;
1747 virtual void Draw(const Window
*w
)
1749 for (NWidgetBase
*child_wid
= this->head
; child_wid
!= NULL
; child_wid
= child_wid
->next
) child_wid
->Draw(w
);
1753 /** Widget parts of the smallmap display. */
1754 static const NWidgetPart _nested_smallmap_display
[] = {
1755 NWidget(WWT_PANEL
, COLOUR_BROWN
, WID_SM_MAP_BORDER
),
1756 NWidget(WWT_INSET
, COLOUR_BROWN
, WID_SM_MAP
), SetMinimalSize(346, 140), SetResize(1, 1), SetPadding(2, 2, 2, 2), EndContainer(),
1760 /** Widget parts of the smallmap legend bar + image buttons. */
1761 static const NWidgetPart _nested_smallmap_bar
[] = {
1762 NWidget(WWT_PANEL
, COLOUR_BROWN
),
1763 NWidget(NWID_HORIZONTAL
),
1764 NWidget(WWT_EMPTY
, INVALID_COLOUR
, WID_SM_LEGEND
), SetResize(1, 1),
1765 NWidget(NWID_VERTICAL
),
1766 /* Top button row. */
1767 NWidget(NWID_HORIZONTAL
, NC_EQUALSIZE
),
1768 NWidget(WWT_PUSHIMGBTN
, COLOUR_BROWN
, WID_SM_ZOOM_IN
),
1769 SetDataTip(SPR_IMG_ZOOMIN
, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_IN
), SetFill(1, 1),
1770 NWidget(WWT_PUSHIMGBTN
, COLOUR_BROWN
, WID_SM_CENTERMAP
),
1771 SetDataTip(SPR_IMG_SMALLMAP
, STR_SMALLMAP_CENTER
), SetFill(1, 1),
1772 NWidget(WWT_IMGBTN
, COLOUR_BROWN
, WID_SM_BLANK
),
1773 SetDataTip(SPR_DOT_SMALL
, STR_NULL
), SetFill(1, 1),
1774 NWidget(WWT_IMGBTN
, COLOUR_BROWN
, WID_SM_CONTOUR
),
1775 SetDataTip(SPR_IMG_SHOW_COUNTOURS
, STR_SMALLMAP_TOOLTIP_SHOW_LAND_CONTOURS_ON_MAP
), SetFill(1, 1),
1776 NWidget(WWT_IMGBTN
, COLOUR_BROWN
, WID_SM_VEHICLES
),
1777 SetDataTip(SPR_IMG_SHOW_VEHICLES
, STR_SMALLMAP_TOOLTIP_SHOW_VEHICLES_ON_MAP
), SetFill(1, 1),
1778 NWidget(WWT_IMGBTN
, COLOUR_BROWN
, WID_SM_INDUSTRIES
),
1779 SetDataTip(SPR_IMG_INDUSTRY
, STR_SMALLMAP_TOOLTIP_SHOW_INDUSTRIES_ON_MAP
), SetFill(1, 1),
1781 /* Bottom button row. */
1782 NWidget(NWID_HORIZONTAL
, NC_EQUALSIZE
),
1783 NWidget(WWT_PUSHIMGBTN
, COLOUR_BROWN
, WID_SM_ZOOM_OUT
),
1784 SetDataTip(SPR_IMG_ZOOMOUT
, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_OUT
), SetFill(1, 1),
1785 NWidget(WWT_IMGBTN
, COLOUR_BROWN
, WID_SM_TOGGLETOWNNAME
),
1786 SetDataTip(SPR_IMG_TOWN
, STR_SMALLMAP_TOOLTIP_TOGGLE_TOWN_NAMES_ON_OFF
), SetFill(1, 1),
1787 NWidget(WWT_IMGBTN
, COLOUR_BROWN
, WID_SM_LINKSTATS
),
1788 SetDataTip(SPR_IMG_CARGOFLOW
, STR_SMALLMAP_TOOLTIP_SHOW_LINK_STATS_ON_MAP
), SetFill(1, 1),
1789 NWidget(WWT_IMGBTN
, COLOUR_BROWN
, WID_SM_ROUTES
),
1790 SetDataTip(SPR_IMG_SHOW_ROUTES
, STR_SMALLMAP_TOOLTIP_SHOW_TRANSPORT_ROUTES_ON
), SetFill(1, 1),
1791 NWidget(WWT_IMGBTN
, COLOUR_BROWN
, WID_SM_VEGETATION
),
1792 SetDataTip(SPR_IMG_PLANTTREES
, STR_SMALLMAP_TOOLTIP_SHOW_VEGETATION_ON_MAP
), SetFill(1, 1),
1793 NWidget(WWT_IMGBTN
, COLOUR_BROWN
, WID_SM_OWNERS
),
1794 SetDataTip(SPR_IMG_COMPANY_GENERAL
, STR_SMALLMAP_TOOLTIP_SHOW_LAND_OWNERS_ON_MAP
), SetFill(1, 1),
1796 NWidget(NWID_SPACER
), SetResize(0, 1),
1802 static NWidgetBase
*SmallMapDisplay(int *biggest_index
)
1804 NWidgetContainer
*map_display
= new NWidgetSmallmapDisplay
;
1806 MakeNWidgets(_nested_smallmap_display
, lengthof(_nested_smallmap_display
), biggest_index
, map_display
);
1807 MakeNWidgets(_nested_smallmap_bar
, lengthof(_nested_smallmap_bar
), biggest_index
, map_display
);
1812 static const NWidgetPart _nested_smallmap_widgets
[] = {
1813 NWidget(NWID_HORIZONTAL
),
1814 NWidget(WWT_CLOSEBOX
, COLOUR_BROWN
),
1815 NWidget(WWT_CAPTION
, COLOUR_BROWN
, WID_SM_CAPTION
), SetDataTip(STR_SMALLMAP_CAPTION
, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS
),
1816 NWidget(WWT_SHADEBOX
, COLOUR_BROWN
),
1817 NWidget(WWT_DEFSIZEBOX
, COLOUR_BROWN
),
1818 NWidget(WWT_STICKYBOX
, COLOUR_BROWN
),
1820 NWidgetFunction(SmallMapDisplay
), // Smallmap display and legend bar + image buttons.
1821 /* Bottom button row and resize box. */
1822 NWidget(NWID_HORIZONTAL
),
1823 NWidget(NWID_SELECTION
, INVALID_COLOUR
, WID_SM_SELECT_BUTTONS
),
1824 NWidget(NWID_HORIZONTAL
, NC_EQUALSIZE
),
1825 NWidget(WWT_PUSHTXTBTN
, COLOUR_BROWN
, WID_SM_ENABLE_ALL
), SetDataTip(STR_SMALLMAP_ENABLE_ALL
, STR_NULL
),
1826 NWidget(WWT_PUSHTXTBTN
, COLOUR_BROWN
, WID_SM_DISABLE_ALL
), SetDataTip(STR_SMALLMAP_DISABLE_ALL
, STR_NULL
),
1827 NWidget(WWT_TEXTBTN
, COLOUR_BROWN
, WID_SM_SHOW_HEIGHT
), SetDataTip(STR_SMALLMAP_SHOW_HEIGHT
, STR_SMALLMAP_TOOLTIP_SHOW_HEIGHT
),
1828 NWidget(WWT_PANEL
, COLOUR_BROWN
), SetFill(1, 0), SetResize(1, 0),
1831 NWidget(WWT_PANEL
, COLOUR_BROWN
), SetFill(1, 0), SetResize(1, 0),
1834 NWidget(WWT_RESIZEBOX
, COLOUR_BROWN
),
1838 static WindowDesc
_smallmap_desc(
1839 WDP_AUTO
, "smallmap", 484, 314,
1840 WC_SMALLMAP
, WC_NONE
,
1842 _nested_smallmap_widgets
, lengthof(_nested_smallmap_widgets
)
1846 * Show the smallmap window.
1850 AllocateWindowDescFront
<SmallMapWindow
>(&_smallmap_desc
, 0);
1854 * Scrolls the main window to given coordinates.
1855 * @param x x coordinate
1856 * @param y y coordinate
1857 * @param z z coordinate; -1 to scroll to terrain height
1858 * @param instant scroll instantly (meaningful only when smooth_scrolling is active)
1859 * @return did the viewport position change?
1861 bool ScrollMainWindowTo(int x
, int y
, int z
, bool instant
)
1863 bool res
= ScrollWindowTo(x
, y
, z
, FindWindowById(WC_MAIN_WINDOW
, 0), instant
);
1865 /* If a user scrolls to a tile (via what way what so ever) and already is on
1866 * that tile (e.g.: pressed twice), move the smallmap to that location,
1867 * so you directly see where you are on the smallmap. */
1869 if (res
) return res
;
1871 SmallMapWindow
*w
= dynamic_cast<SmallMapWindow
*>(FindWindowById(WC_SMALLMAP
, 0));
1872 if (w
!= NULL
) w
->SmallMapCenterOnCurrentPos();