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