OpenTTD
viewport.cpp
Go to the documentation of this file.
1 /* $Id$ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
65 #include "stdafx.h"
66 #include "landscape.h"
67 #include "viewport_func.h"
68 #include "station_base.h"
69 #include "waypoint_base.h"
70 #include "town.h"
71 #include "signs_base.h"
72 #include "signs_func.h"
73 #include "vehicle_base.h"
74 #include "vehicle_gui.h"
75 #include "blitter/factory.hpp"
76 #include "strings_func.h"
77 #include "zoom_func.h"
78 #include "vehicle_func.h"
79 #include "company_func.h"
80 #include "waypoint_func.h"
81 #include "window_func.h"
82 #include "tilehighlight_func.h"
83 #include "window_gui.h"
85 #include "viewport_kdtree.h"
86 #include "town_kdtree.h"
87 #include "viewport_sprite_sorter.h"
88 #include "bridge_map.h"
89 #include "company_base.h"
90 #include "command_func.h"
91 #include "network/network_func.h"
92 #include "framerate_type.h"
93 
94 #include <map>
95 
96 #include "table/strings.h"
97 #include "table/string_colours.h"
98 
99 #include "safeguards.h"
100 
101 Point _tile_fract_coords;
102 
103 
104 ViewportSignKdtree _viewport_sign_kdtree(&Kdtree_ViewportSignXYFunc);
105 static int _viewport_sign_maxwidth = 0;
106 
107 
108 static const int MAX_TILE_EXTENT_LEFT = ZOOM_LVL_BASE * TILE_PIXELS;
109 static const int MAX_TILE_EXTENT_RIGHT = ZOOM_LVL_BASE * TILE_PIXELS;
110 static const int MAX_TILE_EXTENT_TOP = ZOOM_LVL_BASE * MAX_BUILDING_PIXELS;
111 static const int MAX_TILE_EXTENT_BOTTOM = ZOOM_LVL_BASE * (TILE_PIXELS + 2 * TILE_HEIGHT);
112 
114  StringID string;
115  Colours colour;
116  int32 x;
117  int32 y;
118  uint64 params[2];
119  uint16 width;
120 };
121 
123  SpriteID image;
124  PaletteID pal;
125  const SubSprite *sub;
126  int32 x;
127  int32 y;
128 };
129 
131  SpriteID image;
132  PaletteID pal;
133  const SubSprite *sub;
134  int32 x;
135  int32 y;
136  int next;
137 };
138 
144  FOUNDATION_PART_END
145 };
146 
155 };
156 
157 typedef std::vector<TileSpriteToDraw> TileSpriteToDrawVector;
158 typedef std::vector<StringSpriteToDraw> StringSpriteToDrawVector;
159 typedef std::vector<ParentSpriteToDraw> ParentSpriteToDrawVector;
160 typedef std::vector<ChildScreenSpriteToDraw> ChildScreenSpriteToDrawVector;
161 
164  DrawPixelInfo dpi;
165 
166  StringSpriteToDrawVector string_sprites_to_draw;
167  TileSpriteToDrawVector tile_sprites_to_draw;
168  ParentSpriteToDrawVector parent_sprites_to_draw;
169  ParentSpriteToSortVector parent_sprites_to_sort;
170  ChildScreenSpriteToDrawVector child_screen_sprites_to_draw;
171 
172  int *last_child;
173 
175 
176  int foundation[FOUNDATION_PART_END];
178  int *last_foundation_child[FOUNDATION_PART_END];
179  Point foundation_offset[FOUNDATION_PART_END];
180 };
181 
182 static void MarkViewportDirty(const ViewPort *vp, int left, int top, int right, int bottom);
183 
184 static ViewportDrawer _vd;
185 
186 TileHighlightData _thd;
187 static TileInfo *_cur_ti;
188 bool _draw_bounding_boxes = false;
189 bool _draw_dirty_blocks = false;
190 uint _dirty_block_colour = 0;
191 static VpSpriteSorter _vp_sprite_sorter = nullptr;
192 
193 static Point MapXYZToViewport(const ViewPort *vp, int x, int y, int z)
194 {
195  Point p = RemapCoords(x, y, z);
196  p.x -= vp->virtual_width / 2;
197  p.y -= vp->virtual_height / 2;
198  return p;
199 }
200 
201 void DeleteWindowViewport(Window *w)
202 {
203  if (w->viewport == nullptr) return;
204 
205  delete w->viewport->overlay;
206  free(w->viewport);
207  w->viewport = nullptr;
208 }
209 
222 void InitializeWindowViewport(Window *w, int x, int y,
223  int width, int height, uint32 follow_flags, ZoomLevel zoom)
224 {
225  assert(w->viewport == nullptr);
226 
227  ViewportData *vp = CallocT<ViewportData>(1);
228 
229  vp->left = x + w->left;
230  vp->top = y + w->top;
231  vp->width = width;
232  vp->height = height;
233 
235 
236  vp->virtual_width = ScaleByZoom(width, zoom);
237  vp->virtual_height = ScaleByZoom(height, zoom);
238 
239  Point pt;
240 
241  if (follow_flags & 0x80000000) {
242  const Vehicle *veh;
243 
244  vp->follow_vehicle = (VehicleID)(follow_flags & 0xFFFFF);
245  veh = Vehicle::Get(vp->follow_vehicle);
246  pt = MapXYZToViewport(vp, veh->x_pos, veh->y_pos, veh->z_pos);
247  } else {
248  uint x = TileX(follow_flags) * TILE_SIZE;
249  uint y = TileY(follow_flags) * TILE_SIZE;
250 
252  pt = MapXYZToViewport(vp, x, y, GetSlopePixelZ(x, y));
253  }
254 
255  vp->scrollpos_x = pt.x;
256  vp->scrollpos_y = pt.y;
257  vp->dest_scrollpos_x = pt.x;
258  vp->dest_scrollpos_y = pt.y;
259 
260  vp->overlay = nullptr;
261 
262  w->viewport = vp;
263  vp->virtual_left = 0; // pt.x;
264  vp->virtual_top = 0; // pt.y;
265 }
266 
267 static Point _vp_move_offs;
268 
269 static void DoSetViewportPosition(const Window *w, int left, int top, int width, int height)
270 {
272  if (left + width > w->left &&
273  w->left + w->width > left &&
274  top + height > w->top &&
275  w->top + w->height > top) {
276 
277  if (left < w->left) {
278  DoSetViewportPosition(w, left, top, w->left - left, height);
279  DoSetViewportPosition(w, left + (w->left - left), top, width - (w->left - left), height);
280  return;
281  }
282 
283  if (left + width > w->left + w->width) {
284  DoSetViewportPosition(w, left, top, (w->left + w->width - left), height);
285  DoSetViewportPosition(w, left + (w->left + w->width - left), top, width - (w->left + w->width - left), height);
286  return;
287  }
288 
289  if (top < w->top) {
290  DoSetViewportPosition(w, left, top, width, (w->top - top));
291  DoSetViewportPosition(w, left, top + (w->top - top), width, height - (w->top - top));
292  return;
293  }
294 
295  if (top + height > w->top + w->height) {
296  DoSetViewportPosition(w, left, top, width, (w->top + w->height - top));
297  DoSetViewportPosition(w, left, top + (w->top + w->height - top), width, height - (w->top + w->height - top));
298  return;
299  }
300 
301  return;
302  }
303  }
304 
305  {
306  int xo = _vp_move_offs.x;
307  int yo = _vp_move_offs.y;
308 
309  if (abs(xo) >= width || abs(yo) >= height) {
310  /* fully_outside */
311  RedrawScreenRect(left, top, left + width, top + height);
312  return;
313  }
314 
315  GfxScroll(left, top, width, height, xo, yo);
316 
317  if (xo > 0) {
318  RedrawScreenRect(left, top, xo + left, top + height);
319  left += xo;
320  width -= xo;
321  } else if (xo < 0) {
322  RedrawScreenRect(left + width + xo, top, left + width, top + height);
323  width += xo;
324  }
325 
326  if (yo > 0) {
327  RedrawScreenRect(left, top, width + left, top + yo);
328  } else if (yo < 0) {
329  RedrawScreenRect(left, top + height + yo, width + left, top + height);
330  }
331  }
332 }
333 
334 static void SetViewportPosition(Window *w, int x, int y)
335 {
336  ViewPort *vp = w->viewport;
337  int old_left = vp->virtual_left;
338  int old_top = vp->virtual_top;
339  int i;
340  int left, top, width, height;
341 
342  vp->virtual_left = x;
343  vp->virtual_top = y;
344 
345  /* Viewport is bound to its left top corner, so it must be rounded down (UnScaleByZoomLower)
346  * else glitch described in FS#1412 will happen (offset by 1 pixel with zoom level > NORMAL)
347  */
348  old_left = UnScaleByZoomLower(old_left, vp->zoom);
349  old_top = UnScaleByZoomLower(old_top, vp->zoom);
350  x = UnScaleByZoomLower(x, vp->zoom);
351  y = UnScaleByZoomLower(y, vp->zoom);
352 
353  old_left -= x;
354  old_top -= y;
355 
356  if (old_top == 0 && old_left == 0) return;
357 
358  _vp_move_offs.x = old_left;
359  _vp_move_offs.y = old_top;
360 
361  left = vp->left;
362  top = vp->top;
363  width = vp->width;
364  height = vp->height;
365 
366  if (left < 0) {
367  width += left;
368  left = 0;
369  }
370 
371  i = left + width - _screen.width;
372  if (i >= 0) width -= i;
373 
374  if (width > 0) {
375  if (top < 0) {
376  height += top;
377  top = 0;
378  }
379 
380  i = top + height - _screen.height;
381  if (i >= 0) height -= i;
382 
383  if (height > 0) DoSetViewportPosition(w->z_front, left, top, width, height);
384  }
385 }
386 
395 ViewPort *IsPtInWindowViewport(const Window *w, int x, int y)
396 {
397  ViewPort *vp = w->viewport;
398 
399  if (vp != nullptr &&
400  IsInsideMM(x, vp->left, vp->left + vp->width) &&
401  IsInsideMM(y, vp->top, vp->top + vp->height))
402  return vp;
403 
404  return nullptr;
405 }
406 
419 Point TranslateXYToTileCoord(const ViewPort *vp, int x, int y, bool clamp_to_map)
420 {
421  if (!IsInsideBS(x, vp->left, vp->width) || !IsInsideBS(y, vp->top, vp->height)) {
422  Point pt = { -1, -1 };
423  return pt;
424  }
425 
426  return InverseRemapCoords2(
427  ScaleByZoom(x - vp->left, vp->zoom) + vp->virtual_left,
428  ScaleByZoom(y - vp->top, vp->zoom) + vp->virtual_top, clamp_to_map);
429 }
430 
431 /* When used for zooming, check area below current coordinates (x,y)
432  * and return the tile of the zoomed out/in position (zoom_x, zoom_y)
433  * when you just want the tile, make x = zoom_x and y = zoom_y */
434 static Point GetTileFromScreenXY(int x, int y, int zoom_x, int zoom_y)
435 {
436  Window *w;
437  ViewPort *vp;
438  Point pt;
439 
440  if ( (w = FindWindowFromPt(x, y)) != nullptr &&
441  (vp = IsPtInWindowViewport(w, x, y)) != nullptr)
442  return TranslateXYToTileCoord(vp, zoom_x, zoom_y);
443 
444  pt.y = pt.x = -1;
445  return pt;
446 }
447 
448 Point GetTileBelowCursor()
449 {
450  return GetTileFromScreenXY(_cursor.pos.x, _cursor.pos.y, _cursor.pos.x, _cursor.pos.y);
451 }
452 
453 
454 Point GetTileZoomCenterWindow(bool in, Window * w)
455 {
456  int x, y;
457  ViewPort *vp = w->viewport;
458 
459  if (in) {
460  x = ((_cursor.pos.x - vp->left) >> 1) + (vp->width >> 2);
461  y = ((_cursor.pos.y - vp->top) >> 1) + (vp->height >> 2);
462  } else {
463  x = vp->width - (_cursor.pos.x - vp->left);
464  y = vp->height - (_cursor.pos.y - vp->top);
465  }
466  /* Get the tile below the cursor and center on the zoomed-out center */
467  return GetTileFromScreenXY(_cursor.pos.x, _cursor.pos.y, x + vp->left, y + vp->top);
468 }
469 
478 void HandleZoomMessage(Window *w, const ViewPort *vp, byte widget_zoom_in, byte widget_zoom_out)
479 {
480  w->SetWidgetDisabledState(widget_zoom_in, vp->zoom <= _settings_client.gui.zoom_min);
481  w->SetWidgetDirty(widget_zoom_in);
482 
483  w->SetWidgetDisabledState(widget_zoom_out, vp->zoom >= _settings_client.gui.zoom_max);
484  w->SetWidgetDirty(widget_zoom_out);
485 }
486 
499 static void AddTileSpriteToDraw(SpriteID image, PaletteID pal, int32 x, int32 y, int z, const SubSprite *sub = nullptr, int extra_offs_x = 0, int extra_offs_y = 0)
500 {
501  assert((image & SPRITE_MASK) < MAX_SPRITES);
502 
503  /*C++17: TileSpriteToDraw &ts = */ _vd.tile_sprites_to_draw.emplace_back();
504  TileSpriteToDraw &ts = _vd.tile_sprites_to_draw.back();
505  ts.image = image;
506  ts.pal = pal;
507  ts.sub = sub;
508  Point pt = RemapCoords(x, y, z);
509  ts.x = pt.x + extra_offs_x;
510  ts.y = pt.y + extra_offs_y;
511 }
512 
525 static void AddChildSpriteToFoundation(SpriteID image, PaletteID pal, const SubSprite *sub, FoundationPart foundation_part, int extra_offs_x, int extra_offs_y)
526 {
527  assert(IsInsideMM(foundation_part, 0, FOUNDATION_PART_END));
528  assert(_vd.foundation[foundation_part] != -1);
529  Point offs = _vd.foundation_offset[foundation_part];
530 
531  /* Change the active ChildSprite list to the one of the foundation */
532  int *old_child = _vd.last_child;
533  _vd.last_child = _vd.last_foundation_child[foundation_part];
534 
535  AddChildSpriteScreen(image, pal, offs.x + extra_offs_x, offs.y + extra_offs_y, false, sub, false);
536 
537  /* Switch back to last ChildSprite list */
538  _vd.last_child = old_child;
539 }
540 
554 void DrawGroundSpriteAt(SpriteID image, PaletteID pal, int32 x, int32 y, int z, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
555 {
556  /* Switch to first foundation part, if no foundation was drawn */
558 
559  if (_vd.foundation[_vd.foundation_part] != -1) {
560  Point pt = RemapCoords(x, y, z);
561  AddChildSpriteToFoundation(image, pal, sub, _vd.foundation_part, pt.x + extra_offs_x * ZOOM_LVL_BASE, pt.y + extra_offs_y * ZOOM_LVL_BASE);
562  } else {
563  AddTileSpriteToDraw(image, pal, _cur_ti->x + x, _cur_ti->y + y, _cur_ti->z + z, sub, extra_offs_x * ZOOM_LVL_BASE, extra_offs_y * ZOOM_LVL_BASE);
564  }
565 }
566 
577 void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
578 {
579  DrawGroundSpriteAt(image, pal, 0, 0, 0, sub, extra_offs_x, extra_offs_y);
580 }
581 
589 void OffsetGroundSprite(int x, int y)
590 {
591  /* Switch to next foundation part */
592  switch (_vd.foundation_part) {
595  break;
598  break;
599  default: NOT_REACHED();
600  }
601 
602  /* _vd.last_child == nullptr if foundation sprite was clipped by the viewport bounds */
603  if (_vd.last_child != nullptr) _vd.foundation[_vd.foundation_part] = (uint)_vd.parent_sprites_to_draw.size() - 1;
604 
605  _vd.foundation_offset[_vd.foundation_part].x = x * ZOOM_LVL_BASE;
606  _vd.foundation_offset[_vd.foundation_part].y = y * ZOOM_LVL_BASE;
607  _vd.last_foundation_child[_vd.foundation_part] = _vd.last_child;
608 }
609 
621 static void AddCombinedSprite(SpriteID image, PaletteID pal, int x, int y, int z, const SubSprite *sub)
622 {
623  Point pt = RemapCoords(x, y, z);
624  const Sprite *spr = GetSprite(image & SPRITE_MASK, ST_NORMAL);
625 
626  if (pt.x + spr->x_offs >= _vd.dpi.left + _vd.dpi.width ||
627  pt.x + spr->x_offs + spr->width <= _vd.dpi.left ||
628  pt.y + spr->y_offs >= _vd.dpi.top + _vd.dpi.height ||
629  pt.y + spr->y_offs + spr->height <= _vd.dpi.top)
630  return;
631 
632  const ParentSpriteToDraw &pstd = _vd.parent_sprites_to_draw.back();
633  AddChildSpriteScreen(image, pal, pt.x - pstd.left, pt.y - pstd.top, false, sub, false);
634 }
635 
661 void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int w, int h, int dz, int z, bool transparent, int bb_offset_x, int bb_offset_y, int bb_offset_z, const SubSprite *sub)
662 {
663  int32 left, right, top, bottom;
664 
665  assert((image & SPRITE_MASK) < MAX_SPRITES);
666 
667  /* make the sprites transparent with the right palette */
668  if (transparent) {
671  }
672 
674  AddCombinedSprite(image, pal, x, y, z, sub);
675  return;
676  }
677 
678  _vd.last_child = nullptr;
679 
680  Point pt = RemapCoords(x, y, z);
681  int tmp_left, tmp_top, tmp_x = pt.x, tmp_y = pt.y;
682 
683  /* Compute screen extents of sprite */
684  if (image == SPR_EMPTY_BOUNDING_BOX) {
685  left = tmp_left = RemapCoords(x + w , y + bb_offset_y, z + bb_offset_z).x;
686  right = RemapCoords(x + bb_offset_x, y + h , z + bb_offset_z).x + 1;
687  top = tmp_top = RemapCoords(x + bb_offset_x, y + bb_offset_y, z + dz ).y;
688  bottom = RemapCoords(x + w , y + h , z + bb_offset_z).y + 1;
689  } else {
690  const Sprite *spr = GetSprite(image & SPRITE_MASK, ST_NORMAL);
691  left = tmp_left = (pt.x += spr->x_offs);
692  right = (pt.x + spr->width );
693  top = tmp_top = (pt.y += spr->y_offs);
694  bottom = (pt.y + spr->height);
695  }
696 
697  if (_draw_bounding_boxes && (image != SPR_EMPTY_BOUNDING_BOX)) {
698  /* Compute maximal extents of sprite and its bounding box */
699  left = min(left , RemapCoords(x + w , y + bb_offset_y, z + bb_offset_z).x);
700  right = max(right , RemapCoords(x + bb_offset_x, y + h , z + bb_offset_z).x + 1);
701  top = min(top , RemapCoords(x + bb_offset_x, y + bb_offset_y, z + dz ).y);
702  bottom = max(bottom, RemapCoords(x + w , y + h , z + bb_offset_z).y + 1);
703  }
704 
705  /* Do not add the sprite to the viewport, if it is outside */
706  if (left >= _vd.dpi.left + _vd.dpi.width ||
707  right <= _vd.dpi.left ||
708  top >= _vd.dpi.top + _vd.dpi.height ||
709  bottom <= _vd.dpi.top) {
710  return;
711  }
712 
713  /*C++17: ParentSpriteToDraw &ps = */ _vd.parent_sprites_to_draw.emplace_back();
714  ParentSpriteToDraw &ps = _vd.parent_sprites_to_draw.back();
715  ps.x = tmp_x;
716  ps.y = tmp_y;
717 
718  ps.left = tmp_left;
719  ps.top = tmp_top;
720 
721  ps.image = image;
722  ps.pal = pal;
723  ps.sub = sub;
724  ps.xmin = x + bb_offset_x;
725  ps.xmax = x + max(bb_offset_x, w) - 1;
726 
727  ps.ymin = y + bb_offset_y;
728  ps.ymax = y + max(bb_offset_y, h) - 1;
729 
730  ps.zmin = z + bb_offset_z;
731  ps.zmax = z + max(bb_offset_z, dz) - 1;
732 
733  ps.comparison_done = false;
734  ps.first_child = -1;
735 
736  _vd.last_child = &ps.first_child;
737 
739 }
740 
760 {
761  assert(_vd.combine_sprites == SPRITE_COMBINE_NONE);
763 }
764 
770 {
771  assert(_vd.combine_sprites != SPRITE_COMBINE_NONE);
773 }
774 
784 static bool IsInRangeInclusive(int begin, int end, int check)
785 {
786  if (begin > end) Swap(begin, end);
787  return begin <= check && check <= end;
788 }
789 
796 bool IsInsideRotatedRectangle(int x, int y)
797 {
798  int dist_a = (_thd.size.x + _thd.size.y); // Rotated coordinate system for selected rectangle.
799  int dist_b = (_thd.size.x - _thd.size.y); // We don't have to divide by 2. It's all relative!
800  int a = ((x - _thd.pos.x) + (y - _thd.pos.y)); // Rotated coordinate system for the point under scrutiny.
801  int b = ((x - _thd.pos.x) - (y - _thd.pos.y));
802 
803  /* Check if a and b are between 0 and dist_a or dist_b respectively. */
804  return IsInRangeInclusive(dist_a, 0, a) && IsInRangeInclusive(dist_b, 0, b);
805 }
806 
817 void AddChildSpriteScreen(SpriteID image, PaletteID pal, int x, int y, bool transparent, const SubSprite *sub, bool scale)
818 {
819  assert((image & SPRITE_MASK) < MAX_SPRITES);
820 
821  /* If the ParentSprite was clipped by the viewport bounds, do not draw the ChildSprites either */
822  if (_vd.last_child == nullptr) return;
823 
824  /* make the sprites transparent with the right palette */
825  if (transparent) {
828  }
829 
830  *_vd.last_child = (uint)_vd.child_screen_sprites_to_draw.size();
831 
832  /*C++17: ChildScreenSpriteToDraw &cs = */ _vd.child_screen_sprites_to_draw.emplace_back();
833  ChildScreenSpriteToDraw &cs = _vd.child_screen_sprites_to_draw.back();
834  cs.image = image;
835  cs.pal = pal;
836  cs.sub = sub;
837  cs.x = scale ? x * ZOOM_LVL_BASE : x;
838  cs.y = scale ? y * ZOOM_LVL_BASE : y;
839  cs.next = -1;
840 
841  /* Append the sprite to the active ChildSprite list.
842  * If the active ParentSprite is a foundation, update last_foundation_child as well.
843  * Note: ChildSprites of foundations are NOT sequential in the vector, as selection sprites are added at last. */
844  if (_vd.last_foundation_child[0] == _vd.last_child) _vd.last_foundation_child[0] = &cs.next;
845  if (_vd.last_foundation_child[1] == _vd.last_child) _vd.last_foundation_child[1] = &cs.next;
846  _vd.last_child = &cs.next;
847 }
848 
849 static void AddStringToDraw(int x, int y, StringID string, uint64 params_1, uint64 params_2, Colours colour, uint16 width)
850 {
851  assert(width != 0);
852  /*C++17: StringSpriteToDraw &ss = */ _vd.string_sprites_to_draw.emplace_back();
853  StringSpriteToDraw &ss = _vd.string_sprites_to_draw.back();
854  ss.string = string;
855  ss.x = x;
856  ss.y = y;
857  ss.params[0] = params_1;
858  ss.params[1] = params_2;
859  ss.width = width;
860  ss.colour = colour;
861 }
862 
863 
875 static void DrawSelectionSprite(SpriteID image, PaletteID pal, const TileInfo *ti, int z_offset, FoundationPart foundation_part)
876 {
877  /* FIXME: This is not totally valid for some autorail highlights that extend over the edges of the tile. */
878  if (_vd.foundation[foundation_part] == -1) {
879  /* draw on real ground */
880  AddTileSpriteToDraw(image, pal, ti->x, ti->y, ti->z + z_offset);
881  } else {
882  /* draw on top of foundation */
883  AddChildSpriteToFoundation(image, pal, nullptr, foundation_part, 0, -z_offset * ZOOM_LVL_BASE);
884  }
885 }
886 
893 static void DrawTileSelectionRect(const TileInfo *ti, PaletteID pal)
894 {
895  if (!IsValidTile(ti->tile)) return;
896 
897  SpriteID sel;
898  if (IsHalftileSlope(ti->tileh)) {
899  Corner halftile_corner = GetHalftileSlopeCorner(ti->tileh);
900  SpriteID sel2 = SPR_HALFTILE_SELECTION_FLAT + halftile_corner;
902 
903  Corner opposite_corner = OppositeCorner(halftile_corner);
904  if (IsSteepSlope(ti->tileh)) {
905  sel = SPR_HALFTILE_SELECTION_DOWN;
906  } else {
907  sel = ((ti->tileh & SlopeWithOneCornerRaised(opposite_corner)) != 0 ? SPR_HALFTILE_SELECTION_UP : SPR_HALFTILE_SELECTION_FLAT);
908  }
909  sel += opposite_corner;
910  } else {
911  sel = SPR_SELECT_TILE + SlopeToSpriteOffset(ti->tileh);
912  }
914 }
915 
916 static bool IsPartOfAutoLine(int px, int py)
917 {
918  px -= _thd.selstart.x;
919  py -= _thd.selstart.y;
920 
921  if ((_thd.drawstyle & HT_DRAG_MASK) != HT_LINE) return false;
922 
923  switch (_thd.drawstyle & HT_DIR_MASK) {
924  case HT_DIR_X: return py == 0; // x direction
925  case HT_DIR_Y: return px == 0; // y direction
926  case HT_DIR_HU: return px == -py || px == -py - 16; // horizontal upper
927  case HT_DIR_HL: return px == -py || px == -py + 16; // horizontal lower
928  case HT_DIR_VL: return px == py || px == py + 16; // vertical left
929  case HT_DIR_VR: return px == py || px == py - 16; // vertical right
930  default:
931  NOT_REACHED();
932  }
933 }
934 
935 /* [direction][side] */
936 static const HighLightStyle _autorail_type[6][2] = {
937  { HT_DIR_X, HT_DIR_X },
938  { HT_DIR_Y, HT_DIR_Y },
939  { HT_DIR_HU, HT_DIR_HL },
940  { HT_DIR_HL, HT_DIR_HU },
941  { HT_DIR_VL, HT_DIR_VR },
942  { HT_DIR_VR, HT_DIR_VL }
943 };
944 
945 #include "table/autorail.h"
946 
953 static void DrawAutorailSelection(const TileInfo *ti, uint autorail_type)
954 {
955  SpriteID image;
956  PaletteID pal;
957  int offset;
958 
959  FoundationPart foundation_part = FOUNDATION_PART_NORMAL;
960  Slope autorail_tileh = RemoveHalftileSlope(ti->tileh);
961  if (IsHalftileSlope(ti->tileh)) {
962  static const uint _lower_rail[4] = { 5U, 2U, 4U, 3U };
963  Corner halftile_corner = GetHalftileSlopeCorner(ti->tileh);
964  if (autorail_type != _lower_rail[halftile_corner]) {
965  foundation_part = FOUNDATION_PART_HALFTILE;
966  /* Here we draw the highlights of the "three-corners-raised"-slope. That looks ok to me. */
967  autorail_tileh = SlopeWithThreeCornersRaised(OppositeCorner(halftile_corner));
968  }
969  }
970 
971  offset = _AutorailTilehSprite[autorail_tileh][autorail_type];
972  if (offset >= 0) {
973  image = SPR_AUTORAIL_BASE + offset;
974  pal = PAL_NONE;
975  } else {
976  image = SPR_AUTORAIL_BASE - offset;
977  pal = PALETTE_SEL_TILE_RED;
978  }
979 
980  DrawSelectionSprite(image, _thd.make_square_red ? PALETTE_SEL_TILE_RED : pal, ti, 7, foundation_part);
981 }
982 
983 enum TileHighlightType {
984  THT_NONE,
985  THT_WHITE,
986  THT_BLUE,
987  THT_RED,
988 };
989 
992 
998 static TileHighlightType GetTileHighlightType(TileIndex t)
999 {
1000  if (_viewport_highlight_station != nullptr) {
1001  if (IsTileType(t, MP_STATION) && GetStationIndex(t) == _viewport_highlight_station->index) return THT_WHITE;
1002  if (_viewport_highlight_station->TileIsInCatchment(t)) return THT_BLUE;
1003  }
1004 
1005  if (_viewport_highlight_town != nullptr) {
1006  if (IsTileType(t, MP_HOUSE)) {
1007  if (GetTownIndex(t) == _viewport_highlight_town->index) {
1008  TileHighlightType type = THT_RED;
1009  for (const Station *st : _viewport_highlight_town->stations_near) {
1010  if (st->owner != _current_company) continue;
1011  if (st->TileIsInCatchment(t)) return THT_BLUE;
1012  }
1013  return type;
1014  }
1015  } else if (IsTileType(t, MP_STATION)) {
1016  for (const Station *st : _viewport_highlight_town->stations_near) {
1017  if (st->owner != _current_company) continue;
1018  if (GetStationIndex(t) == st->index) return THT_WHITE;
1019  }
1020  }
1021  }
1022 
1023  return THT_NONE;
1024 }
1025 
1031 static void DrawTileHighlightType(const TileInfo *ti, TileHighlightType tht)
1032 {
1033  switch (tht) {
1034  default:
1035  case THT_NONE: break;
1036  case THT_WHITE: DrawTileSelectionRect(ti, PAL_NONE); break;
1037  case THT_BLUE: DrawTileSelectionRect(ti, PALETTE_SEL_TILE_BLUE); break;
1038  case THT_RED: DrawTileSelectionRect(ti, PALETTE_TILE_RED_PULSATING); break;
1039  }
1040 }
1041 
1047 {
1048  /* Going through cases in order of computational time. */
1049 
1050  if (_town_local_authority_kdtree.Count() == 0) return;
1051 
1052  /* Tile belongs to town regardless of distance from town. */
1053  if (GetTileType(ti->tile) == MP_HOUSE) {
1054  if (!Town::GetByTile(ti->tile)->show_zone) return;
1055 
1057  return;
1058  }
1059 
1060  /* If the closest town in the highlighted list is far, we can stop searching. */
1061  TownID tid = _town_local_authority_kdtree.FindNearest(TileX(ti->tile), TileY(ti->tile));
1062  Town *closest_highlighted_town = Town::Get(tid);
1063 
1064  if (DistanceManhattan(ti->tile, closest_highlighted_town->xy) >= _settings_game.economy.dist_local_authority) return;
1065 
1066  /* Tile is inside of the local autrhority distance of a highlighted town,
1067  but it is possible that a non-highlighted town is even closer. */
1069 
1070  if (closest_town->show_zone) {
1072  }
1073 
1074 }
1075 
1080 static void DrawTileSelection(const TileInfo *ti)
1081 {
1082  /* Highlight tiles insede local authority of selected towns. */
1084 
1085  /* Draw a red error square? */
1086  bool is_redsq = _thd.redsq == ti->tile;
1088 
1089  TileHighlightType tht = GetTileHighlightType(ti->tile);
1090  DrawTileHighlightType(ti, tht);
1091 
1092  /* No tile selection active? */
1093  if ((_thd.drawstyle & HT_DRAG_MASK) == HT_NONE) return;
1094 
1095  if (_thd.diagonal) { // We're drawing a 45 degrees rotated (diagonal) rectangle
1096  if (IsInsideRotatedRectangle((int)ti->x, (int)ti->y)) goto draw_inner;
1097  return;
1098  }
1099 
1100  /* Inside the inner area? */
1101  if (IsInsideBS(ti->x, _thd.pos.x, _thd.size.x) &&
1102  IsInsideBS(ti->y, _thd.pos.y, _thd.size.y)) {
1103 draw_inner:
1104  if (_thd.drawstyle & HT_RECT) {
1105  if (!is_redsq) DrawTileSelectionRect(ti, _thd.make_square_red ? PALETTE_SEL_TILE_RED : PAL_NONE);
1106  } else if (_thd.drawstyle & HT_POINT) {
1107  /* Figure out the Z coordinate for the single dot. */
1108  int z = 0;
1109  FoundationPart foundation_part = FOUNDATION_PART_NORMAL;
1110  if (ti->tileh & SLOPE_N) {
1111  z += TILE_HEIGHT;
1113  }
1114  if (IsHalftileSlope(ti->tileh)) {
1115  Corner halftile_corner = GetHalftileSlopeCorner(ti->tileh);
1116  if ((halftile_corner == CORNER_W) || (halftile_corner == CORNER_E)) z += TILE_HEIGHT;
1117  if (halftile_corner != CORNER_S) {
1118  foundation_part = FOUNDATION_PART_HALFTILE;
1119  if (IsSteepSlope(ti->tileh)) z -= TILE_HEIGHT;
1120  }
1121  }
1122  DrawSelectionSprite(_cur_dpi->zoom <= ZOOM_LVL_DETAIL ? SPR_DOT : SPR_DOT_SMALL, PAL_NONE, ti, z, foundation_part);
1123  } else if (_thd.drawstyle & HT_RAIL) {
1124  /* autorail highlight piece under cursor */
1125  HighLightStyle type = _thd.drawstyle & HT_DIR_MASK;
1126  assert(type < HT_DIR_END);
1127  DrawAutorailSelection(ti, _autorail_type[type][0]);
1128  } else if (IsPartOfAutoLine(ti->x, ti->y)) {
1129  /* autorail highlighting long line */
1130  HighLightStyle dir = _thd.drawstyle & HT_DIR_MASK;
1131  uint side;
1132 
1133  if (dir == HT_DIR_X || dir == HT_DIR_Y) {
1134  side = 0;
1135  } else {
1136  TileIndex start = TileVirtXY(_thd.selstart.x, _thd.selstart.y);
1137  side = Delta(Delta(TileX(start), TileX(ti->tile)), Delta(TileY(start), TileY(ti->tile)));
1138  }
1139 
1140  DrawAutorailSelection(ti, _autorail_type[dir][side]);
1141  }
1142  return;
1143  }
1144 
1145  /* Check if it's inside the outer area? */
1146  if (!is_redsq && (tht == THT_NONE || tht == THT_RED) && _thd.outersize.x > 0 &&
1147  IsInsideBS(ti->x, _thd.pos.x + _thd.offs.x, _thd.size.x + _thd.outersize.x) &&
1148  IsInsideBS(ti->y, _thd.pos.y + _thd.offs.y, _thd.size.y + _thd.outersize.y)) {
1149  /* Draw a blue rect. */
1151  return;
1152  }
1153 }
1154 
1161 static int GetViewportY(Point tile)
1162 {
1163  /* Each increment in X or Y direction moves down by half a tile, i.e. TILE_PIXELS / 2. */
1164  return (tile.y * (int)(TILE_PIXELS / 2) + tile.x * (int)(TILE_PIXELS / 2) - TilePixelHeightOutsideMap(tile.x, tile.y)) << ZOOM_LVL_SHIFT;
1165 }
1166 
1171 {
1172  assert(_vd.dpi.top <= _vd.dpi.top + _vd.dpi.height);
1173  assert(_vd.dpi.left <= _vd.dpi.left + _vd.dpi.width);
1174 
1175  Point upper_left = InverseRemapCoords(_vd.dpi.left, _vd.dpi.top);
1176  Point upper_right = InverseRemapCoords(_vd.dpi.left + _vd.dpi.width, _vd.dpi.top);
1177 
1178  /* Transformations between tile coordinates and viewport rows/columns: See vp_column_row
1179  * column = y - x
1180  * row = x + y
1181  * x = (row - column) / 2
1182  * y = (row + column) / 2
1183  * Note: (row, columns) pairs are only valid, if they are both even or both odd.
1184  */
1185 
1186  /* Columns overlap with neighbouring columns by a half tile.
1187  * - Left column is column of upper_left (rounded down) and one column to the left.
1188  * - Right column is column of upper_right (rounded up) and one column to the right.
1189  * Note: Integer-division does not round down for negative numbers, so ensure rounding with another increment/decrement.
1190  */
1191  int left_column = (upper_left.y - upper_left.x) / (int)TILE_SIZE - 2;
1192  int right_column = (upper_right.y - upper_right.x) / (int)TILE_SIZE + 2;
1193 
1194  int potential_bridge_height = ZOOM_LVL_BASE * TILE_HEIGHT * _settings_game.construction.max_bridge_height;
1195 
1196  /* Rows overlap with neighbouring rows by a half tile.
1197  * The first row that could possibly be visible is the row above upper_left (if it is at height 0).
1198  * Due to integer-division not rounding down for negative numbers, we need another decrement.
1199  */
1200  int row = (upper_left.x + upper_left.y) / (int)TILE_SIZE - 2;
1201  bool last_row = false;
1202  for (; !last_row; row++) {
1203  last_row = true;
1204  for (int column = left_column; column <= right_column; column++) {
1205  /* Valid row/column? */
1206  if ((row + column) % 2 != 0) continue;
1207 
1208  Point tilecoord;
1209  tilecoord.x = (row - column) / 2;
1210  tilecoord.y = (row + column) / 2;
1211  assert(column == tilecoord.y - tilecoord.x);
1212  assert(row == tilecoord.y + tilecoord.x);
1213 
1214  TileType tile_type;
1215  TileInfo tile_info;
1216  _cur_ti = &tile_info;
1217  tile_info.x = tilecoord.x * TILE_SIZE; // FIXME tile_info should use signed integers
1218  tile_info.y = tilecoord.y * TILE_SIZE;
1219 
1220  if (IsInsideBS(tilecoord.x, 0, MapSizeX()) && IsInsideBS(tilecoord.y, 0, MapSizeY())) {
1221  /* This includes the south border at MapMaxX / MapMaxY. When terraforming we still draw tile selections there. */
1222  tile_info.tile = TileXY(tilecoord.x, tilecoord.y);
1223  tile_type = GetTileType(tile_info.tile);
1224  } else {
1225  tile_info.tile = INVALID_TILE;
1226  tile_type = MP_VOID;
1227  }
1228 
1229  if (tile_type != MP_VOID) {
1230  /* We are inside the map => paint landscape. */
1231  tile_info.tileh = GetTilePixelSlope(tile_info.tile, &tile_info.z);
1232  } else {
1233  /* We are outside the map => paint black. */
1234  tile_info.tileh = GetTilePixelSlopeOutsideMap(tilecoord.x, tilecoord.y, &tile_info.z);
1235  }
1236 
1237  int viewport_y = GetViewportY(tilecoord);
1238 
1239  if (viewport_y + MAX_TILE_EXTENT_BOTTOM < _vd.dpi.top) {
1240  /* The tile in this column is not visible yet.
1241  * Tiles in other columns may be visible, but we need more rows in any case. */
1242  last_row = false;
1243  continue;
1244  }
1245 
1246  int min_visible_height = viewport_y - (_vd.dpi.top + _vd.dpi.height);
1247  bool tile_visible = min_visible_height <= 0;
1248 
1249  if (tile_type != MP_VOID) {
1250  /* Is tile with buildings visible? */
1251  if (min_visible_height < MAX_TILE_EXTENT_TOP) tile_visible = true;
1252 
1253  if (IsBridgeAbove(tile_info.tile)) {
1254  /* Is the bridge visible? */
1255  TileIndex bridge_tile = GetNorthernBridgeEnd(tile_info.tile);
1256  int bridge_height = ZOOM_LVL_BASE * (GetBridgePixelHeight(bridge_tile) - TilePixelHeight(tile_info.tile));
1257  if (min_visible_height < bridge_height + MAX_TILE_EXTENT_TOP) tile_visible = true;
1258  }
1259 
1260  /* Would a higher bridge on a more southern tile be visible?
1261  * If yes, we need to loop over more rows to possibly find one. */
1262  if (min_visible_height < potential_bridge_height + MAX_TILE_EXTENT_TOP) last_row = false;
1263  } else {
1264  /* Outside of map. If we are on the north border of the map, there may still be a bridge visible,
1265  * so we need to loop over more rows to possibly find one. */
1266  if ((tilecoord.x <= 0 || tilecoord.y <= 0) && min_visible_height < potential_bridge_height + MAX_TILE_EXTENT_TOP) last_row = false;
1267  }
1268 
1269  if (tile_visible) {
1270  last_row = false;
1272  _vd.foundation[0] = -1;
1273  _vd.foundation[1] = -1;
1274  _vd.last_foundation_child[0] = nullptr;
1275  _vd.last_foundation_child[1] = nullptr;
1276 
1277  _tile_type_procs[tile_type]->draw_tile_proc(&tile_info);
1278  if (tile_info.tile != INVALID_TILE) DrawTileSelection(&tile_info);
1279  }
1280  }
1281  }
1282 }
1283 
1294 void ViewportAddString(const DrawPixelInfo *dpi, ZoomLevel small_from, const ViewportSign *sign, StringID string_normal, StringID string_small, StringID string_small_shadow, uint64 params_1, uint64 params_2, Colours colour)
1295 {
1296  bool small = dpi->zoom >= small_from;
1297 
1298  int left = dpi->left;
1299  int top = dpi->top;
1300  int right = left + dpi->width;
1301  int bottom = top + dpi->height;
1302 
1303  int sign_height = ScaleByZoom(VPSM_TOP + FONT_HEIGHT_NORMAL + VPSM_BOTTOM, dpi->zoom);
1304  int sign_half_width = ScaleByZoom((small ? sign->width_small : sign->width_normal) / 2, dpi->zoom);
1305 
1306  if (bottom < sign->top ||
1307  top > sign->top + sign_height ||
1308  right < sign->center - sign_half_width ||
1309  left > sign->center + sign_half_width) {
1310  return;
1311  }
1312 
1313  if (!small) {
1314  AddStringToDraw(sign->center - sign_half_width, sign->top, string_normal, params_1, params_2, colour, sign->width_normal);
1315  } else {
1316  int shadow_offset = 0;
1317  if (string_small_shadow != STR_NULL) {
1318  shadow_offset = 4;
1319  AddStringToDraw(sign->center - sign_half_width + shadow_offset, sign->top, string_small_shadow, params_1, params_2, INVALID_COLOUR, sign->width_small);
1320  }
1321  AddStringToDraw(sign->center - sign_half_width, sign->top - shadow_offset, string_small, params_1, params_2,
1322  colour, sign->width_small | 0x8000);
1323  }
1324 }
1325 
1326 static Rect ExpandRectWithViewportSignMargins(Rect r, ZoomLevel zoom)
1327 {
1328  /* Pessimistically always use normal font, but also assume small font is never larger in either dimension */
1329  const int fh = FONT_HEIGHT_NORMAL;
1330  const int max_tw = _viewport_sign_maxwidth / 2 + 1;
1331  const int expand_y = ScaleByZoom(VPSM_TOP + fh + VPSM_BOTTOM, zoom);
1332  const int expand_x = ScaleByZoom(VPSM_LEFT + max_tw + VPSM_RIGHT, zoom);
1333 
1334  r.left -= expand_x;
1335  r.right += expand_x;
1336  r.top -= expand_y;
1337  r.bottom += expand_y;
1338 
1339  return r;
1340 }
1341 
1342 static void ViewportAddKdtreeSigns(DrawPixelInfo *dpi)
1343 {
1344  Rect search_rect{ dpi->left, dpi->top, dpi->left + dpi->width, dpi->top + dpi->height };
1345  search_rect = ExpandRectWithViewportSignMargins(search_rect, dpi->zoom);
1346 
1347  bool show_stations = HasBit(_display_opt, DO_SHOW_STATION_NAMES) && _game_mode != GM_MENU;
1348  bool show_waypoints = HasBit(_display_opt, DO_SHOW_WAYPOINT_NAMES) && _game_mode != GM_MENU;
1349  bool show_towns = HasBit(_display_opt, DO_SHOW_TOWN_NAMES) && _game_mode != GM_MENU;
1350  bool show_signs = HasBit(_display_opt, DO_SHOW_SIGNS) && !IsInvisibilitySet(TO_SIGNS);
1351  bool show_competitors = HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS);
1352 
1353  const BaseStation *st;
1354  const Sign *si;
1355 
1356  /* Collect all the items first and draw afterwards, to ensure layering */
1357  std::vector<const BaseStation *> stations;
1358  std::vector<const Town *> towns;
1359  std::vector<const Sign *> signs;
1360 
1361  _viewport_sign_kdtree.FindContained(search_rect.left, search_rect.top, search_rect.right, search_rect.bottom, [&](const ViewportSignKdtreeItem & item) {
1362  switch (item.type) {
1363  case ViewportSignKdtreeItem::VKI_STATION:
1364  if (!show_stations) break;
1365  st = BaseStation::Get(item.id.station);
1366 
1367  /* Don't draw if station is owned by another company and competitor station names are hidden. Stations owned by none are never ignored. */
1368  if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
1369 
1370  stations.push_back(st);
1371  break;
1372 
1373  case ViewportSignKdtreeItem::VKI_WAYPOINT:
1374  if (!show_waypoints) break;
1375  st = BaseStation::Get(item.id.station);
1376 
1377  /* Don't draw if station is owned by another company and competitor station names are hidden. Stations owned by none are never ignored. */
1378  if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
1379 
1380  stations.push_back(st);
1381  break;
1382 
1383  case ViewportSignKdtreeItem::VKI_TOWN:
1384  if (!show_towns) break;
1385  towns.push_back(Town::Get(item.id.town));
1386  break;
1387 
1388  case ViewportSignKdtreeItem::VKI_SIGN:
1389  if (!show_signs) break;
1390  si = Sign::Get(item.id.sign);
1391 
1392  /* Don't draw if sign is owned by another company and competitor signs should be hidden.
1393  * Note: It is intentional that also signs owned by OWNER_NONE are hidden. Bankrupt
1394  * companies can leave OWNER_NONE signs after them. */
1395  if (!show_competitors && _local_company != si->owner && si->owner != OWNER_DEITY) break;
1396 
1397  signs.push_back(si);
1398  break;
1399 
1400  default:
1401  NOT_REACHED();
1402  }
1403  });
1404 
1405  /* Layering order (bottom to top): Town names, signs, stations */
1406 
1407  for (const auto *t : towns) {
1408  ViewportAddString(dpi, ZOOM_LVL_OUT_16X, &t->cache.sign,
1409  _settings_client.gui.population_in_label ? STR_VIEWPORT_TOWN_POP : STR_VIEWPORT_TOWN,
1410  STR_VIEWPORT_TOWN_TINY_WHITE, STR_VIEWPORT_TOWN_TINY_BLACK,
1411  t->index, t->cache.population);
1412  }
1413 
1414  for (const auto *si : signs) {
1415  ViewportAddString(dpi, ZOOM_LVL_OUT_16X, &si->sign,
1416  STR_WHITE_SIGN,
1417  (IsTransparencySet(TO_SIGNS) || si->owner == OWNER_DEITY) ? STR_VIEWPORT_SIGN_SMALL_WHITE : STR_VIEWPORT_SIGN_SMALL_BLACK, STR_NULL,
1418  si->index, 0, (si->owner == OWNER_NONE) ? COLOUR_GREY : (si->owner == OWNER_DEITY ? INVALID_COLOUR : _company_colours[si->owner]));
1419  }
1420 
1421  for (const auto *st : stations) {
1422  if (Station::IsExpected(st)) {
1423  /* Station */
1424  ViewportAddString(dpi, ZOOM_LVL_OUT_16X, &st->sign,
1425  STR_VIEWPORT_STATION, STR_VIEWPORT_STATION + 1, STR_NULL,
1426  st->index, st->facilities, (st->owner == OWNER_NONE || !st->IsInUse()) ? COLOUR_GREY : _company_colours[st->owner]);
1427  } else {
1428  /* Waypoint */
1429  ViewportAddString(dpi, ZOOM_LVL_OUT_16X, &st->sign,
1430  STR_VIEWPORT_WAYPOINT, STR_VIEWPORT_WAYPOINT + 1, STR_NULL,
1431  st->index, st->facilities, (st->owner == OWNER_NONE || !st->IsInUse()) ? COLOUR_GREY : _company_colours[st->owner]);
1432  }
1433  }
1434 }
1435 
1436 
1444 void ViewportSign::UpdatePosition(int center, int top, StringID str, StringID str_small)
1445 {
1446  if (this->width_normal != 0) this->MarkDirty();
1447 
1448  this->top = top;
1449 
1450  char buffer[DRAW_STRING_BUFFER];
1451 
1452  GetString(buffer, str, lastof(buffer));
1453  this->width_normal = VPSM_LEFT + Align(GetStringBoundingBox(buffer).width, 2) + VPSM_RIGHT;
1454  this->center = center;
1455 
1456  /* zoomed out version */
1457  if (str_small != STR_NULL) {
1458  GetString(buffer, str_small, lastof(buffer));
1459  }
1460  this->width_small = VPSM_LEFT + Align(GetStringBoundingBox(buffer, FS_SMALL).width, 2) + VPSM_RIGHT;
1461 
1462  this->MarkDirty();
1463 }
1464 
1472 {
1473  Rect zoomlevels[ZOOM_LVL_COUNT];
1474 
1475  for (ZoomLevel zoom = ZOOM_LVL_BEGIN; zoom != ZOOM_LVL_END; zoom++) {
1476  /* FIXME: This doesn't switch to width_small when appropriate. */
1477  zoomlevels[zoom].left = this->center - ScaleByZoom(this->width_normal / 2 + 1, zoom);
1478  zoomlevels[zoom].top = this->top - ScaleByZoom(1, zoom);
1479  zoomlevels[zoom].right = this->center + ScaleByZoom(this->width_normal / 2 + 1, zoom);
1480  zoomlevels[zoom].bottom = this->top + ScaleByZoom(VPSM_TOP + FONT_HEIGHT_NORMAL + VPSM_BOTTOM + 1, zoom);
1481  }
1482 
1483  Window *w;
1484  FOR_ALL_WINDOWS_FROM_BACK(w) {
1485  ViewPort *vp = w->viewport;
1486  if (vp != nullptr && vp->zoom <= maxzoom) {
1487  assert(vp->width != 0);
1488  Rect &zl = zoomlevels[vp->zoom];
1489  MarkViewportDirty(vp, zl.left, zl.top, zl.right, zl.bottom);
1490  }
1491  }
1492 }
1493 
1494 static void ViewportDrawTileSprites(const TileSpriteToDrawVector *tstdv)
1495 {
1496  for (const TileSpriteToDraw &ts : *tstdv) {
1497  DrawSpriteViewport(ts.image, ts.pal, ts.x, ts.y, ts.sub);
1498  }
1499 }
1500 
1503 {
1504  return true;
1505 }
1506 
1508 static void ViewportSortParentSprites(ParentSpriteToSortVector *psdv)
1509 {
1510  auto psdvend = psdv->end();
1511  auto psd = psdv->begin();
1512  while (psd != psdvend) {
1513  ParentSpriteToDraw *ps = *psd;
1514 
1515  if (ps->comparison_done) {
1516  psd++;
1517  continue;
1518  }
1519 
1520  ps->comparison_done = true;
1521 
1522  for (auto psd2 = psd + 1; psd2 != psdvend; psd2++) {
1523  ParentSpriteToDraw *ps2 = *psd2;
1524 
1525  if (ps2->comparison_done) continue;
1526 
1527  /* Decide which comparator to use, based on whether the bounding
1528  * boxes overlap
1529  */
1530  if (ps->xmax >= ps2->xmin && ps->xmin <= ps2->xmax && // overlap in X?
1531  ps->ymax >= ps2->ymin && ps->ymin <= ps2->ymax && // overlap in Y?
1532  ps->zmax >= ps2->zmin && ps->zmin <= ps2->zmax) { // overlap in Z?
1533  /* Use X+Y+Z as the sorting order, so sprites closer to the bottom of
1534  * the screen and with higher Z elevation, are drawn in front.
1535  * Here X,Y,Z are the coordinates of the "center of mass" of the sprite,
1536  * i.e. X=(left+right)/2, etc.
1537  * However, since we only care about order, don't actually divide / 2
1538  */
1539  if (ps->xmin + ps->xmax + ps->ymin + ps->ymax + ps->zmin + ps->zmax <=
1540  ps2->xmin + ps2->xmax + ps2->ymin + ps2->ymax + ps2->zmin + ps2->zmax) {
1541  continue;
1542  }
1543  } else {
1544  /* We only change the order, if it is definite.
1545  * I.e. every single order of X, Y, Z says ps2 is behind ps or they overlap.
1546  * That is: If one partial order says ps behind ps2, do not change the order.
1547  */
1548  if (ps->xmax < ps2->xmin ||
1549  ps->ymax < ps2->ymin ||
1550  ps->zmax < ps2->zmin) {
1551  continue;
1552  }
1553  }
1554 
1555  /* Move ps2 in front of ps */
1556  ParentSpriteToDraw *temp = ps2;
1557  for (auto psd3 = psd2; psd3 > psd; psd3--) {
1558  *psd3 = *(psd3 - 1);
1559  }
1560  *psd = temp;
1561  }
1562  }
1563 }
1564 
1565 static void ViewportDrawParentSprites(const ParentSpriteToSortVector *psd, const ChildScreenSpriteToDrawVector *csstdv)
1566 {
1567  for (const ParentSpriteToDraw *ps : *psd) {
1568  if (ps->image != SPR_EMPTY_BOUNDING_BOX) DrawSpriteViewport(ps->image, ps->pal, ps->x, ps->y, ps->sub);
1569 
1570  int child_idx = ps->first_child;
1571  while (child_idx >= 0) {
1572  const ChildScreenSpriteToDraw *cs = csstdv->data() + child_idx;
1573  child_idx = cs->next;
1574  DrawSpriteViewport(cs->image, cs->pal, ps->left + cs->x, ps->top + cs->y, cs->sub);
1575  }
1576  }
1577 }
1578 
1583 static void ViewportDrawBoundingBoxes(const ParentSpriteToSortVector *psd)
1584 {
1585  for (const ParentSpriteToDraw *ps : *psd) {
1586  Point pt1 = RemapCoords(ps->xmax + 1, ps->ymax + 1, ps->zmax + 1); // top front corner
1587  Point pt2 = RemapCoords(ps->xmin , ps->ymax + 1, ps->zmax + 1); // top left corner
1588  Point pt3 = RemapCoords(ps->xmax + 1, ps->ymin , ps->zmax + 1); // top right corner
1589  Point pt4 = RemapCoords(ps->xmax + 1, ps->ymax + 1, ps->zmin ); // bottom front corner
1590 
1591  DrawBox( pt1.x, pt1.y,
1592  pt2.x - pt1.x, pt2.y - pt1.y,
1593  pt3.x - pt1.x, pt3.y - pt1.y,
1594  pt4.x - pt1.x, pt4.y - pt1.y);
1595  }
1596 }
1597 
1602 {
1604  const DrawPixelInfo *dpi = _cur_dpi;
1605  void *dst;
1606  int right = UnScaleByZoom(dpi->width, dpi->zoom);
1607  int bottom = UnScaleByZoom(dpi->height, dpi->zoom);
1608 
1609  int colour = _string_colourmap[_dirty_block_colour & 0xF];
1610 
1611  dst = dpi->dst_ptr;
1612 
1613  byte bo = UnScaleByZoom(dpi->left + dpi->top, dpi->zoom) & 1;
1614  do {
1615  for (int i = (bo ^= 1); i < right; i += 2) blitter->SetPixel(dst, i, 0, (uint8)colour);
1616  dst = blitter->MoveTo(dst, 0, 1);
1617  } while (--bottom > 0);
1618 }
1619 
1620 static void ViewportDrawStrings(ZoomLevel zoom, const StringSpriteToDrawVector *sstdv)
1621 {
1622  for (const StringSpriteToDraw &ss : *sstdv) {
1623  TextColour colour = TC_BLACK;
1624  bool small = HasBit(ss.width, 15);
1625  int w = GB(ss.width, 0, 15);
1626  int x = UnScaleByZoom(ss.x, zoom);
1627  int y = UnScaleByZoom(ss.y, zoom);
1628  int h = VPSM_TOP + (small ? FONT_HEIGHT_SMALL : FONT_HEIGHT_NORMAL) + VPSM_BOTTOM;
1629 
1630  SetDParam(0, ss.params[0]);
1631  SetDParam(1, ss.params[1]);
1632 
1633  if (ss.colour != INVALID_COLOUR) {
1634  /* Do not draw signs nor station names if they are set invisible */
1635  if (IsInvisibilitySet(TO_SIGNS) && ss.string != STR_WHITE_SIGN) continue;
1636 
1637  if (IsTransparencySet(TO_SIGNS) && ss.string != STR_WHITE_SIGN) {
1638  /* Don't draw the rectangle.
1639  * Real colours need the TC_IS_PALETTE_COLOUR flag.
1640  * Otherwise colours from _string_colourmap are assumed. */
1641  colour = (TextColour)_colour_gradient[ss.colour][6] | TC_IS_PALETTE_COLOUR;
1642  } else {
1643  /* Draw the rectangle if 'transparent station signs' is off,
1644  * or if we are drawing a general text sign (STR_WHITE_SIGN). */
1645  DrawFrameRect(
1646  x, y, x + w, y + h, ss.colour,
1648  );
1649  }
1650  }
1651 
1652  DrawString(x + VPSM_LEFT, x + w - 1 - VPSM_RIGHT, y + VPSM_TOP, ss.string, colour, SA_HOR_CENTER);
1653  }
1654 }
1655 
1656 void ViewportDoDraw(const ViewPort *vp, int left, int top, int right, int bottom)
1657 {
1658  DrawPixelInfo *old_dpi = _cur_dpi;
1659  _cur_dpi = &_vd.dpi;
1660 
1661  _vd.dpi.zoom = vp->zoom;
1662  int mask = ScaleByZoom(-1, vp->zoom);
1663 
1665 
1666  _vd.dpi.width = (right - left) & mask;
1667  _vd.dpi.height = (bottom - top) & mask;
1668  _vd.dpi.left = left & mask;
1669  _vd.dpi.top = top & mask;
1670  _vd.dpi.pitch = old_dpi->pitch;
1671  _vd.last_child = nullptr;
1672 
1673  int x = UnScaleByZoom(_vd.dpi.left - (vp->virtual_left & mask), vp->zoom) + vp->left;
1674  int y = UnScaleByZoom(_vd.dpi.top - (vp->virtual_top & mask), vp->zoom) + vp->top;
1675 
1676  _vd.dpi.dst_ptr = BlitterFactory::GetCurrentBlitter()->MoveTo(old_dpi->dst_ptr, x - old_dpi->left, y - old_dpi->top);
1677 
1679  ViewportAddVehicles(&_vd.dpi);
1680 
1681  ViewportAddKdtreeSigns(&_vd.dpi);
1682 
1683  DrawTextEffects(&_vd.dpi);
1684 
1685  if (_vd.tile_sprites_to_draw.size() != 0) ViewportDrawTileSprites(&_vd.tile_sprites_to_draw);
1686 
1687  for (auto &psd : _vd.parent_sprites_to_draw) {
1688  _vd.parent_sprites_to_sort.push_back(&psd);
1689  }
1690 
1691  _vp_sprite_sorter(&_vd.parent_sprites_to_sort);
1692  ViewportDrawParentSprites(&_vd.parent_sprites_to_sort, &_vd.child_screen_sprites_to_draw);
1693 
1694  if (_draw_bounding_boxes) ViewportDrawBoundingBoxes(&_vd.parent_sprites_to_sort);
1695  if (_draw_dirty_blocks) ViewportDrawDirtyBlocks();
1696 
1697  DrawPixelInfo dp = _vd.dpi;
1698  ZoomLevel zoom = _vd.dpi.zoom;
1699  dp.zoom = ZOOM_LVL_NORMAL;
1700  dp.width = UnScaleByZoom(dp.width, zoom);
1701  dp.height = UnScaleByZoom(dp.height, zoom);
1702  _cur_dpi = &dp;
1703 
1704  if (vp->overlay != nullptr && vp->overlay->GetCargoMask() != 0 && vp->overlay->GetCompanyMask() != 0) {
1705  /* translate to window coordinates */
1706  dp.left = x;
1707  dp.top = y;
1708  vp->overlay->Draw(&dp);
1709  }
1710 
1711  if (_vd.string_sprites_to_draw.size() != 0) {
1712  /* translate to world coordinates */
1713  dp.left = UnScaleByZoom(_vd.dpi.left, zoom);
1714  dp.top = UnScaleByZoom(_vd.dpi.top, zoom);
1715  ViewportDrawStrings(zoom, &_vd.string_sprites_to_draw);
1716  }
1717 
1718  _cur_dpi = old_dpi;
1719 
1720  _vd.string_sprites_to_draw.clear();
1721  _vd.tile_sprites_to_draw.clear();
1722  _vd.parent_sprites_to_draw.clear();
1723  _vd.parent_sprites_to_sort.clear();
1724  _vd.child_screen_sprites_to_draw.clear();
1725 }
1726 
1731 static void ViewportDrawChk(const ViewPort *vp, int left, int top, int right, int bottom)
1732 {
1733  if (ScaleByZoom(bottom - top, vp->zoom) * ScaleByZoom(right - left, vp->zoom) > (int)(180000 * ZOOM_LVL_BASE * ZOOM_LVL_BASE)) {
1734  if ((bottom - top) > (right - left)) {
1735  int t = (top + bottom) >> 1;
1736  ViewportDrawChk(vp, left, top, right, t);
1737  ViewportDrawChk(vp, left, t, right, bottom);
1738  } else {
1739  int t = (left + right) >> 1;
1740  ViewportDrawChk(vp, left, top, t, bottom);
1741  ViewportDrawChk(vp, t, top, right, bottom);
1742  }
1743  } else {
1744  ViewportDoDraw(vp,
1745  ScaleByZoom(left - vp->left, vp->zoom) + vp->virtual_left,
1746  ScaleByZoom(top - vp->top, vp->zoom) + vp->virtual_top,
1747  ScaleByZoom(right - vp->left, vp->zoom) + vp->virtual_left,
1748  ScaleByZoom(bottom - vp->top, vp->zoom) + vp->virtual_top
1749  );
1750  }
1751 }
1752 
1753 static inline void ViewportDraw(const ViewPort *vp, int left, int top, int right, int bottom)
1754 {
1755  if (right <= vp->left || bottom <= vp->top) return;
1756 
1757  if (left >= vp->left + vp->width) return;
1758 
1759  if (left < vp->left) left = vp->left;
1760  if (right > vp->left + vp->width) right = vp->left + vp->width;
1761 
1762  if (top >= vp->top + vp->height) return;
1763 
1764  if (top < vp->top) top = vp->top;
1765  if (bottom > vp->top + vp->height) bottom = vp->top + vp->height;
1766 
1767  ViewportDrawChk(vp, left, top, right, bottom);
1768 }
1769 
1774 {
1776 
1777  DrawPixelInfo *dpi = _cur_dpi;
1778 
1779  dpi->left += this->left;
1780  dpi->top += this->top;
1781 
1782  ViewportDraw(this->viewport, dpi->left, dpi->top, dpi->left + dpi->width, dpi->top + dpi->height);
1783 
1784  dpi->left -= this->left;
1785  dpi->top -= this->top;
1786 }
1787 
1798 static inline void ClampViewportToMap(const ViewPort *vp, int *scroll_x, int *scroll_y)
1799 {
1800  /* Centre of the viewport is hot spot. */
1801  Point pt = {
1802  *scroll_x + vp->virtual_width / 2,
1803  *scroll_y + vp->virtual_height / 2
1804  };
1805 
1806  /* Find nearest tile that is within borders of the map. */
1807  bool clamped;
1808  pt = InverseRemapCoords2(pt.x, pt.y, true, &clamped);
1809 
1810  if (clamped) {
1811  /* Convert back to viewport coordinates and remove centering. */
1812  pt = RemapCoords2(pt.x, pt.y);
1813  *scroll_x = pt.x - vp->virtual_width / 2;
1814  *scroll_y = pt.y - vp->virtual_height / 2;
1815  }
1816 }
1817 
1823 {
1824  const ViewPort *vp = w->viewport;
1825 
1827  const Vehicle *veh = Vehicle::Get(w->viewport->follow_vehicle);
1828  Point pt = MapXYZToViewport(vp, veh->x_pos, veh->y_pos, veh->z_pos);
1829 
1830  w->viewport->scrollpos_x = pt.x;
1831  w->viewport->scrollpos_y = pt.y;
1832  SetViewportPosition(w, pt.x, pt.y);
1833  } else {
1834  /* Ensure the destination location is within the map */
1836 
1837  int delta_x = w->viewport->dest_scrollpos_x - w->viewport->scrollpos_x;
1838  int delta_y = w->viewport->dest_scrollpos_y - w->viewport->scrollpos_y;
1839 
1840  bool update_overlay = false;
1841  if (delta_x != 0 || delta_y != 0) {
1843  int max_scroll = ScaleByMapSize1D(512 * ZOOM_LVL_BASE);
1844  /* Not at our desired position yet... */
1845  w->viewport->scrollpos_x += Clamp(DivAwayFromZero(delta_x, 4), -max_scroll, max_scroll);
1846  w->viewport->scrollpos_y += Clamp(DivAwayFromZero(delta_y, 4), -max_scroll, max_scroll);
1847  } else {
1850  }
1851  update_overlay = (w->viewport->scrollpos_x == w->viewport->dest_scrollpos_x &&
1853  }
1854 
1856 
1857  SetViewportPosition(w, w->viewport->scrollpos_x, w->viewport->scrollpos_y);
1858  if (update_overlay) RebuildViewportOverlay(w);
1859  }
1860 }
1861 
1871 static void MarkViewportDirty(const ViewPort *vp, int left, int top, int right, int bottom)
1872 {
1873  /* Rounding wrt. zoom-out level */
1874  right += (1 << vp->zoom) - 1;
1875  bottom += (1 << vp->zoom) - 1;
1876 
1877  right -= vp->virtual_left;
1878  if (right <= 0) return;
1879 
1880  bottom -= vp->virtual_top;
1881  if (bottom <= 0) return;
1882 
1883  left = max(0, left - vp->virtual_left);
1884 
1885  if (left >= vp->virtual_width) return;
1886 
1887  top = max(0, top - vp->virtual_top);
1888 
1889  if (top >= vp->virtual_height) return;
1890 
1892  UnScaleByZoomLower(left, vp->zoom) + vp->left,
1893  UnScaleByZoomLower(top, vp->zoom) + vp->top,
1894  UnScaleByZoom(right, vp->zoom) + vp->left + 1,
1895  UnScaleByZoom(bottom, vp->zoom) + vp->top + 1
1896  );
1897 }
1898 
1907 void MarkAllViewportsDirty(int left, int top, int right, int bottom)
1908 {
1909  Window *w;
1910  FOR_ALL_WINDOWS_FROM_BACK(w) {
1911  ViewPort *vp = w->viewport;
1912  if (vp != nullptr) {
1913  assert(vp->width != 0);
1914  MarkViewportDirty(vp, left, top, right, bottom);
1915  }
1916  }
1917 }
1918 
1919 void ConstrainAllViewportsZoom()
1920 {
1921  Window *w;
1922  FOR_ALL_WINDOWS_FROM_FRONT(w) {
1923  if (w->viewport == nullptr) continue;
1924 
1926  if (zoom != w->viewport->zoom) {
1927  while (w->viewport->zoom < zoom) DoZoomInOutWindow(ZOOM_OUT, w);
1928  while (w->viewport->zoom > zoom) DoZoomInOutWindow(ZOOM_IN, w);
1929  }
1930  }
1931 }
1932 
1940 void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
1941 {
1942  Point pt = RemapCoords(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, tile_height_override * TILE_HEIGHT);
1944  pt.x - MAX_TILE_EXTENT_LEFT,
1945  pt.y - MAX_TILE_EXTENT_TOP - ZOOM_LVL_BASE * TILE_HEIGHT * bridge_level_offset,
1946  pt.x + MAX_TILE_EXTENT_RIGHT,
1947  pt.y + MAX_TILE_EXTENT_BOTTOM);
1948 }
1949 
1958 {
1959  int x_size = _thd.size.x;
1960  int y_size = _thd.size.y;
1961 
1962  if (!_thd.diagonal) { // Selecting in a straight rectangle (or a single square)
1963  int x_start = _thd.pos.x;
1964  int y_start = _thd.pos.y;
1965 
1966  if (_thd.outersize.x != 0) {
1967  x_size += _thd.outersize.x;
1968  x_start += _thd.offs.x;
1969  y_size += _thd.outersize.y;
1970  y_start += _thd.offs.y;
1971  }
1972 
1973  x_size -= TILE_SIZE;
1974  y_size -= TILE_SIZE;
1975 
1976  assert(x_size >= 0);
1977  assert(y_size >= 0);
1978 
1979  int x_end = Clamp(x_start + x_size, 0, MapSizeX() * TILE_SIZE - TILE_SIZE);
1980  int y_end = Clamp(y_start + y_size, 0, MapSizeY() * TILE_SIZE - TILE_SIZE);
1981 
1982  x_start = Clamp(x_start, 0, MapSizeX() * TILE_SIZE - TILE_SIZE);
1983  y_start = Clamp(y_start, 0, MapSizeY() * TILE_SIZE - TILE_SIZE);
1984 
1985  /* make sure everything is multiple of TILE_SIZE */
1986  assert((x_end | y_end | x_start | y_start) % TILE_SIZE == 0);
1987 
1988  /* How it works:
1989  * Suppose we have to mark dirty rectangle of 3x4 tiles:
1990  * x
1991  * xxx
1992  * xxxxx
1993  * xxxxx
1994  * xxx
1995  * x
1996  * This algorithm marks dirty columns of tiles, so it is done in 3+4-1 steps:
1997  * 1) x 2) x
1998  * xxx Oxx
1999  * Oxxxx xOxxx
2000  * xxxxx Oxxxx
2001  * xxx xxx
2002  * x x
2003  * And so forth...
2004  */
2005 
2006  int top_x = x_end; // coordinates of top dirty tile
2007  int top_y = y_start;
2008  int bot_x = top_x; // coordinates of bottom dirty tile
2009  int bot_y = top_y;
2010 
2011  do {
2012  /* topmost dirty point */
2013  TileIndex top_tile = TileVirtXY(top_x, top_y);
2014  Point top = RemapCoords(top_x, top_y, GetTileMaxPixelZ(top_tile));
2015 
2016  /* bottommost point */
2017  TileIndex bottom_tile = TileVirtXY(bot_x, bot_y);
2018  Point bot = RemapCoords(bot_x + TILE_SIZE, bot_y + TILE_SIZE, GetTilePixelZ(bottom_tile)); // bottommost point
2019 
2020  /* the 'x' coordinate of 'top' and 'bot' is the same (and always in the same distance from tile middle),
2021  * tile height/slope affects only the 'y' on-screen coordinate! */
2022 
2023  int l = top.x - TILE_PIXELS * ZOOM_LVL_BASE; // 'x' coordinate of left side of the dirty rectangle
2024  int t = top.y; // 'y' coordinate of top side of the dirty rectangle
2025  int r = top.x + TILE_PIXELS * ZOOM_LVL_BASE; // 'x' coordinate of right side of the dirty rectangle
2026  int b = bot.y; // 'y' coordinate of bottom side of the dirty rectangle
2027 
2028  static const int OVERLAY_WIDTH = 4 * ZOOM_LVL_BASE; // part of selection sprites is drawn outside the selected area (in particular: terraforming)
2029 
2030  /* For halftile foundations on SLOPE_STEEP_S the sprite extents some more towards the top */
2031  MarkAllViewportsDirty(l - OVERLAY_WIDTH, t - OVERLAY_WIDTH - TILE_HEIGHT * ZOOM_LVL_BASE, r + OVERLAY_WIDTH, b + OVERLAY_WIDTH);
2032 
2033  /* haven't we reached the topmost tile yet? */
2034  if (top_x != x_start) {
2035  top_x -= TILE_SIZE;
2036  } else {
2037  top_y += TILE_SIZE;
2038  }
2039 
2040  /* the way the bottom tile changes is different when we reach the bottommost tile */
2041  if (bot_y != y_end) {
2042  bot_y += TILE_SIZE;
2043  } else {
2044  bot_x -= TILE_SIZE;
2045  }
2046  } while (bot_x >= top_x);
2047  } else { // Selecting in a 45 degrees rotated (diagonal) rectangle.
2048  /* a_size, b_size describe a rectangle with rotated coordinates */
2049  int a_size = x_size + y_size, b_size = x_size - y_size;
2050 
2051  int interval_a = a_size < 0 ? -(int)TILE_SIZE : (int)TILE_SIZE;
2052  int interval_b = b_size < 0 ? -(int)TILE_SIZE : (int)TILE_SIZE;
2053 
2054  for (int a = -interval_a; a != a_size + interval_a; a += interval_a) {
2055  for (int b = -interval_b; b != b_size + interval_b; b += interval_b) {
2056  uint x = (_thd.pos.x + (a + b) / 2) / TILE_SIZE;
2057  uint y = (_thd.pos.y + (a - b) / 2) / TILE_SIZE;
2058 
2059  if (x < MapMaxX() && y < MapMaxY()) {
2060  MarkTileDirtyByTile(TileXY(x, y));
2061  }
2062  }
2063  }
2064  }
2065 }
2066 
2067 
2068 void SetSelectionRed(bool b)
2069 {
2070  _thd.make_square_red = b;
2072 }
2073 
2082 static bool CheckClickOnViewportSign(const ViewPort *vp, int x, int y, const ViewportSign *sign)
2083 {
2084  bool small = (vp->zoom >= ZOOM_LVL_OUT_16X);
2085  int sign_half_width = ScaleByZoom((small ? sign->width_small : sign->width_normal) / 2, vp->zoom);
2086  int sign_height = ScaleByZoom(VPSM_TOP + (small ? FONT_HEIGHT_SMALL : FONT_HEIGHT_NORMAL) + VPSM_BOTTOM, vp->zoom);
2087 
2088  return y >= sign->top && y < sign->top + sign_height &&
2089  x >= sign->center - sign_half_width && x < sign->center + sign_half_width;
2090 }
2091 
2092 
2100 static bool CheckClickOnViewportSign(const ViewPort *vp, int x, int y)
2101 {
2102  if (_game_mode == GM_MENU) return false;
2103 
2104  x = ScaleByZoom(x - vp->left, vp->zoom) + vp->virtual_left;
2105  y = ScaleByZoom(y - vp->top, vp->zoom) + vp->virtual_top;
2106 
2107  Rect search_rect{ x - 1, y - 1, x + 1, y + 1 };
2108  search_rect = ExpandRectWithViewportSignMargins(search_rect, vp->zoom);
2109 
2112  bool show_towns = HasBit(_display_opt, DO_SHOW_TOWN_NAMES);
2113  bool show_signs = HasBit(_display_opt, DO_SHOW_SIGNS) && !IsInvisibilitySet(TO_SIGNS);
2114  bool show_competitors = HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS);
2115 
2116  /* Topmost of each type that was hit */
2117  BaseStation *st = nullptr, *last_st = nullptr;
2118  Town *t = nullptr, *last_t = nullptr;
2119  Sign *si = nullptr, *last_si = nullptr;
2120 
2121  /* See ViewportAddKdtreeSigns() for details on the search logic */
2122  _viewport_sign_kdtree.FindContained(search_rect.left, search_rect.top, search_rect.right, search_rect.bottom, [&](const ViewportSignKdtreeItem & item) {
2123  switch (item.type) {
2124  case ViewportSignKdtreeItem::VKI_STATION:
2125  if (!show_stations) break;
2126  st = BaseStation::Get(item.id.station);
2127  if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
2128  if (CheckClickOnViewportSign(vp, x, y, &st->sign)) last_st = st;
2129  break;
2130 
2131  case ViewportSignKdtreeItem::VKI_WAYPOINT:
2132  if (!show_waypoints) break;
2133  st = BaseStation::Get(item.id.station);
2134  if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
2135  if (CheckClickOnViewportSign(vp, x, y, &st->sign)) last_st = st;
2136  break;
2137 
2138  case ViewportSignKdtreeItem::VKI_TOWN:
2139  if (!show_towns) break;
2140  t = Town::Get(item.id.town);
2141  if (CheckClickOnViewportSign(vp, x, y, &t->cache.sign)) last_t = t;
2142  break;
2143 
2144  case ViewportSignKdtreeItem::VKI_SIGN:
2145  if (!show_signs) break;
2146  si = Sign::Get(item.id.sign);
2147  if (!show_competitors && _local_company != si->owner && si->owner != OWNER_DEITY) break;
2148  if (CheckClickOnViewportSign(vp, x, y, &si->sign)) last_si = si;
2149  break;
2150 
2151  default:
2152  NOT_REACHED();
2153  }
2154  });
2155 
2156  /* Select which hit to handle based on priority */
2157  if (last_st != nullptr) {
2158  if (Station::IsExpected(last_st)) {
2159  ShowStationViewWindow(last_st->index);
2160  } else {
2162  }
2163  return true;
2164  } else if (last_t != nullptr) {
2165  ShowTownViewWindow(last_t->index);
2166  return true;
2167  } else if (last_si != nullptr) {
2168  HandleClickOnSign(last_si);
2169  return true;
2170  } else {
2171  return false;
2172  }
2173 }
2174 
2175 
2176 ViewportSignKdtreeItem ViewportSignKdtreeItem::MakeStation(StationID id)
2177 {
2179  item.type = VKI_STATION;
2180  item.id.station = id;
2181 
2182  const Station *st = Station::Get(id);
2183  Point pt = RemapCoords(TileX(st->xy) * TILE_SIZE, TileY(st->xy) * TILE_SIZE, GetTileMaxZ(st->xy) * TILE_HEIGHT);
2184 
2185  pt.y -= 32 * ZOOM_LVL_BASE;
2186  if ((st->facilities & FACIL_AIRPORT) && st->airport.type == AT_OILRIG) pt.y -= 16 * ZOOM_LVL_BASE;
2187 
2188  item.center = pt.x;
2189  item.top = pt.y;
2190 
2191  /* Assume the sign can be a candidate for drawing, so measure its width */
2192  _viewport_sign_maxwidth = max<int>(_viewport_sign_maxwidth, st->sign.width_normal);
2193 
2194  return item;
2195 }
2196 
2197 ViewportSignKdtreeItem ViewportSignKdtreeItem::MakeWaypoint(StationID id)
2198 {
2200  item.type = VKI_WAYPOINT;
2201  item.id.station = id;
2202 
2203  const Waypoint *st = Waypoint::Get(id);
2204  Point pt = RemapCoords(TileX(st->xy) * TILE_SIZE, TileY(st->xy) * TILE_SIZE, GetTileMaxZ(st->xy) * TILE_HEIGHT);
2205 
2206  pt.y -= 32 * ZOOM_LVL_BASE;
2207 
2208  item.center = pt.x;
2209  item.top = pt.y;
2210 
2211  /* Assume the sign can be a candidate for drawing, so measure its width */
2212  _viewport_sign_maxwidth = max<int>(_viewport_sign_maxwidth, st->sign.width_normal);
2213 
2214  return item;
2215 }
2216 
2217 ViewportSignKdtreeItem ViewportSignKdtreeItem::MakeTown(TownID id)
2218 {
2220  item.type = VKI_TOWN;
2221  item.id.town = id;
2222 
2223  const Town *town = Town::Get(id);
2224  /* Avoid using RemapCoords2, it has dependency on the foundations status of the tile, and that can be unavailable during saveload, leading to crashes.
2225  * Instead "fake" foundations by taking the highest Z coordinate of any corner of the tile. */
2226  Point pt = RemapCoords(TileX(town->xy) * TILE_SIZE, TileY(town->xy) * TILE_SIZE, GetTileMaxZ(town->xy) * TILE_HEIGHT);
2227 
2228  pt.y -= 24 * ZOOM_LVL_BASE;
2229 
2230  item.center = pt.x;
2231  item.top = pt.y;
2232 
2233  /* Assume the sign can be a candidate for drawing, so measure its width */
2234  _viewport_sign_maxwidth = max<int>(_viewport_sign_maxwidth, town->cache.sign.width_normal);
2235 
2236  return item;
2237 }
2238 
2239 ViewportSignKdtreeItem ViewportSignKdtreeItem::MakeSign(SignID id)
2240 {
2242  item.type = VKI_SIGN;
2243  item.id.sign = id;
2244 
2245  const Sign *sign = Sign::Get(id);
2246  Point pt = RemapCoords(sign->x, sign->y, sign->z);
2247 
2248  pt.y -= 6 * ZOOM_LVL_BASE;
2249 
2250  item.center = pt.x;
2251  item.top = pt.y;
2252 
2253  /* Assume the sign can be a candidate for drawing, so measure its width */
2254  _viewport_sign_maxwidth = max<int>(_viewport_sign_maxwidth, sign->sign.width_normal);
2255 
2256  return item;
2257 }
2258 
2259 void RebuildViewportKdtree()
2260 {
2261  /* Reset biggest size sign seen */
2262  _viewport_sign_maxwidth = 0;
2263 
2264  std::vector<ViewportSignKdtreeItem> items;
2266 
2267  const Station *st;
2268  FOR_ALL_STATIONS(st) {
2269  items.push_back(ViewportSignKdtreeItem::MakeStation(st->index));
2270  }
2271 
2272  const Waypoint *wp;
2273  FOR_ALL_WAYPOINTS(wp) {
2274  items.push_back(ViewportSignKdtreeItem::MakeWaypoint(wp->index));
2275  }
2276 
2277  const Town *town;
2278  FOR_ALL_TOWNS(town) {
2279  items.push_back(ViewportSignKdtreeItem::MakeTown(town->index));
2280  }
2281 
2282  const Sign *sign;
2283  FOR_ALL_SIGNS(sign) {
2284  items.push_back(ViewportSignKdtreeItem::MakeSign(sign->index));
2285  }
2286 
2287  _viewport_sign_kdtree.Build(items.begin(), items.end());
2288 }
2289 
2290 
2291 static bool CheckClickOnLandscape(const ViewPort *vp, int x, int y)
2292 {
2293  Point pt = TranslateXYToTileCoord(vp, x, y);
2294 
2295  if (pt.x != -1) return ClickTile(TileVirtXY(pt.x, pt.y));
2296  return true;
2297 }
2298 
2299 static void PlaceObject()
2300 {
2301  Point pt;
2302  Window *w;
2303 
2304  pt = GetTileBelowCursor();
2305  if (pt.x == -1) return;
2306 
2307  if ((_thd.place_mode & HT_DRAG_MASK) == HT_POINT) {
2308  pt.x += TILE_SIZE / 2;
2309  pt.y += TILE_SIZE / 2;
2310  }
2311 
2312  _tile_fract_coords.x = pt.x & TILE_UNIT_MASK;
2313  _tile_fract_coords.y = pt.y & TILE_UNIT_MASK;
2314 
2315  w = _thd.GetCallbackWnd();
2316  if (w != nullptr) w->OnPlaceObject(pt, TileVirtXY(pt.x, pt.y));
2317 }
2318 
2319 
2320 bool HandleViewportClicked(const ViewPort *vp, int x, int y)
2321 {
2322  const Vehicle *v = CheckClickOnVehicle(vp, x, y);
2323 
2324  if (_thd.place_mode & HT_VEHICLE) {
2325  if (v != nullptr && VehicleClicked(v)) return true;
2326  }
2327 
2328  /* Vehicle placement mode already handled above. */
2329  if ((_thd.place_mode & HT_DRAG_MASK) != HT_NONE) {
2330  PlaceObject();
2331  return true;
2332  }
2333 
2334  if (CheckClickOnViewportSign(vp, x, y)) return true;
2335  bool result = CheckClickOnLandscape(vp, x, y);
2336 
2337  if (v != nullptr) {
2338  DEBUG(misc, 2, "Vehicle %d (index %d) at %p", v->unitnumber, v->index, v);
2340  v = v->First();
2341  if (_ctrl_pressed && v->owner == _local_company) {
2342  StartStopVehicle(v, true);
2343  } else {
2345  }
2346  }
2347  return true;
2348  }
2349  return result;
2350 }
2351 
2352 void RebuildViewportOverlay(Window *w)
2353 {
2354  if (w->viewport->overlay != nullptr &&
2355  w->viewport->overlay->GetCompanyMask() != 0 &&
2356  w->viewport->overlay->GetCargoMask() != 0) {
2357  w->viewport->overlay->SetDirty();
2358  w->SetDirty();
2359  }
2360 }
2361 
2371 bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
2372 {
2373  /* The slope cannot be acquired outside of the map, so make sure we are always within the map. */
2374  if (z == -1) {
2375  if ( x >= 0 && x <= (int)MapSizeX() * (int)TILE_SIZE - 1
2376  && y >= 0 && y <= (int)MapSizeY() * (int)TILE_SIZE - 1) {
2377  z = GetSlopePixelZ(x, y);
2378  } else {
2379  z = TileHeightOutsideMap(x / (int)TILE_SIZE, y / (int)TILE_SIZE);
2380  }
2381  }
2382 
2383  Point pt = MapXYZToViewport(w->viewport, x, y, z);
2385 
2386  if (w->viewport->dest_scrollpos_x == pt.x && w->viewport->dest_scrollpos_y == pt.y) return false;
2387 
2388  if (instant) {
2389  w->viewport->scrollpos_x = pt.x;
2390  w->viewport->scrollpos_y = pt.y;
2391  RebuildViewportOverlay(w);
2392  }
2393 
2394  w->viewport->dest_scrollpos_x = pt.x;
2395  w->viewport->dest_scrollpos_y = pt.y;
2396  return true;
2397 }
2398 
2406 bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
2407 {
2408  return ScrollWindowTo(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, -1, w, instant);
2409 }
2410 
2417 bool ScrollMainWindowToTile(TileIndex tile, bool instant)
2418 {
2419  return ScrollMainWindowTo(TileX(tile) * TILE_SIZE + TILE_SIZE / 2, TileY(tile) * TILE_SIZE + TILE_SIZE / 2, -1, instant);
2420 }
2421 
2427 {
2428  TileIndex old;
2429 
2430  old = _thd.redsq;
2431  _thd.redsq = tile;
2432 
2433  if (tile != old) {
2434  if (tile != INVALID_TILE) MarkTileDirtyByTile(tile);
2435  if (old != INVALID_TILE) MarkTileDirtyByTile(old);
2436  }
2437 }
2438 
2444 void SetTileSelectSize(int w, int h)
2445 {
2446  _thd.new_size.x = w * TILE_SIZE;
2447  _thd.new_size.y = h * TILE_SIZE;
2448  _thd.new_outersize.x = 0;
2449  _thd.new_outersize.y = 0;
2450 }
2451 
2452 void SetTileSelectBigSize(int ox, int oy, int sx, int sy)
2453 {
2454  _thd.offs.x = ox * TILE_SIZE;
2455  _thd.offs.y = oy * TILE_SIZE;
2456  _thd.new_outersize.x = sx * TILE_SIZE;
2457  _thd.new_outersize.y = sy * TILE_SIZE;
2458 }
2459 
2461 static HighLightStyle GetAutorailHT(int x, int y)
2462 {
2463  return HT_RAIL | _autorail_piece[x & TILE_UNIT_MASK][y & TILE_UNIT_MASK];
2464 }
2465 
2470 {
2471  this->pos.x = 0;
2472  this->pos.y = 0;
2473  this->new_pos.x = 0;
2474  this->new_pos.y = 0;
2475 }
2476 
2482 {
2483  return (this->place_mode & HT_DIAGONAL) != 0 && _ctrl_pressed && _left_button_down;
2484 }
2485 
2491 {
2492  return FindWindowById(this->window_class, this->window_number);
2493 }
2494 
2495 
2496 
2505 {
2506  int x1;
2507  int y1;
2508 
2509  if (_thd.freeze) return;
2510 
2511  HighLightStyle new_drawstyle = HT_NONE;
2512  bool new_diagonal = false;
2513 
2514  if ((_thd.place_mode & HT_DRAG_MASK) == HT_SPECIAL) {
2515  x1 = _thd.selend.x;
2516  y1 = _thd.selend.y;
2517  if (x1 != -1) {
2518  int x2 = _thd.selstart.x & ~TILE_UNIT_MASK;
2519  int y2 = _thd.selstart.y & ~TILE_UNIT_MASK;
2520  x1 &= ~TILE_UNIT_MASK;
2521  y1 &= ~TILE_UNIT_MASK;
2522 
2523  if (_thd.IsDraggingDiagonal()) {
2524  new_diagonal = true;
2525  } else {
2526  if (x1 >= x2) Swap(x1, x2);
2527  if (y1 >= y2) Swap(y1, y2);
2528  }
2529  _thd.new_pos.x = x1;
2530  _thd.new_pos.y = y1;
2531  _thd.new_size.x = x2 - x1;
2532  _thd.new_size.y = y2 - y1;
2533  if (!new_diagonal) {
2534  _thd.new_size.x += TILE_SIZE;
2535  _thd.new_size.y += TILE_SIZE;
2536  }
2537  new_drawstyle = _thd.next_drawstyle;
2538  }
2539  } else if ((_thd.place_mode & HT_DRAG_MASK) != HT_NONE) {
2540  Point pt = GetTileBelowCursor();
2541  x1 = pt.x;
2542  y1 = pt.y;
2543  if (x1 != -1) {
2544  switch (_thd.place_mode & HT_DRAG_MASK) {
2545  case HT_RECT:
2546  new_drawstyle = HT_RECT;
2547  break;
2548  case HT_POINT:
2549  new_drawstyle = HT_POINT;
2550  x1 += TILE_SIZE / 2;
2551  y1 += TILE_SIZE / 2;
2552  break;
2553  case HT_RAIL:
2554  /* Draw one highlighted tile in any direction */
2555  new_drawstyle = GetAutorailHT(pt.x, pt.y);
2556  break;
2557  case HT_LINE:
2558  switch (_thd.place_mode & HT_DIR_MASK) {
2559  case HT_DIR_X: new_drawstyle = HT_LINE | HT_DIR_X; break;
2560  case HT_DIR_Y: new_drawstyle = HT_LINE | HT_DIR_Y; break;
2561 
2562  case HT_DIR_HU:
2563  case HT_DIR_HL:
2564  new_drawstyle = (pt.x & TILE_UNIT_MASK) + (pt.y & TILE_UNIT_MASK) <= TILE_SIZE ? HT_LINE | HT_DIR_HU : HT_LINE | HT_DIR_HL;
2565  break;
2566 
2567  case HT_DIR_VL:
2568  case HT_DIR_VR:
2569  new_drawstyle = (pt.x & TILE_UNIT_MASK) > (pt.y & TILE_UNIT_MASK) ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
2570  break;
2571 
2572  default: NOT_REACHED();
2573  }
2574  _thd.selstart.x = x1 & ~TILE_UNIT_MASK;
2575  _thd.selstart.y = y1 & ~TILE_UNIT_MASK;
2576  break;
2577  default:
2578  NOT_REACHED();
2579  }
2580  _thd.new_pos.x = x1 & ~TILE_UNIT_MASK;
2581  _thd.new_pos.y = y1 & ~TILE_UNIT_MASK;
2582  }
2583  }
2584 
2585  /* redraw selection */
2586  if (_thd.drawstyle != new_drawstyle ||
2587  _thd.pos.x != _thd.new_pos.x || _thd.pos.y != _thd.new_pos.y ||
2588  _thd.size.x != _thd.new_size.x || _thd.size.y != _thd.new_size.y ||
2589  _thd.outersize.x != _thd.new_outersize.x ||
2590  _thd.outersize.y != _thd.new_outersize.y ||
2591  _thd.diagonal != new_diagonal) {
2592  /* Clear the old tile selection? */
2594 
2595  _thd.drawstyle = new_drawstyle;
2596  _thd.pos = _thd.new_pos;
2597  _thd.size = _thd.new_size;
2598  _thd.outersize = _thd.new_outersize;
2599  _thd.diagonal = new_diagonal;
2600  _thd.dirty = 0xff;
2601 
2602  /* Draw the new tile selection? */
2603  if ((new_drawstyle & HT_DRAG_MASK) != HT_NONE) SetSelectionTilesDirty();
2604  }
2605 }
2606 
2614 static inline void ShowMeasurementTooltips(StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_cond = TCC_NONE)
2615 {
2616  if (!_settings_client.gui.measure_tooltip) return;
2617  GuiShowTooltips(_thd.GetCallbackWnd(), str, paramcount, params, close_cond);
2618 }
2619 
2620 static void HideMeasurementTooltips()
2621 {
2623 }
2624 
2627 {
2628  _thd.select_method = method;
2629  _thd.select_proc = process;
2630  _thd.selend.x = TileX(tile) * TILE_SIZE;
2631  _thd.selstart.x = TileX(tile) * TILE_SIZE;
2632  _thd.selend.y = TileY(tile) * TILE_SIZE;
2633  _thd.selstart.y = TileY(tile) * TILE_SIZE;
2634 
2635  /* Needed so several things (road, autoroad, bridges, ...) are placed correctly.
2636  * In effect, placement starts from the centre of a tile
2637  */
2638  if (method == VPM_X_OR_Y || method == VPM_FIX_X || method == VPM_FIX_Y) {
2639  _thd.selend.x += TILE_SIZE / 2;
2640  _thd.selend.y += TILE_SIZE / 2;
2641  _thd.selstart.x += TILE_SIZE / 2;
2642  _thd.selstart.y += TILE_SIZE / 2;
2643  }
2644 
2645  HighLightStyle others = _thd.place_mode & ~(HT_DRAG_MASK | HT_DIR_MASK);
2646  if ((_thd.place_mode & HT_DRAG_MASK) == HT_RECT) {
2647  _thd.place_mode = HT_SPECIAL | others;
2648  _thd.next_drawstyle = HT_RECT | others;
2649  } else if (_thd.place_mode & (HT_RAIL | HT_LINE)) {
2650  _thd.place_mode = HT_SPECIAL | others;
2651  _thd.next_drawstyle = _thd.drawstyle | others;
2652  } else {
2653  _thd.place_mode = HT_SPECIAL | others;
2654  _thd.next_drawstyle = HT_POINT | others;
2655  }
2657 }
2658 
2659 void VpSetPlaceSizingLimit(int limit)
2660 {
2661  _thd.sizelimit = limit;
2662 }
2663 
2670 {
2671  uint64 distance = DistanceManhattan(from, to) + 1;
2672 
2673  _thd.selend.x = TileX(to) * TILE_SIZE;
2674  _thd.selend.y = TileY(to) * TILE_SIZE;
2675  _thd.selstart.x = TileX(from) * TILE_SIZE;
2676  _thd.selstart.y = TileY(from) * TILE_SIZE;
2677  _thd.next_drawstyle = HT_RECT;
2678 
2679  /* show measurement only if there is any length to speak of */
2680  if (distance > 1) {
2681  ShowMeasurementTooltips(STR_MEASURE_LENGTH, 1, &distance);
2682  } else {
2683  HideMeasurementTooltips();
2684  }
2685 }
2686 
2687 static void VpStartPreSizing()
2688 {
2689  _thd.selend.x = -1;
2691 }
2692 
2698 {
2699  int fxpy = _tile_fract_coords.x + _tile_fract_coords.y;
2700  int sxpy = (_thd.selend.x & TILE_UNIT_MASK) + (_thd.selend.y & TILE_UNIT_MASK);
2701  int fxmy = _tile_fract_coords.x - _tile_fract_coords.y;
2702  int sxmy = (_thd.selend.x & TILE_UNIT_MASK) - (_thd.selend.y & TILE_UNIT_MASK);
2703 
2704  switch (mode) {
2705  default: NOT_REACHED();
2706  case 0: // end piece is lower right
2707  if (fxpy >= 20 && sxpy <= 12) return HT_DIR_HL;
2708  if (fxmy < -3 && sxmy > 3) return HT_DIR_VR;
2709  return HT_DIR_Y;
2710 
2711  case 1:
2712  if (fxmy > 3 && sxmy < -3) return HT_DIR_VL;
2713  if (fxpy <= 12 && sxpy >= 20) return HT_DIR_HU;
2714  return HT_DIR_Y;
2715 
2716  case 2:
2717  if (fxmy > 3 && sxmy < -3) return HT_DIR_VL;
2718  if (fxpy >= 20 && sxpy <= 12) return HT_DIR_HL;
2719  return HT_DIR_X;
2720 
2721  case 3:
2722  if (fxmy < -3 && sxmy > 3) return HT_DIR_VR;
2723  if (fxpy <= 12 && sxpy >= 20) return HT_DIR_HU;
2724  return HT_DIR_X;
2725  }
2726 }
2727 
2741 static bool SwapDirection(HighLightStyle style, TileIndex start_tile, TileIndex end_tile)
2742 {
2743  uint start_x = TileX(start_tile);
2744  uint start_y = TileY(start_tile);
2745  uint end_x = TileX(end_tile);
2746  uint end_y = TileY(end_tile);
2747 
2748  switch (style & HT_DRAG_MASK) {
2749  case HT_RAIL:
2750  case HT_LINE: return (end_x > start_x || (end_x == start_x && end_y > start_y));
2751 
2752  case HT_RECT:
2753  case HT_POINT: return (end_x != start_x && end_y < start_y);
2754  default: NOT_REACHED();
2755  }
2756 
2757  return false;
2758 }
2759 
2775 static int CalcHeightdiff(HighLightStyle style, uint distance, TileIndex start_tile, TileIndex end_tile)
2776 {
2777  bool swap = SwapDirection(style, start_tile, end_tile);
2778  uint h0, h1; // Start height and end height.
2779 
2780  if (start_tile == end_tile) return 0;
2781  if (swap) Swap(start_tile, end_tile);
2782 
2783  switch (style & HT_DRAG_MASK) {
2784  case HT_RECT: {
2785  static const TileIndexDiffC heightdiff_area_by_dir[] = {
2786  /* Start */ {1, 0}, /* Dragging east */ {0, 0}, // Dragging south
2787  /* End */ {0, 1}, /* Dragging east */ {1, 1} // Dragging south
2788  };
2789 
2790  /* In the case of an area we can determine whether we were dragging south or
2791  * east by checking the X-coordinates of the tiles */
2792  byte style_t = (byte)(TileX(end_tile) > TileX(start_tile));
2793  start_tile = TILE_ADD(start_tile, ToTileIndexDiff(heightdiff_area_by_dir[style_t]));
2794  end_tile = TILE_ADD(end_tile, ToTileIndexDiff(heightdiff_area_by_dir[2 + style_t]));
2795  FALLTHROUGH;
2796  }
2797 
2798  case HT_POINT:
2799  h0 = TileHeight(start_tile);
2800  h1 = TileHeight(end_tile);
2801  break;
2802  default: { // All other types, this is mostly only line/autorail
2803  static const HighLightStyle flip_style_direction[] = {
2805  };
2806  static const TileIndexDiffC heightdiff_line_by_dir[] = {
2807  /* Start */ {1, 0}, {1, 1}, /* HT_DIR_X */ {0, 1}, {1, 1}, // HT_DIR_Y
2808  /* Start */ {1, 0}, {0, 0}, /* HT_DIR_HU */ {1, 0}, {1, 1}, // HT_DIR_HL
2809  /* Start */ {1, 0}, {1, 1}, /* HT_DIR_VL */ {0, 1}, {1, 1}, // HT_DIR_VR
2810 
2811  /* Start */ {0, 1}, {0, 0}, /* HT_DIR_X */ {1, 0}, {0, 0}, // HT_DIR_Y
2812  /* End */ {0, 1}, {0, 0}, /* HT_DIR_HU */ {1, 1}, {0, 1}, // HT_DIR_HL
2813  /* End */ {1, 0}, {0, 0}, /* HT_DIR_VL */ {0, 0}, {0, 1}, // HT_DIR_VR
2814  };
2815 
2816  distance %= 2; // we're only interested if the distance is even or uneven
2817  style &= HT_DIR_MASK;
2818 
2819  /* To handle autorail, we do some magic to be able to use a lookup table.
2820  * Firstly if we drag the other way around, we switch start&end, and if needed
2821  * also flip the drag-position. Eg if it was on the left, and the distance is even
2822  * that means the end, which is now the start is on the right */
2823  if (swap && distance == 0) style = flip_style_direction[style];
2824 
2825  /* Use lookup table for start-tile based on HighLightStyle direction */
2826  byte style_t = style * 2;
2827  assert(style_t < lengthof(heightdiff_line_by_dir) - 13);
2828  h0 = TileHeight(TILE_ADD(start_tile, ToTileIndexDiff(heightdiff_line_by_dir[style_t])));
2829  uint ht = TileHeight(TILE_ADD(start_tile, ToTileIndexDiff(heightdiff_line_by_dir[style_t + 1])));
2830  h0 = max(h0, ht);
2831 
2832  /* Use lookup table for end-tile based on HighLightStyle direction
2833  * flip around side (lower/upper, left/right) based on distance */
2834  if (distance == 0) style_t = flip_style_direction[style] * 2;
2835  assert(style_t < lengthof(heightdiff_line_by_dir) - 13);
2836  h1 = TileHeight(TILE_ADD(end_tile, ToTileIndexDiff(heightdiff_line_by_dir[12 + style_t])));
2837  ht = TileHeight(TILE_ADD(end_tile, ToTileIndexDiff(heightdiff_line_by_dir[12 + style_t + 1])));
2838  h1 = max(h1, ht);
2839  break;
2840  }
2841  }
2842 
2843  if (swap) Swap(h0, h1);
2844  return (int)(h1 - h0) * TILE_HEIGHT_STEP;
2845 }
2846 
2847 static const StringID measure_strings_length[] = {STR_NULL, STR_MEASURE_LENGTH, STR_MEASURE_LENGTH_HEIGHTDIFF};
2848 
2855 static void CheckUnderflow(int &test, int &other, int mult)
2856 {
2857  if (test >= 0) return;
2858 
2859  other += mult * test;
2860  test = 0;
2861 }
2862 
2870 static void CheckOverflow(int &test, int &other, int max, int mult)
2871 {
2872  if (test <= max) return;
2873 
2874  other += mult * (test - max);
2875  test = max;
2876 }
2877 
2879 static void CalcRaildirsDrawstyle(int x, int y, int method)
2880 {
2881  HighLightStyle b;
2882 
2883  int dx = _thd.selstart.x - (_thd.selend.x & ~TILE_UNIT_MASK);
2884  int dy = _thd.selstart.y - (_thd.selend.y & ~TILE_UNIT_MASK);
2885  uint w = abs(dx) + TILE_SIZE;
2886  uint h = abs(dy) + TILE_SIZE;
2887 
2888  if (method & ~(VPM_RAILDIRS | VPM_SIGNALDIRS)) {
2889  /* We 'force' a selection direction; first four rail buttons. */
2890  method &= ~(VPM_RAILDIRS | VPM_SIGNALDIRS);
2891  int raw_dx = _thd.selstart.x - _thd.selend.x;
2892  int raw_dy = _thd.selstart.y - _thd.selend.y;
2893  switch (method) {
2894  case VPM_FIX_X:
2895  b = HT_LINE | HT_DIR_Y;
2896  x = _thd.selstart.x;
2897  break;
2898 
2899  case VPM_FIX_Y:
2900  b = HT_LINE | HT_DIR_X;
2901  y = _thd.selstart.y;
2902  break;
2903 
2904  case VPM_FIX_HORIZONTAL:
2905  if (dx == -dy) {
2906  /* We are on a straight horizontal line. Determine the 'rail'
2907  * to build based the sub tile location. */
2909  } else {
2910  /* We are not on a straight line. Determine the rail to build
2911  * based on whether we are above or below it. */
2912  b = dx + dy >= (int)TILE_SIZE ? HT_LINE | HT_DIR_HU : HT_LINE | HT_DIR_HL;
2913 
2914  /* Calculate where a horizontal line through the start point and
2915  * a vertical line from the selected end point intersect and
2916  * use that point as the end point. */
2917  int offset = (raw_dx - raw_dy) / 2;
2918  x = _thd.selstart.x - (offset & ~TILE_UNIT_MASK);
2919  y = _thd.selstart.y + (offset & ~TILE_UNIT_MASK);
2920 
2921  /* 'Build' the last half rail tile if needed */
2922  if ((offset & TILE_UNIT_MASK) > (TILE_SIZE / 2)) {
2923  if (dx + dy >= (int)TILE_SIZE) {
2924  x += (dx + dy < 0) ? (int)TILE_SIZE : -(int)TILE_SIZE;
2925  } else {
2926  y += (dx + dy < 0) ? (int)TILE_SIZE : -(int)TILE_SIZE;
2927  }
2928  }
2929 
2930  /* Make sure we do not overflow the map! */
2931  CheckUnderflow(x, y, 1);
2932  CheckUnderflow(y, x, 1);
2933  CheckOverflow(x, y, (MapMaxX() - 1) * TILE_SIZE, 1);
2934  CheckOverflow(y, x, (MapMaxY() - 1) * TILE_SIZE, 1);
2935  assert(x >= 0 && y >= 0 && x <= (int)(MapMaxX() * TILE_SIZE) && y <= (int)(MapMaxY() * TILE_SIZE));
2936  }
2937  break;
2938 
2939  case VPM_FIX_VERTICAL:
2940  if (dx == dy) {
2941  /* We are on a straight vertical line. Determine the 'rail'
2942  * to build based the sub tile location. */
2943  b = (x & TILE_UNIT_MASK) > (y & TILE_UNIT_MASK) ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
2944  } else {
2945  /* We are not on a straight line. Determine the rail to build
2946  * based on whether we are left or right from it. */
2947  b = dx < dy ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
2948 
2949  /* Calculate where a vertical line through the start point and
2950  * a horizontal line from the selected end point intersect and
2951  * use that point as the end point. */
2952  int offset = (raw_dx + raw_dy + (int)TILE_SIZE) / 2;
2953  x = _thd.selstart.x - (offset & ~TILE_UNIT_MASK);
2954  y = _thd.selstart.y - (offset & ~TILE_UNIT_MASK);
2955 
2956  /* 'Build' the last half rail tile if needed */
2957  if ((offset & TILE_UNIT_MASK) > (TILE_SIZE / 2)) {
2958  if (dx - dy < 0) {
2959  y += (dx > dy) ? (int)TILE_SIZE : -(int)TILE_SIZE;
2960  } else {
2961  x += (dx < dy) ? (int)TILE_SIZE : -(int)TILE_SIZE;
2962  }
2963  }
2964 
2965  /* Make sure we do not overflow the map! */
2966  CheckUnderflow(x, y, -1);
2967  CheckUnderflow(y, x, -1);
2968  CheckOverflow(x, y, (MapMaxX() - 1) * TILE_SIZE, -1);
2969  CheckOverflow(y, x, (MapMaxY() - 1) * TILE_SIZE, -1);
2970  assert(x >= 0 && y >= 0 && x <= (int)(MapMaxX() * TILE_SIZE) && y <= (int)(MapMaxY() * TILE_SIZE));
2971  }
2972  break;
2973 
2974  default:
2975  NOT_REACHED();
2976  }
2977  } else if (TileVirtXY(_thd.selstart.x, _thd.selstart.y) == TileVirtXY(x, y)) { // check if we're only within one tile
2978  if (method & VPM_RAILDIRS) {
2979  b = GetAutorailHT(x, y);
2980  } else { // rect for autosignals on one tile
2981  b = HT_RECT;
2982  }
2983  } else if (h == TILE_SIZE) { // Is this in X direction?
2984  if (dx == (int)TILE_SIZE) { // 2x1 special handling
2985  b = (Check2x1AutoRail(3)) | HT_LINE;
2986  } else if (dx == -(int)TILE_SIZE) {
2987  b = (Check2x1AutoRail(2)) | HT_LINE;
2988  } else {
2989  b = HT_LINE | HT_DIR_X;
2990  }
2991  y = _thd.selstart.y;
2992  } else if (w == TILE_SIZE) { // Or Y direction?
2993  if (dy == (int)TILE_SIZE) { // 2x1 special handling
2994  b = (Check2x1AutoRail(1)) | HT_LINE;
2995  } else if (dy == -(int)TILE_SIZE) { // 2x1 other direction
2996  b = (Check2x1AutoRail(0)) | HT_LINE;
2997  } else {
2998  b = HT_LINE | HT_DIR_Y;
2999  }
3000  x = _thd.selstart.x;
3001  } else if (w > h * 2) { // still count as x dir?
3002  b = HT_LINE | HT_DIR_X;
3003  y = _thd.selstart.y;
3004  } else if (h > w * 2) { // still count as y dir?
3005  b = HT_LINE | HT_DIR_Y;
3006  x = _thd.selstart.x;
3007  } else { // complicated direction
3008  int d = w - h;
3009  _thd.selend.x = _thd.selend.x & ~TILE_UNIT_MASK;
3010  _thd.selend.y = _thd.selend.y & ~TILE_UNIT_MASK;
3011 
3012  /* four cases. */
3013  if (x > _thd.selstart.x) {
3014  if (y > _thd.selstart.y) {
3015  /* south */
3016  if (d == 0) {
3017  b = (x & TILE_UNIT_MASK) > (y & TILE_UNIT_MASK) ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
3018  } else if (d >= 0) {
3019  x = _thd.selstart.x + h;
3020  b = HT_LINE | HT_DIR_VL;
3021  } else {
3022  y = _thd.selstart.y + w;
3023  b = HT_LINE | HT_DIR_VR;
3024  }
3025  } else {
3026  /* west */
3027  if (d == 0) {
3029  } else if (d >= 0) {
3030  x = _thd.selstart.x + h;
3031  b = HT_LINE | HT_DIR_HL;
3032  } else {
3033  y = _thd.selstart.y - w;
3034  b = HT_LINE | HT_DIR_HU;
3035  }
3036  }
3037  } else {
3038  if (y > _thd.selstart.y) {
3039  /* east */
3040  if (d == 0) {
3042  } else if (d >= 0) {
3043  x = _thd.selstart.x - h;
3044  b = HT_LINE | HT_DIR_HU;
3045  } else {
3046  y = _thd.selstart.y + w;
3047  b = HT_LINE | HT_DIR_HL;
3048  }
3049  } else {
3050  /* north */
3051  if (d == 0) {
3052  b = (x & TILE_UNIT_MASK) > (y & TILE_UNIT_MASK) ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
3053  } else if (d >= 0) {
3054  x = _thd.selstart.x - h;
3055  b = HT_LINE | HT_DIR_VR;
3056  } else {
3057  y = _thd.selstart.y - w;
3058  b = HT_LINE | HT_DIR_VL;
3059  }
3060  }
3061  }
3062  }
3063 
3065  TileIndex t0 = TileVirtXY(_thd.selstart.x, _thd.selstart.y);
3066  TileIndex t1 = TileVirtXY(x, y);
3067  uint distance = DistanceManhattan(t0, t1) + 1;
3068  byte index = 0;
3069  uint64 params[2];
3070 
3071  if (distance != 1) {
3072  int heightdiff = CalcHeightdiff(b, distance, t0, t1);
3073  /* If we are showing a tooltip for horizontal or vertical drags,
3074  * 2 tiles have a length of 1. To bias towards the ceiling we add
3075  * one before division. It feels more natural to count 3 lengths as 2 */
3076  if ((b & HT_DIR_MASK) != HT_DIR_X && (b & HT_DIR_MASK) != HT_DIR_Y) {
3077  distance = CeilDiv(distance, 2);
3078  }
3079 
3080  params[index++] = distance;
3081  if (heightdiff != 0) params[index++] = heightdiff;
3082  }
3083 
3084  ShowMeasurementTooltips(measure_strings_length[index], index, params);
3085  }
3086 
3087  _thd.selend.x = x;
3088  _thd.selend.y = y;
3089  _thd.next_drawstyle = b;
3090 }
3091 
3100 {
3101  int sx, sy;
3102  HighLightStyle style;
3103 
3104  if (x == -1) {
3105  _thd.selend.x = -1;
3106  return;
3107  }
3108 
3109  /* Special handling of drag in any (8-way) direction */
3110  if (method & (VPM_RAILDIRS | VPM_SIGNALDIRS)) {
3111  _thd.selend.x = x;
3112  _thd.selend.y = y;
3113  CalcRaildirsDrawstyle(x, y, method);
3114  return;
3115  }
3116 
3117  /* Needed so level-land is placed correctly */
3118  if ((_thd.next_drawstyle & HT_DRAG_MASK) == HT_POINT) {
3119  x += TILE_SIZE / 2;
3120  y += TILE_SIZE / 2;
3121  }
3122 
3123  sx = _thd.selstart.x;
3124  sy = _thd.selstart.y;
3125 
3126  int limit = 0;
3127 
3128  switch (method) {
3129  case VPM_X_OR_Y: // drag in X or Y direction
3130  if (abs(sy - y) < abs(sx - x)) {
3131  y = sy;
3132  style = HT_DIR_X;
3133  } else {
3134  x = sx;
3135  style = HT_DIR_Y;
3136  }
3137  goto calc_heightdiff_single_direction;
3138 
3139  case VPM_X_LIMITED: // Drag in X direction (limited size).
3140  limit = (_thd.sizelimit - 1) * TILE_SIZE;
3141  FALLTHROUGH;
3142 
3143  case VPM_FIX_X: // drag in Y direction
3144  x = sx;
3145  style = HT_DIR_Y;
3146  goto calc_heightdiff_single_direction;
3147 
3148  case VPM_Y_LIMITED: // Drag in Y direction (limited size).
3149  limit = (_thd.sizelimit - 1) * TILE_SIZE;
3150  FALLTHROUGH;
3151 
3152  case VPM_FIX_Y: // drag in X direction
3153  y = sy;
3154  style = HT_DIR_X;
3155 
3156 calc_heightdiff_single_direction:;
3157  if (limit > 0) {
3158  x = sx + Clamp(x - sx, -limit, limit);
3159  y = sy + Clamp(y - sy, -limit, limit);
3160  }
3162  TileIndex t0 = TileVirtXY(sx, sy);
3163  TileIndex t1 = TileVirtXY(x, y);
3164  uint distance = DistanceManhattan(t0, t1) + 1;
3165  byte index = 0;
3166  uint64 params[2];
3167 
3168  if (distance != 1) {
3169  /* With current code passing a HT_LINE style to calculate the height
3170  * difference is enough. However if/when a point-tool is created
3171  * with this method, function should be called with new_style (below)
3172  * instead of HT_LINE | style case HT_POINT is handled specially
3173  * new_style := (_thd.next_drawstyle & HT_RECT) ? HT_LINE | style : _thd.next_drawstyle; */
3174  int heightdiff = CalcHeightdiff(HT_LINE | style, 0, t0, t1);
3175 
3176  params[index++] = distance;
3177  if (heightdiff != 0) params[index++] = heightdiff;
3178  }
3179 
3180  ShowMeasurementTooltips(measure_strings_length[index], index, params);
3181  }
3182  break;
3183 
3184  case VPM_X_AND_Y_LIMITED: // Drag an X by Y constrained rect area.
3185  limit = (_thd.sizelimit - 1) * TILE_SIZE;
3186  x = sx + Clamp(x - sx, -limit, limit);
3187  y = sy + Clamp(y - sy, -limit, limit);
3188  FALLTHROUGH;
3189 
3190  case VPM_X_AND_Y: // drag an X by Y area
3192  static const StringID measure_strings_area[] = {
3193  STR_NULL, STR_NULL, STR_MEASURE_AREA, STR_MEASURE_AREA_HEIGHTDIFF
3194  };
3195 
3196  TileIndex t0 = TileVirtXY(sx, sy);
3197  TileIndex t1 = TileVirtXY(x, y);
3198  uint dx = Delta(TileX(t0), TileX(t1)) + 1;
3199  uint dy = Delta(TileY(t0), TileY(t1)) + 1;
3200  byte index = 0;
3201  uint64 params[3];
3202 
3203  /* If dragging an area (eg dynamite tool) and it is actually a single
3204  * row/column, change the type to 'line' to get proper calculation for height */
3205  style = (HighLightStyle)_thd.next_drawstyle;
3206  if (_thd.IsDraggingDiagonal()) {
3207  /* Determine the "area" of the diagonal dragged selection.
3208  * We assume the area is the number of tiles along the X
3209  * edge and the number of tiles along the Y edge. However,
3210  * multiplying these two numbers does not give the exact
3211  * number of tiles; basically we are counting the black
3212  * squares on a chess board and ignore the white ones to
3213  * make the tile counts at the edges match up. There is no
3214  * other way to make a proper count though.
3215  *
3216  * First convert to the rotated coordinate system. */
3217  int dist_x = TileX(t0) - TileX(t1);
3218  int dist_y = TileY(t0) - TileY(t1);
3219  int a_max = dist_x + dist_y;
3220  int b_max = dist_y - dist_x;
3221 
3222  /* Now determine the size along the edge, but due to the
3223  * chess board principle this counts double. */
3224  a_max = abs(a_max + (a_max > 0 ? 2 : -2)) / 2;
3225  b_max = abs(b_max + (b_max > 0 ? 2 : -2)) / 2;
3226 
3227  /* We get a 1x1 on normal 2x1 rectangles, due to it being
3228  * a seen as two sides. As the result for actual building
3229  * will be the same as non-diagonal dragging revert to that
3230  * behaviour to give it a more normally looking size. */
3231  if (a_max != 1 || b_max != 1) {
3232  dx = a_max;
3233  dy = b_max;
3234  }
3235  } else if (style & HT_RECT) {
3236  if (dx == 1) {
3237  style = HT_LINE | HT_DIR_Y;
3238  } else if (dy == 1) {
3239  style = HT_LINE | HT_DIR_X;
3240  }
3241  }
3242 
3243  if (dx != 1 || dy != 1) {
3244  int heightdiff = CalcHeightdiff(style, 0, t0, t1);
3245 
3246  params[index++] = dx - (style & HT_POINT ? 1 : 0);
3247  params[index++] = dy - (style & HT_POINT ? 1 : 0);
3248  if (heightdiff != 0) params[index++] = heightdiff;
3249  }
3250 
3251  ShowMeasurementTooltips(measure_strings_area[index], index, params);
3252  }
3253  break;
3254 
3255  default: NOT_REACHED();
3256  }
3257 
3258  _thd.selend.x = x;
3259  _thd.selend.y = y;
3260 }
3261 
3267 {
3269 
3270  /* stop drag mode if the window has been closed */
3271  Window *w = _thd.GetCallbackWnd();
3272  if (w == nullptr) {
3274  return ES_HANDLED;
3275  }
3276 
3277  /* while dragging execute the drag procedure of the corresponding window (mostly VpSelectTilesWithMethod() ) */
3278  if (_left_button_down) {
3279  w->OnPlaceDrag(_thd.select_method, _thd.select_proc, GetTileBelowCursor());
3280  return ES_HANDLED;
3281  }
3282 
3283  /* mouse button released..
3284  * keep the selected tool, but reset it to the original mode. */
3286  HighLightStyle others = _thd.place_mode & ~(HT_DRAG_MASK | HT_DIR_MASK);
3287  if ((_thd.next_drawstyle & HT_DRAG_MASK) == HT_RECT) {
3288  _thd.place_mode = HT_RECT | others;
3289  } else if (_thd.select_method & VPM_SIGNALDIRS) {
3290  _thd.place_mode = HT_RECT | others;
3291  } else if (_thd.select_method & VPM_RAILDIRS) {
3292  _thd.place_mode = (_thd.select_method & ~VPM_RAILDIRS) ? _thd.next_drawstyle : (HT_RAIL | others);
3293  } else {
3294  _thd.place_mode = HT_POINT | others;
3295  }
3296  SetTileSelectSize(1, 1);
3297 
3298  HideMeasurementTooltips();
3299  w->OnPlaceMouseUp(_thd.select_method, _thd.select_proc, _thd.selend, TileVirtXY(_thd.selstart.x, _thd.selstart.y), TileVirtXY(_thd.selend.x, _thd.selend.y));
3300 
3301  return ES_HANDLED;
3302 }
3303 
3312 {
3313  SetObjectToPlace(icon, pal, mode, w->window_class, w->window_number);
3314 }
3315 
3316 #include "table/animcursors.h"
3317 
3326 void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowClass window_class, WindowNumber window_num)
3327 {
3328  if (_thd.window_class != WC_INVALID) {
3329  /* Undo clicking on button and drag & drop */
3330  Window *w = _thd.GetCallbackWnd();
3331  /* Call the abort function, but set the window class to something
3332  * that will never be used to avoid infinite loops. Setting it to
3333  * the 'next' window class must not be done because recursion into
3334  * this function might in some cases reset the newly set object to
3335  * place or not properly reset the original selection. */
3336  _thd.window_class = WC_INVALID;
3337  if (w != nullptr) {
3338  w->OnPlaceObjectAbort();
3339  HideMeasurementTooltips();
3340  }
3341  }
3342 
3343  /* Mark the old selection dirty, in case the selection shape or colour changes */
3345 
3346  SetTileSelectSize(1, 1);
3347 
3348  _thd.make_square_red = false;
3349 
3350  if (mode == HT_DRAG) { // HT_DRAG is for dragdropping trains in the depot window
3351  mode = HT_NONE;
3353  } else {
3355  }
3356 
3357  _thd.place_mode = mode;
3358  _thd.window_class = window_class;
3359  _thd.window_number = window_num;
3360 
3361  if ((mode & HT_DRAG_MASK) == HT_SPECIAL) { // special tools, like tunnels or docks start with presizing mode
3362  VpStartPreSizing();
3363  }
3364 
3365  if ((icon & ANIMCURSOR_FLAG) != 0) {
3366  SetAnimatedMouseCursor(_animcursors[icon & ~ANIMCURSOR_FLAG]);
3367  } else {
3368  SetMouseCursor(icon, pal);
3369  }
3370 
3371 }
3372 
3375 {
3377 }
3378 
3379 Point GetViewportStationMiddle(const ViewPort *vp, const Station *st)
3380 {
3381  int x = TileX(st->xy) * TILE_SIZE;
3382  int y = TileY(st->xy) * TILE_SIZE;
3383  int z = GetSlopePixelZ(Clamp(x, 0, MapSizeX() * TILE_SIZE - 1), Clamp(y, 0, MapSizeY() * TILE_SIZE - 1));
3384 
3385  Point p = RemapCoords(x, y, z);
3386  p.x = UnScaleByZoom(p.x - vp->virtual_left, vp->zoom) + vp->left;
3387  p.y = UnScaleByZoom(p.y - vp->virtual_top, vp->zoom) + vp->top;
3388  return p;
3389 }
3390 
3395 };
3396 
3399 #ifdef WITH_SSE
3400  { &ViewportSortParentSpritesSSE41Checker, &ViewportSortParentSpritesSSE41 },
3401 #endif
3403 };
3404 
3407 {
3408  for (uint i = 0; i < lengthof(_vp_sprite_sorters); i++) {
3409  if (_vp_sprite_sorters[i].fct_checker()) {
3410  _vp_sprite_sorter = _vp_sprite_sorters[i].fct_sorter;
3411  break;
3412  }
3413  }
3414  assert(_vp_sprite_sorter != nullptr);
3415 }
3416 
3426 CommandCost CmdScrollViewport(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
3427 {
3428  if (_current_company != OWNER_DEITY) return CMD_ERROR;
3430  switch (target) {
3431  case VST_EVERYONE:
3432  break;
3433  case VST_COMPANY:
3434  if (_local_company != (CompanyID)p2) return CommandCost();
3435  break;
3436  case VST_CLIENT:
3437  if (_network_own_client_id != (ClientID)p2) return CommandCost();
3438  break;
3439  default:
3440  return CMD_ERROR;
3441  }
3442 
3443  if (flags & DC_EXEC) {
3445  ScrollMainWindowToTile(tile);
3446  }
3447  return CommandCost();
3448 }
3449 
3450 static void MarkCatchmentTilesDirty()
3451 {
3452  if (_viewport_highlight_town != nullptr) {
3454  return;
3455  }
3456  if (_viewport_highlight_station != nullptr) {
3459  _viewport_highlight_station = nullptr;
3460  } else {
3462  for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
3463  MarkTileDirtyByTile(tile);
3464  }
3465  }
3466  }
3467 }
3468 
3475 void SetViewportCatchmentStation(const Station *st, bool sel)
3476 {
3479  if (sel && _viewport_highlight_station != st) {
3480  MarkCatchmentTilesDirty();
3482  _viewport_highlight_town = nullptr;
3483  MarkCatchmentTilesDirty();
3484  } else if (!sel && _viewport_highlight_station == st) {
3485  MarkCatchmentTilesDirty();
3486  _viewport_highlight_station = nullptr;
3487  }
3489 }
3490 
3497 void SetViewportCatchmentTown(const Town *t, bool sel)
3498 {
3501  if (sel && _viewport_highlight_town != t) {
3502  _viewport_highlight_station = nullptr;
3505  } else if (!sel && _viewport_highlight_town == t) {
3506  _viewport_highlight_town = nullptr;
3508  }
3510 }
EventState
State of handling an event.
Definition: window_type.h:713
void ViewportAddVehicles(DrawPixelInfo *dpi)
Add the vehicle sprites that should be drawn at a part of the screen.
Definition: vehicle.cpp:1112
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
Definition: main_gui.cpp:138
Functions related to OTTD&#39;s strings.
static TileType GetTileType(TileIndex tile)
Get the tiletype of a given tile.
Definition: tile_map.h:98
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you&#39;ve selected it...
Definition: viewport_type.h:97
Y direction.
Owner
Enum for all companies/owners.
Definition: company_type.h:20
bool measure_tooltip
show a permanent tooltip when dragging tools
static bool IsHalftileSlope(Slope s)
Checks for non-continuous slope on halftile foundations.
Definition: slope_func.h:49
Iterator to iterate over all tiles belonging to a bitmaptilearea.
Definition: bitmap_type.h:109
static void DrawAutorailSelection(const TileInfo *ti, uint autorail_type)
Draws autorail highlights.
Definition: viewport.cpp:953
static const PaletteID PALETTE_SEL_TILE_RED
makes a square red. is used when removing rails or other stuff
Definition: sprites.h:1554
static void Swap(T &a, T &b)
Type safe swap operation.
Definition: math_func.hpp:277
byte type
Type of this airport,.
Definition: station_base.h:311
the north corner of the tile is raised
Definition: slope_type.h:55
Corner
Enumeration of tile corners.
Definition: slope_type.h:24
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:20
StationFacility facilities
The facilities that this station has.
static const uint TILE_PIXELS
Pixel distance between tile columns/rows in #ZOOM_LVL_BASE.
Definition: tile_type.h:17
WindowNumber window_number
The WindowNumber of the window that is responsible for the selection mode.
static uint MapSizeX()
Get the size of the map along the X.
Definition: map_func.h:74
static const int MAX_TILE_EXTENT_RIGHT
Maximum right extent of tile relative to north corner.
Definition: viewport.cpp:109
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:81
bool IsDraggingDiagonal()
Is the user dragging a &#39;diagonal rectangle&#39;?
Definition: viewport.cpp:2481
int32 zmin
minimal world Z coordinate of bounding box
Definition of stuff that is very close to a company, like the company struct itself.
int32 zmax
maximal world Z coordinate of bounding box
static const PaletteID PALETTE_TO_TRANSPARENT
This sets the sprite to transparent.
Definition: sprites.h:1586
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
Definition: window.cpp:1862
void ShowWaypointWindow(const Waypoint *wp)
Show the window for the given waypoint.
int virtual_left
Virtual left coordinate.
Definition: viewport_type.h:30
int32 top
minimal screen Y coordinate of sprite (= y + sprite->y_offs), reference point for child sprites ...
void InitializeWindowViewport(Window *w, int x, int y, int width, int height, uint32 follow_flags, ZoomLevel zoom)
Initialize viewport of the window for use.
Definition: viewport.cpp:222
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.
Definition: viewport.cpp:2741
Data about how and where to blit pixels.
Definition: gfx_type.h:156
static uint MapSizeY()
Get the size of the map along the Y.
Definition: map_func.h:84
Horizontally center the text.
Definition: gfx_func.h:97
Tile information, used while rendering the tile.
Definition: tile_cmd.h:44
Sprite combining will start with the next unclipped sprite.
Definition: viewport.cpp:153
SpriteCombineMode
Mode of "sprite combining".
Definition: viewport.cpp:151
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:394
Point pos
Location, in tile "units", of the northern tile of the selected area.
No special mouse mode.
Definition: window_gui.h:910
Point pos
logical mouse position
Definition: gfx_type.h:119
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3199
area of land of limited size
Definition: viewport_type.h:83
void(* VpSpriteSorter)(ParentSpriteToSortVector *psd)
Type for the actual viewport sprite sorter.
The mask to for the main sprite.
Definition: sprites.h:1539
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:1553
uint32 GetCompanyMask()
Get a bitmask of the currently shown companies.
Definition: linkgraph_gui.h:70
signs
Definition: transparency.h:25
byte _display_opt
What do we want to draw/do?
EconomySettings economy
settings to change the economy
int left
x position of left edge of the window
Definition: window_gui.h:319
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Definition: window.cpp:82
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
Zoom out (get helicopter view).
Definition: viewport_type.h:64
static int GetTilePixelZ(TileIndex tile)
Get bottom height of the tile.
Definition: tile_map.h:296
int height
Screen height of the viewport.
Definition: viewport_type.h:28
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
int32 y
screen Y coordinate of sprite
Definition: viewport.cpp:127
Declarations for accessing the k-d tree of towns.
Display waypoint names.
Definition: openttd.h:48
void HandleZoomMessage(Window *w, const ViewPort *vp, byte widget_zoom_in, byte widget_zoom_out)
Update the status of the zoom-buttons according to the zoom-level of the viewport.
Definition: viewport.cpp:478
static 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:84
vertical right
VpSorterChecker fct_checker
The check function.
Definition: viewport.cpp:3393
TileType
The different types of tiles.
Definition: tile_type.h:42
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:581
static int UnScaleByZoomLower(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL)
Definition: zoom_func.h:58
int next
next child to draw (-1 at the end)
Definition: viewport.cpp:136
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Dragging an object.
Definition: window_gui.h:911
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1114
The passed event is not handled.
Definition: window_type.h:715
X direction.
Display station names.
Definition: openttd.h:44
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:54
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
Definition: viewport.cpp:2444
static int UnScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL) When shifting right...
Definition: zoom_func.h:36
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:25
drag only in X axis
Definition: viewport_type.h:80
Data structure describing a sprite.
Definition: spritecache.h:18
Slope tileh
Slope of the tile.
Definition: tile_cmd.h:47
Sprite combining is active. AddSortableSpriteToDraw outputs child sprites.
Definition: viewport.cpp:154
Types for recording game performance data.
Drag only in X axis with limited size.
Definition: viewport_type.h:86
static const AnimCursor *const _animcursors[]
This is an array of pointers to all the animated cursor definitions we have above.
Definition: animcursors.h:87
similar to VMP_RAILDIRS, but with different cursor
Definition: viewport_type.h:89
void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition: misc_gui.cpp:766
Slope GetTilePixelSlopeOutsideMap(int x, int y, int *h)
Return the slope of a given tile, also for tiles outside the map (virtual "black" tiles)...
Definition: tile_map.cpp:84
static void CheckUnderflow(int &test, int &other, int mult)
Check for underflowing the map.
Definition: viewport.cpp:2855
Point size
Size, in tile "units", of the white/red selection area.
virtual void SetPixel(void *video, int x, int y, uint8 colour)=0
Draw a pixel with a given colour on the video-buffer.
End for iteration.
Definition: zoom_type.h:30
bool population_in_label
show the population of a town in his label?
drag only in Y axis
Definition: viewport_type.h:81
Drag only in Y axis with limited size.
Definition: viewport_type.h:87
Functions related to vehicles.
static const int MAX_TILE_EXTENT_LEFT
Maximum left extent of tile relative to north corner.
Definition: viewport.cpp:108
Zoomed 16 times out.
Definition: zoom_type.h:28
int virtual_height
height << zoom
Definition: viewport_type.h:33
Point new_size
New value for size; used to determine whether to redraw the selection.
static void AddTileSpriteToDraw(SpriteID image, PaletteID pal, int32 x, int32 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:499
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:207
Vehicle data structure.
Definition: vehicle_base.h:212
Point new_pos
New value for pos; used to determine whether to redraw the selection.
int top
y position of top edge of the window
Definition: window_gui.h:320
static bool IsExpected(const BaseStation *st)
Helper for checking whether the given station is of this type.
Display town names.
Definition: openttd.h:43
static int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL) When shifting right...
Definition: zoom_func.h:24
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
int foundation[FOUNDATION_PART_END]
Foundation sprites (index into parent_sprites_to_draw).
Definition: viewport.cpp:176
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
Definition: gfx_func.h:85
static bool IsSteepSlope(Slope s)
Checks if a slope is steep.
Definition: slope_func.h:38
bool show_zone
NOSAVE: mark town to show the local authority zone in the viewports.
Definition: town.h:104
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
Definition: openttd.h:49
Zoom in (get more detailed view).
Definition: viewport_type.h:63
Representation of a waypoint.
Definition: waypoint_base.h:18
void SetViewportCatchmentTown(const Town *t, bool sel)
Select or deselect town for coverage area highlight.
Definition: viewport.cpp:3497
Maximum number of sprites that can be loaded at a given time.
Definition: sprites.h:1538
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
void FindContained(CoordT x1, CoordT y1, CoordT x2, CoordT y2, Outputter outputter) const
Find all items contained within the given rectangle.
Definition: kdtree.hpp:462
Number of zoom levels.
Definition: zoom_type.h:32
All players.
SpriteCombineMode combine_sprites
Current mode of "sprite combining".
Definition: viewport.cpp:174
T FindNearest(CoordT x, CoordT y) const
Find the element closest to given coordinate, in Manhattan distance.
Definition: kdtree.hpp:444
Second part (halftile foundation)
Definition: viewport.cpp:143
static Corner GetHalftileSlopeCorner(Slope s)
Returns the leveled halftile of a halftile slope.
Definition: slope_func.h:150
byte dist_local_authority
distance for town local authority, default 20
WindowClass
Window classes.
Definition: window_type.h:39
ParentSpriteToSortVector parent_sprites_to_sort
Parent sprite pointer array used for sorting.
Definition: viewport.cpp:169
static int DivAwayFromZero(int a, uint b)
Computes (a / b) rounded away from zero.
Definition: math_func.hpp:355
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:778
Invalid window.
Definition: window_type.h:696
virtual void OnPlaceObjectAbort()
The user cancelled a tile highlight mode that has been set.
Definition: window_gui.h:768
Common return value for all commands.
Definition: command_type.h:25
How all blitters should look like.
Definition: base.hpp:30
ClientID
&#39;Unique&#39; identifier to be given to clients
Definition: network_type.h:41
static Slope SlopeWithOneCornerRaised(Corner corner)
Returns the slope with a specific corner raised.
Definition: slope_func.h:101
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:57
void StartSpriteCombine()
Starts a block of sprites, which are "combined" into a single bounding box.
Definition: viewport.cpp:759
Functions related to signs.
void UpdatePosition(int center, int top, StringID str, StringID str_small=STR_NULL)
Update the position of the viewport sign.
Definition: viewport.cpp:1444
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:26
vertical left
Presizing mode (docks, tunnels).
Definition: window_gui.h:913
Functions related to the vehicle&#39;s GUIs.
Left margin.
Definition: viewport_type.h:41
int z
Height.
Definition: tile_cmd.h:49
Window * GetCallbackWnd()
Get the window that started the current highlighting.
Definition: viewport.cpp:2490
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:15
FoundationPart foundation_part
Currently active foundation for ground sprite drawing.
Definition: viewport.cpp:177
void MarkDirty(ZoomLevel maxzoom=ZOOM_LVL_MAX) const
Mark the sign dirty in all viewports.
Definition: viewport.cpp:1471
int32 x
screen X coordinate of sprite
Definition: viewport.cpp:126
Highlight/sprite information for autorail.
CommandCost CmdScrollViewport(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Scroll players main viewport.
Definition: viewport.cpp:3426
HighLightStyle place_mode
Method which is used to place the selection.
Functions, definitions and such used only by the GUI.
TileIndex GetNorthernBridgeEnd(TileIndex t)
Finds the northern end of a bridge starting at a middle tile.
Definition: bridge_map.cpp:41
static Waypoint * From(BaseStation *st)
Converts a BaseStation to SpecializedStation with type checking.
ViewportScrollTarget
Target of the viewport scrolling GS method.
static 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.
Definition: math_func.hpp:250
Display signs.
Definition: openttd.h:45
Point foundation_offset[FOUNDATION_PART_END]
Pixel offset for ground sprites on the foundations.
Definition: viewport.cpp:179
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:177
Right margin.
Definition: viewport_type.h:42
Functions related to (drawing on) viewports.
void Draw(const DrawPixelInfo *dpi)
Draw the linkgraph overlay or some part of it, in the area given.
Declaration of linkgraph overlay GUI.
Data structure for an opened window.
Definition: window_gui.h:278
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:37
Data structure storing rendering information.
Definition: viewport.cpp:163
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
Definition: tile_map.h:163
void EndSpriteCombine()
Terminates a block of sprites started by StartSpriteCombine.
Definition: viewport.cpp:769
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
Definition: math_func.hpp:266
static bool IsBridgeAbove(TileIndex t)
checks if a bridge is set above the ground of this tile
Definition: bridge_map.h:47
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:419
dragging items in the depot windows
Begin for iteration.
Definition: zoom_type.h:23
ViewportSign sign
NOSAVE: Dimensions of sign.
static HighLightStyle GetAutorailHT(int x, int y)
returns the best autorail highlight type from map coordinates
Definition: viewport.cpp:2461
Point selstart
The location where the dragging started.
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold...
Definition: town_cmd.cpp:3499
Main window; Window numbers:
Definition: window_type.h:46
byte sizelimit
Whether the selection is limited in length, and what the maximum length is.
First part (normal foundation or no foundation)
Definition: viewport.cpp:142
Point selend
The location where the drag currently ends.
uint x
X position of the tile in unit coordinates.
Definition: tile_cmd.h:45
The tile has no ownership.
Definition: company_type.h:27
TileIndex xy
town center tile
Definition: town.h:56
Every AddSortableSpriteToDraw start its own bounding box.
Definition: viewport.cpp:152
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:152
int16 y_offs
Number of pixels to shift the sprite downwards.
Definition: spritecache.h:22
ViewportSign sign
Location of name sign, UpdateVirtCoord updates this.
Definition: town.h:48
TileIndex tile
Tile index.
Definition: tile_cmd.h:48
UnitID unitnumber
unit number, for display purposes only
Definition: vehicle_base.h:291
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:175
int32 ymin
minimal world Y coordinate of bounding box
int32 first_child
the first child to draw.
masks the drag-direction
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Definition: viewport.cpp:3374
static T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
Definition: math_func.hpp:97
const Town * _viewport_highlight_town
Currently selected town for coverage area highlight.
Definition: viewport.cpp:991
int32 top
The top of the sign.
Definition: viewport_type.h:50
void SetRedErrorSquare(TileIndex tile)
Set a tile to display a red error square.
Definition: viewport.cpp:2426
size_t Count() const
Get number of elements stored in tree.
Definition: kdtree.hpp:433
Tooltip window; Window numbers:
Definition: window_type.h:111
void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process)
highlighting tiles while only going over them with the mouse
Definition: viewport.cpp:2626
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...
Definition: viewport.cpp:3326
int32 x
screen X coordinate of sprite
void MarkAllViewportsDirty(int left, int top, int right, int bottom)
Mark all viewports that display an area as dirty (in need of repaint).
Definition: viewport.cpp:1907
Point offs
Offset, in tile "units", for the blue coverage area from the selected area&#39;s northern tile...
static TownID GetTownIndex(TileIndex t)
Get the index of which town this house/street is attached to.
Definition: town_map.h:24
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:18
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
Definition: viewport_type.h:78
end marker
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
Draw a sprite in a viewport.
Definition: gfx.cpp:805
DoCommandFlag
List of flags for a command.
Definition: command_type.h:344
bool _left_button_down
Is left mouse button pressed?
Definition: gfx.cpp:40
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:178
drag in X or Y direction
Definition: viewport_type.h:79
ClientID _network_own_client_id
Our client identifier.
Definition: network.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:80
static const CursorID ANIMCURSOR_FLAG
Flag for saying a cursor sprite is an animated cursor.
Definition: sprites.h:1486
static void ShowMeasurementTooltips(StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_cond=TCC_NONE)
Displays the measurement tooltips when selecting multiple tiles.
Definition: viewport.cpp:2614
static ViewportSSCSS _vp_sprite_sorters[]
List of sorters ordered from best to worst.
Definition: viewport.cpp:3398
static void ViewportDrawChk(const ViewPort *vp, int left, int top, int right, int bottom)
Make sure we don&#39;t draw a too big area at a time.
Definition: viewport.cpp:1731
Definition of base types and functions in a cross-platform compatible way.
Location information about a sign as seen on the viewport.
Definition: viewport_type.h:48
static void ViewportDrawBoundingBoxes(const ParentSpriteToSortVector *psd)
Draws the bounding boxes of all ParentSprites.
Definition: viewport.cpp:1583
static void ViewportSortParentSprites(ParentSpriteToSortVector *psdv)
Sort parent sprites pointer array.
Definition: viewport.cpp:1508
A number of safeguards to prevent using unsafe methods.
StationList stations_near
NOSAVE: List of nearby stations.
Definition: town.h:91
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:247
static void SetSelectionTilesDirty()
Marks the selected tiles as dirty.
Definition: viewport.cpp:1957
Base of waypoints.
static void CheckOverflow(int &test, int &other, int max, int mult)
Check for overflowing the map.
Definition: viewport.cpp:2870
rectangle (stations, depots, ...)
uint y
Y position of the tile in unit coordinates.
Definition: tile_cmd.h:46
int32 y
screen Y coordinate of sprite
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:316
ViewportPlaceMethod select_method
The method which governs how tiles are selected.
static void HighlightTownLocalAuthorityTiles(const TileInfo *ti)
Highlights tiles insede local authority of selected towns.
Definition: viewport.cpp:1046
void StartStopVehicle(const Vehicle *v, bool texteffect)
Executes CMD_START_STOP_VEHICLE for given vehicle.
Data structure for a window viewport.
Definition: window_gui.h:258
All zoomlevels below or equal to this, will result in details on the screen, like road-work...
Definition: zoom_type.h:45
static Slope GetTilePixelSlope(TileIndex tile, int *h)
Return the slope of a given tile.
Definition: tile_map.h:282
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in #ZOOM_LVL_BASE.
Definition: tile_type.h:18
int32 scrollpos_x
Currently shown x coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition: window_gui.h:260
Single player.
int32 xmin
minimal world X coordinate of bounding box
HighLightStyle drawstyle
Lower bits 0-3 are reserved for detailed highlight information.
uint16 width_normal
The width when not zoomed out (normal font)
Definition: viewport_type.h:51
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
Definition: viewport.cpp:3475
static void DrawTileSelectionRect(const TileInfo *ti, PaletteID pal)
Draws a selection rectangle on a tile.
Definition: viewport.cpp:893
Map accessor functions for bridges.
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:796
static Slope SlopeWithThreeCornersRaised(Corner corner)
Returns the slope with all except one corner raised.
Definition: slope_func.h:208
ZoomLevel zoom_max
maximum zoom out level
int virtual_width
width << zoom
Definition: viewport_type.h:32
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
Definition: viewport.cpp:1940
static const PaletteID PALETTE_SEL_TILE_BLUE
This draws a blueish square (catchment areas for example)
Definition: sprites.h:1555
Sizing mode.
Definition: window_gui.h:912
Station view; Window numbers:
Definition: window_type.h:340
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:499
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
static int CalcHeightdiff(HighLightStyle style, uint distance, TileIndex start_tile, TileIndex end_tile)
Calculates height difference between one tile and another.
Definition: viewport.cpp:2775
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:273
void SetDirtyBlocks(int left, int top, int right, int bottom)
This function extends the internal _invalid_rect rectangle as it now contains the rectangle defined b...
Definition: gfx.cpp:1416
bool smooth_scroll
smooth scroll viewports
Definition: settings_type.h:99
autorail (one piece), lower bits: direction
static int GetViewportY(Point tile)
Returns the y coordinate in the viewport coordinate system where the given tile is painted...
Definition: viewport.cpp:1161
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:147
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, INVALID_VEHICLE otherwise.
Definition: window_gui.h:259
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
static void ClampViewportToMap(const ViewPort *vp, int *scroll_x, int *scroll_y)
Ensure that a given viewport has a valid scroll position.
Definition: viewport.cpp:1798
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:621
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2406
Also allow &#39;diagonal rectangles&#39;. Only usable in combination with HT_RECT or HT_POINT.
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...
Definition: viewport.cpp:3311
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
Vehicle * First() const
Get the first vehicle of this vehicle chain.
Definition: vehicle_base.h:594
Point new_outersize
New value for outersize; used to determine whether to redraw the selection.
drag only in horizontal direction
Definition: viewport_type.h:84
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:278
ViewPort * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
Definition: viewport.cpp:395
int32 dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:263
const SubSprite * sub
only draw a rectangular part of the sprite
Definition: viewport.cpp:133
void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int w, int h, int dz, int z, bool transparent, int bb_offset_x, int bb_offset_y, int bb_offset_z, const SubSprite *sub)
Draw a (transparent) sprite at given coordinates with a given bounding box.
Definition: viewport.cpp:661
static Slope RemoveHalftileSlope(Slope s)
Removes a halftile slope from a slope.
Definition: slope_func.h:62
void ShowStationViewWindow(StationID station)
Opens StationViewWindow for given station.
bool make_square_red
Whether to give a tile a red selection.
uint16 height
Height of the sprite.
Definition: spritecache.h:19
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:139
static const int MAX_TILE_EXTENT_TOP
Maximum top extent of tile relative to north corner (not considering bridges).
Definition: viewport.cpp:110
The most basic (normal) sprite.
Definition: gfx_type.h:298
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:968
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:37
point (lower land, raise land, level land, ...)
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:698
static HighLightStyle Check2x1AutoRail(int mode)
returns information about the 2x1 piece to be build.
Definition: viewport.cpp:2697
int32 center
The center position of the sign.
Definition: viewport_type.h:49
static void 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...
Definition: viewport.cpp:1871
TileIndex tile
The base tile of the area.
Definition: tilearea_type.h:19
const SubSprite * sub
only draw a rectangular part of the sprite
ViewportDragDropSelectionProcess select_proc
The procedure that has to be called when the selection is done.
void SetMouseCursor(CursorID sprite, PaletteID pal)
Assign a single non-animated sprite to the cursor.
Definition: gfx.cpp:1615
Mask for the tile drag-type modes.
void UpdateTileSelection()
Updates tile highlighting for all cases.
Definition: viewport.cpp:2504
static uint ScaleByMapSize1D(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:138
A pair-construct of a TileIndexDiff.
Definition: map_type.h:59
int * last_foundation_child[FOUNDATION_PART_END]
Tail of ChildSprite list of the foundations. (index into child_screen_sprites_to_draw) ...
Definition: viewport.cpp:178
int left
Screen coordinate left edge of the viewport.
Definition: viewport_type.h:25
static const int TILE_HEIGHT_STEP
One Z unit tile height difference is displayed as 50m.
Definition: viewport_func.h:21
void DrawViewport() const
Draw the viewport of this window.
Definition: viewport.cpp:1773
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1146
static TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)
Return the offset between to tiles from a TileIndexDiffC struct.
Definition: map_func.h:232
execute the given command
Definition: command_type.h:346
Station with an airport.
Definition: station_type.h:57
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:784
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
Definition: gfx.cpp:1628
uint16 width
Width of the sprite.
Definition: spritecache.h:20
Functions related to companies.
default
static StationID GetStationIndex(TileIndex t)
Get StationID from a tile.
Definition: station_map.h:30
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:196
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
int32 dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:262
area of land in X and Y directions
Definition: viewport_type.h:82
static bool ViewportSortParentSpritesChecker()
This fallback sprite checker always exists.
Definition: viewport.cpp:1502
Bottom margin.
Definition: viewport_type.h:44
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:525
Parent sprite that should be drawn.
static 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:86
GUISettings gui
settings related to the GUI
SpriteID image
sprite to draw
Invisible tiles at the SW and SE border.
Definition: tile_type.h:50
Base class for all vehicles.
void Build(It begin, It end)
Clear and rebuild the tree from a new sequence of elements,.
Definition: kdtree.hpp:365
Data structure for viewport, display of a part of the world.
Definition: viewport_type.h:24
static void DrawTileSelection(const TileInfo *ti)
Checks if the specified tile is selected and if so draws selection using correct selectionstyle.
Definition: viewport.cpp:1080
static void ViewportAddLandscape()
Add the landscape to the viewport, i.e.
Definition: viewport.cpp:1170
Point InverseRemapCoords2(int x, int y, bool clamp_to_map, bool *clamped)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Definition: landscape.cpp:105
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:19
int GetTileMaxZ(TileIndex t)
Get top height of the tile inside the map.
Definition: tile_map.cpp:143
Time spent drawing world viewports in GUI.
Oilrig airport.
Definition: airport.h:40
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1589
Window * z_front
The window in front of us in z-order.
Definition: window_gui.h:340
static const byte _string_colourmap[17]
Colour mapping for TextColour.
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:159
bool diagonal
Whether the dragged area is a 45 degrees rotated rectangle.
static size_t GetNumItems()
Returns number of valid items in the pool.
Definition: pool_type.hpp:276
All players in specific company.
void HandleClickOnSign(const Sign *si)
Handle clicking on a sign.
Definition: signs_gui.cpp:559
Helper class for getting the best sprite sorter.
Definition: viewport.cpp:3392
static int GetBridgePixelHeight(TileIndex tile)
Get the height (&#39;z&#39;) of a bridge in pixels.
Definition: bridge_map.h:86
bool(* VpSorterChecker)()
Type for method for checking whether a viewport sprite sorter exists.
TileIndex redsq
The tile that has to get a red selection.
static const int MAX_TILE_EXTENT_BOTTOM
Maximum bottom extent of tile relative to north corner (worst case: SLOPE_STEEP_N).
Definition: viewport.cpp:111
int32 ymax
maximal world Y coordinate of bounding box
Top margin.
Definition: viewport_type.h:43
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:217
int32 xmax
maximal world X coordinate of bounding box
when a sprite is to be displayed transparently, this bit needs to be set.
Definition: sprites.h:1528
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:83
const Station * _viewport_highlight_station
Currently selected station for coverage area highlight.
Definition: viewport.cpp:990
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
Definition: viewport.cpp:3099
TileIndex xy
Base tile of the station.
void Reset()
Reset tile highlighting.
Definition: viewport.cpp:2469
static void DrawSelectionSprite(SpriteID image, PaletteID pal, const TileInfo *ti, int z_offset, FoundationPart foundation_part)
Draws sprites between ground sprite and everything above.
Definition: viewport.cpp:875
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Functions related to zooming.
static Point InverseRemapCoords(int x, int y)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Definition: landscape.h:114
Slope
Enumeration for the slope-type.
Definition: slope_type.h:50
Town view; Window numbers:
Definition: window_type.h:328
A tile of a station.
Definition: tile_type.h:48
Neither foundation nor groundsprite drawn yet.
Definition: viewport.cpp:141
const TileTypeProcs *const _tile_type_procs[16]
Tile callback functions for each type of tile.
Definition: landscape.cpp:62
BitmapTileArea catchment_tiles
NOSAVE: Set of individual tiles covered by catchment area.
Definition: station_base.h:472
TownCache cache
Container for all cacheable data.
Definition: town.h:58
static uint MapMaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition: map_func.h:113
RAII class for measuring multi-step elements of performance.
Town data structure.
Definition: town.h:55
void VpSetPresizeRange(TileIndex from, TileIndex to)
Highlights all tiles between a set of two tiles.
Definition: viewport.cpp:2669
int16 x_offs
Number of pixels to shift the sprite to the right.
Definition: spritecache.h:21
Used to only draw a part of the sprite.
Definition: gfx_type.h:219
Vehicle * CheckClickOnVehicle(const ViewPort *vp, int x, int y)
Find the vehicle close to the clicked coordinates.
Definition: vehicle.cpp:1170
byte max_bridge_height
maximum height of bridges
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...
static const uint TILE_UNIT_MASK
For masking in/out the inner-tile world coordinate units.
Definition: tile_type.h:16
static const uint MAX_BUILDING_PIXELS
Maximum height of a building in pixels in #ZOOM_LVL_BASE. (Also applies to "bridge buildings" on the ...
Definition: tile_type.h:20
Functions related to OTTD&#39;s landscape.
The normal zoom level.
Definition: zoom_type.h:24
int32 z_pos
z coordinate.
Definition: vehicle_base.h:270
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2417
void OffsetGroundSprite(int x, int y)
Called when a foundation has been drawn for the current tile.
Definition: viewport.cpp:589
Functions related to commands.
Network functions used by other parts of OpenTTD.
VpSpriteSorter fct_sorter
The sorting function.
Definition: viewport.cpp:3394
uint32 CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:21
Coordinates of a point in 2D.
used for autorail highlighting (longer stretches), lower bits: direction
a steep slope falling to south (from north)
Definition: slope_type.h:71
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
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:577
Owner owner
The owner of this station.
Colours _company_colours[MAX_COMPANIES]
NOSAVE: can be determined from company structs.
Definition: company_cmd.cpp:48
static uint TileHeight(TileIndex tile)
Returns the height of a tile.
Definition: tile_map.h:31
The colour translation of GRF&#39;s strings.
special mode used for highlighting while dragging (and for tunnels/docks)
static bool CheckClickOnViewportSign(const ViewPort *vp, int x, int y, const ViewportSign *sign)
Test whether a sign is below the mouse.
Definition: viewport.cpp:2082
uint16 SignID
The type of the IDs of signs.
Definition: signs_type.h:16
bool freeze
Freeze highlight in place.
EventState VpHandlePlaceSizingDrag()
Handle the mouse while dragging for placement/resizing.
Definition: viewport.cpp:3266
Index of the small font in the font tables.
Definition: gfx_type.h:205
static uint SlopeToSpriteOffset(Slope s)
Returns the Sprite offset for a given Slope.
Definition: slope_func.h:417
ConstructionSettings construction
construction of things in-game
Colour value is already a real palette colour index, not an index of a StringColour.
Definition: gfx_type.h:270
HighLightStyle
Highlighting draw styles.
Functions related to waypoints.
K-dimensional tree, specialised for 2-dimensional space.
Definition: kdtree.hpp:38
DrawTileProc * draw_tile_proc
Called to render the tile and its contents to the screen.
Definition: tile_cmd.h:148
void AddChildSpriteScreen(SpriteID image, PaletteID pal, int x, int y, bool transparent, const SubSprite *sub, bool scale)
Add a child sprite to a parent sprite.
Definition: viewport.cpp:817
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:131
Airport airport
Tile area the airport covers.
Definition: station_base.h:466
drag only in vertical direction
Definition: viewport_type.h:85
vehicle is accepted as target as well (bitmask)
ZoomLevel zoom
The zoom level of the viewport.
Definition: viewport_type.h:35
horizontal lower
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:321
Metadata about the current highlighting.
int32 x_pos
x coordinate.
Definition: vehicle_base.h:268
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
void InitializeSpriteSorter()
Choose the "best" sprite sorter and set _vp_sprite_sorter.
Definition: viewport.cpp:3406
Types related to sprite sorting.
PaletteID pal
palette to use
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:85
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
Base of the town class.
static 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:44
int virtual_top
Virtual top coordinate.
Definition: viewport_type.h:31
void ViewportAddString(const DrawPixelInfo *dpi, ZoomLevel small_from, const ViewportSign *sign, StringID string_normal, StringID string_small, StringID string_small_shadow, uint64 params_1, uint64 params_2, Colours colour)
Add a string to draw in the viewport.
Definition: viewport.cpp:1294
int32 left
minimal screen X coordinate of sprite (= x + sprite->x_offs), reference point for child sprites ...
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:707
horizontal upper
WindowClass window_class
Window class.
Definition: window_gui.h:313
Specification of a rectangle with absolute coordinates of all edges.
A house by a town.
Definition: tile_type.h:46
WindowClass window_class
The WindowClass of the window that is responsible for the selection mode.
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:756
The passed event is handled.
Definition: window_type.h:714
int32 y_pos
y coordinate.
Definition: vehicle_base.h:269
uint16 width_small
The width when zoomed out (small font)
Definition: viewport_type.h:52
static uint MapMaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition: map_func.h:104
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:314
void DrawGroundSpriteAt(SpriteID image, PaletteID pal, int32 x, int32 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:554
static bool IsInvisibilitySet(TransparencyOption to)
Check if the invisibility option bit is set and if we aren&#39;t in the game menu (there&#39;s never transpar...
Definition: transparency.h:61
FoundationPart
Enumeration of multi-part foundations.
Definition: viewport.cpp:140
static TileHighlightType GetTileHighlightType(TileIndex t)
Get tile highlight type of coverage area for a given tile.
Definition: viewport.cpp:998
Functions related to tile highlights.
HighLightStyle next_drawstyle
Queued, but not yet drawn style.
Window functions not directly related to making/drawing windows.
all rail directions
Definition: viewport_type.h:88
int top
Screen coordinate top edge of the viewport.
Definition: viewport_type.h:26
void SetDirty()
Mark the linkgraph dirty to be rebuilt next time Draw() is called.
Definition: linkgraph_gui.h:64
static void ViewportDrawDirtyBlocks()
Draw/colour the blocks that have been redrawn.
Definition: viewport.cpp:1601
Point outersize
Size, in tile "units", of the blue coverage area excluding the side of the selected area...
Makes the background transparent if set.
Definition: window_gui.h:29
#define TILE_ADD(x, y)
Adds to tiles together.
Definition: map_func.h:246
ZoomLevel zoom_min
minimum zoom out level
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:328
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1369
Base classes/functions for stations.
static Station * Get(size_t index)
Gets station with given index.
static T Delta(const T a, const T b)
Returns the (absolute) difference between two (scalar) variables.
Definition: math_func.hpp:232
bool comparison_done
Used during sprite sorting: true if sprite has been compared with all other sprites.
CargoTypes GetCargoMask()
Get a bitmask of the currently shown cargoes.
Definition: linkgraph_gui.h:67
static 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:100
int32 scrollpos_y
Currently shown y coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition: window_gui.h:261
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
The object is owned by a superuser / goal script.
Definition: company_type.h:29
static bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
Definition: vehicle_func.h:91
const SubSprite * sub
only draw a rectangular part of the sprite
Definition: viewport.cpp:125
bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2371
Base class for all station-ish types.
Station data structure.
Definition: station_base.h:452
static bool IsTransparencySet(TransparencyOption to)
Check if the transparency option bit is set and if we aren&#39;t in the game menu (there&#39;s never transpar...
Definition: transparency.h:50
Factory to &#39;query&#39; all available blitters.
byte dirty
Whether the build station window needs to redraw due to the changed selection.
static uint TilePixelHeight(TileIndex tile)
Returns the height of a tile in pixels.
Definition: tile_map.h:74
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition: map_func.h:165
static Corner OppositeCorner(Corner corner)
Returns the opposite corner.
Definition: slope_func.h:186
static void DrawTileHighlightType(const TileInfo *ti, TileHighlightType tht)
Draw tile highlight for coverage area highlight.
Definition: viewport.cpp:1031
This file defines all the the animated cursors.
#define FOR_ALL_WAYPOINTS(var)
Iterate over all waypoints.
Definition: waypoint_base.h:76
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:789
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:322
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1459
void UpdateViewportPosition(Window *w)
Update the viewport position being displayed.
Definition: viewport.cpp:1822
#define FOR_ALL_WINDOWS_FROM_BACK_FROM(w, start)
Iterate over all windows.
Definition: window_gui.h:894
static int GetTileMaxPixelZ(TileIndex tile)
Get top height of the tile.
Definition: tile_map.h:306
Base class for signs.
static void CalcRaildirsDrawstyle(int x, int y, int method)
while dragging
Definition: viewport.cpp:2879
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:201
int width
Screen width of the viewport.
Definition: viewport_type.h:27