OpenTTD Source 20250820-master-g77503776b6
viewport.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
63#include "stdafx.h"
64#include "core/backup_type.hpp"
65#include "landscape.h"
66#include "viewport_func.h"
67#include "station_base.h"
68#include "waypoint_base.h"
69#include "town.h"
70#include "signs_base.h"
71#include "signs_func.h"
72#include "vehicle_base.h"
73#include "vehicle_gui.h"
74#include "blitter/factory.hpp"
75#include "strings_func.h"
76#include "zoom_func.h"
77#include "vehicle_func.h"
78#include "company_func.h"
79#include "waypoint_func.h"
80#include "window_func.h"
81#include "tilehighlight_func.h"
82#include "window_gui.h"
84#include "viewport_kdtree.h"
85#include "town_kdtree.h"
87#include "bridge_map.h"
88#include "company_base.h"
89#include "command_func.h"
91#include "framerate_type.h"
92#include "viewport_cmd.h"
93
94#include <forward_list>
95#include <stack>
96
98
99#include "table/strings.h"
100#include "table/string_colours.h"
101
102#include "safeguards.h"
103
104Point _tile_fract_coords;
105
106
107ViewportSignKdtree _viewport_sign_kdtree{};
108static int _viewport_sign_maxwidth = 0;
109
110
111static const int MAX_TILE_EXTENT_LEFT = ZOOM_BASE * TILE_PIXELS;
112static const int MAX_TILE_EXTENT_RIGHT = ZOOM_BASE * TILE_PIXELS;
113static const int MAX_TILE_EXTENT_TOP = ZOOM_BASE * MAX_BUILDING_PIXELS;
114static const int MAX_TILE_EXTENT_BOTTOM = ZOOM_BASE * (TILE_PIXELS + 2 * TILE_HEIGHT);
115
117 std::string string;
118 uint16_t width;
119 Colours colour;
121 int32_t x;
122 int32_t y;
123};
124
126 SpriteID image;
127 PaletteID pal;
128 const SubSprite *sub;
129 int32_t x;
130 int32_t y;
131};
132
134 SpriteID image;
135 PaletteID pal;
136 const SubSprite *sub;
137 int32_t x;
138 int32_t y;
139 bool relative;
140 int next;
141};
142
144enum FoundationPart : uint8_t {
148 FOUNDATION_PART_END
149};
150
160
161typedef std::vector<TileSpriteToDraw> TileSpriteToDrawVector;
162typedef std::vector<StringSpriteToDraw> StringSpriteToDrawVector;
163typedef std::vector<ParentSpriteToDraw> ParentSpriteToDrawVector;
164typedef std::vector<ChildScreenSpriteToDraw> ChildScreenSpriteToDrawVector;
165
166constexpr int LAST_CHILD_NONE = -1;
167constexpr int LAST_CHILD_PARENT = -2;
168
171 DrawPixelInfo dpi;
172
173 StringSpriteToDrawVector string_sprites_to_draw;
174 TileSpriteToDrawVector tile_sprites_to_draw;
175 ParentSpriteToDrawVector parent_sprites_to_draw;
176 ParentSpriteToSortVector parent_sprites_to_sort;
177 ChildScreenSpriteToDrawVector child_screen_sprites_to_draw;
178
179 int last_child;
180
182
183 int foundation[FOUNDATION_PART_END];
185 int last_foundation_child[FOUNDATION_PART_END];
186 Point foundation_offset[FOUNDATION_PART_END];
187};
188
189static bool MarkViewportDirty(const Viewport &vp, int left, int top, int right, int bottom);
190
191static ViewportDrawer _vd;
192
194static TileInfo _cur_ti;
195bool _draw_bounding_boxes = false;
196bool _draw_dirty_blocks = false;
197uint _dirty_block_colour = 0;
198static VpSpriteSorter _vp_sprite_sorter = nullptr;
199
200static Point MapXYZToViewport(const Viewport &vp, int x, int y, int z)
201{
202 Point p = RemapCoords(x, y, z);
203 p.x -= vp.virtual_width / 2;
204 p.y -= vp.virtual_height / 2;
205 return p;
206}
207
218void InitializeWindowViewport(Window *w, int x, int y,
219 int width, int height, std::variant<TileIndex, VehicleID> focus, ZoomLevel zoom)
220{
221 assert(w->viewport == nullptr);
222
223 auto vp = std::make_unique<ViewportData>();
224
225 vp->left = x + w->left;
226 vp->top = y + w->top;
227 vp->width = width;
228 vp->height = height;
229
231
232 vp->virtual_width = ScaleByZoom(width, zoom);
233 vp->virtual_height = ScaleByZoom(height, zoom);
234
235 Point pt;
236
237 if (std::holds_alternative<VehicleID>(focus)) {
238 const Vehicle *veh;
239
240 vp->follow_vehicle = std::get<VehicleID>(focus);
241 veh = Vehicle::Get(vp->follow_vehicle);
242 pt = MapXYZToViewport(*vp, veh->x_pos, veh->y_pos, veh->z_pos);
243 } else {
244 TileIndex tile = std::get<TileIndex>(focus);
245 if (tile == INVALID_TILE) {
246 /* No tile? Use center of main viewport. */
247 const Window *mw = GetMainWindow();
248
249 /* center on same place as main window (zoom is maximum, no adjustment needed) */
250 pt.x = mw->viewport->scrollpos_x + mw->viewport->virtual_width / 2;
251 pt.x -= vp->virtual_width / 2;
252 pt.y = mw->viewport->scrollpos_y + mw->viewport->virtual_height / 2;
253 pt.y -= vp->virtual_height / 2;
254 } else {
255 x = TileX(tile) * TILE_SIZE;
256 y = TileY(tile) * TILE_SIZE;
257 pt = MapXYZToViewport(*vp, x, y, GetSlopePixelZ(x, y));
258 }
259 vp->follow_vehicle = VehicleID::Invalid();
260 }
261
262 vp->scrollpos_x = pt.x;
263 vp->scrollpos_y = pt.y;
264 vp->dest_scrollpos_x = pt.x;
265 vp->dest_scrollpos_y = pt.y;
266
267 vp->overlay = nullptr;
268
269 vp->virtual_left = 0;
270 vp->virtual_top = 0;
271
272 w->viewport = std::move(vp);
273}
274
275static Point _vp_move_offs;
276
277static void DoSetViewportPosition(Window::IteratorToFront it, int left, int top, int width, int height)
278{
279 for (; !it.IsEnd(); ++it) {
280 const Window *w = *it;
281 if (left + width > w->left &&
282 w->left + w->width > left &&
283 top + height > w->top &&
284 w->top + w->height > top) {
285
286 if (left < w->left) {
287 DoSetViewportPosition(it, left, top, w->left - left, height);
288 DoSetViewportPosition(it, left + (w->left - left), top, width - (w->left - left), height);
289 return;
290 }
291
292 if (left + width > w->left + w->width) {
293 DoSetViewportPosition(it, left, top, (w->left + w->width - left), height);
294 DoSetViewportPosition(it, left + (w->left + w->width - left), top, width - (w->left + w->width - left), height);
295 return;
296 }
297
298 if (top < w->top) {
299 DoSetViewportPosition(it, left, top, width, (w->top - top));
300 DoSetViewportPosition(it, left, top + (w->top - top), width, height - (w->top - top));
301 return;
302 }
303
304 if (top + height > w->top + w->height) {
305 DoSetViewportPosition(it, left, top, width, (w->top + w->height - top));
306 DoSetViewportPosition(it, left, top + (w->top + w->height - top), width, height - (w->top + w->height - top));
307 return;
308 }
309
310 return;
311 }
312 }
313
314 {
315 int xo = _vp_move_offs.x;
316 int yo = _vp_move_offs.y;
317
318 if (abs(xo) >= width || abs(yo) >= height) {
319 /* fully_outside */
320 RedrawScreenRect(left, top, left + width, top + height);
321 return;
322 }
323
324 GfxScroll(left, top, width, height, xo, yo);
325
326 if (xo > 0) {
327 RedrawScreenRect(left, top, xo + left, top + height);
328 left += xo;
329 width -= xo;
330 } else if (xo < 0) {
331 RedrawScreenRect(left + width + xo, top, left + width, top + height);
332 width += xo;
333 }
334
335 if (yo > 0) {
336 RedrawScreenRect(left, top, width + left, top + yo);
337 } else if (yo < 0) {
338 RedrawScreenRect(left, top + height + yo, width + left, top + height);
339 }
340 }
341}
342
343static void SetViewportPosition(Window *w, int x, int y)
344{
345 Viewport &vp = *w->viewport;
346 int old_left = vp.virtual_left;
347 int old_top = vp.virtual_top;
348 int i;
349 int left, top, width, height;
350
351 vp.virtual_left = x;
352 vp.virtual_top = y;
353
354 /* Viewport is bound to its left top corner, so it must be rounded down (UnScaleByZoomLower)
355 * else glitch described in FS#1412 will happen (offset by 1 pixel with zoom level > NORMAL)
356 */
357 old_left = UnScaleByZoomLower(old_left, vp.zoom);
358 old_top = UnScaleByZoomLower(old_top, vp.zoom);
359 x = UnScaleByZoomLower(x, vp.zoom);
360 y = UnScaleByZoomLower(y, vp.zoom);
361
362 old_left -= x;
363 old_top -= y;
364
365 if (old_top == 0 && old_left == 0) return;
366
367 _vp_move_offs.x = old_left;
368 _vp_move_offs.y = old_top;
369
370 left = vp.left;
371 top = vp.top;
372 width = vp.width;
373 height = vp.height;
374
375 if (left < 0) {
376 width += left;
377 left = 0;
378 }
379
380 i = left + width - _screen.width;
381 if (i >= 0) width -= i;
382
383 if (width > 0) {
384 if (top < 0) {
385 height += top;
386 top = 0;
387 }
388
389 i = top + height - _screen.height;
390 if (i >= 0) height -= i;
391
392 if (height > 0) {
394 ++it;
395 DoSetViewportPosition(it, left, top, width, height);
396 }
397 }
398}
399
408Viewport *IsPtInWindowViewport(const Window *w, int x, int y)
409{
410 if (w->viewport == nullptr) return nullptr;
411
412 const Viewport &vp = *w->viewport;
413 if (IsInsideMM(x, vp.left, vp.left + vp.width) && IsInsideMM(y, vp.top, vp.top + vp.height)) return w->viewport.get();
414
415 return nullptr;
416}
417
430Point TranslateXYToTileCoord(const Viewport &vp, int x, int y, bool clamp_to_map)
431{
432 if (!IsInsideBS(x, vp.left, vp.width) || !IsInsideBS(y, vp.top, vp.height)) {
433 Point pt = { -1, -1 };
434 return pt;
435 }
436
437 return InverseRemapCoords2(
438 ScaleByZoom(x - vp.left, vp.zoom) + vp.virtual_left,
439 ScaleByZoom(y - vp.top, vp.zoom) + vp.virtual_top, clamp_to_map);
440}
441
442/* When used for zooming, check area below current coordinates (x,y)
443 * and return the tile of the zoomed out/in position (zoom_x, zoom_y)
444 * when you just want the tile, make x = zoom_x and y = zoom_y */
445static Point GetTileFromScreenXY(int x, int y, int zoom_x, int zoom_y)
446{
447 if (Window *w = FindWindowFromPt(x, y); w != nullptr) {
448 if (Viewport *vp = IsPtInWindowViewport(w, x, y); vp != nullptr) {
449 return TranslateXYToTileCoord(*vp, zoom_x, zoom_y);
450 }
451 }
452
453 return {-1, -1};
454}
455
456Point GetTileBelowCursor()
457{
458 return GetTileFromScreenXY(_cursor.pos.x, _cursor.pos.y, _cursor.pos.x, _cursor.pos.y);
459}
460
461
462Point GetTileZoomCenterWindow(bool in, Window * w)
463{
464 int x, y;
465 const Viewport &vp = *w->viewport;
466
467 if (in) {
468 x = ((_cursor.pos.x - vp.left) >> 1) + (vp.width >> 2);
469 y = ((_cursor.pos.y - vp.top) >> 1) + (vp.height >> 2);
470 } else {
471 x = vp.width - (_cursor.pos.x - vp.left);
472 y = vp.height - (_cursor.pos.y - vp.top);
473 }
474 /* Get the tile below the cursor and center on the zoomed-out center */
475 return GetTileFromScreenXY(_cursor.pos.x, _cursor.pos.y, x + vp.left, y + vp.top);
476}
477
486void HandleZoomMessage(Window *w, const Viewport &vp, WidgetID widget_zoom_in, WidgetID widget_zoom_out)
487{
488 w->SetWidgetDisabledState(widget_zoom_in, vp.zoom <= _settings_client.gui.zoom_min);
489 w->SetWidgetDirty(widget_zoom_in);
490
491 w->SetWidgetDisabledState(widget_zoom_out, vp.zoom >= _settings_client.gui.zoom_max);
492 w->SetWidgetDirty(widget_zoom_out);
493}
494
507static void AddTileSpriteToDraw(SpriteID image, PaletteID pal, int32_t x, int32_t y, int z, const SubSprite *sub = nullptr, int extra_offs_x = 0, int extra_offs_y = 0)
508{
509 assert((image & SPRITE_MASK) < MAX_SPRITES);
510
511 TileSpriteToDraw &ts = _vd.tile_sprites_to_draw.emplace_back();
512 ts.image = image;
513 ts.pal = pal;
514 ts.sub = sub;
515 Point pt = RemapCoords(x, y, z);
516 ts.x = pt.x + extra_offs_x;
517 ts.y = pt.y + extra_offs_y;
518}
519
532static void AddChildSpriteToFoundation(SpriteID image, PaletteID pal, const SubSprite *sub, FoundationPart foundation_part, int extra_offs_x, int extra_offs_y)
533{
534 assert(IsInsideMM(foundation_part, 0, FOUNDATION_PART_END));
535 assert(_vd.foundation[foundation_part] != -1);
536 Point offs = _vd.foundation_offset[foundation_part];
537
538 /* Change the active ChildSprite list to the one of the foundation */
539 AutoRestoreBackup backup(_vd.last_child, _vd.last_foundation_child[foundation_part]);
540 AddChildSpriteScreen(image, pal, offs.x + extra_offs_x, offs.y + extra_offs_y, false, sub, false, false);
541}
542
556void DrawGroundSpriteAt(SpriteID image, PaletteID pal, int32_t x, int32_t y, int z, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
557{
558 /* Switch to first foundation part, if no foundation was drawn */
560
561 if (_vd.foundation[_vd.foundation_part] != -1) {
562 Point pt = RemapCoords(x, y, z);
563 AddChildSpriteToFoundation(image, pal, sub, _vd.foundation_part, pt.x + extra_offs_x * ZOOM_BASE, pt.y + extra_offs_y * ZOOM_BASE);
564 } else {
565 AddTileSpriteToDraw(image, pal, _cur_ti.x + x, _cur_ti.y + y, _cur_ti.z + z, sub, extra_offs_x * ZOOM_BASE, extra_offs_y * ZOOM_BASE);
566 }
567}
568
579void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
580{
581 DrawGroundSpriteAt(image, pal, 0, 0, 0, sub, extra_offs_x, extra_offs_y);
582}
583
591void OffsetGroundSprite(int x, int y)
592{
593 /* Switch to next foundation part */
594 switch (_vd.foundation_part) {
597 break;
600 break;
601 default: NOT_REACHED();
602 }
603
604 /* _vd.last_child is LAST_CHILD_NONE if foundation sprite was clipped by the viewport bounds */
605 if (_vd.last_child != LAST_CHILD_NONE) _vd.foundation[_vd.foundation_part] = static_cast<uint>(_vd.parent_sprites_to_draw.size()) - 1;
606
607 _vd.foundation_offset[_vd.foundation_part].x = x * ZOOM_BASE;
608 _vd.foundation_offset[_vd.foundation_part].y = y * ZOOM_BASE;
609 _vd.last_foundation_child[_vd.foundation_part] = _vd.last_child;
610}
611
623static void AddCombinedSprite(SpriteID image, PaletteID pal, int x, int y, int z, const SubSprite *sub)
624{
625 Point pt = RemapCoords(x, y, z);
626 const Sprite *spr = GetSprite(image & SPRITE_MASK, SpriteType::Normal);
627
628 if (pt.x + spr->x_offs >= _vd.dpi.left + _vd.dpi.width ||
629 pt.x + spr->x_offs + spr->width <= _vd.dpi.left ||
630 pt.y + spr->y_offs >= _vd.dpi.top + _vd.dpi.height ||
631 pt.y + spr->y_offs + spr->height <= _vd.dpi.top)
632 return;
633
634 const ParentSpriteToDraw &pstd = _vd.parent_sprites_to_draw.back();
635 AddChildSpriteScreen(image, pal, pt.x - pstd.left, pt.y - pstd.top, false, sub, false);
636}
637
663void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int z, const SpriteBounds &bounds, bool transparent, const SubSprite *sub)
664{
665 int32_t left, right, top, bottom;
666
667 assert((image & SPRITE_MASK) < MAX_SPRITES);
668
669 /* Move to bounding box. */
670 x += bounds.origin.x;
671 y += bounds.origin.y;
672 z += bounds.origin.z;
673
674 /* make the sprites transparent with the right palette */
675 if (transparent) {
678 }
679
681 AddCombinedSprite(image, pal, x + bounds.offset.x, y + bounds.offset.y, z + bounds.offset.z, sub);
682 return;
683 }
684
685 _vd.last_child = LAST_CHILD_NONE;
686
687 Point pt = RemapCoords(x + bounds.offset.x, y + bounds.offset.y, z + bounds.offset.z);
688 int tmp_left, tmp_top, tmp_x = pt.x, tmp_y = pt.y;
689
690 /* Compute screen extents of sprite */
691 if (image == SPR_EMPTY_BOUNDING_BOX) {
692 left = tmp_left = RemapCoords(x + bounds.extent.x, y, z).x;
693 right = RemapCoords(x, y + bounds.extent.y, z).x + 1;
694 top = tmp_top = RemapCoords(x, y, z + bounds.extent.z).y;
695 bottom = RemapCoords(x + bounds.extent.x, y + bounds.extent.y, z).y + 1;
696 } else {
697 const Sprite *spr = GetSprite(image & SPRITE_MASK, SpriteType::Normal);
698 left = tmp_left = (pt.x += spr->x_offs);
699 right = (pt.x + spr->width );
700 top = tmp_top = (pt.y += spr->y_offs);
701 bottom = (pt.y + spr->height);
702 }
703
704 if (_draw_bounding_boxes && (image != SPR_EMPTY_BOUNDING_BOX)) {
705 /* Compute maximal extents of sprite and its bounding box */
706 left = std::min(left , RemapCoords(x + bounds.extent.x, y, z).x);
707 right = std::max(right , RemapCoords(x, y + bounds.extent.y, z).x + 1);
708 top = std::min(top , RemapCoords(x, y, z + bounds.extent.z).y);
709 bottom = std::max(bottom, RemapCoords(x + bounds.extent.x, y + bounds.extent.y, z).y + 1);
710 }
711
712 /* Do not add the sprite to the viewport, if it is outside */
713 if (left >= _vd.dpi.left + _vd.dpi.width ||
714 right <= _vd.dpi.left ||
715 top >= _vd.dpi.top + _vd.dpi.height ||
716 bottom <= _vd.dpi.top) {
717 return;
718 }
719
720 ParentSpriteToDraw &ps = _vd.parent_sprites_to_draw.emplace_back();
721 ps.x = tmp_x;
722 ps.y = tmp_y;
723
724 ps.left = tmp_left;
725 ps.top = tmp_top;
726
727 ps.image = image;
728 ps.pal = pal;
729 ps.sub = sub;
730 ps.xmin = x;
731 ps.xmax = x + bounds.extent.x - 1;
732
733 ps.ymin = y;
734 ps.ymax = y + bounds.extent.y - 1;
735
736 ps.zmin = z;
737 ps.zmax = z + bounds.extent.z - 1;
738
740
741 _vd.last_child = LAST_CHILD_PARENT;
742
744}
745
769
779
789static bool IsInRangeInclusive(int begin, int end, int check)
790{
791 if (begin > end) std::swap(begin, end);
792 return begin <= check && check <= end;
793}
794
801bool IsInsideRotatedRectangle(int x, int y)
802{
803 int dist_a = (_thd.size.x + _thd.size.y); // Rotated coordinate system for selected rectangle.
804 int dist_b = (_thd.size.x - _thd.size.y); // We don't have to divide by 2. It's all relative!
805 int a = ((x - _thd.pos.x) + (y - _thd.pos.y)); // Rotated coordinate system for the point under scrutiny.
806 int b = ((x - _thd.pos.x) - (y - _thd.pos.y));
807
808 /* Check if a and b are between 0 and dist_a or dist_b respectively. */
809 return IsInRangeInclusive(dist_a, 0, a) && IsInRangeInclusive(dist_b, 0, b);
810}
811
824void AddChildSpriteScreen(SpriteID image, PaletteID pal, int x, int y, bool transparent, const SubSprite *sub, bool scale, bool relative)
825{
826 assert((image & SPRITE_MASK) < MAX_SPRITES);
827
828 /* If the ParentSprite was clipped by the viewport bounds, do not draw the ChildSprites either */
829 if (_vd.last_child == LAST_CHILD_NONE) return;
830
831 /* make the sprites transparent with the right palette */
832 if (transparent) {
835 }
836
837 int32_t child_id = static_cast<int32_t>(_vd.child_screen_sprites_to_draw.size());
838 if (_vd.last_child != LAST_CHILD_PARENT) {
839 _vd.child_screen_sprites_to_draw[_vd.last_child].next = child_id;
840 } else {
841 _vd.parent_sprites_to_draw.back().first_child = child_id;
842 }
843
844 ChildScreenSpriteToDraw &cs = _vd.child_screen_sprites_to_draw.emplace_back();
845 cs.image = image;
846 cs.pal = pal;
847 cs.sub = sub;
848 cs.x = scale ? x * ZOOM_BASE : x;
849 cs.y = scale ? y * ZOOM_BASE : y;
850 cs.relative = relative;
852
853 /* Append the sprite to the active ChildSprite list.
854 * If the active ParentSprite is a foundation, update last_foundation_child as well.
855 * Note: ChildSprites of foundations are NOT sequential in the vector, as selection sprites are added at last. */
856 if (_vd.last_foundation_child[0] == _vd.last_child) _vd.last_foundation_child[0] = child_id;
857 if (_vd.last_foundation_child[1] == _vd.last_child) _vd.last_foundation_child[1] = child_id;
858 _vd.last_child = child_id;
859}
860
870static std::string &AddStringToDraw(int x, int y, Colours colour, ViewportStringFlags flags, uint16_t width)
871{
872 assert(width != 0);
873 StringSpriteToDraw &ss = _vd.string_sprites_to_draw.emplace_back();
874 ss.colour = colour;
875 ss.flags = flags;
876 ss.x = x;
877 ss.y = y;
878 ss.width = width;
879
880 return ss.string;
881}
882
883
897static void DrawSelectionSprite(SpriteID image, PaletteID pal, const TileInfo *ti, int z_offset, FoundationPart foundation_part, int extra_offs_x = 0, int extra_offs_y = 0)
898{
899 if (_vd.foundation[foundation_part] == -1) {
900 /* draw on real ground */
901 AddTileSpriteToDraw(image, pal, ti->x, ti->y, ti->z + z_offset, nullptr, extra_offs_x, extra_offs_y);
902 } else {
903 /* draw on top of foundation */
904 AddChildSpriteToFoundation(image, pal, nullptr, foundation_part, extra_offs_x, extra_offs_y - z_offset * ZOOM_BASE);
905 }
906}
907
914static void DrawTileSelectionRect(const TileInfo *ti, PaletteID pal)
915{
916 if (!IsValidTile(ti->tile)) return;
917
918 SpriteID sel;
919 if (IsHalftileSlope(ti->tileh)) {
920 Corner halftile_corner = GetHalftileSlopeCorner(ti->tileh);
921 SpriteID sel2 = SPR_HALFTILE_SELECTION_FLAT + halftile_corner;
923
924 Corner opposite_corner = OppositeCorner(halftile_corner);
925 if (IsSteepSlope(ti->tileh)) {
926 sel = SPR_HALFTILE_SELECTION_DOWN;
927 } else {
928 sel = ((ti->tileh & SlopeWithOneCornerRaised(opposite_corner)) != 0 ? SPR_HALFTILE_SELECTION_UP : SPR_HALFTILE_SELECTION_FLAT);
929 }
930 sel += opposite_corner;
931 } else {
932 sel = SPR_SELECT_TILE + SlopeToSpriteOffset(ti->tileh);
933 }
935}
936
937static bool IsPartOfAutoLine(int px, int py)
938{
939 px -= _thd.selstart.x;
940 py -= _thd.selstart.y;
941
942 if ((_thd.drawstyle & HT_DRAG_MASK) != HT_LINE) return false;
943
944 switch (_thd.drawstyle & HT_DIR_MASK) {
945 case HT_DIR_X: return py == 0; // x direction
946 case HT_DIR_Y: return px == 0; // y direction
947 case HT_DIR_HU: return px == -py || px == -py - 16; // horizontal upper
948 case HT_DIR_HL: return px == -py || px == -py + 16; // horizontal lower
949 case HT_DIR_VL: return px == py || px == py + 16; // vertical left
950 case HT_DIR_VR: return px == py || px == py - 16; // vertical right
951 default:
952 NOT_REACHED();
953 }
954}
955
956/* [direction][side] */
957static const HighLightStyle _autorail_type[6][2] = {
958 { HT_DIR_X, HT_DIR_X },
959 { HT_DIR_Y, HT_DIR_Y },
960 { HT_DIR_HU, HT_DIR_HL },
961 { HT_DIR_HL, HT_DIR_HU },
962 { HT_DIR_VL, HT_DIR_VR },
964};
965
966#include "table/autorail.h"
967
974static void DrawAutorailSelection(const TileInfo *ti, uint autorail_type)
975{
976 SpriteID image;
977 PaletteID pal;
978 int offset;
979
980 FoundationPart foundation_part = FOUNDATION_PART_NORMAL;
981 Slope autorail_tileh = RemoveHalftileSlope(ti->tileh);
982 if (IsHalftileSlope(ti->tileh)) {
983 static const uint _lower_rail[4] = { 5U, 2U, 4U, 3U };
984 Corner halftile_corner = GetHalftileSlopeCorner(ti->tileh);
985 if (autorail_type != _lower_rail[halftile_corner]) {
986 foundation_part = FOUNDATION_PART_HALFTILE;
987 /* Here we draw the highlights of the "three-corners-raised"-slope. That looks ok to me. */
988 autorail_tileh = SlopeWithThreeCornersRaised(OppositeCorner(halftile_corner));
989 }
990 }
991
992 offset = _AutorailTilehSprite[autorail_tileh][autorail_type];
993 if (offset >= 0) {
994 image = SPR_AUTORAIL_BASE + offset;
995 pal = PAL_NONE;
996 } else {
997 image = SPR_AUTORAIL_BASE - offset;
999 }
1000
1001 DrawSelectionSprite(image, _thd.make_square_red ? PALETTE_SEL_TILE_RED : pal, ti, 7, foundation_part);
1002}
1003
1004enum TileHighlightType : uint8_t {
1005 THT_NONE,
1006 THT_WHITE,
1007 THT_BLUE,
1008 THT_RED,
1009};
1010
1014
1020static TileHighlightType GetTileHighlightType(TileIndex t)
1021{
1022 if (_viewport_highlight_station != nullptr) {
1023 if (IsTileType(t, MP_STATION) && GetStationIndex(t) == _viewport_highlight_station->index) return THT_WHITE;
1024 if (_viewport_highlight_station->TileIsInCatchment(t)) return THT_BLUE;
1025 }
1026 if (_viewport_highlight_waypoint != nullptr) {
1027 if (IsTileType(t, MP_STATION) && GetStationIndex(t) == _viewport_highlight_waypoint->index) return THT_BLUE;
1028 }
1029
1030 if (_viewport_highlight_town != nullptr) {
1031 if (IsTileType(t, MP_HOUSE)) {
1033 TileHighlightType type = THT_RED;
1035 if (st->owner != _current_company) continue;
1036 if (st->TileIsInCatchment(t)) return THT_BLUE;
1037 }
1038 return type;
1039 }
1040 } else if (IsTileType(t, MP_STATION)) {
1042 if (st->owner != _current_company) continue;
1043 if (GetStationIndex(t) == st->index) return THT_WHITE;
1044 }
1045 }
1046 }
1047
1048 return THT_NONE;
1049}
1050
1056static void DrawTileHighlightType(const TileInfo *ti, TileHighlightType tht)
1057{
1058 switch (tht) {
1059 default:
1060 case THT_NONE: break;
1061 case THT_WHITE: DrawTileSelectionRect(ti, PAL_NONE); break;
1062 case THT_BLUE: DrawTileSelectionRect(ti, PALETTE_SEL_TILE_BLUE); break;
1063 case THT_RED: DrawTileSelectionRect(ti, PALETTE_SEL_TILE_RED); break;
1064 }
1065}
1066
1072{
1073 /* Going through cases in order of computational time. */
1074
1075 if (_town_local_authority_kdtree.Count() == 0) return;
1076
1077 /* Tile belongs to town regardless of distance from town. */
1078 if (GetTileType(ti->tile) == MP_HOUSE) {
1079 if (!Town::GetByTile(ti->tile)->show_zone) return;
1080
1082 return;
1083 }
1084
1085 /* If the closest town in the highlighted list is far, we can stop searching. */
1086 TownID tid = _town_local_authority_kdtree.FindNearest(TileX(ti->tile), TileY(ti->tile));
1087 Town *closest_highlighted_town = Town::Get(tid);
1088
1089 if (DistanceManhattan(ti->tile, closest_highlighted_town->xy) >= _settings_game.economy.dist_local_authority) return;
1090
1091 /* Tile is inside of the local autrhority distance of a highlighted town,
1092 but it is possible that a non-highlighted town is even closer. */
1094
1095 if (closest_town->show_zone) {
1097 }
1098
1099}
1100
1105static void DrawTileSelection(const TileInfo *ti)
1106{
1107 /* Highlight tiles insede local authority of selected towns. */
1109
1110 /* Draw a red error square? */
1111 bool is_redsq = _thd.redsq == ti->tile;
1113
1114 TileHighlightType tht = GetTileHighlightType(ti->tile);
1115 DrawTileHighlightType(ti, tht);
1116
1117 /* No tile selection active? */
1118 if ((_thd.drawstyle & HT_DRAG_MASK) == HT_NONE) return;
1119
1120 if (_thd.diagonal) { // We're drawing a 45 degrees rotated (diagonal) rectangle
1121 if (IsInsideRotatedRectangle((int)ti->x, (int)ti->y)) goto draw_inner;
1122 return;
1123 }
1124
1125 /* Inside the inner area? */
1126 if (IsInsideBS(ti->x, _thd.pos.x, _thd.size.x) &&
1127 IsInsideBS(ti->y, _thd.pos.y, _thd.size.y)) {
1128draw_inner:
1129 if (_thd.drawstyle & HT_RECT) {
1130 if (!is_redsq) DrawTileSelectionRect(ti, _thd.make_square_red ? PALETTE_SEL_TILE_RED : PAL_NONE);
1131 } else if (_thd.drawstyle & HT_POINT) {
1132 /* Figure out the Z coordinate for the single dot. */
1133 int z = 0;
1134 FoundationPart foundation_part = FOUNDATION_PART_NORMAL;
1135 if (ti->tileh & SLOPE_N) {
1136 z += TILE_HEIGHT;
1138 }
1139 if (IsHalftileSlope(ti->tileh)) {
1140 Corner halftile_corner = GetHalftileSlopeCorner(ti->tileh);
1141 if ((halftile_corner == CORNER_W) || (halftile_corner == CORNER_E)) z += TILE_HEIGHT;
1142 if (halftile_corner != CORNER_S) {
1143 foundation_part = FOUNDATION_PART_HALFTILE;
1144 if (IsSteepSlope(ti->tileh)) z -= TILE_HEIGHT;
1145 }
1146 }
1147 DrawSelectionSprite(SPR_DOT, PAL_NONE, ti, z, foundation_part);
1148 } else if (_thd.drawstyle & HT_RAIL) {
1149 /* autorail highlight piece under cursor */
1150 HighLightStyle type = _thd.drawstyle & HT_DIR_MASK;
1151 assert(type < HT_DIR_END);
1152 DrawAutorailSelection(ti, _autorail_type[type][0]);
1153 } else if (IsPartOfAutoLine(ti->x, ti->y)) {
1154 /* autorail highlighting long line */
1156 uint side;
1157
1158 if (dir == HT_DIR_X || dir == HT_DIR_Y) {
1159 side = 0;
1160 } else {
1161 TileIndex start = TileVirtXY(_thd.selstart.x, _thd.selstart.y);
1162 side = Delta(Delta(TileX(start), TileX(ti->tile)), Delta(TileY(start), TileY(ti->tile)));
1163 }
1164
1165 DrawAutorailSelection(ti, _autorail_type[dir][side]);
1166 }
1167 return;
1168 }
1169
1170 /* Check if it's inside the outer area? */
1171 if (!is_redsq && (tht == THT_NONE || tht == THT_RED) && _thd.outersize.x > 0 &&
1172 IsInsideBS(ti->x, _thd.pos.x + _thd.offs.x, _thd.size.x + _thd.outersize.x) &&
1173 IsInsideBS(ti->y, _thd.pos.y + _thd.offs.y, _thd.size.y + _thd.outersize.y)) {
1174 /* Draw a blue rect. */
1176 return;
1177 }
1178}
1179
1186static int GetViewportY(Point tile)
1187{
1188 /* Each increment in X or Y direction moves down by half a tile, i.e. TILE_PIXELS / 2. */
1189 return (tile.y * (int)(TILE_PIXELS / 2) + tile.x * (int)(TILE_PIXELS / 2) - TilePixelHeightOutsideMap(tile.x, tile.y)) << ZOOM_BASE_SHIFT;
1190}
1191
1196{
1197 assert(_vd.dpi.top <= _vd.dpi.top + _vd.dpi.height);
1198 assert(_vd.dpi.left <= _vd.dpi.left + _vd.dpi.width);
1199
1200 Point upper_left = InverseRemapCoords(_vd.dpi.left, _vd.dpi.top);
1201 Point upper_right = InverseRemapCoords(_vd.dpi.left + _vd.dpi.width, _vd.dpi.top);
1202
1203 /* Transformations between tile coordinates and viewport rows/columns: See vp_column_row
1204 * column = y - x
1205 * row = x + y
1206 * x = (row - column) / 2
1207 * y = (row + column) / 2
1208 * Note: (row, columns) pairs are only valid, if they are both even or both odd.
1209 */
1210
1211 /* Columns overlap with neighbouring columns by a half tile.
1212 * - Left column is column of upper_left (rounded down) and one column to the left.
1213 * - Right column is column of upper_right (rounded up) and one column to the right.
1214 * Note: Integer-division does not round down for negative numbers, so ensure rounding with another increment/decrement.
1215 */
1216 int left_column = (upper_left.y - upper_left.x) / (int)TILE_SIZE - 2;
1217 int right_column = (upper_right.y - upper_right.x) / (int)TILE_SIZE + 2;
1218
1219 int potential_bridge_height = ZOOM_BASE * TILE_HEIGHT * _settings_game.construction.max_bridge_height;
1220
1221 /* Rows overlap with neighbouring rows by a half tile.
1222 * The first row that could possibly be visible is the row above upper_left (if it is at height 0).
1223 * Due to integer-division not rounding down for negative numbers, we need another decrement.
1224 */
1225 int row = (upper_left.x + upper_left.y) / (int)TILE_SIZE - 2;
1226 bool last_row = false;
1227 for (; !last_row; row++) {
1228 last_row = true;
1229 for (int column = left_column; column <= right_column; column++) {
1230 /* Valid row/column? */
1231 if ((row + column) % 2 != 0) continue;
1232
1233 Point tilecoord;
1234 tilecoord.x = (row - column) / 2;
1235 tilecoord.y = (row + column) / 2;
1236 assert(column == tilecoord.y - tilecoord.x);
1237 assert(row == tilecoord.y + tilecoord.x);
1238
1239 TileType tile_type;
1240 _cur_ti.x = tilecoord.x * TILE_SIZE;
1241 _cur_ti.y = tilecoord.y * TILE_SIZE;
1242
1243 if (IsInsideBS(tilecoord.x, 0, Map::SizeX()) && IsInsideBS(tilecoord.y, 0, Map::SizeY())) {
1244 /* This includes the south border at Map::MaxX / Map::MaxY. When terraforming we still draw tile selections there. */
1245 _cur_ti.tile = TileXY(tilecoord.x, tilecoord.y);
1246 tile_type = GetTileType(_cur_ti.tile);
1247 } else {
1248 _cur_ti.tile = INVALID_TILE;
1249 tile_type = MP_VOID;
1250 }
1251
1252 if (tile_type != MP_VOID) {
1253 /* We are inside the map => paint landscape. */
1254 std::tie(_cur_ti.tileh, _cur_ti.z) = GetTilePixelSlope(_cur_ti.tile);
1255 } else {
1256 /* We are outside the map => paint black. */
1257 std::tie(_cur_ti.tileh, _cur_ti.z) = GetTilePixelSlopeOutsideMap(tilecoord.x, tilecoord.y);
1258 }
1259
1260 int viewport_y = GetViewportY(tilecoord);
1261
1262 if (viewport_y + MAX_TILE_EXTENT_BOTTOM < _vd.dpi.top) {
1263 /* The tile in this column is not visible yet.
1264 * Tiles in other columns may be visible, but we need more rows in any case. */
1265 last_row = false;
1266 continue;
1267 }
1268
1269 int min_visible_height = viewport_y - (_vd.dpi.top + _vd.dpi.height);
1270 bool tile_visible = min_visible_height <= 0;
1271
1272 if (tile_type != MP_VOID) {
1273 /* Is tile with buildings visible? */
1274 if (min_visible_height < MAX_TILE_EXTENT_TOP) tile_visible = true;
1275
1276 if (IsBridgeAbove(_cur_ti.tile)) {
1277 /* Is the bridge visible? */
1278 TileIndex bridge_tile = GetNorthernBridgeEnd(_cur_ti.tile);
1279 int bridge_height = ZOOM_BASE * (GetBridgePixelHeight(bridge_tile) - TilePixelHeight(_cur_ti.tile));
1280 if (min_visible_height < bridge_height + MAX_TILE_EXTENT_TOP) tile_visible = true;
1281 }
1282
1283 /* Would a higher bridge on a more southern tile be visible?
1284 * If yes, we need to loop over more rows to possibly find one. */
1285 if (min_visible_height < potential_bridge_height + MAX_TILE_EXTENT_TOP) last_row = false;
1286 } else {
1287 /* Outside of map. If we are on the north border of the map, there may still be a bridge visible,
1288 * so we need to loop over more rows to possibly find one. */
1289 if ((tilecoord.x <= 0 || tilecoord.y <= 0) && min_visible_height < potential_bridge_height + MAX_TILE_EXTENT_TOP) last_row = false;
1290 }
1291
1292 if (tile_visible) {
1293 last_row = false;
1295 _vd.foundation[0] = -1;
1296 _vd.foundation[1] = -1;
1299
1300 _tile_type_procs[tile_type]->draw_tile_proc(&_cur_ti);
1301 if (_cur_ti.tile != INVALID_TILE) DrawTileSelection(&_cur_ti);
1302 }
1303 }
1304 }
1305}
1306
1315std::string *ViewportAddString(const DrawPixelInfo *dpi, const ViewportSign *sign, ViewportStringFlags flags, Colours colour)
1316{
1317 int left = dpi->left;
1318 int top = dpi->top;
1319 int right = left + dpi->width;
1320 int bottom = top + dpi->height;
1321
1322 bool small = flags.Test(ViewportStringFlag::Small);
1323 int sign_height = ScaleByZoom(WidgetDimensions::scaled.fullbevel.top + GetCharacterHeight(small ? FS_SMALL : FS_NORMAL) + WidgetDimensions::scaled.fullbevel.bottom, dpi->zoom);
1324 int sign_half_width = ScaleByZoom((small ? sign->width_small : sign->width_normal) / 2, dpi->zoom);
1325
1326 if (bottom < sign->top ||
1327 top > sign->top + sign_height ||
1328 right < sign->center - sign_half_width ||
1329 left > sign->center + sign_half_width) {
1330 return nullptr;
1331 }
1332
1333 return &AddStringToDraw(sign->center - sign_half_width, sign->top, colour, flags, small ? sign->width_small : sign->width_normal);
1334}
1335
1336static Rect ExpandRectWithViewportSignMargins(Rect r, ZoomLevel zoom)
1337{
1338 const int fh = std::max(GetCharacterHeight(FS_NORMAL), GetCharacterHeight(FS_SMALL));
1339 const int max_tw = _viewport_sign_maxwidth / 2 + 1;
1340 const int expand_y = ScaleByZoom(WidgetDimensions::scaled.fullbevel.top + fh + WidgetDimensions::scaled.fullbevel.bottom, zoom);
1341 const int expand_x = ScaleByZoom(WidgetDimensions::scaled.fullbevel.left + max_tw + WidgetDimensions::scaled.fullbevel.right, zoom);
1342
1343 r.left -= expand_x;
1344 r.right += expand_x;
1345 r.top -= expand_y;
1346 r.bottom += expand_y;
1347
1348 return r;
1349}
1350
1357static void ViewportAddTownStrings(DrawPixelInfo *dpi, const std::vector<const Town *> &towns, bool small)
1358{
1359 ViewportStringFlags flags{};
1361
1362 StringID stringid_town = !small && _settings_client.gui.population_in_label ? STR_VIEWPORT_TOWN_POP : STR_TOWN_NAME;
1363 StringID stringid_town_city = stringid_town;
1364 if (!small) {
1365 stringid_town_city = _settings_client.gui.population_in_label ? STR_VIEWPORT_TOWN_CITY_POP : STR_VIEWPORT_TOWN_CITY;
1366 }
1367
1368 for (const Town *t : towns) {
1369 std::string *str = ViewportAddString(dpi, &t->cache.sign, flags, INVALID_COLOUR);
1370 if (str == nullptr) continue;
1371
1372 if (t->larger_town) {
1373 *str = GetString(stringid_town_city, t->index, t->cache.population);
1374 } else {
1375 *str = GetString(stringid_town, t->index, t->cache.population);
1376 }
1377 }
1378}
1379
1386static void ViewportAddSignStrings(DrawPixelInfo *dpi, const std::vector<const Sign *> &signs, bool small)
1387{
1388 ViewportStringFlags flags{};
1389 if (small) flags.Set(ViewportStringFlag::Small);
1390
1391 /* Signs placed by a game script don't have a frame. */
1392 ViewportStringFlags deity_flags{flags};
1394
1395 for (const Sign *si : signs) {
1396 std::string *str = ViewportAddString(dpi, &si->sign, (si->owner == OWNER_DEITY) ? deity_flags : flags,
1397 (si->owner == OWNER_NONE) ? COLOUR_GREY : (si->owner == OWNER_DEITY ? INVALID_COLOUR : _company_colours[si->owner]));
1398 if (str == nullptr) continue;
1399
1400 *str = GetString(STR_SIGN_NAME, si->index);
1401 }
1402}
1403
1410static void ViewportAddStationStrings(DrawPixelInfo *dpi, const std::vector<const BaseStation *> &stations, bool small)
1411{
1412 /* Transparent station signs have colour text instead of a colour panel. */
1414 if (small) flags.Set(ViewportStringFlag::Small);
1415
1416 for (const BaseStation *st : stations) {
1417 std::string *str = ViewportAddString(dpi, &st->sign, flags, (st->owner == OWNER_NONE || !st->IsInUse()) ? COLOUR_GREY : _company_colours[st->owner]);
1418 if (str == nullptr) continue;
1419
1420 if (Station::IsExpected(st)) { /* Station */
1421 *str = GetString(small ? STR_STATION_NAME : STR_VIEWPORT_STATION, st->index, st->facilities);
1422 } else { /* Waypoint */
1423 *str = GetString(STR_WAYPOINT_NAME, st->index);
1424 }
1425 }
1426}
1427
1428static void ViewportAddKdtreeSigns(DrawPixelInfo *dpi)
1429{
1430 Rect search_rect{ dpi->left, dpi->top, dpi->left + dpi->width, dpi->top + dpi->height };
1431 search_rect = ExpandRectWithViewportSignMargins(search_rect, dpi->zoom);
1432
1433 bool show_stations = HasBit(_display_opt, DO_SHOW_STATION_NAMES) && _game_mode != GM_MENU;
1434 bool show_waypoints = HasBit(_display_opt, DO_SHOW_WAYPOINT_NAMES) && _game_mode != GM_MENU;
1435 bool show_towns = HasBit(_display_opt, DO_SHOW_TOWN_NAMES) && _game_mode != GM_MENU;
1437 bool show_competitors = HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS);
1438
1439 /* Collect all the items first and draw afterwards, to ensure layering */
1440 std::vector<const BaseStation *> stations;
1441 std::vector<const Town *> towns;
1442 std::vector<const Sign *> signs;
1443
1444 _viewport_sign_kdtree.FindContained(search_rect.left, search_rect.top, search_rect.right, search_rect.bottom, [&](const ViewportSignKdtreeItem & item) {
1445 switch (item.type) {
1446 case ViewportSignKdtreeItem::VKI_STATION: {
1447 if (!show_stations) break;
1448 const BaseStation *st = BaseStation::Get(std::get<StationID>(item.id));
1449
1450 /* If no facilities are present the station is a ghost station. */
1451 StationFacilities facilities = st->facilities;
1452 if (facilities.None()) facilities = STATION_FACILITY_GHOST;
1453
1454 if (!facilities.Any(_facility_display_opt)) break;
1455
1456 /* Don't draw if station is owned by another company and competitor station names are hidden. Stations owned by none are never ignored. */
1457 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
1458
1459 stations.push_back(st);
1460 break;
1461 }
1462
1463 case ViewportSignKdtreeItem::VKI_WAYPOINT: {
1464 if (!show_waypoints) break;
1465 const BaseStation *st = BaseStation::Get(std::get<StationID>(item.id));
1466
1467 /* Don't draw if station is owned by another company and competitor station names are hidden. Stations owned by none are never ignored. */
1468 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
1469
1470 stations.push_back(st);
1471 break;
1472 }
1473
1474 case ViewportSignKdtreeItem::VKI_TOWN:
1475 if (!show_towns) break;
1476 towns.push_back(Town::Get(std::get<TownID>(item.id)));
1477 break;
1478
1479 case ViewportSignKdtreeItem::VKI_SIGN: {
1480 if (!show_signs) break;
1481 const Sign *si = Sign::Get(std::get<SignID>(item.id));
1482
1483 /* Don't draw if sign is owned by another company and competitor signs should be hidden.
1484 * Note: It is intentional that also signs owned by OWNER_NONE are hidden. Bankrupt
1485 * companies can leave OWNER_NONE signs after them. */
1486 if (!show_competitors && _local_company != si->owner && si->owner != OWNER_DEITY) break;
1487
1488 signs.push_back(si);
1489 break;
1490 }
1491
1492 default:
1493 NOT_REACHED();
1494 }
1495 });
1496
1497 /* Small versions of signs are used zoom level 4X and higher. */
1498 bool small = dpi->zoom >= ZoomLevel::Out4x;
1499
1500 /* Layering order (bottom to top): Town names, signs, stations */
1501 ViewportAddTownStrings(dpi, towns, small);
1502
1503 /* Do not draw signs nor station names if they are set invisible */
1504 if (IsInvisibilitySet(TO_SIGNS)) return;
1505
1506 ViewportAddSignStrings(dpi, signs, small);
1507 ViewportAddStationStrings(dpi, stations, small);
1508}
1509
1510
1518void ViewportSign::UpdatePosition(int center, int top, std::string_view str, std::string_view str_small)
1519{
1520 if (this->width_normal != 0) this->MarkDirty();
1521
1522 this->top = top;
1523
1525 this->center = center;
1526
1527 /* zoomed out version */
1528 if (str_small.empty()) str_small = str;
1530
1531 this->MarkDirty();
1532}
1533
1541{
1542 Rect zoomlevels[to_underlying(ZoomLevel::End)];
1543
1544 /* We don't know which size will be drawn, so mark the largest area dirty. */
1545 const uint half_width = std::max(this->width_normal, this->width_small) / 2 + 1;
1547
1548 for (ZoomLevel zoom = ZoomLevel::Begin; zoom != ZoomLevel::End; zoom++) {
1549 zoomlevels[to_underlying(zoom)].left = this->center - ScaleByZoom(half_width, zoom);
1550 zoomlevels[to_underlying(zoom)].top = this->top - ScaleByZoom(1, zoom);
1551 zoomlevels[to_underlying(zoom)].right = this->center + ScaleByZoom(half_width, zoom);
1552 zoomlevels[to_underlying(zoom)].bottom = this->top + ScaleByZoom(height, zoom);
1553 }
1554
1555 for (const Window *w : Window::Iterate()) {
1556 if (w->viewport == nullptr) continue;
1557
1558 Viewport &vp = *w->viewport;
1559 if (vp.zoom <= maxzoom) {
1560 assert(vp.width != 0);
1561 Rect &zl = zoomlevels[to_underlying(vp.zoom)];
1562 MarkViewportDirty(vp, zl.left, zl.top, zl.right, zl.bottom);
1563 }
1564 }
1565}
1566
1567static void ViewportDrawTileSprites(const TileSpriteToDrawVector *tstdv)
1568{
1569 for (const TileSpriteToDraw &ts : *tstdv) {
1570 DrawSpriteViewport(ts.image, ts.pal, ts.x, ts.y, ts.sub);
1571 }
1572}
1573
1576{
1577 return true;
1578}
1579
1581static void ViewportSortParentSprites(ParentSpriteToSortVector *psdv)
1582{
1583 if (psdv->size() < 2) return;
1584
1585 /* We rely on sprites being, for the most part, already ordered.
1586 * So we don't need to move many of them and can keep track of their
1587 * order efficiently by using stack. We always move sprites to the front
1588 * of the current position, i.e. to the top of the stack.
1589 * Also use special constants to indicate sorting state without
1590 * adding extra fields to ParentSpriteToDraw structure.
1591 */
1592 const uint32_t ORDER_COMPARED = UINT32_MAX; // Sprite was compared but we still need to compare the ones preceding it
1593 const uint32_t ORDER_RETURNED = UINT32_MAX - 1; // Makr sorted sprite in case there are other occurrences of it in the stack
1594 std::stack<ParentSpriteToDraw *> sprite_order;
1595 uint32_t next_order = 0;
1596
1597 std::forward_list<std::pair<int64_t, ParentSpriteToDraw *>> sprite_list; // We store sprites in a list sorted by xmin+ymin
1598
1599 /* Initialize sprite list and order. */
1600 for (auto p = psdv->rbegin(); p != psdv->rend(); p++) {
1601 sprite_list.emplace_front((*p)->xmin + (*p)->ymin, *p);
1602 sprite_order.push(*p);
1603 (*p)->order = next_order++;
1604 }
1605
1606 sprite_list.sort();
1607
1608 std::vector<ParentSpriteToDraw *> preceding; // Temporarily stores sprites that precede current and their position in the list
1609 auto preceding_prev = sprite_list.begin(); // Store iterator in case we need to delete a single preceding sprite
1610 auto out = psdv->begin(); // Iterator to output sorted sprites
1611
1612 while (!sprite_order.empty()) {
1613
1614 auto s = sprite_order.top();
1615 sprite_order.pop();
1616
1617 /* Sprite is already sorted, ignore it. */
1618 if (s->order == ORDER_RETURNED) continue;
1619
1620 /* Sprite was already compared, just need to output it. */
1621 if (s->order == ORDER_COMPARED) {
1622 *(out++) = s;
1623 s->order = ORDER_RETURNED;
1624 continue;
1625 }
1626
1627 preceding.clear();
1628
1629 /* We only need sprites with xmin <= s->xmax && ymin <= s->ymax && zmin <= s->zmax
1630 * So by iterating sprites with xmin + ymin <= s->xmax + s->ymax
1631 * we get all we need and some more that we filter out later.
1632 * We don't include zmin into the sum as there are usually more neighbours on x and y than z
1633 * so including it will actually increase the amount of false positives.
1634 * Also min coordinates can be > max so using max(xmin, xmax) + max(ymin, ymax)
1635 * to ensure that we iterate the current sprite as we need to remove it from the list.
1636 */
1637 auto ssum = std::max(s->xmax, s->xmin) + std::max(s->ymax, s->ymin);
1638 auto prev = sprite_list.before_begin();
1639 auto x = sprite_list.begin();
1640 while (x != sprite_list.end() && ((*x).first <= ssum)) {
1641 auto p = (*x).second;
1642 if (p == s) {
1643 /* We found the current sprite, remove it and move on. */
1644 x = sprite_list.erase_after(prev);
1645 continue;
1646 }
1647
1648 auto p_prev = prev;
1649 prev = x++;
1650
1651 if (s->xmax < p->xmin || s->ymax < p->ymin || s->zmax < p->zmin) continue;
1652 if (s->xmin <= p->xmax && // overlap in X?
1653 s->ymin <= p->ymax && // overlap in Y?
1654 s->zmin <= p->zmax) { // overlap in Z?
1655 if (s->xmin + s->xmax + s->ymin + s->ymax + s->zmin + s->zmax <=
1656 p->xmin + p->xmax + p->ymin + p->ymax + p->zmin + p->zmax) {
1657 continue;
1658 }
1659 }
1660 preceding.push_back(p);
1661 preceding_prev = p_prev;
1662 }
1663
1664 if (preceding.empty()) {
1665 /* No preceding sprites, add current one to the output */
1666 *(out++) = s;
1667 s->order = ORDER_RETURNED;
1668 continue;
1669 }
1670
1671 /* Optimization for the case when we only have 1 sprite to move. */
1672 if (preceding.size() == 1) {
1673 auto p = preceding[0];
1674 /* We can only output the preceding sprite if there can't be any other sprites preceding it. */
1675 if (p->xmax <= s->xmax && p->ymax <= s->ymax && p->zmax <= s->zmax) {
1676 p->order = ORDER_RETURNED;
1677 s->order = ORDER_RETURNED;
1678 sprite_list.erase_after(preceding_prev);
1679 *(out++) = p;
1680 *(out++) = s;
1681 continue;
1682 }
1683 }
1684
1685 /* Sort all preceding sprites by order and assign new orders in reverse (as original sorter did). */
1686 std::sort(preceding.begin(), preceding.end(), [](const ParentSpriteToDraw *a, const ParentSpriteToDraw *b) {
1687 return a->order > b->order;
1688 });
1689
1690 s->order = ORDER_COMPARED;
1691 sprite_order.push(s); // Still need to output so push it back for now
1692
1693 for (auto p: preceding) {
1694 p->order = next_order++;
1695 sprite_order.push(p);
1696 }
1697 }
1698}
1699
1700
1701static void ViewportDrawParentSprites(const ParentSpriteToSortVector *psd, const ChildScreenSpriteToDrawVector *csstdv)
1702{
1703 for (const ParentSpriteToDraw *ps : *psd) {
1704 if (ps->image != SPR_EMPTY_BOUNDING_BOX) DrawSpriteViewport(ps->image, ps->pal, ps->x, ps->y, ps->sub);
1705
1706 int child_idx = ps->first_child;
1707 while (child_idx >= 0) {
1708 const ChildScreenSpriteToDraw *cs = &(*csstdv)[child_idx];
1709 child_idx = cs->next;
1710 if (cs->relative) {
1711 DrawSpriteViewport(cs->image, cs->pal, ps->left + cs->x, ps->top + cs->y, cs->sub);
1712 } else {
1713 DrawSpriteViewport(cs->image, cs->pal, ps->x + cs->x, ps->y + cs->y, cs->sub);
1714 }
1715 }
1716 }
1717}
1718
1723static void ViewportDrawBoundingBoxes(const ParentSpriteToSortVector *psd)
1724{
1725 for (const ParentSpriteToDraw *ps : *psd) {
1726 Point pt1 = RemapCoords(ps->xmax + 1, ps->ymax + 1, ps->zmax + 1); // top front corner
1727 Point pt2 = RemapCoords(ps->xmin , ps->ymax + 1, ps->zmax + 1); // top left corner
1728 Point pt3 = RemapCoords(ps->xmax + 1, ps->ymin , ps->zmax + 1); // top right corner
1729 Point pt4 = RemapCoords(ps->xmax + 1, ps->ymax + 1, ps->zmin ); // bottom front corner
1730
1731 DrawBox( pt1.x, pt1.y,
1732 pt2.x - pt1.x, pt2.y - pt1.y,
1733 pt3.x - pt1.x, pt3.y - pt1.y,
1734 pt4.x - pt1.x, pt4.y - pt1.y);
1735 }
1736}
1737
1742{
1744 const DrawPixelInfo *dpi = _cur_dpi;
1745 void *dst;
1746 int right = UnScaleByZoom(dpi->width, dpi->zoom);
1747 int bottom = UnScaleByZoom(dpi->height, dpi->zoom);
1748
1749 PixelColour colour = _string_colourmap[_dirty_block_colour & 0xF];
1750
1751 dst = dpi->dst_ptr;
1752
1753 uint8_t bo = UnScaleByZoom(dpi->left + dpi->top, dpi->zoom) & 1;
1754 do {
1755 for (int i = (bo ^= 1); i < right; i += 2) blitter->SetPixel(dst, i, 0, colour);
1756 dst = blitter->MoveTo(dst, 0, 1);
1757 } while (--bottom > 0);
1758}
1759
1760static void ViewportDrawStrings(ZoomLevel zoom, const StringSpriteToDrawVector *sstdv)
1761{
1762 for (const StringSpriteToDraw &ss : *sstdv) {
1763 bool small = ss.flags.Test(ViewportStringFlag::Small);
1764 int w = ss.width;
1765 int x = UnScaleByZoom(ss.x, zoom);
1766 int y = UnScaleByZoom(ss.y, zoom);
1767 int h = WidgetDimensions::scaled.fullbevel.top + GetCharacterHeight(small ? FS_SMALL : FS_NORMAL) + WidgetDimensions::scaled.fullbevel.bottom;
1768
1769 TextColour colour = TC_WHITE;
1770 if (ss.flags.Test(ViewportStringFlag::ColourRect)) {
1771 if (ss.colour != INVALID_COLOUR) DrawFrameRect(x, y, x + w - 1, y + h - 1, ss.colour, {});
1772 colour = TC_BLACK;
1773 } else if (ss.flags.Test(ViewportStringFlag::TransparentRect)) {
1774 DrawFrameRect(x, y, x + w - 1, y + h - 1, ss.colour, FrameFlag::Transparent);
1775 }
1776
1777 if (ss.flags.Test(ViewportStringFlag::TextColour)) {
1778 if (ss.colour != INVALID_COLOUR) colour = GetColourGradient(ss.colour, SHADE_LIGHTER).ToTextColour();
1779 }
1780
1781 int left = x + WidgetDimensions::scaled.fullbevel.left;
1782 int right = x + w - 1 - WidgetDimensions::scaled.fullbevel.right;
1783 int top = y + WidgetDimensions::scaled.fullbevel.top;
1784
1785 int shadow_offset = 0;
1786 if (small && ss.flags.Test(ViewportStringFlag::Shadow)) {
1787 /* Shadow needs to be shifted 1 pixel. */
1788 shadow_offset = WidgetDimensions::scaled.fullbevel.top;
1789 DrawString(left + shadow_offset, right + shadow_offset, top, ss.string, TC_BLACK, SA_HOR_CENTER, false, FS_SMALL);
1790 }
1791
1792 DrawString(left, right, top - shadow_offset, ss.string, colour, SA_HOR_CENTER, false, small ? FS_SMALL : FS_NORMAL);
1793 }
1794}
1795
1796void ViewportDoDraw(const Viewport &vp, int left, int top, int right, int bottom)
1797{
1798 _vd.dpi.zoom = vp.zoom;
1799 int mask = ScaleByZoom(-1, vp.zoom);
1800
1802
1803 _vd.dpi.width = (right - left) & mask;
1804 _vd.dpi.height = (bottom - top) & mask;
1805 _vd.dpi.left = left & mask;
1806 _vd.dpi.top = top & mask;
1807 _vd.dpi.pitch = _cur_dpi->pitch;
1808 _vd.last_child = LAST_CHILD_NONE;
1809
1810 int x = UnScaleByZoom(_vd.dpi.left - (vp.virtual_left & mask), vp.zoom) + vp.left;
1811 int y = UnScaleByZoom(_vd.dpi.top - (vp.virtual_top & mask), vp.zoom) + vp.top;
1812
1813 _vd.dpi.dst_ptr = BlitterFactory::GetCurrentBlitter()->MoveTo(_cur_dpi->dst_ptr, x - _cur_dpi->left, y - _cur_dpi->top);
1814 AutoRestoreBackup dpi_backup(_cur_dpi, &_vd.dpi);
1815
1817 ViewportAddVehicles(&_vd.dpi);
1818
1819 ViewportAddKdtreeSigns(&_vd.dpi);
1820
1821 DrawTextEffects(&_vd.dpi);
1822
1823 if (!_vd.tile_sprites_to_draw.empty()) ViewportDrawTileSprites(&_vd.tile_sprites_to_draw);
1824
1825 for (auto &psd : _vd.parent_sprites_to_draw) {
1826 _vd.parent_sprites_to_sort.push_back(&psd);
1827 }
1828
1829 _vp_sprite_sorter(&_vd.parent_sprites_to_sort);
1830 ViewportDrawParentSprites(&_vd.parent_sprites_to_sort, &_vd.child_screen_sprites_to_draw);
1831
1832 if (_draw_bounding_boxes) ViewportDrawBoundingBoxes(&_vd.parent_sprites_to_sort);
1833 if (_draw_dirty_blocks) ViewportDrawDirtyBlocks();
1834
1835 DrawPixelInfo dp = _vd.dpi;
1836 ZoomLevel zoom = _vd.dpi.zoom;
1837 dp.zoom = ZoomLevel::Min;
1838 dp.width = UnScaleByZoom(dp.width, zoom);
1839 dp.height = UnScaleByZoom(dp.height, zoom);
1840 AutoRestoreBackup cur_dpi(_cur_dpi, &dp);
1841
1842 if (vp.overlay != nullptr && vp.overlay->GetCargoMask() != 0 && vp.overlay->GetCompanyMask().Any()) {
1843 /* translate to window coordinates */
1844 dp.left = x;
1845 dp.top = y;
1846 vp.overlay->Draw(&dp);
1847 }
1848
1849 if (!_vd.string_sprites_to_draw.empty()) {
1850 /* translate to world coordinates */
1851 dp.left = UnScaleByZoom(_vd.dpi.left, zoom);
1852 dp.top = UnScaleByZoom(_vd.dpi.top, zoom);
1853 ViewportDrawStrings(zoom, &_vd.string_sprites_to_draw);
1854 }
1855
1856 _vd.string_sprites_to_draw.clear();
1857 _vd.tile_sprites_to_draw.clear();
1858 _vd.parent_sprites_to_draw.clear();
1859 _vd.parent_sprites_to_sort.clear();
1860 _vd.child_screen_sprites_to_draw.clear();
1861}
1862
1863static inline void ViewportDraw(const Viewport &vp, int left, int top, int right, int bottom)
1864{
1865 if (right <= vp.left || bottom <= vp.top) return;
1866
1867 if (left >= vp.left + vp.width) return;
1868
1869 if (left < vp.left) left = vp.left;
1870 if (right > vp.left + vp.width) right = vp.left + vp.width;
1871
1872 if (top >= vp.top + vp.height) return;
1873
1874 if (top < vp.top) top = vp.top;
1875 if (bottom > vp.top + vp.height) bottom = vp.top + vp.height;
1876
1877 ViewportDoDraw(vp,
1878 ScaleByZoom(left - vp.left, vp.zoom) + vp.virtual_left,
1879 ScaleByZoom(top - vp.top, vp.zoom) + vp.virtual_top,
1880 ScaleByZoom(right - vp.left, vp.zoom) + vp.virtual_left,
1881 ScaleByZoom(bottom - vp.top, vp.zoom) + vp.virtual_top
1882 );
1883}
1884
1889{
1891
1892 DrawPixelInfo *dpi = _cur_dpi;
1893
1894 dpi->left += this->left;
1895 dpi->top += this->top;
1896
1897 ViewportDraw(*this->viewport, dpi->left, dpi->top, dpi->left + dpi->width, dpi->top + dpi->height);
1898
1899 dpi->left -= this->left;
1900 dpi->top -= this->top;
1901}
1902
1913static inline void ClampViewportToMap(const Viewport &vp, int *scroll_x, int *scroll_y)
1914{
1915 /* Centre of the viewport is hot spot. */
1916 Point pt = {
1917 *scroll_x + vp.virtual_width / 2,
1918 *scroll_y + vp.virtual_height / 2
1919 };
1920
1921 /* Find nearest tile that is within borders of the map. */
1922 bool clamped;
1923 pt = InverseRemapCoords2(pt.x, pt.y, true, &clamped);
1924
1925 if (clamped) {
1926 /* Convert back to viewport coordinates and remove centering. */
1927 pt = RemapCoords2(pt.x, pt.y);
1928 *scroll_x = pt.x - vp.virtual_width / 2;
1929 *scroll_y = pt.y - vp.virtual_height / 2;
1930 }
1931}
1932
1945static void ClampSmoothScroll(uint32_t delta_ms, int64_t delta_hi, int64_t delta_lo, int &delta_hi_clamped, int &delta_lo_clamped)
1946{
1948 constexpr int PIXELS_PER_TILE = TILE_PIXELS * 2 * ZOOM_BASE;
1949
1950 assert(delta_hi != 0);
1951
1952 /* Move at most 75% of the distance every 30ms, for a smooth experience */
1953 int64_t delta_left = delta_hi * std::pow(0.75, delta_ms / 30.0);
1954 /* Move never more than 16 tiles per 30ms. */
1955 int max_scroll = Map::ScaleBySize1D(16 * PIXELS_PER_TILE * delta_ms / 30);
1956
1957 /* We never go over the max_scroll speed. */
1958 delta_hi_clamped = Clamp(delta_hi - delta_left, -max_scroll, max_scroll);
1959 /* The lower delta is in ratio of the higher delta, so we keep going straight at the destination. */
1960 delta_lo_clamped = delta_lo * delta_hi_clamped / delta_hi;
1961
1962 /* Ensure we always move (delta_hi can't be zero). */
1963 if (delta_hi_clamped == 0) {
1964 delta_hi_clamped = delta_hi > 0 ? 1 : -1;
1965 }
1966}
1967
1973void UpdateViewportPosition(Window *w, uint32_t delta_ms)
1974{
1975 ViewportData &vp = *w->viewport;
1976
1977 if (vp.follow_vehicle != VehicleID::Invalid()) {
1978 const Vehicle *veh = Vehicle::Get(vp.follow_vehicle);
1979 Point pt = MapXYZToViewport(vp, veh->x_pos, veh->y_pos, veh->z_pos);
1980
1981 vp.scrollpos_x = pt.x;
1982 vp.scrollpos_y = pt.y;
1983 SetViewportPosition(w, pt.x, pt.y);
1984 } else {
1985 /* Ensure the destination location is within the map */
1987
1988 int delta_x = vp.dest_scrollpos_x - vp.scrollpos_x;
1989 int delta_y = vp.dest_scrollpos_y - vp.scrollpos_y;
1990
1991 int current_x = vp.scrollpos_x;
1992 int current_y = vp.scrollpos_y;
1993
1994 bool update_overlay = false;
1995 if (delta_x != 0 || delta_y != 0) {
1997 int delta_x_clamped;
1998 int delta_y_clamped;
1999
2000 if (abs(delta_x) > abs(delta_y)) {
2001 ClampSmoothScroll(delta_ms, delta_x, delta_y, delta_x_clamped, delta_y_clamped);
2002 } else {
2003 ClampSmoothScroll(delta_ms, delta_y, delta_x, delta_y_clamped, delta_x_clamped);
2004 }
2005
2006 vp.scrollpos_x += delta_x_clamped;
2007 vp.scrollpos_y += delta_y_clamped;
2008 } else {
2011 }
2012 update_overlay = (vp.scrollpos_x == vp.dest_scrollpos_x &&
2013 vp.scrollpos_y == vp.dest_scrollpos_y);
2014 }
2015
2017
2018 /* When moving small amounts around the border we can get stuck, and
2019 * not actually move. In those cases, teleport to the destination. */
2020 if ((delta_x != 0 || delta_y != 0) && current_x == vp.scrollpos_x && current_y == vp.scrollpos_y) {
2023 }
2024
2025 SetViewportPosition(w, vp.scrollpos_x, vp.scrollpos_y);
2026 if (update_overlay) RebuildViewportOverlay(w);
2027 }
2028}
2029
2040static bool MarkViewportDirty(const Viewport &vp, int left, int top, int right, int bottom)
2041{
2042 /* Rounding wrt. zoom-out level */
2043 right += (1 << to_underlying(vp.zoom)) - 1;
2044 bottom += (1 << to_underlying(vp.zoom)) - 1;
2045
2046 right -= vp.virtual_left;
2047 if (right <= 0) return false;
2048
2049 bottom -= vp.virtual_top;
2050 if (bottom <= 0) return false;
2051
2052 left = std::max(0, left - vp.virtual_left);
2053
2054 if (left >= vp.virtual_width) return false;
2055
2056 top = std::max(0, top - vp.virtual_top);
2057
2058 if (top >= vp.virtual_height) return false;
2059
2061 UnScaleByZoomLower(left, vp.zoom) + vp.left,
2062 UnScaleByZoomLower(top, vp.zoom) + vp.top,
2063 UnScaleByZoom(right, vp.zoom) + vp.left + 1,
2064 UnScaleByZoom(bottom, vp.zoom) + vp.top + 1
2065 );
2066
2067 return true;
2068}
2069
2079bool MarkAllViewportsDirty(int left, int top, int right, int bottom)
2080{
2081 bool dirty = false;
2082
2083 for (const Window *w : Window::Iterate()) {
2084 if (w->viewport != nullptr) {
2085 assert(w->viewport->width != 0);
2086 if (MarkViewportDirty(*w->viewport, left, top, right, bottom)) dirty = true;
2087 }
2088 }
2089
2090 return dirty;
2091}
2092
2093void ConstrainAllViewportsZoom()
2094{
2095 for (Window *w : Window::Iterate()) {
2096 if (w->viewport == nullptr) continue;
2097
2099 if (zoom != w->viewport->zoom) {
2100 while (w->viewport->zoom < zoom) DoZoomInOutWindow(ZOOM_OUT, w);
2101 while (w->viewport->zoom > zoom) DoZoomInOutWindow(ZOOM_IN, w);
2102 }
2103 }
2104}
2105
2113void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
2114{
2115 Point pt = RemapCoords(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, tile_height_override * TILE_HEIGHT);
2118 pt.y - MAX_TILE_EXTENT_TOP - ZOOM_BASE * TILE_HEIGHT * bridge_level_offset,
2121}
2122
2131{
2132 int x_size = _thd.size.x;
2133 int y_size = _thd.size.y;
2134
2135 if (!_thd.diagonal) { // Selecting in a straight rectangle (or a single square)
2136 int x_start = _thd.pos.x;
2137 int y_start = _thd.pos.y;
2138
2139 if (_thd.outersize.x != 0) {
2140 x_size += _thd.outersize.x;
2141 x_start += _thd.offs.x;
2142 y_size += _thd.outersize.y;
2143 y_start += _thd.offs.y;
2144 }
2145
2146 x_size -= TILE_SIZE;
2147 y_size -= TILE_SIZE;
2148
2149 assert(x_size >= 0);
2150 assert(y_size >= 0);
2151
2152 int x_end = Clamp(x_start + x_size, 0, Map::SizeX() * TILE_SIZE - TILE_SIZE);
2153 int y_end = Clamp(y_start + y_size, 0, Map::SizeY() * TILE_SIZE - TILE_SIZE);
2154
2155 x_start = Clamp(x_start, 0, Map::SizeX() * TILE_SIZE - TILE_SIZE);
2156 y_start = Clamp(y_start, 0, Map::SizeY() * TILE_SIZE - TILE_SIZE);
2157
2158 /* make sure everything is multiple of TILE_SIZE */
2159 assert((x_end | y_end | x_start | y_start) % TILE_SIZE == 0);
2160
2161 /* How it works:
2162 * Suppose we have to mark dirty rectangle of 3x4 tiles:
2163 * x
2164 * xxx
2165 * xxxxx
2166 * xxxxx
2167 * xxx
2168 * x
2169 * This algorithm marks dirty columns of tiles, so it is done in 3+4-1 steps:
2170 * 1) x 2) x
2171 * xxx Oxx
2172 * Oxxxx xOxxx
2173 * xxxxx Oxxxx
2174 * xxx xxx
2175 * x x
2176 * And so forth...
2177 */
2178
2179 int top_x = x_end; // coordinates of top dirty tile
2180 int top_y = y_start;
2181 int bot_x = top_x; // coordinates of bottom dirty tile
2182 int bot_y = top_y;
2183
2184 do {
2185 /* topmost dirty point */
2186 TileIndex top_tile = TileVirtXY(top_x, top_y);
2187 Point top = RemapCoords(top_x, top_y, GetTileMaxPixelZ(top_tile));
2188
2189 /* bottommost point */
2190 TileIndex bottom_tile = TileVirtXY(bot_x, bot_y);
2191 Point bot = RemapCoords(bot_x + TILE_SIZE, bot_y + TILE_SIZE, GetTilePixelZ(bottom_tile)); // bottommost point
2192
2193 /* the 'x' coordinate of 'top' and 'bot' is the same (and always in the same distance from tile middle),
2194 * tile height/slope affects only the 'y' on-screen coordinate! */
2195
2196 int l = top.x - TILE_PIXELS * ZOOM_BASE; // 'x' coordinate of left side of the dirty rectangle
2197 int t = top.y; // 'y' coordinate of top side of the dirty rectangle
2198 int r = top.x + TILE_PIXELS * ZOOM_BASE; // 'x' coordinate of right side of the dirty rectangle
2199 int b = bot.y; // 'y' coordinate of bottom side of the dirty rectangle
2200
2201 static const int OVERLAY_WIDTH = 4 * ZOOM_BASE; // part of selection sprites is drawn outside the selected area (in particular: terraforming)
2202
2203 /* For halftile foundations on SLOPE_STEEP_S the sprite extents some more towards the top */
2204 MarkAllViewportsDirty(l - OVERLAY_WIDTH, t - OVERLAY_WIDTH - TILE_HEIGHT * ZOOM_BASE, r + OVERLAY_WIDTH, b + OVERLAY_WIDTH);
2205
2206 /* haven't we reached the topmost tile yet? */
2207 if (top_x != x_start) {
2208 top_x -= TILE_SIZE;
2209 } else {
2210 top_y += TILE_SIZE;
2211 }
2212
2213 /* the way the bottom tile changes is different when we reach the bottommost tile */
2214 if (bot_y != y_end) {
2215 bot_y += TILE_SIZE;
2216 } else {
2217 bot_x -= TILE_SIZE;
2218 }
2219 } while (bot_x >= top_x);
2220 } else { // Selecting in a 45 degrees rotated (diagonal) rectangle.
2221 /* a_size, b_size describe a rectangle with rotated coordinates */
2222 int a_size = x_size + y_size, b_size = x_size - y_size;
2223
2224 int interval_a = a_size < 0 ? -(int)TILE_SIZE : (int)TILE_SIZE;
2225 int interval_b = b_size < 0 ? -(int)TILE_SIZE : (int)TILE_SIZE;
2226
2227 for (int a = -interval_a; a != a_size + interval_a; a += interval_a) {
2228 for (int b = -interval_b; b != b_size + interval_b; b += interval_b) {
2229 uint x = (_thd.pos.x + (a + b) / 2) / TILE_SIZE;
2230 uint y = (_thd.pos.y + (a - b) / 2) / TILE_SIZE;
2231
2232 if (x < Map::MaxX() && y < Map::MaxY()) {
2234 }
2235 }
2236 }
2237 }
2238}
2239
2240
2241void SetSelectionRed(bool b)
2242{
2243 _thd.make_square_red = b;
2245}
2246
2255static bool CheckClickOnViewportSign(const Viewport &vp, int x, int y, const ViewportSign *sign)
2256{
2257 bool small = (vp.zoom >= ZoomLevel::Out4x);
2258 int sign_half_width = ScaleByZoom((small ? sign->width_small : sign->width_normal) / 2, vp.zoom);
2259 int sign_height = ScaleByZoom(WidgetDimensions::scaled.fullbevel.top + GetCharacterHeight(small ? FS_SMALL : FS_NORMAL) + WidgetDimensions::scaled.fullbevel.bottom, vp.zoom);
2260
2261 return y >= sign->top && y < sign->top + sign_height &&
2262 x >= sign->center - sign_half_width && x < sign->center + sign_half_width;
2263}
2264
2265
2273static bool CheckClickOnViewportSign(const Viewport &vp, int x, int y)
2274{
2275 if (_game_mode == GM_MENU) return false;
2276
2277 x = ScaleByZoom(x - vp.left, vp.zoom) + vp.virtual_left;
2278 y = ScaleByZoom(y - vp.top, vp.zoom) + vp.virtual_top;
2279
2280 Rect search_rect{ x - 1, y - 1, x + 1, y + 1 };
2281 search_rect = ExpandRectWithViewportSignMargins(search_rect, vp.zoom);
2282
2285 bool show_towns = HasBit(_display_opt, DO_SHOW_TOWN_NAMES);
2287 bool show_competitors = HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS);
2288
2289 /* Topmost of each type that was hit */
2290 BaseStation *st = nullptr, *last_st = nullptr;
2291 Town *t = nullptr, *last_t = nullptr;
2292 Sign *si = nullptr, *last_si = nullptr;
2293
2294 /* See ViewportAddKdtreeSigns() for details on the search logic */
2295 _viewport_sign_kdtree.FindContained(search_rect.left, search_rect.top, search_rect.right, search_rect.bottom, [&](const ViewportSignKdtreeItem & item) {
2296 switch (item.type) {
2297 case ViewportSignKdtreeItem::VKI_STATION: {
2298 if (!show_stations) break;
2299 st = BaseStation::Get(std::get<StationID>(item.id));
2300 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
2301
2302 StationFacilities facilities = st->facilities;
2303 if (facilities.None()) facilities = STATION_FACILITY_GHOST;
2304 if (!facilities.Any(_facility_display_opt)) break;
2305
2306 if (CheckClickOnViewportSign(vp, x, y, &st->sign)) last_st = st;
2307 break;
2308 }
2309
2310 case ViewportSignKdtreeItem::VKI_WAYPOINT:
2311 if (!show_waypoints) break;
2312 st = BaseStation::Get(std::get<StationID>(item.id));
2313 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
2314 if (CheckClickOnViewportSign(vp, x, y, &st->sign)) last_st = st;
2315 break;
2316
2317 case ViewportSignKdtreeItem::VKI_TOWN:
2318 if (!show_towns) break;
2319 t = Town::Get(std::get<TownID>(item.id));
2320 if (CheckClickOnViewportSign(vp, x, y, &t->cache.sign)) last_t = t;
2321 break;
2322
2323 case ViewportSignKdtreeItem::VKI_SIGN:
2324 if (!show_signs) break;
2325 si = Sign::Get(std::get<SignID>(item.id));
2326 if (!show_competitors && _local_company != si->owner && si->owner != OWNER_DEITY) break;
2327 if (CheckClickOnViewportSign(vp, x, y, &si->sign)) last_si = si;
2328 break;
2329
2330 default:
2331 NOT_REACHED();
2332 }
2333 });
2334
2335 /* Select which hit to handle based on priority */
2336 if (last_st != nullptr) {
2337 if (Station::IsExpected(last_st)) {
2338 ShowStationViewWindow(last_st->index);
2339 } else {
2341 }
2342 return true;
2343 } else if (last_t != nullptr) {
2344 ShowTownViewWindow(last_t->index);
2345 return true;
2346 } else if (last_si != nullptr) {
2347 HandleClickOnSign(last_si);
2348 return true;
2349 } else {
2350 return false;
2351 }
2352}
2353
2354
2355ViewportSignKdtreeItem ViewportSignKdtreeItem::MakeStation(StationID id)
2356{
2358 item.type = VKI_STATION;
2359 item.id = id;
2360
2361 const Station *st = Station::Get(id);
2362 assert(st->sign.kdtree_valid);
2363 item.center = st->sign.center;
2364 item.top = st->sign.top;
2365
2366 /* Assume the sign can be a candidate for drawing, so measure its width */
2367 _viewport_sign_maxwidth = std::max<int>({_viewport_sign_maxwidth, st->sign.width_normal, st->sign.width_small});
2368
2369 return item;
2370}
2371
2372ViewportSignKdtreeItem ViewportSignKdtreeItem::MakeWaypoint(StationID id)
2373{
2375 item.type = VKI_WAYPOINT;
2376 item.id = id;
2377
2378 const Waypoint *st = Waypoint::Get(id);
2379 assert(st->sign.kdtree_valid);
2380 item.center = st->sign.center;
2381 item.top = st->sign.top;
2382
2383 /* Assume the sign can be a candidate for drawing, so measure its width */
2384 _viewport_sign_maxwidth = std::max<int>({_viewport_sign_maxwidth, st->sign.width_normal, st->sign.width_small});
2385
2386 return item;
2387}
2388
2389ViewportSignKdtreeItem ViewportSignKdtreeItem::MakeTown(TownID id)
2390{
2392 item.type = VKI_TOWN;
2393 item.id = id;
2394
2395 const Town *town = Town::Get(id);
2396 assert(town->cache.sign.kdtree_valid);
2397 item.center = town->cache.sign.center;
2398 item.top = town->cache.sign.top;
2399
2400 /* Assume the sign can be a candidate for drawing, so measure its width */
2401 _viewport_sign_maxwidth = std::max<int>({_viewport_sign_maxwidth, town->cache.sign.width_normal, town->cache.sign.width_small});
2402
2403 return item;
2404}
2405
2406ViewportSignKdtreeItem ViewportSignKdtreeItem::MakeSign(SignID id)
2407{
2409 item.type = VKI_SIGN;
2410 item.id = id;
2411
2412 const Sign *sign = Sign::Get(id);
2413 assert(sign->sign.kdtree_valid);
2414 item.center = sign->sign.center;
2415 item.top = sign->sign.top;
2416
2417 /* Assume the sign can be a candidate for drawing, so measure its width */
2418 _viewport_sign_maxwidth = std::max<int>({_viewport_sign_maxwidth, sign->sign.width_normal, sign->sign.width_small});
2419
2420 return item;
2421}
2422
2423void RebuildViewportKdtree()
2424{
2425 /* Reset biggest size sign seen */
2426 _viewport_sign_maxwidth = 0;
2427
2428 std::vector<ViewportSignKdtreeItem> items;
2430
2431 for (const Station *st : Station::Iterate()) {
2432 if (st->sign.kdtree_valid) items.push_back(ViewportSignKdtreeItem::MakeStation(st->index));
2433 }
2434
2435 for (const Waypoint *wp : Waypoint::Iterate()) {
2436 if (wp->sign.kdtree_valid) items.push_back(ViewportSignKdtreeItem::MakeWaypoint(wp->index));
2437 }
2438
2439 for (const Town *town : Town::Iterate()) {
2440 if (town->cache.sign.kdtree_valid) items.push_back(ViewportSignKdtreeItem::MakeTown(town->index));
2441 }
2442
2443 for (const Sign *sign : Sign::Iterate()) {
2444 if (sign->sign.kdtree_valid) items.push_back(ViewportSignKdtreeItem::MakeSign(sign->index));
2445 }
2446
2447 _viewport_sign_kdtree.Build(items.begin(), items.end());
2448}
2449
2450
2451static bool CheckClickOnLandscape(const Viewport &vp, int x, int y)
2452{
2453 Point pt = TranslateXYToTileCoord(vp, x, y);
2454
2455 if (pt.x != -1) return ClickTile(TileVirtXY(pt.x, pt.y));
2456 return true;
2457}
2458
2459static void PlaceObject()
2460{
2461 Point pt;
2462 Window *w;
2463
2464 pt = GetTileBelowCursor();
2465 if (pt.x == -1) return;
2466
2467 if ((_thd.place_mode & HT_DRAG_MASK) == HT_POINT) {
2468 pt.x += TILE_SIZE / 2;
2469 pt.y += TILE_SIZE / 2;
2470 }
2471
2472 _tile_fract_coords.x = pt.x & TILE_UNIT_MASK;
2473 _tile_fract_coords.y = pt.y & TILE_UNIT_MASK;
2474
2475 w = _thd.GetCallbackWnd();
2476 if (w != nullptr) w->OnPlaceObject(pt, TileVirtXY(pt.x, pt.y));
2477}
2478
2479
2480bool HandleViewportClicked(const Viewport &vp, int x, int y)
2481{
2482 const Vehicle *v = CheckClickOnVehicle(vp, x, y);
2483
2484 if (_thd.place_mode & HT_VEHICLE) {
2485 if (v != nullptr && VehicleClicked(v)) return true;
2486 }
2487
2488 /* Vehicle placement mode already handled above. */
2489 if ((_thd.place_mode & HT_DRAG_MASK) != HT_NONE) {
2490 PlaceObject();
2491 return true;
2492 }
2493
2494 if (CheckClickOnViewportSign(vp, x, y)) return true;
2495 bool result = CheckClickOnLandscape(vp, x, y);
2496
2497 if (v != nullptr) {
2498 Debug(misc, 2, "Vehicle {} (index {}) at {}", v->unitnumber, v->index, fmt::ptr(v));
2500 v = v->First();
2501 if (_ctrl_pressed && v->owner == _local_company) {
2502 StartStopVehicle(v, true);
2503 } else {
2505 }
2506 }
2507 return true;
2508 }
2509 return result;
2510}
2511
2512void RebuildViewportOverlay(Window *w)
2513{
2514 if (w->viewport->overlay != nullptr &&
2515 w->viewport->overlay->GetCompanyMask().Any() &&
2516 w->viewport->overlay->GetCargoMask() != 0) {
2517 w->viewport->overlay->SetDirty();
2518 w->SetDirty();
2519 }
2520}
2521
2531bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
2532{
2533 /* The slope cannot be acquired outside of the map, so make sure we are always within the map. */
2534 if (z == -1) {
2535 if ( x >= 0 && x <= (int)Map::SizeX() * (int)TILE_SIZE - 1
2536 && y >= 0 && y <= (int)Map::SizeY() * (int)TILE_SIZE - 1) {
2537 z = GetSlopePixelZ(x, y);
2538 } else {
2539 z = TileHeightOutsideMap(x / (int)TILE_SIZE, y / (int)TILE_SIZE);
2540 }
2541 }
2542
2543 Point pt = MapXYZToViewport(*w->viewport, x, y, z);
2544 w->viewport->CancelFollow(*w);
2545
2546 if (w->viewport->dest_scrollpos_x == pt.x && w->viewport->dest_scrollpos_y == pt.y) return false;
2547
2548 if (instant) {
2549 w->viewport->scrollpos_x = pt.x;
2550 w->viewport->scrollpos_y = pt.y;
2551 RebuildViewportOverlay(w);
2552 }
2553
2554 w->viewport->dest_scrollpos_x = pt.x;
2555 w->viewport->dest_scrollpos_y = pt.y;
2556 return true;
2557}
2558
2566bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
2567{
2568 return ScrollWindowTo(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, -1, w, instant);
2569}
2570
2577bool ScrollMainWindowToTile(TileIndex tile, bool instant)
2578{
2579 return ScrollMainWindowTo(TileX(tile) * TILE_SIZE + TILE_SIZE / 2, TileY(tile) * TILE_SIZE + TILE_SIZE / 2, -1, instant);
2580}
2581
2587{
2588 TileIndex old;
2589
2590 old = _thd.redsq;
2591 _thd.redsq = tile;
2592
2593 if (tile != old) {
2594 if (tile != INVALID_TILE) MarkTileDirtyByTile(tile);
2595 if (old != INVALID_TILE) MarkTileDirtyByTile(old);
2596 }
2597}
2598
2604void SetTileSelectSize(int w, int h)
2605{
2606 _thd.new_size.x = w * TILE_SIZE;
2607 _thd.new_size.y = h * TILE_SIZE;
2608 _thd.new_outersize.x = 0;
2609 _thd.new_outersize.y = 0;
2610}
2611
2612void SetTileSelectBigSize(int ox, int oy, int sx, int sy)
2613{
2614 _thd.offs.x = ox * TILE_SIZE;
2615 _thd.offs.y = oy * TILE_SIZE;
2616 _thd.new_outersize.x = sx * TILE_SIZE;
2617 _thd.new_outersize.y = sy * TILE_SIZE;
2618}
2619
2621static HighLightStyle GetAutorailHT(int x, int y)
2622{
2623 return HT_RAIL | _autorail_piece[x & TILE_UNIT_MASK][y & TILE_UNIT_MASK];
2624}
2625
2630{
2631 this->pos.x = 0;
2632 this->pos.y = 0;
2633 this->new_pos.x = 0;
2634 this->new_pos.y = 0;
2635}
2636
2645
2654
2655
2656
2665{
2666 int x1;
2667 int y1;
2668
2669 if (_thd.freeze) return;
2670
2671 HighLightStyle new_drawstyle = HT_NONE;
2672 bool new_diagonal = false;
2673
2674 if ((_thd.place_mode & HT_DRAG_MASK) == HT_SPECIAL) {
2675 x1 = _thd.selend.x;
2676 y1 = _thd.selend.y;
2677 if (x1 != -1) {
2678 int x2 = _thd.selstart.x & ~TILE_UNIT_MASK;
2679 int y2 = _thd.selstart.y & ~TILE_UNIT_MASK;
2680 x1 &= ~TILE_UNIT_MASK;
2681 y1 &= ~TILE_UNIT_MASK;
2682
2683 if (_thd.IsDraggingDiagonal()) {
2684 new_diagonal = true;
2685 } else {
2686 if (x1 >= x2) std::swap(x1, x2);
2687 if (y1 >= y2) std::swap(y1, y2);
2688 }
2689 _thd.new_pos.x = x1;
2690 _thd.new_pos.y = y1;
2691 _thd.new_size.x = x2 - x1;
2692 _thd.new_size.y = y2 - y1;
2693 if (!new_diagonal) {
2694 _thd.new_size.x += TILE_SIZE;
2695 _thd.new_size.y += TILE_SIZE;
2696 }
2697 new_drawstyle = _thd.next_drawstyle;
2698 }
2699 } else if ((_thd.place_mode & HT_DRAG_MASK) != HT_NONE) {
2700 Point pt = GetTileBelowCursor();
2701 x1 = pt.x;
2702 y1 = pt.y;
2703 if (x1 != -1) {
2704 switch (_thd.place_mode & HT_DRAG_MASK) {
2705 case HT_RECT:
2706 new_drawstyle = HT_RECT;
2707 break;
2708 case HT_POINT:
2709 new_drawstyle = HT_POINT;
2710 x1 += TILE_SIZE / 2;
2711 y1 += TILE_SIZE / 2;
2712 break;
2713 case HT_RAIL:
2714 /* Draw one highlighted tile in any direction */
2715 new_drawstyle = GetAutorailHT(pt.x, pt.y);
2716 break;
2717 case HT_LINE:
2718 switch (_thd.place_mode & HT_DIR_MASK) {
2719 case HT_DIR_X: new_drawstyle = HT_LINE | HT_DIR_X; break;
2720 case HT_DIR_Y: new_drawstyle = HT_LINE | HT_DIR_Y; break;
2721
2722 case HT_DIR_HU:
2723 case HT_DIR_HL:
2724 new_drawstyle = (pt.x & TILE_UNIT_MASK) + (pt.y & TILE_UNIT_MASK) <= TILE_SIZE ? HT_LINE | HT_DIR_HU : HT_LINE | HT_DIR_HL;
2725 break;
2726
2727 case HT_DIR_VL:
2728 case HT_DIR_VR:
2729 new_drawstyle = (pt.x & TILE_UNIT_MASK) > (pt.y & TILE_UNIT_MASK) ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
2730 break;
2731
2732 default: NOT_REACHED();
2733 }
2734 _thd.selstart.x = x1 & ~TILE_UNIT_MASK;
2735 _thd.selstart.y = y1 & ~TILE_UNIT_MASK;
2736 break;
2737 default:
2738 NOT_REACHED();
2739 }
2740 _thd.new_pos.x = x1 & ~TILE_UNIT_MASK;
2741 _thd.new_pos.y = y1 & ~TILE_UNIT_MASK;
2742 }
2743 }
2744
2745 /* redraw selection */
2746 if (_thd.drawstyle != new_drawstyle ||
2747 _thd.pos.x != _thd.new_pos.x || _thd.pos.y != _thd.new_pos.y ||
2748 _thd.size.x != _thd.new_size.x || _thd.size.y != _thd.new_size.y ||
2749 _thd.outersize.x != _thd.new_outersize.x ||
2750 _thd.outersize.y != _thd.new_outersize.y ||
2751 _thd.diagonal != new_diagonal) {
2752 /* Clear the old tile selection? */
2754
2755 _thd.drawstyle = new_drawstyle;
2756 _thd.pos = _thd.new_pos;
2757 _thd.size = _thd.new_size;
2758 _thd.outersize = _thd.new_outersize;
2759 _thd.diagonal = new_diagonal;
2760 _thd.dirty = 0xff;
2761
2762 /* Draw the new tile selection? */
2763 if ((new_drawstyle & HT_DRAG_MASK) != HT_NONE) SetSelectionTilesDirty();
2764 }
2765}
2766
2771static inline void ShowMeasurementTooltips(EncodedString &&text)
2772{
2774 GuiShowTooltips(_thd.GetCallbackWnd(), std::move(text), TCC_EXIT_VIEWPORT);
2775}
2776
2777static void HideMeasurementTooltips()
2778{
2780}
2781
2784{
2785 _thd.select_method = method;
2786 _thd.select_proc = process;
2787 _thd.selend.x = TileX(tile) * TILE_SIZE;
2788 _thd.selstart.x = TileX(tile) * TILE_SIZE;
2789 _thd.selend.y = TileY(tile) * TILE_SIZE;
2790 _thd.selstart.y = TileY(tile) * TILE_SIZE;
2791
2792 /* Needed so several things (road, autoroad, bridges, ...) are placed correctly.
2793 * In effect, placement starts from the centre of a tile
2794 */
2795 if (method == VPM_X_OR_Y || method == VPM_FIX_X || method == VPM_FIX_Y) {
2796 _thd.selend.x += TILE_SIZE / 2;
2797 _thd.selend.y += TILE_SIZE / 2;
2798 _thd.selstart.x += TILE_SIZE / 2;
2799 _thd.selstart.y += TILE_SIZE / 2;
2800 }
2801
2803 if ((_thd.place_mode & HT_DRAG_MASK) == HT_RECT) {
2804 _thd.place_mode = HT_SPECIAL | others;
2805 _thd.next_drawstyle = HT_RECT | others;
2806 } else if (_thd.place_mode & (HT_RAIL | HT_LINE)) {
2807 _thd.place_mode = HT_SPECIAL | others;
2808 _thd.next_drawstyle = _thd.drawstyle | others;
2809 } else {
2810 _thd.place_mode = HT_SPECIAL | others;
2811 _thd.next_drawstyle = HT_POINT | others;
2812 }
2814}
2815
2818{
2820 _thd.select_proc = process;
2821 _thd.selstart.x = 0;
2822 _thd.selstart.y = 0;
2823 _thd.next_drawstyle = HT_RECT;
2824
2826}
2827
2828void VpSetPlaceSizingLimit(int limit)
2829{
2830 _thd.sizelimit = limit;
2831}
2832
2839{
2840 uint64_t distance = DistanceManhattan(from, to) + 1;
2841
2842 _thd.selend.x = TileX(to) * TILE_SIZE;
2843 _thd.selend.y = TileY(to) * TILE_SIZE;
2844 _thd.selstart.x = TileX(from) * TILE_SIZE;
2845 _thd.selstart.y = TileY(from) * TILE_SIZE;
2846 _thd.next_drawstyle = HT_RECT;
2847
2848 /* show measurement only if there is any length to speak of */
2849 if (distance > 1) {
2850 ShowMeasurementTooltips(GetEncodedString(STR_MEASURE_LENGTH, distance));
2851 } else {
2852 HideMeasurementTooltips();
2853 }
2854}
2855
2856static void VpStartPreSizing()
2857{
2858 _thd.selend.x = -1;
2860}
2861
2867{
2868 int fxpy = _tile_fract_coords.x + _tile_fract_coords.y;
2869 int sxpy = (_thd.selend.x & TILE_UNIT_MASK) + (_thd.selend.y & TILE_UNIT_MASK);
2870 int fxmy = _tile_fract_coords.x - _tile_fract_coords.y;
2871 int sxmy = (_thd.selend.x & TILE_UNIT_MASK) - (_thd.selend.y & TILE_UNIT_MASK);
2872
2873 switch (mode) {
2874 default: NOT_REACHED();
2875 case 0: // end piece is lower right
2876 if (fxpy >= 20 && sxpy <= 12) return HT_DIR_HL;
2877 if (fxmy < -3 && sxmy > 3) return HT_DIR_VR;
2878 return HT_DIR_Y;
2879
2880 case 1:
2881 if (fxmy > 3 && sxmy < -3) return HT_DIR_VL;
2882 if (fxpy <= 12 && sxpy >= 20) return HT_DIR_HU;
2883 return HT_DIR_Y;
2884
2885 case 2:
2886 if (fxmy > 3 && sxmy < -3) return HT_DIR_VL;
2887 if (fxpy >= 20 && sxpy <= 12) return HT_DIR_HL;
2888 return HT_DIR_X;
2889
2890 case 3:
2891 if (fxmy < -3 && sxmy > 3) return HT_DIR_VR;
2892 if (fxpy <= 12 && sxpy >= 20) return HT_DIR_HU;
2893 return HT_DIR_X;
2894 }
2895}
2896
2910static bool SwapDirection(HighLightStyle style, TileIndex start_tile, TileIndex end_tile)
2911{
2912 uint start_x = TileX(start_tile);
2913 uint start_y = TileY(start_tile);
2914 uint end_x = TileX(end_tile);
2915 uint end_y = TileY(end_tile);
2916
2917 switch (style & HT_DRAG_MASK) {
2918 case HT_RAIL:
2919 case HT_LINE: return (end_x > start_x || (end_x == start_x && end_y > start_y));
2920
2921 case HT_RECT:
2922 case HT_POINT: return (end_x != start_x && end_y < start_y);
2923 default: NOT_REACHED();
2924 }
2925
2926 return false;
2927}
2928
2944static int CalcHeightdiff(HighLightStyle style, uint distance, TileIndex start_tile, TileIndex end_tile)
2945{
2946 bool swap = SwapDirection(style, start_tile, end_tile);
2947 uint h0, h1; // Start height and end height.
2948
2949 if (start_tile == end_tile) return 0;
2950 if (swap) std::swap(start_tile, end_tile);
2951
2952 switch (style & HT_DRAG_MASK) {
2953 case HT_RECT:
2954 /* In the case of an area we can determine whether we were dragging south or
2955 * east by checking the X-coordinates of the tiles */
2956 if (TileX(end_tile) > TileX(start_tile)) {
2957 /* Dragging south does not need to change the start tile. */
2958 end_tile = TileAddByDir(end_tile, DIR_S);
2959 } else {
2960 /* Dragging east. */
2961 start_tile = TileAddByDir(start_tile, DIR_SW);
2962 end_tile = TileAddByDir(end_tile, DIR_SE);
2963 }
2964 [[fallthrough]];
2965
2966 case HT_POINT:
2967 h0 = TileHeight(start_tile);
2968 h1 = TileHeight(end_tile);
2969 break;
2970 default: { // All other types, this is mostly only line/autorail
2971 static const HighLightStyle flip_style_direction[] = {
2973 };
2974 static const std::pair<TileIndexDiffC, TileIndexDiffC> start_heightdiff_line_by_dir[] = {
2975 { {1, 0}, {1, 1} }, // HT_DIR_X
2976 { {0, 1}, {1, 1} }, // HT_DIR_Y
2977 { {1, 0}, {0, 0} }, // HT_DIR_HU
2978 { {1, 0}, {1, 1} }, // HT_DIR_HL
2979 { {1, 0}, {1, 1} }, // HT_DIR_VL
2980 { {0, 1}, {1, 1} }, // HT_DIR_VR
2981 };
2982 static const std::pair<TileIndexDiffC, TileIndexDiffC> end_heightdiff_line_by_dir[] = {
2983 { {0, 1}, {0, 0} }, // HT_DIR_X
2984 { {1, 0}, {0, 0} }, // HT_DIR_Y
2985 { {0, 1}, {0, 0} }, // HT_DIR_HU
2986 { {1, 1}, {0, 1} }, // HT_DIR_HL
2987 { {1, 0}, {0, 0} }, // HT_DIR_VL
2988 { {0, 0}, {0, 1} }, // HT_DIR_VR
2989 };
2990 static_assert(std::size(start_heightdiff_line_by_dir) == HT_DIR_END);
2991 static_assert(std::size(end_heightdiff_line_by_dir) == HT_DIR_END);
2992
2993 distance %= 2; // we're only interested if the distance is even or uneven
2994 style &= HT_DIR_MASK;
2995 assert(style < HT_DIR_END);
2996
2997 /* To handle autorail, we do some magic to be able to use a lookup table.
2998 * Firstly if we drag the other way around, we switch start&end, and if needed
2999 * also flip the drag-position. Eg if it was on the left, and the distance is even
3000 * that means the end, which is now the start is on the right */
3001 if (swap && distance == 0) style = flip_style_direction[style];
3002
3003 /* Lambda to help calculating the height at one side of the line. */
3004 auto get_height = [](auto &tile, auto &heightdiffs) {
3005 return std::max(
3006 TileHeight(TileAdd(tile, ToTileIndexDiff(heightdiffs.first))),
3007 TileHeight(TileAdd(tile, ToTileIndexDiff(heightdiffs.second))));
3008 };
3009
3010 /* Use lookup table for start-tile based on HighLightStyle direction */
3011 h0 = get_height(start_tile, start_heightdiff_line_by_dir[style]);
3012
3013 /* Use lookup table for end-tile based on HighLightStyle direction
3014 * flip around side (lower/upper, left/right) based on distance */
3015 if (distance == 0) style = flip_style_direction[style];
3016 h1 = get_height(end_tile, end_heightdiff_line_by_dir[style]);
3017 break;
3018 }
3019 }
3020
3021 if (swap) std::swap(h0, h1);
3022 return (int)(h1 - h0) * TILE_HEIGHT_STEP;
3023}
3024
3031static void CheckUnderflow(int &test, int &other, int mult)
3032{
3033 if (test >= 0) return;
3034
3035 other += mult * test;
3036 test = 0;
3037}
3038
3046static void CheckOverflow(int &test, int &other, int max, int mult)
3047{
3048 if (test <= max) return;
3049
3050 other += mult * (test - max);
3051 test = max;
3052}
3053
3055static void CalcRaildirsDrawstyle(int x, int y, int method)
3056{
3058
3059 int dx = _thd.selstart.x - (_thd.selend.x & ~TILE_UNIT_MASK);
3060 int dy = _thd.selstart.y - (_thd.selend.y & ~TILE_UNIT_MASK);
3061 uint w = abs(dx) + TILE_SIZE;
3062 uint h = abs(dy) + TILE_SIZE;
3063
3064 if (method & ~(VPM_RAILDIRS | VPM_SIGNALDIRS)) {
3065 /* We 'force' a selection direction; first four rail buttons. */
3066 method &= ~(VPM_RAILDIRS | VPM_SIGNALDIRS);
3067 int raw_dx = _thd.selstart.x - _thd.selend.x;
3068 int raw_dy = _thd.selstart.y - _thd.selend.y;
3069 switch (method) {
3070 case VPM_FIX_X:
3071 b = HT_LINE | HT_DIR_Y;
3072 x = _thd.selstart.x;
3073 break;
3074
3075 case VPM_FIX_Y:
3076 b = HT_LINE | HT_DIR_X;
3077 y = _thd.selstart.y;
3078 break;
3079
3080 case VPM_FIX_HORIZONTAL:
3081 if (dx == -dy) {
3082 /* We are on a straight horizontal line. Determine the 'rail'
3083 * to build based the sub tile location. */
3085 } else {
3086 /* We are not on a straight line. Determine the rail to build
3087 * based on whether we are above or below it. */
3088 b = dx + dy >= (int)TILE_SIZE ? HT_LINE | HT_DIR_HU : HT_LINE | HT_DIR_HL;
3089
3090 /* Calculate where a horizontal line through the start point and
3091 * a vertical line from the selected end point intersect and
3092 * use that point as the end point. */
3093 int offset = (raw_dx - raw_dy) / 2;
3094 x = _thd.selstart.x - (offset & ~TILE_UNIT_MASK);
3095 y = _thd.selstart.y + (offset & ~TILE_UNIT_MASK);
3096
3097 /* 'Build' the last half rail tile if needed */
3098 if ((offset & TILE_UNIT_MASK) > (TILE_SIZE / 2)) {
3099 if (dx + dy >= (int)TILE_SIZE) {
3100 x -= (int)TILE_SIZE;
3101 } else {
3102 y += (int)TILE_SIZE;
3103 }
3104 }
3105
3106 /* Make sure we do not overflow the map! */
3107 CheckUnderflow(x, y, 1);
3108 CheckUnderflow(y, x, 1);
3109 CheckOverflow(x, y, (Map::MaxX() - 1) * TILE_SIZE, 1);
3110 CheckOverflow(y, x, (Map::MaxY() - 1) * TILE_SIZE, 1);
3111 assert(x >= 0 && y >= 0 && x <= (int)(Map::MaxX() * TILE_SIZE) && y <= (int)(Map::MaxY() * TILE_SIZE));
3112 }
3113 break;
3114
3115 case VPM_FIX_VERTICAL:
3116 if (dx == dy) {
3117 /* We are on a straight vertical line. Determine the 'rail'
3118 * to build based the sub tile location. */
3120 } else {
3121 /* We are not on a straight line. Determine the rail to build
3122 * based on whether we are left or right from it. */
3123 b = dx < dy ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
3124
3125 /* Calculate where a vertical line through the start point and
3126 * a horizontal line from the selected end point intersect and
3127 * use that point as the end point. */
3128 int offset = (raw_dx + raw_dy + (int)TILE_SIZE) / 2;
3129 x = _thd.selstart.x - (offset & ~TILE_UNIT_MASK);
3130 y = _thd.selstart.y - (offset & ~TILE_UNIT_MASK);
3131
3132 /* 'Build' the last half rail tile if needed */
3133 if ((offset & TILE_UNIT_MASK) > (TILE_SIZE / 2)) {
3134 if (dx < dy) {
3135 y -= (int)TILE_SIZE;
3136 } else {
3137 x -= (int)TILE_SIZE;
3138 }
3139 }
3140
3141 /* Make sure we do not overflow the map! */
3142 CheckUnderflow(x, y, -1);
3143 CheckUnderflow(y, x, -1);
3144 CheckOverflow(x, y, (Map::MaxX() - 1) * TILE_SIZE, -1);
3145 CheckOverflow(y, x, (Map::MaxY() - 1) * TILE_SIZE, -1);
3146 assert(x >= 0 && y >= 0 && x <= (int)(Map::MaxX() * TILE_SIZE) && y <= (int)(Map::MaxY() * TILE_SIZE));
3147 }
3148 break;
3149
3150 default:
3151 NOT_REACHED();
3152 }
3153 } else if (TileVirtXY(_thd.selstart.x, _thd.selstart.y) == TileVirtXY(x, y)) { // check if we're only within one tile
3154 if (method & VPM_RAILDIRS) {
3155 b = GetAutorailHT(x, y);
3156 } else { // rect for autosignals on one tile
3157 b = HT_RECT;
3158 }
3159 } else if (h == TILE_SIZE) { // Is this in X direction?
3160 if (dx == (int)TILE_SIZE) { // 2x1 special handling
3161 b = (Check2x1AutoRail(3)) | HT_LINE;
3162 } else if (dx == -(int)TILE_SIZE) {
3163 b = (Check2x1AutoRail(2)) | HT_LINE;
3164 } else {
3165 b = HT_LINE | HT_DIR_X;
3166 }
3167 y = _thd.selstart.y;
3168 } else if (w == TILE_SIZE) { // Or Y direction?
3169 if (dy == (int)TILE_SIZE) { // 2x1 special handling
3170 b = (Check2x1AutoRail(1)) | HT_LINE;
3171 } else if (dy == -(int)TILE_SIZE) { // 2x1 other direction
3172 b = (Check2x1AutoRail(0)) | HT_LINE;
3173 } else {
3174 b = HT_LINE | HT_DIR_Y;
3175 }
3176 x = _thd.selstart.x;
3177 } else if (w > h * 2) { // still count as x dir?
3178 b = HT_LINE | HT_DIR_X;
3179 y = _thd.selstart.y;
3180 } else if (h > w * 2) { // still count as y dir?
3181 b = HT_LINE | HT_DIR_Y;
3182 x = _thd.selstart.x;
3183 } else { // complicated direction
3184 int d = w - h;
3185 _thd.selend.x = _thd.selend.x & ~TILE_UNIT_MASK;
3186 _thd.selend.y = _thd.selend.y & ~TILE_UNIT_MASK;
3187
3188 /* four cases. */
3189 if (x > _thd.selstart.x) {
3190 if (y > _thd.selstart.y) {
3191 /* south */
3192 if (d == 0) {
3194 } else if (d >= 0) {
3195 x = _thd.selstart.x + h;
3196 b = HT_LINE | HT_DIR_VL;
3197 } else {
3198 y = _thd.selstart.y + w;
3199 b = HT_LINE | HT_DIR_VR;
3200 }
3201 } else {
3202 /* west */
3203 if (d == 0) {
3205 } else if (d >= 0) {
3206 x = _thd.selstart.x + h;
3207 b = HT_LINE | HT_DIR_HL;
3208 } else {
3209 y = _thd.selstart.y - w;
3210 b = HT_LINE | HT_DIR_HU;
3211 }
3212 }
3213 } else {
3214 if (y > _thd.selstart.y) {
3215 /* east */
3216 if (d == 0) {
3218 } else if (d >= 0) {
3219 x = _thd.selstart.x - h;
3220 b = HT_LINE | HT_DIR_HU;
3221 } else {
3222 y = _thd.selstart.y + w;
3223 b = HT_LINE | HT_DIR_HL;
3224 }
3225 } else {
3226 /* north */
3227 if (d == 0) {
3229 } else if (d >= 0) {
3230 x = _thd.selstart.x - h;
3231 b = HT_LINE | HT_DIR_VR;
3232 } else {
3233 y = _thd.selstart.y - w;
3234 b = HT_LINE | HT_DIR_VL;
3235 }
3236 }
3237 }
3238 }
3239
3241 TileIndex t0 = TileVirtXY(_thd.selstart.x, _thd.selstart.y);
3242 TileIndex t1 = TileVirtXY(x, y);
3243 uint distance = DistanceManhattan(t0, t1) + 1;
3244
3245 if (distance == 1) {
3246 HideMeasurementTooltips();
3247 } else {
3248 int heightdiff = CalcHeightdiff(b, distance, t0, t1);
3249 /* If we are showing a tooltip for horizontal or vertical drags,
3250 * 2 tiles have a length of 1. To bias towards the ceiling we add
3251 * one before division. It feels more natural to count 3 lengths as 2 */
3252 if ((b & HT_DIR_MASK) != HT_DIR_X && (b & HT_DIR_MASK) != HT_DIR_Y) {
3253 distance = CeilDiv(distance, 2);
3254 }
3255
3256 if (heightdiff == 0) {
3257 ShowMeasurementTooltips(GetEncodedString(STR_MEASURE_LENGTH, distance));
3258 } else {
3259 ShowMeasurementTooltips(GetEncodedString(STR_MEASURE_LENGTH_HEIGHTDIFF, distance, heightdiff));
3260 }
3261 }
3262 }
3263
3264 _thd.selend.x = x;
3265 _thd.selend.y = y;
3266 _thd.next_drawstyle = b;
3267}
3268
3277{
3278 int sx, sy;
3279 HighLightStyle style;
3280
3281 if (x == -1) {
3282 _thd.selend.x = -1;
3283 return;
3284 }
3285
3286 /* Special handling of drag in any (8-way) direction */
3287 if (method & (VPM_RAILDIRS | VPM_SIGNALDIRS)) {
3288 _thd.selend.x = x;
3289 _thd.selend.y = y;
3290 CalcRaildirsDrawstyle(x, y, method);
3291 return;
3292 }
3293
3294 /* Needed so level-land is placed correctly */
3295 if ((_thd.next_drawstyle & HT_DRAG_MASK) == HT_POINT) {
3296 x += TILE_SIZE / 2;
3297 y += TILE_SIZE / 2;
3298 }
3299
3300 sx = _thd.selstart.x;
3301 sy = _thd.selstart.y;
3302
3303 int limit = 0;
3304
3305 switch (method) {
3306 case VPM_X_OR_Y: // drag in X or Y direction
3307 if (abs(sy - y) < abs(sx - x)) {
3308 y = sy;
3309 style = HT_DIR_X;
3310 } else {
3311 x = sx;
3312 style = HT_DIR_Y;
3313 }
3314 goto calc_heightdiff_single_direction;
3315
3316 case VPM_X_LIMITED: // Drag in X direction (limited size).
3317 limit = (_thd.sizelimit - 1) * TILE_SIZE;
3318 [[fallthrough]];
3319
3320 case VPM_FIX_X: // drag in Y direction
3321 x = sx;
3322 style = HT_DIR_Y;
3323 goto calc_heightdiff_single_direction;
3324
3325 case VPM_Y_LIMITED: // Drag in Y direction (limited size).
3326 limit = (_thd.sizelimit - 1) * TILE_SIZE;
3327 [[fallthrough]];
3328
3329 case VPM_FIX_Y: // drag in X direction
3330 y = sy;
3331 style = HT_DIR_X;
3332
3333calc_heightdiff_single_direction:;
3334 if (limit > 0) {
3335 x = sx + Clamp(x - sx, -limit, limit);
3336 y = sy + Clamp(y - sy, -limit, limit);
3337 }
3339 TileIndex t0 = TileVirtXY(sx, sy);
3340 TileIndex t1 = TileVirtXY(x, y);
3341 uint distance = DistanceManhattan(t0, t1) + 1;
3342
3343 if (distance == 1) {
3344 HideMeasurementTooltips();
3345 } else {
3346 /* With current code passing a HT_LINE style to calculate the height
3347 * difference is enough. However if/when a point-tool is created
3348 * with this method, function should be called with new_style (below)
3349 * instead of HT_LINE | style case HT_POINT is handled specially
3350 * new_style := (_thd.next_drawstyle & HT_RECT) ? HT_LINE | style : _thd.next_drawstyle; */
3351 int heightdiff = CalcHeightdiff(HT_LINE | style, 0, t0, t1);
3352
3353 if (heightdiff == 0) {
3354 ShowMeasurementTooltips(GetEncodedString(STR_MEASURE_LENGTH, distance));
3355 } else {
3356 ShowMeasurementTooltips(GetEncodedString(STR_MEASURE_LENGTH_HEIGHTDIFF, distance, heightdiff));
3357 }
3358 }
3359 }
3360 break;
3361
3362 case VPM_X_AND_Y_LIMITED: // Drag an X by Y constrained rect area.
3363 limit = (_thd.sizelimit - 1) * TILE_SIZE;
3364 x = sx + Clamp(x - sx, -limit, limit);
3365 y = sy + Clamp(y - sy, -limit, limit);
3366 [[fallthrough]];
3367
3368 case VPM_X_AND_Y: // drag an X by Y area
3370 TileIndex t0 = TileVirtXY(sx, sy);
3371 TileIndex t1 = TileVirtXY(x, y);
3372 uint dx = Delta(TileX(t0), TileX(t1)) + 1;
3373 uint dy = Delta(TileY(t0), TileY(t1)) + 1;
3374
3375 /* If dragging an area (eg dynamite tool) and it is actually a single
3376 * row/column, change the type to 'line' to get proper calculation for height */
3377 style = (HighLightStyle)_thd.next_drawstyle;
3378 if (_thd.IsDraggingDiagonal()) {
3379 /* Determine the "area" of the diagonal dragged selection.
3380 * We assume the area is the number of tiles along the X
3381 * edge and the number of tiles along the Y edge. However,
3382 * multiplying these two numbers does not give the exact
3383 * number of tiles; basically we are counting the black
3384 * squares on a chess board and ignore the white ones to
3385 * make the tile counts at the edges match up. There is no
3386 * other way to make a proper count though.
3387 *
3388 * First convert to the rotated coordinate system. */
3389 int dist_x = TileX(t0) - TileX(t1);
3390 int dist_y = TileY(t0) - TileY(t1);
3391 int a_max = dist_x + dist_y;
3392 int b_max = dist_y - dist_x;
3393
3394 /* Now determine the size along the edge, but due to the
3395 * chess board principle this counts double. */
3396 a_max = abs(a_max + (a_max > 0 ? 2 : -2)) / 2;
3397 b_max = abs(b_max + (b_max > 0 ? 2 : -2)) / 2;
3398
3399 /* We get a 1x1 on normal 2x1 rectangles, due to it being
3400 * a seen as two sides. As the result for actual building
3401 * will be the same as non-diagonal dragging revert to that
3402 * behaviour to give it a more normally looking size. */
3403 if (a_max != 1 || b_max != 1) {
3404 dx = a_max;
3405 dy = b_max;
3406 }
3407 } else if (style & HT_RECT) {
3408 if (dx == 1) {
3409 style = HT_LINE | HT_DIR_Y;
3410 } else if (dy == 1) {
3411 style = HT_LINE | HT_DIR_X;
3412 }
3413 }
3414
3415 if (dx != 1 || dy != 1) {
3416 int heightdiff = CalcHeightdiff(style, 0, t0, t1);
3417
3418 dx -= (style & HT_POINT ? 1 : 0);
3419 dy -= (style & HT_POINT ? 1 : 0);
3420
3421 if (heightdiff == 0) {
3422 ShowMeasurementTooltips(GetEncodedString(STR_MEASURE_AREA, dx, dy));
3423 } else {
3424 ShowMeasurementTooltips(GetEncodedString(STR_MEASURE_AREA_HEIGHTDIFF, dx, dy, heightdiff));
3425 }
3426 }
3427 }
3428 break;
3429
3430 default: NOT_REACHED();
3431 }
3432
3433 _thd.selend.x = x;
3434 _thd.selend.y = y;
3435}
3436
3442{
3444
3445 /* stop drag mode if the window has been closed */
3446 Window *w = _thd.GetCallbackWnd();
3447 if (w == nullptr) {
3449 return ES_HANDLED;
3450 }
3451
3452 /* while dragging execute the drag procedure of the corresponding window (mostly VpSelectTilesWithMethod() ) */
3453 if (_left_button_down) {
3455 /* Only register a drag event when the mouse moved. */
3456 if (_thd.new_pos.x == _thd.selstart.x && _thd.new_pos.y == _thd.selstart.y) return ES_HANDLED;
3457 _thd.selstart.x = _thd.new_pos.x;
3458 _thd.selstart.y = _thd.new_pos.y;
3459 }
3460
3461 w->OnPlaceDrag(_thd.select_method, _thd.select_proc, GetTileBelowCursor());
3462 return ES_HANDLED;
3463 }
3464
3465 /* Mouse button released. */
3468
3469 /* Keep the selected tool, but reset it to the original mode. */
3471 if ((_thd.next_drawstyle & HT_DRAG_MASK) == HT_RECT) {
3472 _thd.place_mode = HT_RECT | others;
3473 } else if (_thd.select_method & VPM_SIGNALDIRS) {
3474 _thd.place_mode = HT_RECT | others;
3475 } else if (_thd.select_method & VPM_RAILDIRS) {
3476 _thd.place_mode = (_thd.select_method & ~VPM_RAILDIRS) ? _thd.next_drawstyle : (HT_RAIL | others);
3477 } else {
3478 _thd.place_mode = HT_POINT | others;
3479 }
3480 SetTileSelectSize(1, 1);
3481
3482 HideMeasurementTooltips();
3483 w->OnPlaceMouseUp(_thd.select_method, _thd.select_proc, _thd.selend, TileVirtXY(_thd.selstart.x, _thd.selstart.y), TileVirtXY(_thd.selend.x, _thd.selend.y));
3484
3485 return ES_HANDLED;
3486}
3487
3496{
3497 SetObjectToPlace(icon, pal, mode, w->window_class, w->window_number);
3498}
3499
3500#include "table/animcursors.h"
3501
3510void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowClass window_class, WindowNumber window_num)
3511{
3512 if (_thd.window_class != WC_INVALID) {
3513 /* Undo clicking on button and drag & drop */
3514 Window *w = _thd.GetCallbackWnd();
3515 /* Call the abort function, but set the window class to something
3516 * that will never be used to avoid infinite loops. Setting it to
3517 * the 'next' window class must not be done because recursion into
3518 * this function might in some cases reset the newly set object to
3519 * place or not properly reset the original selection. */
3520 _thd.window_class = WC_INVALID;
3521 if (w != nullptr) {
3522 w->OnPlaceObjectAbort();
3523 HideMeasurementTooltips();
3524 }
3525 }
3526
3527 /* Mark the old selection dirty, in case the selection shape or colour changes */
3529
3530 SetTileSelectSize(1, 1);
3531
3532 _thd.make_square_red = false;
3533
3534 if (mode == HT_DRAG) { // HT_DRAG is for dragdropping trains in the depot window
3535 mode = HT_NONE;
3537 } else {
3539 }
3540
3541 _thd.place_mode = mode;
3542 _thd.window_class = window_class;
3543 _thd.window_number = window_num;
3544
3545 if ((mode & HT_DRAG_MASK) == HT_SPECIAL) { // special tools, like tunnels or docks start with presizing mode
3546 VpStartPreSizing();
3547 }
3548
3549 if ((icon & ANIMCURSOR_FLAG) != 0) {
3551 } else {
3552 SetMouseCursor(icon, pal);
3553 }
3554
3555}
3556
3562
3563Point GetViewportStationMiddle(const Viewport &vp, const Station *st)
3564{
3565 int x = TileX(st->xy) * TILE_SIZE;
3566 int y = TileY(st->xy) * TILE_SIZE;
3567 int z = GetSlopePixelZ(Clamp(x, 0, Map::SizeX() * TILE_SIZE - 1), Clamp(y, 0, Map::SizeY() * TILE_SIZE - 1));
3568
3569 Point p = RemapCoords(x, y, z);
3570 p.x = UnScaleByZoom(p.x - vp.virtual_left, vp.zoom) + vp.left;
3571 p.y = UnScaleByZoom(p.y - vp.virtual_top, vp.zoom) + vp.top;
3572 return p;
3573}
3574
3580
3583#ifdef WITH_SSE
3584 { &ViewportSortParentSpritesSSE41Checker, &ViewportSortParentSpritesSSE41 },
3585#endif
3587};
3588
3591{
3592 for (const auto &sprite_sorter : _vp_sprite_sorters) {
3593 if (sprite_sorter.fct_checker()) {
3594 _vp_sprite_sorter = sprite_sorter.fct_sorter;
3595 break;
3596 }
3597 }
3598 assert(_vp_sprite_sorter != nullptr);
3599}
3600
3610{
3611 if (_current_company != OWNER_DEITY) return CMD_ERROR;
3612 switch (target) {
3613 case VST_EVERYONE:
3614 break;
3615 case VST_COMPANY:
3616 if (_local_company != (CompanyID)ref) return CommandCost();
3617 break;
3618 case VST_CLIENT:
3619 if (_network_own_client_id != (ClientID)ref) return CommandCost();
3620 break;
3621 default:
3622 return CMD_ERROR;
3623 }
3624
3625 if (flags.Test(DoCommandFlag::Execute)) {
3628 }
3629 return CommandCost();
3630}
3631
3632void MarkCatchmentTilesDirty()
3633{
3634 if (_viewport_highlight_town != nullptr) {
3636 return;
3637 }
3638 if (_viewport_highlight_station != nullptr) {
3642 } else {
3644 for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
3645 MarkTileDirtyByTile(tile);
3646 }
3647 }
3648 }
3649 if (_viewport_highlight_waypoint != nullptr) {
3652 }
3654 }
3655}
3656
3657static void SetWindowDirtyForViewportCatchment()
3658{
3662}
3663
3664static void ClearViewportCatchment()
3665{
3666 MarkCatchmentTilesDirty();
3669 _viewport_highlight_town = nullptr;
3670}
3671
3678void SetViewportCatchmentStation(const Station *st, bool sel)
3679{
3680 SetWindowDirtyForViewportCatchment();
3681 if (sel && _viewport_highlight_station != st) {
3682 ClearViewportCatchment();
3684 MarkCatchmentTilesDirty();
3685 } else if (!sel && _viewport_highlight_station == st) {
3686 MarkCatchmentTilesDirty();
3688 }
3690}
3691
3699{
3700 SetWindowDirtyForViewportCatchment();
3701 if (sel && _viewport_highlight_waypoint != wp) {
3702 ClearViewportCatchment();
3704 MarkCatchmentTilesDirty();
3705 } else if (!sel && _viewport_highlight_waypoint == wp) {
3706 MarkCatchmentTilesDirty();
3708 }
3710}
3711
3718void SetViewportCatchmentTown(const Town *t, bool sel)
3719{
3720 SetWindowDirtyForViewportCatchment();
3721 if (sel && _viewport_highlight_town != t) {
3722 ClearViewportCatchment();
3725 } else if (!sel && _viewport_highlight_town == t) {
3726 _viewport_highlight_town = nullptr;
3728 }
3730}
3731
3736void ViewportData::CancelFollow(const Window &viewport_window)
3737{
3738 if (this->follow_vehicle == VehicleID::Invalid()) return;
3739
3740 if (viewport_window.window_class == WC_MAIN_WINDOW) {
3741 /* We're cancelling follow in the main viewport, so we need to check for a vehicle view window
3742 * to raise the location follow widget. */
3743 Window *vehicle_window = FindWindowById(WC_VEHICLE_VIEW, this->follow_vehicle);
3744 if (vehicle_window != nullptr) vehicle_window->RaiseWidgetWhenLowered(WID_VV_LOCATION);
3745 }
3746
3747 this->follow_vehicle = VehicleID::Invalid();
3748}
This file defines all the the animated cursors.
static const AnimCursor *const _animcursors[]
This is an array of pointers to all the animated cursor definitions we have above.
Definition animcursors.h:85
Highlight/sprite information for autorail.
Class for backupping variables and making sure they are restored later.
debug_inline constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
TileIndex GetNorthernBridgeEnd(TileIndex t)
Finds the northern end of a bridge starting at a middle tile.
Map accessor functions for bridges.
int GetBridgePixelHeight(TileIndex tile)
Get the height ('z') of a bridge in pixels.
Definition bridge_map.h:84
bool IsBridgeAbove(Tile t)
checks if a bridge is set above the ground of this tile
Definition bridge_map.h:45
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Set()
Set all bits.
Iterator to iterate over all tiles belonging to a bitmaptilearea.
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition factory.hpp:136
How all blitters should look like.
Definition base.hpp:29
virtual void * MoveTo(void *video, int x, int y)=0
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
virtual void SetPixel(void *video, int x, int y, PixelColour colour)=0
Draw a pixel with a given colour on the video-buffer.
Common return value for all commands.
Container for an encoded string, created by GetEncodedString.
K-dimensional tree, specialised for 2-dimensional space.
Definition kdtree.hpp:33
void Build(It begin, It end)
Clear and rebuild the tree from a new sequence of elements,.
Definition kdtree.hpp:360
size_t Count() const
Get number of elements stored in tree.
Definition kdtree.hpp:428
void FindContained(CoordT x1, CoordT y1, CoordT x2, CoordT y2, const Outputter &outputter) const
Find all items contained within the given rectangle.
Definition kdtree.hpp:457
T FindNearest(CoordT x, CoordT y) const
Find the element closest to given coordinate, in Manhattan distance.
Definition kdtree.hpp:439
RAII class for measuring multi-step elements of performance.
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
RectPadding fullbevel
Always-scaled bevel thickness.
Definition window_gui.h:39
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Execute
execute the given command
Definition of stuff that is very close to a company, like the company struct itself.
TypedIndexContainer< std::array< Colours, MAX_COMPANIES >, CompanyID > _company_colours
NOSAVE: can be determined from company structs.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
CompanyID _current_company
Company currently doing an action.
Functions related to companies.
static constexpr Owner OWNER_DEITY
The object is owned by a superuser / goal script.
static constexpr Owner OWNER_NONE
The tile has no ownership.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
@ DIR_SW
Southwest.
@ DIR_SE
Southeast.
@ DIR_S
South.
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23)
Definition enum_type.hpp:17
Factory to 'query' all available blitters.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:87
Types for recording game performance data.
@ PFE_DRAWWORLD
Time spent drawing world viewports in GUI.
void SetMouseCursor(CursorID sprite, PaletteID pal)
Assign a single non-animated sprite to the cursor.
Definition gfx.cpp:1700
bool _left_button_down
Is left mouse button pressed?
Definition gfx.cpp:42
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:895
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:666
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:39
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
Draw a sprite in a viewport.
Definition gfx.cpp:1004
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
Definition gfx.cpp:1713
void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
Draws the projection of a parallelepiped.
Definition gfx.cpp:423
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ Normal
The most basic (normal) sprite.
@ FS_SMALL
Index of the small font in the font tables.
Definition gfx_type.h:251
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:250
uint32_t CursorID
The number of the cursor (sprite)
Definition gfx_type.h:19
@ SA_HOR_CENTER
Horizontally center the text.
Definition gfx_type.h:390
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:308
bool MarkAllViewportsDirty(int left, int top, int right, int bottom)
Mark all viewports that display an area as dirty (in need of repaint).
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:963
void AddDirtyBlock(int left, int top, int right, int bottom)
Extend the internal _invalid_rect rectangle to contain the rectangle defined by the given parameters.
Definition gfx.cpp:1510
void MarkDirty(ZoomLevel maxzoom=ZoomLevel::Max) const
Mark the sign dirty in all viewports.
static bool MarkViewportDirty(const Viewport &vp, int left, int top, int right, int bottom)
Marks a viewport as dirty for repaint if it displays (a part of) the area the needs to be repainted.
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1543
void RedrawScreenRect(int left, int top, int right, int bottom)
Repaints a specific rectangle of the screen.
Definition gfx.cpp:1420
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
static void SetSelectionTilesDirty()
Marks the selected tiles as dirty.
const TileTypeProcs *const _tile_type_procs[16]
Tile callback functions for each type of tile.
Definition landscape.cpp:66
Point InverseRemapCoords2(int x, int y, bool clamp_to_map, bool *clamped)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
int GetSlopePixelZ(int x, int y, bool ground_vehicle)
Return world Z coordinate of a given point of a tile.
Functions related to OTTD's landscape.
Point RemapCoords(int x, int y, int z)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
Definition landscape.h:79
Point RemapCoords2(int x, int y)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
Definition landscape.h:95
Point InverseRemapCoords(int x, int y)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Definition landscape.h:109
Declaration of linkgraph overlay GUI.
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
Definition main_gui.cpp:93
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition map.cpp:142
TileIndex TileAddByDir(TileIndex tile, Direction dir)
Adds a Direction to a tile.
Definition map_func.h:598
static debug_inline TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition map_func.h:372
TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)
Return the offset between two tiles from a TileIndexDiffC struct.
Definition map_func.h:439
constexpr TileIndex TileAdd(TileIndex tile, TileIndexDiff offset)
Adds a given offset to a tile.
Definition map_func.h:456
static debug_inline uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:424
static debug_inline uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:414
static debug_inline TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:403
constexpr bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
constexpr T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition math_func.hpp:23
constexpr T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
Definition math_func.hpp:37
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
constexpr T Delta(const T a, const T b)
Returns the (absolute) difference between two (scalar) variables.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
void GuiShowTooltips(Window *parent, EncodedString &&text, TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition misc_gui.cpp:688
ClientID _network_own_client_id
Our client identifier.
Definition network.cpp:72
Network functions used by other parts of OpenTTD.
ClientID
'Unique' identifier to be given to clients
@ DO_SHOW_TOWN_NAMES
Display town names.
Definition openttd.h:46
@ DO_SHOW_COMPETITOR_SIGNS
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
Definition openttd.h:52
@ DO_SHOW_SIGNS
Display signs.
Definition openttd.h:48
@ DO_SHOW_WAYPOINT_NAMES
Display waypoint names.
Definition openttd.h:51
@ DO_SHOW_STATION_NAMES
Display station names.
Definition openttd.h:47
PixelColour GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition palette.cpp:388
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
Base class for signs.
Functions related to signs.
void HandleClickOnSign(const Sign *si)
Handle clicking on a sign.
Slope SlopeWithThreeCornersRaised(Corner corner)
Returns the slope with all except one corner raised.
Definition slope_func.h:206
Corner OppositeCorner(Corner corner)
Returns the opposite corner.
Definition slope_func.h:184
static constexpr Corner GetHalftileSlopeCorner(Slope s)
Returns the leveled halftile of a halftile slope.
Definition slope_func.h:148
static constexpr Slope RemoveHalftileSlope(Slope s)
Removes a halftile slope from a slope.
Definition slope_func.h:60
uint SlopeToSpriteOffset(Slope s)
Returns the Sprite offset for a given Slope.
Definition slope_func.h:415
static constexpr bool IsSteepSlope(Slope s)
Checks if a slope is steep.
Definition slope_func.h:36
static constexpr bool IsHalftileSlope(Slope s)
Checks for non-continuous slope on halftile foundations.
Definition slope_func.h:47
Slope SlopeWithOneCornerRaised(Corner corner)
Returns the slope with a specific corner raised.
Definition slope_func.h:99
Corner
Enumeration of tile corners.
Definition slope_type.h:22
Slope
Enumeration for the slope-type.
Definition slope_type.h:48
@ SLOPE_N
the north corner of the tile is raised
Definition slope_type.h:53
@ SLOPE_STEEP_N
a steep slope falling to south (from north)
Definition slope_type.h:69
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
static constexpr uint32_t MAX_SPRITES
Masks needed for sprite operations.
Definition sprites.h:1561
static const PaletteID PALETTE_TILE_RED_PULSATING
pulsating red tile drawn if you try to build a wrong tunnel or raise/lower land where it is not possi...
Definition sprites.h:1575
static const CursorID ANIMCURSOR_FLAG
Flag for saying a cursor sprite is an animated cursor.
Definition sprites.h:1513
static const PaletteID PALETTE_SEL_TILE_RED
makes a square red. is used when removing rails or other stuff
Definition sprites.h:1576
static constexpr uint32_t SPRITE_MASK
The mask to for the main sprite.
Definition sprites.h:1562
static constexpr uint8_t PALETTE_MODIFIER_TRANSPARENT
when a sprite is to be displayed transparently, this bit needs to be set.
Definition sprites.h:1553
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition sprites.h:1611
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition sprites.h:1396
static const PaletteID PALETTE_SEL_TILE_BLUE
This draws a blueish square (catchment areas for example)
Definition sprites.h:1577
static const PaletteID PALETTE_TO_TRANSPARENT
This sets the sprite to transparent.
Definition sprites.h:1608
Base classes/functions for stations.
void ShowStationViewWindow(StationID station)
Opens StationViewWindow for given station.
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
Definition of base types and functions in a cross-platform compatible way.
The colour translation of GRF's strings.
static constexpr PixelColour _string_colourmap[17]
Colour mapping for TextColour.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
Base class for all station-ish types.
TileIndex xy
Base tile of the station.
bool IsInUse() const
Check whether the base station currently is in use; in use means that it is not scheduled for deletio...
TrackedViewportSign sign
NOSAVE: Dimensions of sign.
int next
next child to draw (-1 at the end)
Definition viewport.cpp:140
const SubSprite * sub
only draw a rectangular part of the sprite
Definition viewport.cpp:136
GUISettings gui
settings related to the GUI
uint8_t max_bridge_height
maximum height of bridges
T y
Y coordinate.
T x
X coordinate.
T x
X coordinate.
T y
Y coordinate.
T z
Z coordinate.
Point pos
logical mouse position
Definition gfx_type.h:126
Data about how and where to blit pixels.
Definition gfx_type.h:158
uint8_t dist_local_authority
distance for town local authority, default 20
bool population_in_label
show the population of a town in its label?
bool measure_tooltip
show a permanent tooltip when dragging tools
ZoomLevel zoom_min
minimum zoom out level
bool smooth_scroll
smooth scroll viewports
ZoomLevel zoom_max
maximum zoom out level
EconomySettings economy
settings to change the economy
ConstructionSettings construction
construction of things in-game
static uint SizeY()
Get the size of the map along the Y.
Definition map_func.h:278
static debug_inline uint SizeX()
Get the size of the map along the X.
Definition map_func.h:269
static uint ScaleBySize1D(uint n)
Scales the given value by the maps circumference, where the given value is for a 256 by 256 map.
Definition map_func.h:340
static uint MaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition map_func.h:305
static debug_inline uint MaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition map_func.h:296
TileIndex tile
The base tile of the area.
Parent sprite that should be drawn.
const SubSprite * sub
only draw a rectangular part of the sprite
int32_t zmin
minimal world Z coordinate of bounding box
SpriteID image
sprite to draw
int32_t xmax
maximal world X coordinate of bounding box
int32_t ymax
maximal world Y coordinate of bounding box
int32_t x
screen X coordinate of sprite
int32_t y
screen Y coordinate of sprite
int32_t first_child
the first child to draw.
int32_t zmax
maximal world Z coordinate of bounding box
int32_t xmin
minimal world X coordinate of bounding box
int32_t ymin
minimal world Y coordinate of bounding box
PaletteID pal
palette to use
int32_t left
minimal screen X coordinate of sprite (= x + sprite->x_offs), reference point for child sprites
int32_t top
minimal screen Y coordinate of sprite (= y + sprite->y_offs), reference point for child sprites
Colour for pixel/line drawing.
Definition gfx_type.h:406
static Titem * Get(auto index)
Returns Titem with given index.
static size_t GetNumItems()
Returns number of valid items in the pool.
Tindex index
Index of this pool item.
Specification of a rectangle with absolute coordinates of all edges.
static bool IsExpected(const BaseStation *st)
Helper for checking whether the given station is of this type.
static Station * Get(auto index)
Gets station with given index.
static Waypoint * From(BaseStation *st)
Converts a BaseStation to SpecializedStation with type checking.
Coord3D< int8_t > offset
Relative position of sprite from bounding box.
Definition sprite.h:21
Coord3D< int8_t > origin
Position of northern corner within tile.
Definition sprite.h:19
Coord3D< uint8_t > extent
Size of bounding box.
Definition sprite.h:20
Data structure describing a sprite.
uint16_t width
Width of the sprite.
uint16_t height
Height of the sprite.
int16_t y_offs
Number of pixels to shift the sprite downwards.
int16_t x_offs
Number of pixels to shift the sprite to the right.
Station data structure.
BitmapTileArea catchment_tiles
NOSAVE: Set of individual tiles covered by catchment area.
Used to only draw a part of the sprite.
Definition gfx_type.h:279
Metadata about the current highlighting.
TileIndex redsq
The tile that has to get a red selection.
Point new_pos
New value for pos; used to determine whether to redraw the selection.
Window * GetCallbackWnd()
Get the window that started the current highlighting.
bool make_square_red
Whether to give a tile a red selection.
bool IsDraggingDiagonal()
Is the user dragging a 'diagonal rectangle'?
ViewportDragDropSelectionProcess select_proc
The procedure that has to be called when the selection is done.
Point selstart
The location where the dragging started.
Point new_outersize
New value for outersize; used to determine whether to redraw the selection.
HighLightStyle drawstyle
Lower bits 0-3 are reserved for detailed highlight information.
HighLightStyle place_mode
Method which is used to place the selection.
WindowClass window_class
The WindowClass of the window that is responsible for the selection mode.
uint8_t dirty
Whether the build station window needs to redraw due to the changed selection.
Point offs
Offset, in tile "units", for the blue coverage area from the selected area's northern tile.
Point size
Size, in tile "units", of the white/red selection area.
uint8_t sizelimit
Whether the selection is limited in length, and what the maximum length is.
Point pos
Location, in tile "units", of the northern tile of the selected area.
Point outersize
Size, in tile "units", of the blue coverage area excluding the side of the selected area.
bool diagonal
Whether the dragged area is a 45 degrees rotated rectangle.
void Reset()
Reset tile highlighting.
Point selend
The location where the drag currently ends.
Point new_size
New value for size; used to determine whether to redraw the selection.
bool freeze
Freeze highlight in place.
HighLightStyle next_drawstyle
Queued, but not yet drawn style.
ViewportPlaceMethod select_method
The method which governs how tiles are selected.
WindowNumber window_number
The WindowNumber of the window that is responsible for the selection mode.
Tile information, used while rendering the tile.
Definition tile_cmd.h:30
Slope tileh
Slope of the tile.
Definition tile_cmd.h:31
TileIndex tile
Tile index.
Definition tile_cmd.h:32
int32_t y
screen Y coordinate of sprite
Definition viewport.cpp:130
int32_t x
screen X coordinate of sprite
Definition viewport.cpp:129
const SubSprite * sub
only draw a rectangular part of the sprite
Definition viewport.cpp:128
DrawTileProc * draw_tile_proc
Called to render the tile and its contents to the screen.
Definition tile_cmd.h:143
TrackedViewportSign sign
Location of name sign, UpdateVirtCoord updates this.
Definition town.h:44
Town data structure.
Definition town.h:53
TileIndex xy
town center tile
Definition town.h:54
TownCache cache
Container for all cacheable data.
Definition town.h:56
bool show_zone
NOSAVE: mark town to show the local authority zone in the viewports.
Definition town.h:143
StationList stations_near
NOSAVE: List of nearby stations.
Definition town.h:130
bool kdtree_valid
Are the sign data valid for use with the _viewport_sign_kdtree?
Vehicle data structure.
int32_t z_pos
z coordinate.
Vehicle * First() const
Get the first vehicle of this vehicle chain.
int32_t y_pos
y coordinate.
int32_t x_pos
x coordinate.
Owner owner
Which company owns the vehicle?
UnitID unitnumber
unit number, for display purposes only
Data structure for a window viewport.
Definition window_gui.h:250
void CancelFollow(const Window &viewport_window)
Cancel viewport vehicle following, and raise follow location widget if needed.
int32_t dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition window_gui.h:255
int32_t scrollpos_y
Currently shown y coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition window_gui.h:253
int32_t dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition window_gui.h:254
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, VehicleID::Invalid() otherwise.
Definition window_gui.h:251
int32_t scrollpos_x
Currently shown x coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition window_gui.h:252
Data structure storing rendering information.
Definition viewport.cpp:170
int foundation[FOUNDATION_PART_END]
Foundation sprites (index into parent_sprites_to_draw).
Definition viewport.cpp:183
int last_foundation_child[FOUNDATION_PART_END]
Tail of ChildSprite list of the foundations. (index into child_screen_sprites_to_draw)
Definition viewport.cpp:185
ParentSpriteToSortVector parent_sprites_to_sort
Parent sprite pointer array used for sorting.
Definition viewport.cpp:176
Point foundation_offset[FOUNDATION_PART_END]
Pixel offset for ground sprites on the foundations.
Definition viewport.cpp:186
SpriteCombineMode combine_sprites
Current mode of "sprite combining".
Definition viewport.cpp:181
FoundationPart foundation_part
Currently active foundation for ground sprite drawing.
Definition viewport.cpp:184
Helper class for getting the best sprite sorter.
VpSorterChecker fct_checker
The check function.
VpSpriteSorter fct_sorter
The sorting function.
Location information about a sign as seen on the viewport.
int32_t center
The center position of the sign.
uint16_t width_small
The width when zoomed out (small font)
uint16_t width_normal
The width when not zoomed out (normal font)
void UpdatePosition(int center, int top, std::string_view str, std::string_view str_small={})
Update the position of the viewport sign.
int32_t top
The top of the sign.
Data structure for viewport, display of a part of the world.
int top
Screen coordinate top edge of the viewport.
int width
Screen width of the viewport.
ZoomLevel zoom
The zoom level of the viewport.
int virtual_top
Virtual top coordinate.
int virtual_left
Virtual left coordinate.
int virtual_width
width << zoom
int left
Screen coordinate left edge of the viewport.
int height
Screen height of the viewport.
int virtual_height
height << zoom
Representation of a waypoint.
Number to differentiate different windows of the same class.
Iterator to iterate all valid Windows.
Definition window_gui.h:874
Data structure for an opened window.
Definition window_gui.h:273
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:556
std::unique_ptr< ViewportData > viewport
Pointer to viewport data, if present.
Definition window_gui.h:318
void RaiseWidgetWhenLowered(WidgetID widget_index)
Marks a widget as raised and dirty (redraw), when it is marked as lowered.
Definition window_gui.h:478
virtual void OnPlaceObjectAbort()
The user cancelled a tile highlight mode that has been set.
Definition window_gui.h:821
WindowClass window_class
Window class.
Definition window_gui.h:301
void DrawViewport() const
Draw the viewport of this window.
virtual void OnPlaceObject(Point pt, TileIndex tile)
The user clicked some place on the map when a tile highlight mode has been set.
Definition window_gui.h:800
int left
x position of left edge of the window
Definition window_gui.h:309
int top
y position of top edge of the window
Definition window_gui.h:310
virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
The user has dragged over the map when the tile highlight mode has been set.
Definition window_gui.h:842
virtual void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
The user is dragging over the map when the tile highlight mode has been set.
Definition window_gui.h:831
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:381
AllWindows< false > Iterate
Iterate all windows in whatever order is easiest.
Definition window_gui.h:932
int height
Height of the window (number of pixels down in y direction)
Definition window_gui.h:312
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:311
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:302
std::tuple< Slope, int > GetTilePixelSlopeOutsideMap(int x, int y)
Return the slope of a given tile, also for tiles outside the map (virtual "black" tiles).
Definition tile_map.cpp:78
int GetTilePixelZ(TileIndex tile)
Get bottom height of the tile.
Definition tile_map.h:302
int GetTileMaxPixelZ(TileIndex tile)
Get top height of the tile.
Definition tile_map.h:312
static debug_inline TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition tile_map.h:96
std::tuple< Slope, int > GetTilePixelSlope(TileIndex tile)
Return the slope of a given tile.
Definition tile_map.h:289
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition tile_map.h:161
uint TilePixelHeight(Tile tile)
Returns the height of a tile in pixels.
Definition tile_map.h:72
uint TilePixelHeightOutsideMap(int x, int y)
Returns the height of a tile in pixels, also for tiles outside the map (virtual "black" tiles).
Definition tile_map.h:84
static debug_inline bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
static debug_inline uint TileHeight(Tile tile)
Returns the height of a tile.
Definition tile_map.h:29
uint TileHeightOutsideMap(int x, int y)
Returns the height of a tile, also for tiles outside the map (virtual "black" tiles).
Definition tile_map.h:42
static constexpr uint TILE_UNIT_MASK
For masking in/out the inner-tile world coordinate units.
Definition tile_type.h:16
static constexpr uint MAX_BUILDING_PIXELS
Maximum height of a building in pixels in ZOOM_BASE. (Also applies to "bridge buildings" on the bridg...
Definition tile_type.h:20
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
static constexpr uint TILE_PIXELS
Pixel distance between tile columns/rows in ZOOM_BASE.
Definition tile_type.h:17
static constexpr uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in ZOOM_BASE.
Definition tile_type.h:18
TileType
The different types of tiles.
Definition tile_type.h:47
@ MP_STATION
A tile of a station.
Definition tile_type.h:53
@ MP_HOUSE
A house by a town.
Definition tile_type.h:51
@ MP_VOID
Invisible tiles at the SW and SE border.
Definition tile_type.h:55
Functions related to tile highlights.
HighLightStyle
Highlighting draw styles.
@ HT_LINE
used for autorail highlighting (longer stretches), lower bits: direction
@ HT_DIR_HL
horizontal lower
@ HT_DIR_HU
horizontal upper
@ HT_DRAG
dragging items in the depot windows
@ HT_NONE
default
@ HT_DIR_X
X direction.
@ HT_DIAGONAL
Also allow 'diagonal rectangles'. Only usable in combination with HT_RECT or HT_POINT.
@ HT_POINT
point (lower land, raise land, level land, ...)
@ HT_RECT
rectangle (stations, depots, ...)
@ HT_DIR_MASK
masks the drag-direction
@ HT_RAIL
autorail (one piece), lower bits: direction
@ HT_DIR_END
end marker
@ HT_DRAG_MASK
Mask for the tile drag-type modes.
@ HT_DIR_VL
vertical left
@ HT_VEHICLE
vehicle is accepted as target as well (bitmask)
@ HT_DIR_VR
vertical right
@ HT_SPECIAL
special mode used for highlighting while dragging (and for tunnels/docks)
@ HT_DIR_Y
Y direction.
Base of the town class.
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold.
Declarations for accessing the k-d tree of towns.
TownID GetTownIndex(Tile t)
Get the index of which town this house/street is attached to.
Definition town_map.h:23
bool IsTransparencySet(TransparencyOption to)
Check if the transparency option bit is set and if we aren't in the game menu (there's never transpar...
uint8_t _display_opt
What do we want to draw/do?
bool IsInvisibilitySet(TransparencyOption to)
Check if the invisibility option bit is set and if we aren't in the game menu (there's never transpar...
@ TO_SIGNS
signs
void ViewportAddVehicles(DrawPixelInfo *dpi)
Add the vehicle sprites that should be drawn at a part of the screen.
Definition vehicle.cpp:1121
Vehicle * CheckClickOnVehicle(const Viewport &vp, int x, int y)
Find the vehicle close to the clicked coordinates.
Definition vehicle.cpp:1215
Base class for all vehicles.
Functions related to vehicles.
bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
void StartStopVehicle(const Vehicle *v, bool texteffect)
Executes CMD_START_STOP_VEHICLE for given vehicle.
Functions related to the vehicle's GUIs.
Types related to the vehicle widgets.
@ WID_VV_LOCATION
Center the main view on this vehicle.
static void HighlightTownLocalAuthorityTiles(const TileInfo *ti)
Highlights tiles insede local authority of selected towns.
std::string * ViewportAddString(const DrawPixelInfo *dpi, const ViewportSign *sign, ViewportStringFlags flags, Colours colour)
Add a string to draw in the current viewport.
static void CheckOverflow(int &test, int &other, int max, int mult)
Check for overflowing the map.
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
FoundationPart
Enumeration of multi-part foundations.
Definition viewport.cpp:144
@ FOUNDATION_PART_NONE
Neither foundation nor groundsprite drawn yet.
Definition viewport.cpp:145
@ FOUNDATION_PART_HALFTILE
Second part (halftile foundation)
Definition viewport.cpp:147
@ FOUNDATION_PART_NORMAL
First part (normal foundation or no foundation)
Definition viewport.cpp:146
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
CommandCost CmdScrollViewport(DoCommandFlags flags, TileIndex tile, ViewportScrollTarget target, uint32_t ref)
Scroll players main viewport.
static void ViewportAddStationStrings(DrawPixelInfo *dpi, const std::vector< const BaseStation * > &stations, bool small)
Add station strings to a viewport.
void OffsetGroundSprite(int x, int y)
Called when a foundation has been drawn for the current tile.
Definition viewport.cpp:591
constexpr int LAST_CHILD_NONE
There is no last_child to fill.
Definition viewport.cpp:166
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
static void ViewportAddSignStrings(DrawPixelInfo *dpi, const std::vector< const Sign * > &signs, bool small)
Add sign strings to a viewport.
void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Window *w)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
constexpr int LAST_CHILD_PARENT
Fill last_child of the most recent parent sprite.
Definition viewport.cpp:167
static const int MAX_TILE_EXTENT_TOP
Maximum top extent of tile relative to north corner (not considering bridges).
Definition viewport.cpp:113
static void ShowMeasurementTooltips(EncodedString &&text)
Displays the measurement tooltips when selecting multiple tiles.
static const int MAX_TILE_EXTENT_LEFT
Maximum left extent of tile relative to north corner.
Definition viewport.cpp:111
bool IsInsideRotatedRectangle(int x, int y)
Checks whether a point is inside the selected a diagonal rectangle given by _thd.size and _thd....
Definition viewport.cpp:801
static int CalcHeightdiff(HighLightStyle style, uint distance, TileIndex start_tile, TileIndex end_tile)
Calculates height difference between one tile and another.
static void DrawTileSelectionRect(const TileInfo *ti, PaletteID pal)
Draws a selection rectangle on a tile.
Definition viewport.cpp:914
void StartSpriteCombine()
Starts a block of sprites, which are "combined" into a single bounding box.
Definition viewport.cpp:764
void InitializeSpriteSorter()
Choose the "best" sprite sorter and set _vp_sprite_sorter.
static const ViewportSSCSS _vp_sprite_sorters[]
List of sorters ordered from best to worst.
static void AddCombinedSprite(SpriteID image, PaletteID pal, int x, int y, int z, const SubSprite *sub)
Adds a child sprite to a parent sprite.
Definition viewport.cpp:623
static int GetViewportY(Point tile)
Returns the y coordinate in the viewport coordinate system where the given tile is painted.
static void AddChildSpriteToFoundation(SpriteID image, PaletteID pal, const SubSprite *sub, FoundationPart foundation_part, int extra_offs_x, int extra_offs_y)
Adds a child sprite to the active foundation.
Definition viewport.cpp:532
static HighLightStyle GetAutorailHT(int x, int y)
returns the best autorail highlight type from map coordinates
static void ClampSmoothScroll(uint32_t delta_ms, int64_t delta_hi, int64_t delta_lo, int &delta_hi_clamped, int &delta_lo_clamped)
Clamp the smooth scroll to a maxmimum speed and distance based on time elapsed.
static void DrawTileSelection(const TileInfo *ti)
Checks if the specified tile is selected and if so draws selection using correct selectionstyle.
static TileHighlightType GetTileHighlightType(TileIndex t)
Get tile highlight type of coverage area for a given tile.
static bool IsInRangeInclusive(int begin, int end, int check)
Check if the parameter "check" is inside the interval between begin and end, including both begin and...
Definition viewport.cpp:789
Point TranslateXYToTileCoord(const Viewport &vp, int x, int y, bool clamp_to_map)
Translate screen coordinate in a viewport to underlying tile coordinate.
Definition viewport.cpp:430
static void DrawAutorailSelection(const TileInfo *ti, uint autorail_type)
Draws autorail highlights.
Definition viewport.cpp:974
SpriteCombineMode
Mode of "sprite combining".
Definition viewport.cpp:155
@ SPRITE_COMBINE_PENDING
Sprite combining will start with the next unclipped sprite.
Definition viewport.cpp:157
@ SPRITE_COMBINE_ACTIVE
Sprite combining is active. AddSortableSpriteToDraw outputs child sprites.
Definition viewport.cpp:158
@ SPRITE_COMBINE_NONE
Every AddSortableSpriteToDraw start its own bounding box.
Definition viewport.cpp:156
static void DrawTileHighlightType(const TileInfo *ti, TileHighlightType tht)
Draw tile highlight for coverage area highlight.
static void ViewportDrawBoundingBoxes(const ParentSpriteToSortVector *psd)
Draws the bounding boxes of all ParentSprites.
static void ViewportAddTownStrings(DrawPixelInfo *dpi, const std::vector< const Town * > &towns, bool small)
Add town strings to a viewport.
void SetViewportCatchmentWaypoint(const Waypoint *wp, bool sel)
Select or deselect waypoint for coverage area highlight.
void SetRedErrorSquare(TileIndex tile)
Set a tile to display a red error square.
static void ViewportSortParentSprites(ParentSpriteToSortVector *psdv)
Sort parent sprites pointer array replicating the way original sorter did it.
void VpSetPresizeRange(TileIndex from, TileIndex to)
Highlights all tiles between a set of two tiles.
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
EventState VpHandlePlaceSizingDrag()
Handle the mouse while dragging for placement/resizing.
Viewport * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
Definition viewport.cpp:408
void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int z, const SpriteBounds &bounds, bool transparent, const SubSprite *sub)
Draw a (transparent) sprite at given coordinates with a given bounding box.
Definition viewport.cpp:663
void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowClass window_class, WindowNumber window_num)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
void EndSpriteCombine()
Terminates a block of sprites started by StartSpriteCombine.
Definition viewport.cpp:774
static const int MAX_TILE_EXTENT_RIGHT
Maximum right extent of tile relative to north corner.
Definition viewport.cpp:112
void AddChildSpriteScreen(SpriteID image, PaletteID pal, int x, int y, bool transparent, const SubSprite *sub, bool scale, bool relative)
Add a child sprite to a parent sprite.
Definition viewport.cpp:824
static void CheckUnderflow(int &test, int &other, int mult)
Check for underflowing the map.
static bool ViewportSortParentSpritesChecker()
This fallback sprite checker always exists.
void DrawGroundSpriteAt(SpriteID image, PaletteID pal, int32_t x, int32_t y, int z, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
Draws a ground sprite at a specific world-coordinate relative to the current tile.
Definition viewport.cpp:556
void VpStartDragging(ViewportDragDropSelectionProcess process)
Drag over the map while holding the left mouse down.
void UpdateTileSelection()
Updates tile highlighting for all cases.
static void DrawSelectionSprite(SpriteID image, PaletteID pal, const TileInfo *ti, int z_offset, FoundationPart foundation_part, int extra_offs_x=0, int extra_offs_y=0)
Draws sprites between ground sprite and everything above.
Definition viewport.cpp:897
static const int MAX_TILE_EXTENT_BOTTOM
Maximum bottom extent of tile relative to north corner (worst case: SLOPE_STEEP_N).
Definition viewport.cpp:114
static bool CheckClickOnViewportSign(const Viewport &vp, int x, int y, const ViewportSign *sign)
Test whether a sign is below the mouse.
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
void SetViewportCatchmentTown(const Town *t, bool sel)
Select or deselect town for coverage area highlight.
static bool SwapDirection(HighLightStyle style, TileIndex start_tile, TileIndex end_tile)
Check if the direction of start and end tile should be swapped based on the dragging-style.
void InitializeWindowViewport(Window *w, int x, int y, int width, int height, std::variant< TileIndex, VehicleID > focus, ZoomLevel zoom)
Initialize viewport of the window for use.
Definition viewport.cpp:218
void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
Draws a ground sprite for the current tile.
Definition viewport.cpp:579
static void CalcRaildirsDrawstyle(int x, int y, int method)
while dragging
static HighLightStyle Check2x1AutoRail(int mode)
returns information about the 2x1 piece to be build.
static void ViewportDrawDirtyBlocks()
Draw/colour the blocks that have been redrawn.
void HandleZoomMessage(Window *w, const Viewport &vp, WidgetID widget_zoom_in, WidgetID widget_zoom_out)
Update the status of the zoom-buttons according to the zoom-level of the viewport.
Definition viewport.cpp:486
void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process)
highlighting tiles while only going over them with the mouse
static void ClampViewportToMap(const Viewport &vp, int *scroll_x, int *scroll_y)
Ensure that a given viewport has a valid scroll position.
static void AddTileSpriteToDraw(SpriteID image, PaletteID pal, int32_t x, int32_t y, int z, const SubSprite *sub=nullptr, int extra_offs_x=0, int extra_offs_y=0)
Schedules a tile sprite for drawing.
Definition viewport.cpp:507
static void ViewportAddLandscape()
Add the landscape to the viewport, i.e.
static std::string & AddStringToDraw(int x, int y, Colours colour, ViewportStringFlags flags, uint16_t width)
Add a string to draw to a viewport.
Definition viewport.cpp:870
const Station * _viewport_highlight_station
Currently selected station for coverage area highlight.
const Town * _viewport_highlight_town
Currently selected town for coverage area highlight.
void UpdateViewportPosition(Window *w, uint32_t delta_ms)
Update the viewport position being displayed.
const Waypoint * _viewport_highlight_waypoint
Currently selected waypoint for coverage area highlight.
bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Command definitions related to viewports.
Functions related to (drawing on) viewports.
static const int TILE_HEIGHT_STEP
One Z unit tile height difference is displayed as 50m.
Types related to sprite sorting.
bool(* VpSorterChecker)()
Type for method for checking whether a viewport sprite sorter exists.
void(* VpSpriteSorter)(ParentSpriteToSortVector *psd)
Type for the actual viewport sprite sorter.
ViewportScrollTarget
Target of the viewport scrolling GS method.
@ VST_EVERYONE
All players.
@ VST_COMPANY
All players in specific company.
@ VST_CLIENT
Single player.
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
@ VPM_FIX_Y
drag only in Y axis
@ VPM_Y_LIMITED
Drag only in Y axis with limited size.
@ VPM_X_AND_Y_LIMITED
area of land of limited size
@ VPM_FIX_VERTICAL
drag only in vertical direction
@ VPM_X_LIMITED
Drag only in X axis with limited size.
@ VPM_X_AND_Y
area of land in X and Y directions
@ VPM_FIX_HORIZONTAL
drag only in horizontal direction
@ VPM_FIX_X
drag only in X axis
@ VPM_SIGNALDIRS
similar to VMP_RAILDIRS, but with different cursor
@ VPM_X_OR_Y
drag in X or Y direction
@ VPM_RAILDIRS
all rail directions
@ ZOOM_IN
Zoom in (get more detailed view).
@ ZOOM_OUT
Zoom out (get helicopter view).
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you've selected it.
@ ColourRect
Draw a colour rect around the sign.
@ Small
Draw using the small font.
@ Shadow
Draw an extra text shadow. Should only be used with ViewportStringFlag::Small, as normal font already...
@ TransparentRect
Draw a transparent rect around the sign.
@ TextColour
Draw text in colour.
Base of waypoints.
Functions related to waypoints.
void ShowWaypointWindow(const Waypoint *wp)
Show the window for the given waypoint.
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition widget.cpp:298
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1190
Window * GetMainWindow()
Get the main window, i.e.
Definition window.cpp:1177
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
Definition window.cpp:1821
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Definition window.cpp:96
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1148
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition window.cpp:3155
Window functions not directly related to making/drawing windows.
Functions, definitions and such used only by the GUI.
@ Transparent
Makes the background transparent if set.
@ WSM_DRAGDROP
Drag&drop an object.
@ WSM_DRAGGING
Dragging mode (trees).
@ WSM_PRESIZE
Presizing mode (docks, tunnels).
@ WSM_NONE
No special mouse mode.
@ WSM_SIZING
Sizing mode.
int WidgetID
Widget ID.
Definition window_type.h:20
EventState
State of handling an event.
@ ES_HANDLED
The passed event is handled.
@ ES_NOT_HANDLED
The passed event is not handled.
WindowClass
Window classes.
Definition window_type.h:46
@ WC_INVALID
Invalid window.
@ WC_WAYPOINT_VIEW
Waypoint view; Window numbers:
@ WC_STATION_VIEW
Station view; Window numbers:
@ WC_MAIN_WINDOW
Main window; Window numbers:
Definition window_type.h:53
@ WC_TOWN_VIEW
Town view; Window numbers:
@ WC_TOOLTIPS
Tooltip window; Window numbers:
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
Functions related to zooming.
int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZoomLevel::Min) When shifting right,...
Definition zoom_func.h:22
int UnScaleByZoomLower(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZoomLevel::Min)
Definition zoom_func.h:67
int UnScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZoomLevel::Min) When shifting right,...
Definition zoom_func.h:34
ZoomLevel
All zoom levels we know.
Definition zoom_type.h:16
@ Begin
Begin for iteration.
@ Min
Minimum zoom level.
@ End
End for iteration.
@ Out4x
Zoomed 4 times out.