OpenTTD
viewport.cpp
Go to the documentation of this file.
1 /* $Id: viewport.cpp 27893 2017-08-13 18:38:42Z frosch $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
65 #include "stdafx.h"
66 #include "landscape.h"
67 #include "viewport_func.h"
68 #include "station_base.h"
69 #include "waypoint_base.h"
70 #include "town.h"
71 #include "signs_base.h"
72 #include "signs_func.h"
73 #include "vehicle_base.h"
74 #include "vehicle_gui.h"
75 #include "blitter/factory.hpp"
76 #include "strings_func.h"
77 #include "zoom_func.h"
78 #include "vehicle_func.h"
79 #include "company_func.h"
80 #include "waypoint_func.h"
81 #include "window_func.h"
82 #include "tilehighlight_func.h"
83 #include "window_gui.h"
85 #include "viewport_sprite_sorter.h"
86 #include "bridge_map.h"
87 
88 #include <map>
89 
90 #include "table/strings.h"
91 #include "table/string_colours.h"
92 
93 #include "safeguards.h"
94 
95 Point _tile_fract_coords;
96 
97 
98 static const int MAX_TILE_EXTENT_LEFT = ZOOM_LVL_BASE * TILE_PIXELS;
99 static const int MAX_TILE_EXTENT_RIGHT = ZOOM_LVL_BASE * TILE_PIXELS;
100 static const int MAX_TILE_EXTENT_TOP = ZOOM_LVL_BASE * MAX_BUILDING_PIXELS;
101 static const int MAX_TILE_EXTENT_BOTTOM = ZOOM_LVL_BASE * (TILE_PIXELS + 2 * TILE_HEIGHT);
102 
104  StringID string;
105  Colours colour;
106  int32 x;
107  int32 y;
108  uint64 params[2];
109  uint16 width;
110 };
111 
113  SpriteID image;
114  PaletteID pal;
115  const SubSprite *sub;
116  int32 x;
117  int32 y;
118 };
119 
121  SpriteID image;
122  PaletteID pal;
123  const SubSprite *sub;
124  int32 x;
125  int32 y;
126  int next;
127 };
128 
134  FOUNDATION_PART_END
135 };
136 
145 };
146 
151 
154  DrawPixelInfo dpi;
155 
156  StringSpriteToDrawVector string_sprites_to_draw;
157  TileSpriteToDrawVector tile_sprites_to_draw;
158  ParentSpriteToDrawVector parent_sprites_to_draw;
160  ChildScreenSpriteToDrawVector child_screen_sprites_to_draw;
161 
162  int *last_child;
163 
165 
166  int foundation[FOUNDATION_PART_END];
168  int *last_foundation_child[FOUNDATION_PART_END];
169  Point foundation_offset[FOUNDATION_PART_END];
170 };
171 
172 static void MarkViewportDirty(const ViewPort *vp, int left, int top, int right, int bottom);
173 
174 static ViewportDrawer _vd;
175 
176 TileHighlightData _thd;
177 static TileInfo *_cur_ti;
178 bool _draw_bounding_boxes = false;
179 bool _draw_dirty_blocks = false;
180 uint _dirty_block_colour = 0;
181 static VpSpriteSorter _vp_sprite_sorter = NULL;
182 
183 static Point MapXYZToViewport(const ViewPort *vp, int x, int y, int z)
184 {
185  Point p = RemapCoords(x, y, z);
186  p.x -= vp->virtual_width / 2;
187  p.y -= vp->virtual_height / 2;
188  return p;
189 }
190 
191 void DeleteWindowViewport(Window *w)
192 {
193  if (w->viewport == NULL) return;
194 
195  delete w->viewport->overlay;
196  free(w->viewport);
197  w->viewport = NULL;
198 }
199 
212 void InitializeWindowViewport(Window *w, int x, int y,
213  int width, int height, uint32 follow_flags, ZoomLevel zoom)
214 {
215  assert(w->viewport == NULL);
216 
217  ViewportData *vp = CallocT<ViewportData>(1);
218 
219  vp->left = x + w->left;
220  vp->top = y + w->top;
221  vp->width = width;
222  vp->height = height;
223 
225 
226  vp->virtual_width = ScaleByZoom(width, zoom);
227  vp->virtual_height = ScaleByZoom(height, zoom);
228 
229  Point pt;
230 
231  if (follow_flags & 0x80000000) {
232  const Vehicle *veh;
233 
234  vp->follow_vehicle = (VehicleID)(follow_flags & 0xFFFFF);
235  veh = Vehicle::Get(vp->follow_vehicle);
236  pt = MapXYZToViewport(vp, veh->x_pos, veh->y_pos, veh->z_pos);
237  } else {
238  uint x = TileX(follow_flags) * TILE_SIZE;
239  uint y = TileY(follow_flags) * TILE_SIZE;
240 
242  pt = MapXYZToViewport(vp, x, y, GetSlopePixelZ(x, y));
243  }
244 
245  vp->scrollpos_x = pt.x;
246  vp->scrollpos_y = pt.y;
247  vp->dest_scrollpos_x = pt.x;
248  vp->dest_scrollpos_y = pt.y;
249 
250  vp->overlay = NULL;
251 
252  w->viewport = vp;
253  vp->virtual_left = 0; // pt.x;
254  vp->virtual_top = 0; // pt.y;
255 }
256 
257 static Point _vp_move_offs;
258 
259 static void DoSetViewportPosition(const Window *w, int left, int top, int width, int height)
260 {
262  if (left + width > w->left &&
263  w->left + w->width > left &&
264  top + height > w->top &&
265  w->top + w->height > top) {
266 
267  if (left < w->left) {
268  DoSetViewportPosition(w, left, top, w->left - left, height);
269  DoSetViewportPosition(w, left + (w->left - left), top, width - (w->left - left), height);
270  return;
271  }
272 
273  if (left + width > w->left + w->width) {
274  DoSetViewportPosition(w, left, top, (w->left + w->width - left), height);
275  DoSetViewportPosition(w, left + (w->left + w->width - left), top, width - (w->left + w->width - left), height);
276  return;
277  }
278 
279  if (top < w->top) {
280  DoSetViewportPosition(w, left, top, width, (w->top - top));
281  DoSetViewportPosition(w, left, top + (w->top - top), width, height - (w->top - top));
282  return;
283  }
284 
285  if (top + height > w->top + w->height) {
286  DoSetViewportPosition(w, left, top, width, (w->top + w->height - top));
287  DoSetViewportPosition(w, left, top + (w->top + w->height - top), width, height - (w->top + w->height - top));
288  return;
289  }
290 
291  return;
292  }
293  }
294 
295  {
296  int xo = _vp_move_offs.x;
297  int yo = _vp_move_offs.y;
298 
299  if (abs(xo) >= width || abs(yo) >= height) {
300  /* fully_outside */
301  RedrawScreenRect(left, top, left + width, top + height);
302  return;
303  }
304 
305  GfxScroll(left, top, width, height, xo, yo);
306 
307  if (xo > 0) {
308  RedrawScreenRect(left, top, xo + left, top + height);
309  left += xo;
310  width -= xo;
311  } else if (xo < 0) {
312  RedrawScreenRect(left + width + xo, top, left + width, top + height);
313  width += xo;
314  }
315 
316  if (yo > 0) {
317  RedrawScreenRect(left, top, width + left, top + yo);
318  } else if (yo < 0) {
319  RedrawScreenRect(left, top + height + yo, width + left, top + height);
320  }
321  }
322 }
323 
324 static void SetViewportPosition(Window *w, int x, int y)
325 {
326  ViewPort *vp = w->viewport;
327  int old_left = vp->virtual_left;
328  int old_top = vp->virtual_top;
329  int i;
330  int left, top, width, height;
331 
332  vp->virtual_left = x;
333  vp->virtual_top = y;
334 
335  /* Viewport is bound to its left top corner, so it must be rounded down (UnScaleByZoomLower)
336  * else glitch described in FS#1412 will happen (offset by 1 pixel with zoom level > NORMAL)
337  */
338  old_left = UnScaleByZoomLower(old_left, vp->zoom);
339  old_top = UnScaleByZoomLower(old_top, vp->zoom);
340  x = UnScaleByZoomLower(x, vp->zoom);
341  y = UnScaleByZoomLower(y, vp->zoom);
342 
343  old_left -= x;
344  old_top -= y;
345 
346  if (old_top == 0 && old_left == 0) return;
347 
348  _vp_move_offs.x = old_left;
349  _vp_move_offs.y = old_top;
350 
351  left = vp->left;
352  top = vp->top;
353  width = vp->width;
354  height = vp->height;
355 
356  if (left < 0) {
357  width += left;
358  left = 0;
359  }
360 
361  i = left + width - _screen.width;
362  if (i >= 0) width -= i;
363 
364  if (width > 0) {
365  if (top < 0) {
366  height += top;
367  top = 0;
368  }
369 
370  i = top + height - _screen.height;
371  if (i >= 0) height -= i;
372 
373  if (height > 0) DoSetViewportPosition(w->z_front, left, top, width, height);
374  }
375 }
376 
385 ViewPort *IsPtInWindowViewport(const Window *w, int x, int y)
386 {
387  ViewPort *vp = w->viewport;
388 
389  if (vp != NULL &&
390  IsInsideMM(x, vp->left, vp->left + vp->width) &&
391  IsInsideMM(y, vp->top, vp->top + vp->height))
392  return vp;
393 
394  return NULL;
395 }
396 
405 Point TranslateXYToTileCoord(const ViewPort *vp, int x, int y, bool clamp_to_map)
406 {
407  Point pt;
408  int a, b;
409  int z;
410 
411  if ( (uint)(x -= vp->left) >= (uint)vp->width ||
412  (uint)(y -= vp->top) >= (uint)vp->height) {
413  Point pt = {-1, -1};
414  return pt;
415  }
416 
417  x = (ScaleByZoom(x, vp->zoom) + vp->virtual_left) >> (2 + ZOOM_LVL_SHIFT);
418  y = (ScaleByZoom(y, vp->zoom) + vp->virtual_top) >> (1 + ZOOM_LVL_SHIFT);
419 
420  a = y - x;
421  b = y + x;
422 
423  if (clamp_to_map) {
424  /* Bring the coordinates near to a valid range. This is mostly due to the
425  * tiles on the north side of the map possibly being drawn too high due to
426  * the extra height levels. So at the top we allow a number of extra tiles.
427  * This number is based on the tile height and pixels. */
429  a = Clamp(a, -extra_tiles * TILE_SIZE, MapMaxX() * TILE_SIZE - 1);
430  b = Clamp(b, -extra_tiles * TILE_SIZE, MapMaxY() * TILE_SIZE - 1);
431  }
432 
433  /* (a, b) is the X/Y-world coordinate that belongs to (x,y) if the landscape would be completely flat on height 0.
434  * Now find the Z-world coordinate by fix point iteration.
435  * This is a bit tricky because the tile height is non-continuous at foundations.
436  * The clicked point should be approached from the back, otherwise there are regions that are not clickable.
437  * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)
438  * So give it a z-malus of 4 in the first iterations.
439  */
440  z = 0;
441 
442  int min_coord = _settings_game.construction.freeform_edges ? TILE_SIZE : 0;
443 
444  for (int i = 0; i < 5; i++) z = GetSlopePixelZ(Clamp(a + max(z, 4) - 4, min_coord, MapMaxX() * TILE_SIZE - 1), Clamp(b + max(z, 4) - 4, min_coord, MapMaxY() * TILE_SIZE - 1)) / 2;
445  for (int malus = 3; malus > 0; malus--) z = GetSlopePixelZ(Clamp(a + max(z, malus) - malus, min_coord, MapMaxX() * TILE_SIZE - 1), Clamp(b + max(z, malus) - malus, min_coord, MapMaxY() * TILE_SIZE - 1)) / 2;
446  for (int i = 0; i < 5; i++) z = GetSlopePixelZ(Clamp(a + z, min_coord, MapMaxX() * TILE_SIZE - 1), Clamp(b + z, min_coord, MapMaxY() * TILE_SIZE - 1)) / 2;
447 
448  if (clamp_to_map) {
449  pt.x = Clamp(a + z, min_coord, MapMaxX() * TILE_SIZE - 1);
450  pt.y = Clamp(b + z, min_coord, MapMaxY() * TILE_SIZE - 1);
451  } else {
452  pt.x = a + z;
453  pt.y = b + z;
454  }
455 
456  return pt;
457 }
458 
459 /* When used for zooming, check area below current coordinates (x,y)
460  * and return the tile of the zoomed out/in position (zoom_x, zoom_y)
461  * when you just want the tile, make x = zoom_x and y = zoom_y */
462 static Point GetTileFromScreenXY(int x, int y, int zoom_x, int zoom_y)
463 {
464  Window *w;
465  ViewPort *vp;
466  Point pt;
467 
468  if ( (w = FindWindowFromPt(x, y)) != NULL &&
469  (vp = IsPtInWindowViewport(w, x, y)) != NULL)
470  return TranslateXYToTileCoord(vp, zoom_x, zoom_y);
471 
472  pt.y = pt.x = -1;
473  return pt;
474 }
475 
476 Point GetTileBelowCursor()
477 {
478  return GetTileFromScreenXY(_cursor.pos.x, _cursor.pos.y, _cursor.pos.x, _cursor.pos.y);
479 }
480 
481 
482 Point GetTileZoomCenterWindow(bool in, Window * w)
483 {
484  int x, y;
485  ViewPort *vp = w->viewport;
486 
487  if (in) {
488  x = ((_cursor.pos.x - vp->left) >> 1) + (vp->width >> 2);
489  y = ((_cursor.pos.y - vp->top) >> 1) + (vp->height >> 2);
490  } else {
491  x = vp->width - (_cursor.pos.x - vp->left);
492  y = vp->height - (_cursor.pos.y - vp->top);
493  }
494  /* Get the tile below the cursor and center on the zoomed-out center */
495  return GetTileFromScreenXY(_cursor.pos.x, _cursor.pos.y, x + vp->left, y + vp->top);
496 }
497 
506 void HandleZoomMessage(Window *w, const ViewPort *vp, byte widget_zoom_in, byte widget_zoom_out)
507 {
508  w->SetWidgetDisabledState(widget_zoom_in, vp->zoom <= _settings_client.gui.zoom_min);
509  w->SetWidgetDirty(widget_zoom_in);
510 
511  w->SetWidgetDisabledState(widget_zoom_out, vp->zoom >= _settings_client.gui.zoom_max);
512  w->SetWidgetDirty(widget_zoom_out);
513 }
514 
527 static void AddTileSpriteToDraw(SpriteID image, PaletteID pal, int32 x, int32 y, int z, const SubSprite *sub = NULL, int extra_offs_x = 0, int extra_offs_y = 0)
528 {
529  assert((image & SPRITE_MASK) < MAX_SPRITES);
530 
531  TileSpriteToDraw *ts = _vd.tile_sprites_to_draw.Append();
532  ts->image = image;
533  ts->pal = pal;
534  ts->sub = sub;
535  Point pt = RemapCoords(x, y, z);
536  ts->x = pt.x + extra_offs_x;
537  ts->y = pt.y + extra_offs_y;
538 }
539 
552 static void AddChildSpriteToFoundation(SpriteID image, PaletteID pal, const SubSprite *sub, FoundationPart foundation_part, int extra_offs_x, int extra_offs_y)
553 {
554  assert(IsInsideMM(foundation_part, 0, FOUNDATION_PART_END));
555  assert(_vd.foundation[foundation_part] != -1);
556  Point offs = _vd.foundation_offset[foundation_part];
557 
558  /* Change the active ChildSprite list to the one of the foundation */
559  int *old_child = _vd.last_child;
560  _vd.last_child = _vd.last_foundation_child[foundation_part];
561 
562  AddChildSpriteScreen(image, pal, offs.x + extra_offs_x, offs.y + extra_offs_y, false, sub, false);
563 
564  /* Switch back to last ChildSprite list */
565  _vd.last_child = old_child;
566 }
567 
581 void DrawGroundSpriteAt(SpriteID image, PaletteID pal, int32 x, int32 y, int z, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
582 {
583  /* Switch to first foundation part, if no foundation was drawn */
585 
586  if (_vd.foundation[_vd.foundation_part] != -1) {
587  Point pt = RemapCoords(x, y, z);
588  AddChildSpriteToFoundation(image, pal, sub, _vd.foundation_part, pt.x + extra_offs_x * ZOOM_LVL_BASE, pt.y + extra_offs_y * ZOOM_LVL_BASE);
589  } else {
590  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);
591  }
592 }
593 
604 void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
605 {
606  DrawGroundSpriteAt(image, pal, 0, 0, 0, sub, extra_offs_x, extra_offs_y);
607 }
608 
616 void OffsetGroundSprite(int x, int y)
617 {
618  /* Switch to next foundation part */
619  switch (_vd.foundation_part) {
622  break;
625  break;
626  default: NOT_REACHED();
627  }
628 
629  /* _vd.last_child == NULL if foundation sprite was clipped by the viewport bounds */
630  if (_vd.last_child != NULL) _vd.foundation[_vd.foundation_part] = _vd.parent_sprites_to_draw.Length() - 1;
631 
632  _vd.foundation_offset[_vd.foundation_part].x = x * ZOOM_LVL_BASE;
633  _vd.foundation_offset[_vd.foundation_part].y = y * ZOOM_LVL_BASE;
634  _vd.last_foundation_child[_vd.foundation_part] = _vd.last_child;
635 }
636 
648 static void AddCombinedSprite(SpriteID image, PaletteID pal, int x, int y, int z, const SubSprite *sub)
649 {
650  Point pt = RemapCoords(x, y, z);
651  const Sprite *spr = GetSprite(image & SPRITE_MASK, ST_NORMAL);
652 
653  if (pt.x + spr->x_offs >= _vd.dpi.left + _vd.dpi.width ||
654  pt.x + spr->x_offs + spr->width <= _vd.dpi.left ||
655  pt.y + spr->y_offs >= _vd.dpi.top + _vd.dpi.height ||
656  pt.y + spr->y_offs + spr->height <= _vd.dpi.top)
657  return;
658 
659  const ParentSpriteToDraw *pstd = _vd.parent_sprites_to_draw.End() - 1;
660  AddChildSpriteScreen(image, pal, pt.x - pstd->left, pt.y - pstd->top, false, sub, false);
661 }
662 
688 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)
689 {
690  int32 left, right, top, bottom;
691 
692  assert((image & SPRITE_MASK) < MAX_SPRITES);
693 
694  /* make the sprites transparent with the right palette */
695  if (transparent) {
698  }
699 
701  AddCombinedSprite(image, pal, x, y, z, sub);
702  return;
703  }
704 
705  _vd.last_child = NULL;
706 
707  Point pt = RemapCoords(x, y, z);
708  int tmp_left, tmp_top, tmp_x = pt.x, tmp_y = pt.y;
709 
710  /* Compute screen extents of sprite */
711  if (image == SPR_EMPTY_BOUNDING_BOX) {
712  left = tmp_left = RemapCoords(x + w , y + bb_offset_y, z + bb_offset_z).x;
713  right = RemapCoords(x + bb_offset_x, y + h , z + bb_offset_z).x + 1;
714  top = tmp_top = RemapCoords(x + bb_offset_x, y + bb_offset_y, z + dz ).y;
715  bottom = RemapCoords(x + w , y + h , z + bb_offset_z).y + 1;
716  } else {
717  const Sprite *spr = GetSprite(image & SPRITE_MASK, ST_NORMAL);
718  left = tmp_left = (pt.x += spr->x_offs);
719  right = (pt.x + spr->width );
720  top = tmp_top = (pt.y += spr->y_offs);
721  bottom = (pt.y + spr->height);
722  }
723 
724  if (_draw_bounding_boxes && (image != SPR_EMPTY_BOUNDING_BOX)) {
725  /* Compute maximal extents of sprite and its bounding box */
726  left = min(left , RemapCoords(x + w , y + bb_offset_y, z + bb_offset_z).x);
727  right = max(right , RemapCoords(x + bb_offset_x, y + h , z + bb_offset_z).x + 1);
728  top = min(top , RemapCoords(x + bb_offset_x, y + bb_offset_y, z + dz ).y);
729  bottom = max(bottom, RemapCoords(x + w , y + h , z + bb_offset_z).y + 1);
730  }
731 
732  /* Do not add the sprite to the viewport, if it is outside */
733  if (left >= _vd.dpi.left + _vd.dpi.width ||
734  right <= _vd.dpi.left ||
735  top >= _vd.dpi.top + _vd.dpi.height ||
736  bottom <= _vd.dpi.top) {
737  return;
738  }
739 
740  ParentSpriteToDraw *ps = _vd.parent_sprites_to_draw.Append();
741  ps->x = tmp_x;
742  ps->y = tmp_y;
743 
744  ps->left = tmp_left;
745  ps->top = tmp_top;
746 
747  ps->image = image;
748  ps->pal = pal;
749  ps->sub = sub;
750  ps->xmin = x + bb_offset_x;
751  ps->xmax = x + max(bb_offset_x, w) - 1;
752 
753  ps->ymin = y + bb_offset_y;
754  ps->ymax = y + max(bb_offset_y, h) - 1;
755 
756  ps->zmin = z + bb_offset_z;
757  ps->zmax = z + max(bb_offset_z, dz) - 1;
758 
759  ps->comparison_done = false;
760  ps->first_child = -1;
761 
762  _vd.last_child = &ps->first_child;
763 
765 }
766 
786 {
787  assert(_vd.combine_sprites == SPRITE_COMBINE_NONE);
789 }
790 
796 {
797  assert(_vd.combine_sprites != SPRITE_COMBINE_NONE);
799 }
800 
810 static bool IsInRangeInclusive(int begin, int end, int check)
811 {
812  if (begin > end) Swap(begin, end);
813  return begin <= check && check <= end;
814 }
815 
822 bool IsInsideRotatedRectangle(int x, int y)
823 {
824  int dist_a = (_thd.size.x + _thd.size.y); // Rotated coordinate system for selected rectangle.
825  int dist_b = (_thd.size.x - _thd.size.y); // We don't have to divide by 2. It's all relative!
826  int a = ((x - _thd.pos.x) + (y - _thd.pos.y)); // Rotated coordinate system for the point under scrutiny.
827  int b = ((x - _thd.pos.x) - (y - _thd.pos.y));
828 
829  /* Check if a and b are between 0 and dist_a or dist_b respectively. */
830  return IsInRangeInclusive(dist_a, 0, a) && IsInRangeInclusive(dist_b, 0, b);
831 }
832 
843 void AddChildSpriteScreen(SpriteID image, PaletteID pal, int x, int y, bool transparent, const SubSprite *sub, bool scale)
844 {
845  assert((image & SPRITE_MASK) < MAX_SPRITES);
846 
847  /* If the ParentSprite was clipped by the viewport bounds, do not draw the ChildSprites either */
848  if (_vd.last_child == NULL) return;
849 
850  /* make the sprites transparent with the right palette */
851  if (transparent) {
854  }
855 
856  *_vd.last_child = _vd.child_screen_sprites_to_draw.Length();
857 
858  ChildScreenSpriteToDraw *cs = _vd.child_screen_sprites_to_draw.Append();
859  cs->image = image;
860  cs->pal = pal;
861  cs->sub = sub;
862  cs->x = scale ? x * ZOOM_LVL_BASE : x;
863  cs->y = scale ? y * ZOOM_LVL_BASE : y;
864  cs->next = -1;
865 
866  /* Append the sprite to the active ChildSprite list.
867  * If the active ParentSprite is a foundation, update last_foundation_child as well.
868  * Note: ChildSprites of foundations are NOT sequential in the vector, as selection sprites are added at last. */
869  if (_vd.last_foundation_child[0] == _vd.last_child) _vd.last_foundation_child[0] = &cs->next;
870  if (_vd.last_foundation_child[1] == _vd.last_child) _vd.last_foundation_child[1] = &cs->next;
871  _vd.last_child = &cs->next;
872 }
873 
874 static void AddStringToDraw(int x, int y, StringID string, uint64 params_1, uint64 params_2, Colours colour, uint16 width)
875 {
876  assert(width != 0);
877  StringSpriteToDraw *ss = _vd.string_sprites_to_draw.Append();
878  ss->string = string;
879  ss->x = x;
880  ss->y = y;
881  ss->params[0] = params_1;
882  ss->params[1] = params_2;
883  ss->width = width;
884  ss->colour = colour;
885 }
886 
887 
899 static void DrawSelectionSprite(SpriteID image, PaletteID pal, const TileInfo *ti, int z_offset, FoundationPart foundation_part)
900 {
901  /* FIXME: This is not totally valid for some autorail highlights that extend over the edges of the tile. */
902  if (_vd.foundation[foundation_part] == -1) {
903  /* draw on real ground */
904  AddTileSpriteToDraw(image, pal, ti->x, ti->y, ti->z + z_offset);
905  } else {
906  /* draw on top of foundation */
907  AddChildSpriteToFoundation(image, pal, NULL, foundation_part, 0, -z_offset * ZOOM_LVL_BASE);
908  }
909 }
910 
917 static void DrawTileSelectionRect(const TileInfo *ti, PaletteID pal)
918 {
919  if (!IsValidTile(ti->tile)) return;
920 
921  SpriteID sel;
922  if (IsHalftileSlope(ti->tileh)) {
923  Corner halftile_corner = GetHalftileSlopeCorner(ti->tileh);
924  SpriteID sel2 = SPR_HALFTILE_SELECTION_FLAT + halftile_corner;
926 
927  Corner opposite_corner = OppositeCorner(halftile_corner);
928  if (IsSteepSlope(ti->tileh)) {
929  sel = SPR_HALFTILE_SELECTION_DOWN;
930  } else {
931  sel = ((ti->tileh & SlopeWithOneCornerRaised(opposite_corner)) != 0 ? SPR_HALFTILE_SELECTION_UP : SPR_HALFTILE_SELECTION_FLAT);
932  }
933  sel += opposite_corner;
934  } else {
935  sel = SPR_SELECT_TILE + SlopeToSpriteOffset(ti->tileh);
936  }
938 }
939 
940 static bool IsPartOfAutoLine(int px, int py)
941 {
942  px -= _thd.selstart.x;
943  py -= _thd.selstart.y;
944 
945  if ((_thd.drawstyle & HT_DRAG_MASK) != HT_LINE) return false;
946 
947  switch (_thd.drawstyle & HT_DIR_MASK) {
948  case HT_DIR_X: return py == 0; // x direction
949  case HT_DIR_Y: return px == 0; // y direction
950  case HT_DIR_HU: return px == -py || px == -py - 16; // horizontal upper
951  case HT_DIR_HL: return px == -py || px == -py + 16; // horizontal lower
952  case HT_DIR_VL: return px == py || px == py + 16; // vertical left
953  case HT_DIR_VR: return px == py || px == py - 16; // vertical right
954  default:
955  NOT_REACHED();
956  }
957 }
958 
959 /* [direction][side] */
960 static const HighLightStyle _autorail_type[6][2] = {
961  { HT_DIR_X, HT_DIR_X },
962  { HT_DIR_Y, HT_DIR_Y },
963  { HT_DIR_HU, HT_DIR_HL },
964  { HT_DIR_HL, HT_DIR_HU },
965  { HT_DIR_VL, HT_DIR_VR },
966  { HT_DIR_VR, HT_DIR_VL }
967 };
968 
969 #include "table/autorail.h"
970 
977 static void DrawAutorailSelection(const TileInfo *ti, uint autorail_type)
978 {
979  SpriteID image;
980  PaletteID pal;
981  int offset;
982 
983  FoundationPart foundation_part = FOUNDATION_PART_NORMAL;
984  Slope autorail_tileh = RemoveHalftileSlope(ti->tileh);
985  if (IsHalftileSlope(ti->tileh)) {
986  static const uint _lower_rail[4] = { 5U, 2U, 4U, 3U };
987  Corner halftile_corner = GetHalftileSlopeCorner(ti->tileh);
988  if (autorail_type != _lower_rail[halftile_corner]) {
989  foundation_part = FOUNDATION_PART_HALFTILE;
990  /* Here we draw the highlights of the "three-corners-raised"-slope. That looks ok to me. */
991  autorail_tileh = SlopeWithThreeCornersRaised(OppositeCorner(halftile_corner));
992  }
993  }
994 
995  offset = _AutorailTilehSprite[autorail_tileh][autorail_type];
996  if (offset >= 0) {
997  image = SPR_AUTORAIL_BASE + offset;
998  pal = PAL_NONE;
999  } else {
1000  image = SPR_AUTORAIL_BASE - offset;
1001  pal = PALETTE_SEL_TILE_RED;
1002  }
1003 
1004  DrawSelectionSprite(image, _thd.make_square_red ? PALETTE_SEL_TILE_RED : pal, ti, 7, foundation_part);
1005 }
1006 
1011 static void DrawTileSelection(const TileInfo *ti)
1012 {
1013  /* Draw a red error square? */
1014  bool is_redsq = _thd.redsq == ti->tile;
1016 
1017  /* No tile selection active? */
1018  if ((_thd.drawstyle & HT_DRAG_MASK) == HT_NONE) return;
1019 
1020  if (_thd.diagonal) { // We're drawing a 45 degrees rotated (diagonal) rectangle
1021  if (IsInsideRotatedRectangle((int)ti->x, (int)ti->y)) goto draw_inner;
1022  return;
1023  }
1024 
1025  /* Inside the inner area? */
1026  if (IsInsideBS(ti->x, _thd.pos.x, _thd.size.x) &&
1027  IsInsideBS(ti->y, _thd.pos.y, _thd.size.y)) {
1028 draw_inner:
1029  if (_thd.drawstyle & HT_RECT) {
1030  if (!is_redsq) DrawTileSelectionRect(ti, _thd.make_square_red ? PALETTE_SEL_TILE_RED : PAL_NONE);
1031  } else if (_thd.drawstyle & HT_POINT) {
1032  /* Figure out the Z coordinate for the single dot. */
1033  int z = 0;
1034  FoundationPart foundation_part = FOUNDATION_PART_NORMAL;
1035  if (ti->tileh & SLOPE_N) {
1036  z += TILE_HEIGHT;
1038  }
1039  if (IsHalftileSlope(ti->tileh)) {
1040  Corner halftile_corner = GetHalftileSlopeCorner(ti->tileh);
1041  if ((halftile_corner == CORNER_W) || (halftile_corner == CORNER_E)) z += TILE_HEIGHT;
1042  if (halftile_corner != CORNER_S) {
1043  foundation_part = FOUNDATION_PART_HALFTILE;
1044  if (IsSteepSlope(ti->tileh)) z -= TILE_HEIGHT;
1045  }
1046  }
1047  DrawSelectionSprite(_cur_dpi->zoom <= ZOOM_LVL_DETAIL ? SPR_DOT : SPR_DOT_SMALL, PAL_NONE, ti, z, foundation_part);
1048  } else if (_thd.drawstyle & HT_RAIL) {
1049  /* autorail highlight piece under cursor */
1050  HighLightStyle type = _thd.drawstyle & HT_DIR_MASK;
1051  assert(type < HT_DIR_END);
1052  DrawAutorailSelection(ti, _autorail_type[type][0]);
1053  } else if (IsPartOfAutoLine(ti->x, ti->y)) {
1054  /* autorail highlighting long line */
1055  HighLightStyle dir = _thd.drawstyle & HT_DIR_MASK;
1056  uint side;
1057 
1058  if (dir == HT_DIR_X || dir == HT_DIR_Y) {
1059  side = 0;
1060  } else {
1061  TileIndex start = TileVirtXY(_thd.selstart.x, _thd.selstart.y);
1062  side = Delta(Delta(TileX(start), TileX(ti->tile)), Delta(TileY(start), TileY(ti->tile)));
1063  }
1064 
1065  DrawAutorailSelection(ti, _autorail_type[dir][side]);
1066  }
1067  return;
1068  }
1069 
1070  /* Check if it's inside the outer area? */
1071  if (!is_redsq && _thd.outersize.x > 0 &&
1072  IsInsideBS(ti->x, _thd.pos.x + _thd.offs.x, _thd.size.x + _thd.outersize.x) &&
1073  IsInsideBS(ti->y, _thd.pos.y + _thd.offs.y, _thd.size.y + _thd.outersize.y)) {
1074  /* Draw a blue rect. */
1076  return;
1077  }
1078 }
1079 
1086 static int GetViewportY(Point tile)
1087 {
1088  /* Each increment in X or Y direction moves down by half a tile, i.e. TILE_PIXELS / 2. */
1089  return (tile.y * (int)(TILE_PIXELS / 2) + tile.x * (int)(TILE_PIXELS / 2) - TilePixelHeightOutsideMap(tile.x, tile.y)) << ZOOM_LVL_SHIFT;
1090 }
1091 
1096 {
1097  assert(_vd.dpi.top <= _vd.dpi.top + _vd.dpi.height);
1098  assert(_vd.dpi.left <= _vd.dpi.left + _vd.dpi.width);
1099 
1100  Point upper_left = InverseRemapCoords(_vd.dpi.left, _vd.dpi.top);
1101  Point upper_right = InverseRemapCoords(_vd.dpi.left + _vd.dpi.width, _vd.dpi.top);
1102 
1103  /* Transformations between tile coordinates and viewport rows/columns: See vp_column_row
1104  * column = y - x
1105  * row = x + y
1106  * x = (row - column) / 2
1107  * y = (row + column) / 2
1108  * Note: (row, columns) pairs are only valid, if they are both even or both odd.
1109  */
1110 
1111  /* Columns overlap with neighbouring columns by a half tile.
1112  * - Left column is column of upper_left (rounded down) and one column to the left.
1113  * - Right column is column of upper_right (rounded up) and one column to the right.
1114  * Note: Integer-division does not round down for negative numbers, so ensure rounding with another increment/decrement.
1115  */
1116  int left_column = (upper_left.y - upper_left.x) / (int)TILE_SIZE - 2;
1117  int right_column = (upper_right.y - upper_right.x) / (int)TILE_SIZE + 2;
1118 
1119  int potential_bridge_height = ZOOM_LVL_BASE * TILE_HEIGHT * _settings_game.construction.max_bridge_height;
1120 
1121  /* Rows overlap with neighbouring rows by a half tile.
1122  * The first row that could possibly be visible is the row above upper_left (if it is at height 0).
1123  * Due to integer-division not rounding down for negative numbers, we need another decrement.
1124  */
1125  int row = (upper_left.x + upper_left.y) / (int)TILE_SIZE - 2;
1126  bool last_row = false;
1127  for (; !last_row; row++) {
1128  last_row = true;
1129  for (int column = left_column; column <= right_column; column++) {
1130  /* Valid row/column? */
1131  if ((row + column) % 2 != 0) continue;
1132 
1133  Point tilecoord;
1134  tilecoord.x = (row - column) / 2;
1135  tilecoord.y = (row + column) / 2;
1136  assert(column == tilecoord.y - tilecoord.x);
1137  assert(row == tilecoord.y + tilecoord.x);
1138 
1139  TileType tile_type;
1140  TileInfo tile_info;
1141  _cur_ti = &tile_info;
1142  tile_info.x = tilecoord.x * TILE_SIZE; // FIXME tile_info should use signed integers
1143  tile_info.y = tilecoord.y * TILE_SIZE;
1144 
1145  if (IsInsideBS(tilecoord.x, 0, MapSizeX()) && IsInsideBS(tilecoord.y, 0, MapSizeY())) {
1146  /* This includes the south border at MapMaxX / MapMaxY. When terraforming we still draw tile selections there. */
1147  tile_info.tile = TileXY(tilecoord.x, tilecoord.y);
1148  tile_type = GetTileType(tile_info.tile);
1149  } else {
1150  tile_info.tile = INVALID_TILE;
1151  tile_type = MP_VOID;
1152  }
1153 
1154  if (tile_type != MP_VOID) {
1155  /* We are inside the map => paint landscape. */
1156  tile_info.tileh = GetTilePixelSlope(tile_info.tile, &tile_info.z);
1157  } else {
1158  /* We are outside the map => paint black. */
1159  tile_info.tileh = GetTilePixelSlopeOutsideMap(tilecoord.x, tilecoord.y, &tile_info.z);
1160  }
1161 
1162  int viewport_y = GetViewportY(tilecoord);
1163 
1164  if (viewport_y + MAX_TILE_EXTENT_BOTTOM < _vd.dpi.top) {
1165  /* The tile in this column is not visible yet.
1166  * Tiles in other columns may be visible, but we need more rows in any case. */
1167  last_row = false;
1168  continue;
1169  }
1170 
1171  int min_visible_height = viewport_y - (_vd.dpi.top + _vd.dpi.height);
1172  bool tile_visible = min_visible_height <= 0;
1173 
1174  if (tile_type != MP_VOID) {
1175  /* Is tile with buildings visible? */
1176  if (min_visible_height < MAX_TILE_EXTENT_TOP) tile_visible = true;
1177 
1178  if (IsBridgeAbove(tile_info.tile)) {
1179  /* Is the bridge visible? */
1180  TileIndex bridge_tile = GetNorthernBridgeEnd(tile_info.tile);
1181  int bridge_height = ZOOM_LVL_BASE * (GetBridgePixelHeight(bridge_tile) - TilePixelHeight(tile_info.tile));
1182  if (min_visible_height < bridge_height + MAX_TILE_EXTENT_TOP) tile_visible = true;
1183  }
1184 
1185  /* Would a higher bridge on a more southern tile be visible?
1186  * If yes, we need to loop over more rows to possibly find one. */
1187  if (min_visible_height < potential_bridge_height + MAX_TILE_EXTENT_TOP) last_row = false;
1188  } else {
1189  /* Outside of map. If we are on the north border of the map, there may still be a bridge visible,
1190  * so we need to loop over more rows to possibly find one. */
1191  if ((tilecoord.x <= 0 || tilecoord.y <= 0) && min_visible_height < potential_bridge_height + MAX_TILE_EXTENT_TOP) last_row = false;
1192  }
1193 
1194  if (tile_visible) {
1195  last_row = false;
1197  _vd.foundation[0] = -1;
1198  _vd.foundation[1] = -1;
1199  _vd.last_foundation_child[0] = NULL;
1200  _vd.last_foundation_child[1] = NULL;
1201 
1202  _tile_type_procs[tile_type]->draw_tile_proc(&tile_info);
1203  if (tile_info.tile != INVALID_TILE) DrawTileSelection(&tile_info);
1204  }
1205  }
1206  }
1207 }
1208 
1219 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)
1220 {
1221  bool small = dpi->zoom >= small_from;
1222 
1223  int left = dpi->left;
1224  int top = dpi->top;
1225  int right = left + dpi->width;
1226  int bottom = top + dpi->height;
1227 
1228  int sign_height = ScaleByZoom(VPSM_TOP + FONT_HEIGHT_NORMAL + VPSM_BOTTOM, dpi->zoom);
1229  int sign_half_width = ScaleByZoom((small ? sign->width_small : sign->width_normal) / 2, dpi->zoom);
1230 
1231  if (bottom < sign->top ||
1232  top > sign->top + sign_height ||
1233  right < sign->center - sign_half_width ||
1234  left > sign->center + sign_half_width) {
1235  return;
1236  }
1237 
1238  if (!small) {
1239  AddStringToDraw(sign->center - sign_half_width, sign->top, string_normal, params_1, params_2, colour, sign->width_normal);
1240  } else {
1241  int shadow_offset = 0;
1242  if (string_small_shadow != STR_NULL) {
1243  shadow_offset = 4;
1244  AddStringToDraw(sign->center - sign_half_width + shadow_offset, sign->top, string_small_shadow, params_1, params_2, INVALID_COLOUR, sign->width_small);
1245  }
1246  AddStringToDraw(sign->center - sign_half_width, sign->top - shadow_offset, string_small, params_1, params_2,
1247  colour, sign->width_small | 0x8000);
1248  }
1249 }
1250 
1251 static void ViewportAddTownNames(DrawPixelInfo *dpi)
1252 {
1253  if (!HasBit(_display_opt, DO_SHOW_TOWN_NAMES) || _game_mode == GM_MENU) return;
1254 
1255  const Town *t;
1256  FOR_ALL_TOWNS(t) {
1258  _settings_client.gui.population_in_label ? STR_VIEWPORT_TOWN_POP : STR_VIEWPORT_TOWN,
1259  STR_VIEWPORT_TOWN_TINY_WHITE, STR_VIEWPORT_TOWN_TINY_BLACK,
1260  t->index, t->cache.population);
1261  }
1262 }
1263 
1264 
1265 static void ViewportAddStationNames(DrawPixelInfo *dpi)
1266 {
1267  if (!(HasBit(_display_opt, DO_SHOW_STATION_NAMES) || HasBit(_display_opt, DO_SHOW_WAYPOINT_NAMES)) || _game_mode == GM_MENU) return;
1268 
1269  const BaseStation *st;
1270  FOR_ALL_BASE_STATIONS(st) {
1271  /* Check whether the base station is a station or a waypoint */
1272  bool is_station = Station::IsExpected(st);
1273 
1274  /* Don't draw if the display options are disabled */
1275  if (!HasBit(_display_opt, is_station ? DO_SHOW_STATION_NAMES : DO_SHOW_WAYPOINT_NAMES)) continue;
1276 
1277  /* Don't draw if station is owned by another company and competitor station names are hidden. Stations owned by none are never ignored. */
1278  if (!HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS) && _local_company != st->owner && st->owner != OWNER_NONE) continue;
1279 
1281  is_station ? STR_VIEWPORT_STATION : STR_VIEWPORT_WAYPOINT,
1282  (is_station ? STR_VIEWPORT_STATION : STR_VIEWPORT_WAYPOINT) + 1, STR_NULL,
1283  st->index, st->facilities, (st->owner == OWNER_NONE || !st->IsInUse()) ? COLOUR_GREY : _company_colours[st->owner]);
1284  }
1285 }
1286 
1287 
1288 static void ViewportAddSigns(DrawPixelInfo *dpi)
1289 {
1290  /* Signs are turned off or are invisible */
1292 
1293  const Sign *si;
1294  FOR_ALL_SIGNS(si) {
1295  /* Don't draw if sign is owned by another company and competitor signs should be hidden.
1296  * Note: It is intentional that also signs owned by OWNER_NONE are hidden. Bankrupt
1297  * companies can leave OWNER_NONE signs after them. */
1298  if (!HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS) && _local_company != si->owner && si->owner != OWNER_DEITY) continue;
1299 
1300  ViewportAddString(dpi, ZOOM_LVL_OUT_16X, &si->sign,
1301  STR_WHITE_SIGN,
1302  (IsTransparencySet(TO_SIGNS) || si->owner == OWNER_DEITY) ? STR_VIEWPORT_SIGN_SMALL_WHITE : STR_VIEWPORT_SIGN_SMALL_BLACK, STR_NULL,
1303  si->index, 0, (si->owner == OWNER_NONE) ? COLOUR_GREY : (si->owner == OWNER_DEITY ? INVALID_COLOUR : _company_colours[si->owner]));
1304  }
1305 }
1306 
1314 void ViewportSign::UpdatePosition(int center, int top, StringID str, StringID str_small)
1315 {
1316  if (this->width_normal != 0) this->MarkDirty();
1317 
1318  this->top = top;
1319 
1320  char buffer[DRAW_STRING_BUFFER];
1321 
1322  GetString(buffer, str, lastof(buffer));
1323  this->width_normal = VPSM_LEFT + Align(GetStringBoundingBox(buffer).width, 2) + VPSM_RIGHT;
1324  this->center = center;
1325 
1326  /* zoomed out version */
1327  if (str_small != STR_NULL) {
1328  GetString(buffer, str_small, lastof(buffer));
1329  }
1330  this->width_small = VPSM_LEFT + Align(GetStringBoundingBox(buffer, FS_SMALL).width, 2) + VPSM_RIGHT;
1331 
1332  this->MarkDirty();
1333 }
1334 
1342 {
1343  Rect zoomlevels[ZOOM_LVL_COUNT];
1344 
1345  for (ZoomLevel zoom = ZOOM_LVL_BEGIN; zoom != ZOOM_LVL_END; zoom++) {
1346  /* FIXME: This doesn't switch to width_small when appropriate. */
1347  zoomlevels[zoom].left = this->center - ScaleByZoom(this->width_normal / 2 + 1, zoom);
1348  zoomlevels[zoom].top = this->top - ScaleByZoom(1, zoom);
1349  zoomlevels[zoom].right = this->center + ScaleByZoom(this->width_normal / 2 + 1, zoom);
1350  zoomlevels[zoom].bottom = this->top + ScaleByZoom(VPSM_TOP + FONT_HEIGHT_NORMAL + VPSM_BOTTOM + 1, zoom);
1351  }
1352 
1353  Window *w;
1354  FOR_ALL_WINDOWS_FROM_BACK(w) {
1355  ViewPort *vp = w->viewport;
1356  if (vp != NULL && vp->zoom <= maxzoom) {
1357  assert(vp->width != 0);
1358  Rect &zl = zoomlevels[vp->zoom];
1359  MarkViewportDirty(vp, zl.left, zl.top, zl.right, zl.bottom);
1360  }
1361  }
1362 }
1363 
1364 static void ViewportDrawTileSprites(const TileSpriteToDrawVector *tstdv)
1365 {
1366  const TileSpriteToDraw *tsend = tstdv->End();
1367  for (const TileSpriteToDraw *ts = tstdv->Begin(); ts != tsend; ++ts) {
1368  DrawSpriteViewport(ts->image, ts->pal, ts->x, ts->y, ts->sub);
1369  }
1370 }
1371 
1374 {
1375  return true;
1376 }
1377 
1380 {
1381  ParentSpriteToDraw **psdvend = psdv->End();
1382  ParentSpriteToDraw **psd = psdv->Begin();
1383  while (psd != psdvend) {
1384  ParentSpriteToDraw *ps = *psd;
1385 
1386  if (ps->comparison_done) {
1387  psd++;
1388  continue;
1389  }
1390 
1391  ps->comparison_done = true;
1392 
1393  for (ParentSpriteToDraw **psd2 = psd + 1; psd2 != psdvend; psd2++) {
1394  ParentSpriteToDraw *ps2 = *psd2;
1395 
1396  if (ps2->comparison_done) continue;
1397 
1398  /* Decide which comparator to use, based on whether the bounding
1399  * boxes overlap
1400  */
1401  if (ps->xmax >= ps2->xmin && ps->xmin <= ps2->xmax && // overlap in X?
1402  ps->ymax >= ps2->ymin && ps->ymin <= ps2->ymax && // overlap in Y?
1403  ps->zmax >= ps2->zmin && ps->zmin <= ps2->zmax) { // overlap in Z?
1404  /* Use X+Y+Z as the sorting order, so sprites closer to the bottom of
1405  * the screen and with higher Z elevation, are drawn in front.
1406  * Here X,Y,Z are the coordinates of the "center of mass" of the sprite,
1407  * i.e. X=(left+right)/2, etc.
1408  * However, since we only care about order, don't actually divide / 2
1409  */
1410  if (ps->xmin + ps->xmax + ps->ymin + ps->ymax + ps->zmin + ps->zmax <=
1411  ps2->xmin + ps2->xmax + ps2->ymin + ps2->ymax + ps2->zmin + ps2->zmax) {
1412  continue;
1413  }
1414  } else {
1415  /* We only change the order, if it is definite.
1416  * I.e. every single order of X, Y, Z says ps2 is behind ps or they overlap.
1417  * That is: If one partial order says ps behind ps2, do not change the order.
1418  */
1419  if (ps->xmax < ps2->xmin ||
1420  ps->ymax < ps2->ymin ||
1421  ps->zmax < ps2->zmin) {
1422  continue;
1423  }
1424  }
1425 
1426  /* Move ps2 in front of ps */
1427  ParentSpriteToDraw *temp = ps2;
1428  for (ParentSpriteToDraw **psd3 = psd2; psd3 > psd; psd3--) {
1429  *psd3 = *(psd3 - 1);
1430  }
1431  *psd = temp;
1432  }
1433  }
1434 }
1435 
1436 static void ViewportDrawParentSprites(const ParentSpriteToSortVector *psd, const ChildScreenSpriteToDrawVector *csstdv)
1437 {
1438  const ParentSpriteToDraw * const *psd_end = psd->End();
1439  for (const ParentSpriteToDraw * const *it = psd->Begin(); it != psd_end; it++) {
1440  const ParentSpriteToDraw *ps = *it;
1441  if (ps->image != SPR_EMPTY_BOUNDING_BOX) DrawSpriteViewport(ps->image, ps->pal, ps->x, ps->y, ps->sub);
1442 
1443  int child_idx = ps->first_child;
1444  while (child_idx >= 0) {
1445  const ChildScreenSpriteToDraw *cs = csstdv->Get(child_idx);
1446  child_idx = cs->next;
1447  DrawSpriteViewport(cs->image, cs->pal, ps->left + cs->x, ps->top + cs->y, cs->sub);
1448  }
1449  }
1450 }
1451 
1457 {
1458  const ParentSpriteToDraw * const *psd_end = psd->End();
1459  for (const ParentSpriteToDraw * const *it = psd->Begin(); it != psd_end; it++) {
1460  const ParentSpriteToDraw *ps = *it;
1461  Point pt1 = RemapCoords(ps->xmax + 1, ps->ymax + 1, ps->zmax + 1); // top front corner
1462  Point pt2 = RemapCoords(ps->xmin , ps->ymax + 1, ps->zmax + 1); // top left corner
1463  Point pt3 = RemapCoords(ps->xmax + 1, ps->ymin , ps->zmax + 1); // top right corner
1464  Point pt4 = RemapCoords(ps->xmax + 1, ps->ymax + 1, ps->zmin ); // bottom front corner
1465 
1466  DrawBox( pt1.x, pt1.y,
1467  pt2.x - pt1.x, pt2.y - pt1.y,
1468  pt3.x - pt1.x, pt3.y - pt1.y,
1469  pt4.x - pt1.x, pt4.y - pt1.y);
1470  }
1471 }
1472 
1477 {
1479  const DrawPixelInfo *dpi = _cur_dpi;
1480  void *dst;
1481  int right = UnScaleByZoom(dpi->width, dpi->zoom);
1482  int bottom = UnScaleByZoom(dpi->height, dpi->zoom);
1483 
1484  int colour = _string_colourmap[_dirty_block_colour & 0xF];
1485 
1486  dst = dpi->dst_ptr;
1487 
1488  byte bo = UnScaleByZoom(dpi->left + dpi->top, dpi->zoom) & 1;
1489  do {
1490  for (int i = (bo ^= 1); i < right; i += 2) blitter->SetPixel(dst, i, 0, (uint8)colour);
1491  dst = blitter->MoveTo(dst, 0, 1);
1492  } while (--bottom > 0);
1493 }
1494 
1495 static void ViewportDrawStrings(ZoomLevel zoom, const StringSpriteToDrawVector *sstdv)
1496 {
1497  const StringSpriteToDraw *ssend = sstdv->End();
1498  for (const StringSpriteToDraw *ss = sstdv->Begin(); ss != ssend; ++ss) {
1499  TextColour colour = TC_BLACK;
1500  bool small = HasBit(ss->width, 15);
1501  int w = GB(ss->width, 0, 15);
1502  int x = UnScaleByZoom(ss->x, zoom);
1503  int y = UnScaleByZoom(ss->y, zoom);
1504  int h = VPSM_TOP + (small ? FONT_HEIGHT_SMALL : FONT_HEIGHT_NORMAL) + VPSM_BOTTOM;
1505 
1506  SetDParam(0, ss->params[0]);
1507  SetDParam(1, ss->params[1]);
1508 
1509  if (ss->colour != INVALID_COLOUR) {
1510  /* Do not draw signs nor station names if they are set invisible */
1511  if (IsInvisibilitySet(TO_SIGNS) && ss->string != STR_WHITE_SIGN) continue;
1512 
1513  if (IsTransparencySet(TO_SIGNS) && ss->string != STR_WHITE_SIGN) {
1514  /* Don't draw the rectangle.
1515  * Real colours need the TC_IS_PALETTE_COLOUR flag.
1516  * Otherwise colours from _string_colourmap are assumed. */
1517  colour = (TextColour)_colour_gradient[ss->colour][6] | TC_IS_PALETTE_COLOUR;
1518  } else {
1519  /* Draw the rectangle if 'transparent station signs' is off,
1520  * or if we are drawing a general text sign (STR_WHITE_SIGN). */
1521  DrawFrameRect(
1522  x, y, x + w, y + h, ss->colour,
1524  );
1525  }
1526  }
1527 
1528  DrawString(x + VPSM_LEFT, x + w - 1 - VPSM_RIGHT, y + VPSM_TOP, ss->string, colour, SA_HOR_CENTER);
1529  }
1530 }
1531 
1532 void ViewportDoDraw(const ViewPort *vp, int left, int top, int right, int bottom)
1533 {
1534  DrawPixelInfo *old_dpi = _cur_dpi;
1535  _cur_dpi = &_vd.dpi;
1536 
1537  _vd.dpi.zoom = vp->zoom;
1538  int mask = ScaleByZoom(-1, vp->zoom);
1539 
1541 
1542  _vd.dpi.width = (right - left) & mask;
1543  _vd.dpi.height = (bottom - top) & mask;
1544  _vd.dpi.left = left & mask;
1545  _vd.dpi.top = top & mask;
1546  _vd.dpi.pitch = old_dpi->pitch;
1547  _vd.last_child = NULL;
1548 
1549  int x = UnScaleByZoom(_vd.dpi.left - (vp->virtual_left & mask), vp->zoom) + vp->left;
1550  int y = UnScaleByZoom(_vd.dpi.top - (vp->virtual_top & mask), vp->zoom) + vp->top;
1551 
1552  _vd.dpi.dst_ptr = BlitterFactory::GetCurrentBlitter()->MoveTo(old_dpi->dst_ptr, x - old_dpi->left, y - old_dpi->top);
1553 
1555  ViewportAddVehicles(&_vd.dpi);
1556 
1557  ViewportAddTownNames(&_vd.dpi);
1558  ViewportAddStationNames(&_vd.dpi);
1559  ViewportAddSigns(&_vd.dpi);
1560 
1561  DrawTextEffects(&_vd.dpi);
1562 
1563  if (_vd.tile_sprites_to_draw.Length() != 0) ViewportDrawTileSprites(&_vd.tile_sprites_to_draw);
1564 
1565  ParentSpriteToDraw *psd_end = _vd.parent_sprites_to_draw.End();
1566  for (ParentSpriteToDraw *it = _vd.parent_sprites_to_draw.Begin(); it != psd_end; it++) {
1567  *_vd.parent_sprites_to_sort.Append() = it;
1568  }
1569 
1570  _vp_sprite_sorter(&_vd.parent_sprites_to_sort);
1571  ViewportDrawParentSprites(&_vd.parent_sprites_to_sort, &_vd.child_screen_sprites_to_draw);
1572 
1573  if (_draw_bounding_boxes) ViewportDrawBoundingBoxes(&_vd.parent_sprites_to_sort);
1574  if (_draw_dirty_blocks) ViewportDrawDirtyBlocks();
1575 
1576  DrawPixelInfo dp = _vd.dpi;
1577  ZoomLevel zoom = _vd.dpi.zoom;
1578  dp.zoom = ZOOM_LVL_NORMAL;
1579  dp.width = UnScaleByZoom(dp.width, zoom);
1580  dp.height = UnScaleByZoom(dp.height, zoom);
1581  _cur_dpi = &dp;
1582 
1583  if (vp->overlay != NULL && vp->overlay->GetCargoMask() != 0 && vp->overlay->GetCompanyMask() != 0) {
1584  /* translate to window coordinates */
1585  dp.left = x;
1586  dp.top = y;
1587  vp->overlay->Draw(&dp);
1588  }
1589 
1590  if (_vd.string_sprites_to_draw.Length() != 0) {
1591  /* translate to world coordinates */
1592  dp.left = UnScaleByZoom(_vd.dpi.left, zoom);
1593  dp.top = UnScaleByZoom(_vd.dpi.top, zoom);
1594  ViewportDrawStrings(zoom, &_vd.string_sprites_to_draw);
1595  }
1596 
1597  _cur_dpi = old_dpi;
1598 
1599  _vd.string_sprites_to_draw.Clear();
1600  _vd.tile_sprites_to_draw.Clear();
1601  _vd.parent_sprites_to_draw.Clear();
1603  _vd.child_screen_sprites_to_draw.Clear();
1604 }
1605 
1610 static void ViewportDrawChk(const ViewPort *vp, int left, int top, int right, int bottom)
1611 {
1612  if (ScaleByZoom(bottom - top, vp->zoom) * ScaleByZoom(right - left, vp->zoom) > 180000 * ZOOM_LVL_BASE * ZOOM_LVL_BASE) {
1613  if ((bottom - top) > (right - left)) {
1614  int t = (top + bottom) >> 1;
1615  ViewportDrawChk(vp, left, top, right, t);
1616  ViewportDrawChk(vp, left, t, right, bottom);
1617  } else {
1618  int t = (left + right) >> 1;
1619  ViewportDrawChk(vp, left, top, t, bottom);
1620  ViewportDrawChk(vp, t, top, right, bottom);
1621  }
1622  } else {
1623  ViewportDoDraw(vp,
1624  ScaleByZoom(left - vp->left, vp->zoom) + vp->virtual_left,
1625  ScaleByZoom(top - vp->top, vp->zoom) + vp->virtual_top,
1626  ScaleByZoom(right - vp->left, vp->zoom) + vp->virtual_left,
1627  ScaleByZoom(bottom - vp->top, vp->zoom) + vp->virtual_top
1628  );
1629  }
1630 }
1631 
1632 static inline void ViewportDraw(const ViewPort *vp, int left, int top, int right, int bottom)
1633 {
1634  if (right <= vp->left || bottom <= vp->top) return;
1635 
1636  if (left >= vp->left + vp->width) return;
1637 
1638  if (left < vp->left) left = vp->left;
1639  if (right > vp->left + vp->width) right = vp->left + vp->width;
1640 
1641  if (top >= vp->top + vp->height) return;
1642 
1643  if (top < vp->top) top = vp->top;
1644  if (bottom > vp->top + vp->height) bottom = vp->top + vp->height;
1645 
1646  ViewportDrawChk(vp, left, top, right, bottom);
1647 }
1648 
1653 {
1654  DrawPixelInfo *dpi = _cur_dpi;
1655 
1656  dpi->left += this->left;
1657  dpi->top += this->top;
1658 
1659  ViewportDraw(this->viewport, dpi->left, dpi->top, dpi->left + dpi->width, dpi->top + dpi->height);
1660 
1661  dpi->left -= this->left;
1662  dpi->top -= this->top;
1663 }
1664 
1673 typedef bool ContinueMapEdgeSearch(int iter, int iter_limit, int sy, int sy_limit);
1674 
1676 static inline bool ContinueLowerMapEdgeSearch(int iter, int iter_limit, int sy, int sy_limit) { return iter > 0 && sy > sy_limit; }
1678 static inline bool ContinueUpperMapEdgeSearch(int iter, int iter_limit, int sy, int sy_limit) { return iter < iter_limit && sy < sy_limit; }
1679 
1693 static int SearchMapEdge(Point &curr_tile, int &iter, int iter_limit, int offset, int sy_limit, ContinueMapEdgeSearch continue_criteria)
1694 {
1695  int sy;
1696  do {
1697  iter = Clamp(iter + offset, 0, iter_limit);
1698  sy = GetViewportY(curr_tile);
1699  } while (continue_criteria(iter, iter_limit, sy, sy_limit));
1700 
1701  return iter;
1702 }
1703 
1718 static inline int ClampXYToMap(Point &curr_tile, int &iter, int iter_limit, int start, int &other_ref, int other_value, int vp_value, int other_limit, int vp_top, int vp_bottom)
1719 {
1720  bool upper_edge = other_value < _settings_game.construction.max_heightlevel / 4;
1721 
1722  /*
1723  * First get an estimate of the tiles relevant for us at that edge. Relevant in the sense
1724  * "at least close to the visible area". Thus, we don't look at exactly each tile, inspecting
1725  * e.g. every tenth should be enough. After all, the desired screen limit is set such that
1726  * the bordermost tiles are painted in the middle of the screen when one hits the limit,
1727  * i.e. it is no harm if there is some small error in that calculation
1728  */
1729 
1730  other_ref = upper_edge ? 0 : other_limit;
1731  iter = start;
1732  int min_iter = SearchMapEdge(curr_tile, iter, iter_limit, upper_edge ? -10 : +10, vp_top, upper_edge ? ContinueLowerMapEdgeSearch : ContinueUpperMapEdgeSearch);
1733  iter = start;
1734  int max_iter = SearchMapEdge(curr_tile, iter, iter_limit, upper_edge ? +10 : -10, vp_bottom, upper_edge ? ContinueUpperMapEdgeSearch : ContinueLowerMapEdgeSearch);
1735 
1736  max_iter = min(max_iter + _settings_game.construction.max_heightlevel / 4, iter_limit);
1737  min_iter = min(min_iter, max_iter);
1738 
1739  /* Now, calculate the highest heightlevel of these tiles. Again just as an estimate. */
1740  int max_heightlevel_at_edge = 0;
1741  for (iter = min_iter; iter <= max_iter; iter += 10) {
1742  max_heightlevel_at_edge = max(max_heightlevel_at_edge, (int)TileHeight(TileXY(curr_tile.x, curr_tile.y)));
1743  }
1744 
1745  /* Based on that heightlevel, calculate the limit. For the upper edge a tile with height zero would
1746  * get a limit of zero, on the other side it depends on the number of tiles along the axis. */
1747  return upper_edge ?
1748  max(vp_value, -max_heightlevel_at_edge * (int)(TILE_HEIGHT * 2 * ZOOM_LVL_BASE)) :
1749  min(vp_value, (other_limit * TILE_SIZE * 4 - max_heightlevel_at_edge * TILE_HEIGHT * 2) * ZOOM_LVL_BASE);
1750 }
1751 
1752 static inline void ClampViewportToMap(const ViewPort *vp, int &x, int &y)
1753 {
1754  int original_y = y;
1755 
1756  /* Centre of the viewport is hot spot */
1757  x += vp->virtual_width / 2;
1758  y += vp->virtual_height / 2;
1759 
1760  /* Convert viewport coordinates to map coordinates
1761  * Calculation is scaled by 4 to avoid rounding errors */
1762  int vx = -x + y * 2;
1763  int vy = x + y * 2;
1764 
1765  /* Find out which tile corresponds to (vx,vy) if one assumes height zero. The cast is necessary to prevent C++ from
1766  * converting the result to an uint, which gives an overflow instead of a negative result... */
1767  int tx = vx / (int)(TILE_SIZE * 4 * ZOOM_LVL_BASE);
1768  int ty = vy / (int)(TILE_SIZE * 4 * ZOOM_LVL_BASE);
1769 
1770  Point curr_tile;
1771  vx = ClampXYToMap(curr_tile, curr_tile.y, MapMaxY(), ty, curr_tile.x, tx, vx, MapMaxX(), original_y, original_y + vp->virtual_height);
1772  vy = ClampXYToMap(curr_tile, curr_tile.x, MapMaxX(), tx, curr_tile.y, ty, vy, MapMaxY(), original_y, original_y + vp->virtual_height);
1773 
1774  /* Convert map coordinates to viewport coordinates */
1775  x = (-vx + vy) / 2;
1776  y = ( vx + vy) / 4;
1777 
1778  /* Remove centering */
1779  x -= vp->virtual_width / 2;
1780  y -= vp->virtual_height / 2;
1781 }
1782 
1788 {
1789  const ViewPort *vp = w->viewport;
1790 
1792  const Vehicle *veh = Vehicle::Get(w->viewport->follow_vehicle);
1793  Point pt = MapXYZToViewport(vp, veh->x_pos, veh->y_pos, veh->z_pos);
1794 
1795  w->viewport->scrollpos_x = pt.x;
1796  w->viewport->scrollpos_y = pt.y;
1797  SetViewportPosition(w, pt.x, pt.y);
1798  } else {
1799  /* Ensure the destination location is within the map */
1800  ClampViewportToMap(vp, w->viewport->dest_scrollpos_x, w->viewport->dest_scrollpos_y);
1801 
1802  int delta_x = w->viewport->dest_scrollpos_x - w->viewport->scrollpos_x;
1803  int delta_y = w->viewport->dest_scrollpos_y - w->viewport->scrollpos_y;
1804 
1805  bool update_overlay = false;
1806  if (delta_x != 0 || delta_y != 0) {
1808  int max_scroll = ScaleByMapSize1D(512 * ZOOM_LVL_BASE);
1809  /* Not at our desired position yet... */
1810  w->viewport->scrollpos_x += Clamp(delta_x / 4, -max_scroll, max_scroll);
1811  w->viewport->scrollpos_y += Clamp(delta_y / 4, -max_scroll, max_scroll);
1812  } else {
1815  }
1816  update_overlay = (w->viewport->scrollpos_x == w->viewport->dest_scrollpos_x &&
1818  }
1819 
1820  ClampViewportToMap(vp, w->viewport->scrollpos_x, w->viewport->scrollpos_y);
1821 
1822  SetViewportPosition(w, w->viewport->scrollpos_x, w->viewport->scrollpos_y);
1823  if (update_overlay) RebuildViewportOverlay(w);
1824  }
1825 }
1826 
1836 static void MarkViewportDirty(const ViewPort *vp, int left, int top, int right, int bottom)
1837 {
1838  /* Rounding wrt. zoom-out level */
1839  right += (1 << vp->zoom) - 1;
1840  bottom += (1 << vp->zoom) - 1;
1841 
1842  right -= vp->virtual_left;
1843  if (right <= 0) return;
1844 
1845  bottom -= vp->virtual_top;
1846  if (bottom <= 0) return;
1847 
1848  left = max(0, left - vp->virtual_left);
1849 
1850  if (left >= vp->virtual_width) return;
1851 
1852  top = max(0, top - vp->virtual_top);
1853 
1854  if (top >= vp->virtual_height) return;
1855 
1857  UnScaleByZoomLower(left, vp->zoom) + vp->left,
1858  UnScaleByZoomLower(top, vp->zoom) + vp->top,
1859  UnScaleByZoom(right, vp->zoom) + vp->left + 1,
1860  UnScaleByZoom(bottom, vp->zoom) + vp->top + 1
1861  );
1862 }
1863 
1872 void MarkAllViewportsDirty(int left, int top, int right, int bottom)
1873 {
1874  Window *w;
1875  FOR_ALL_WINDOWS_FROM_BACK(w) {
1876  ViewPort *vp = w->viewport;
1877  if (vp != NULL) {
1878  assert(vp->width != 0);
1879  MarkViewportDirty(vp, left, top, right, bottom);
1880  }
1881  }
1882 }
1883 
1884 void ConstrainAllViewportsZoom()
1885 {
1886  Window *w;
1887  FOR_ALL_WINDOWS_FROM_FRONT(w) {
1888  if (w->viewport == NULL) continue;
1889 
1891  if (zoom != w->viewport->zoom) {
1892  while (w->viewport->zoom < zoom) DoZoomInOutWindow(ZOOM_OUT, w);
1893  while (w->viewport->zoom > zoom) DoZoomInOutWindow(ZOOM_IN, w);
1894  }
1895  }
1896 }
1897 
1904 void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset)
1905 {
1906  Point pt = RemapCoords(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, TilePixelHeight(tile));
1908  pt.x - MAX_TILE_EXTENT_LEFT,
1909  pt.y - MAX_TILE_EXTENT_TOP - ZOOM_LVL_BASE * TILE_HEIGHT * bridge_level_offset,
1910  pt.x + MAX_TILE_EXTENT_RIGHT,
1911  pt.y + MAX_TILE_EXTENT_BOTTOM);
1912 }
1913 
1921 {
1922  Point pt = RemapCoords(x * TILE_SIZE, y * TILE_SIZE, TilePixelHeightOutsideMap(x, y));
1924  pt.x - MAX_TILE_EXTENT_LEFT,
1925  pt.y, // no buildings outside of map
1926  pt.x + MAX_TILE_EXTENT_RIGHT,
1927  pt.y + MAX_TILE_EXTENT_BOTTOM);
1928 }
1929 
1938 {
1939  int x_size = _thd.size.x;
1940  int y_size = _thd.size.y;
1941 
1942  if (!_thd.diagonal) { // Selecting in a straight rectangle (or a single square)
1943  int x_start = _thd.pos.x;
1944  int y_start = _thd.pos.y;
1945 
1946  if (_thd.outersize.x != 0) {
1947  x_size += _thd.outersize.x;
1948  x_start += _thd.offs.x;
1949  y_size += _thd.outersize.y;
1950  y_start += _thd.offs.y;
1951  }
1952 
1953  x_size -= TILE_SIZE;
1954  y_size -= TILE_SIZE;
1955 
1956  assert(x_size >= 0);
1957  assert(y_size >= 0);
1958 
1959  int x_end = Clamp(x_start + x_size, 0, MapSizeX() * TILE_SIZE - TILE_SIZE);
1960  int y_end = Clamp(y_start + y_size, 0, MapSizeY() * TILE_SIZE - TILE_SIZE);
1961 
1962  x_start = Clamp(x_start, 0, MapSizeX() * TILE_SIZE - TILE_SIZE);
1963  y_start = Clamp(y_start, 0, MapSizeY() * TILE_SIZE - TILE_SIZE);
1964 
1965  /* make sure everything is multiple of TILE_SIZE */
1966  assert((x_end | y_end | x_start | y_start) % TILE_SIZE == 0);
1967 
1968  /* How it works:
1969  * Suppose we have to mark dirty rectangle of 3x4 tiles:
1970  * x
1971  * xxx
1972  * xxxxx
1973  * xxxxx
1974  * xxx
1975  * x
1976  * This algorithm marks dirty columns of tiles, so it is done in 3+4-1 steps:
1977  * 1) x 2) x
1978  * xxx Oxx
1979  * Oxxxx xOxxx
1980  * xxxxx Oxxxx
1981  * xxx xxx
1982  * x x
1983  * And so forth...
1984  */
1985 
1986  int top_x = x_end; // coordinates of top dirty tile
1987  int top_y = y_start;
1988  int bot_x = top_x; // coordinates of bottom dirty tile
1989  int bot_y = top_y;
1990 
1991  do {
1992  /* topmost dirty point */
1993  TileIndex top_tile = TileVirtXY(top_x, top_y);
1994  Point top = RemapCoords(top_x, top_y, GetTileMaxPixelZ(top_tile));
1995 
1996  /* bottommost point */
1997  TileIndex bottom_tile = TileVirtXY(bot_x, bot_y);
1998  Point bot = RemapCoords(bot_x + TILE_SIZE, bot_y + TILE_SIZE, GetTilePixelZ(bottom_tile)); // bottommost point
1999 
2000  /* the 'x' coordinate of 'top' and 'bot' is the same (and always in the same distance from tile middle),
2001  * tile height/slope affects only the 'y' on-screen coordinate! */
2002 
2003  int l = top.x - TILE_PIXELS * ZOOM_LVL_BASE; // 'x' coordinate of left side of the dirty rectangle
2004  int t = top.y; // 'y' coordinate of top side of the dirty rectangle
2005  int r = top.x + TILE_PIXELS * ZOOM_LVL_BASE; // 'x' coordinate of right side of the dirty rectangle
2006  int b = bot.y; // 'y' coordinate of bottom side of the dirty rectangle
2007 
2008  static const int OVERLAY_WIDTH = 4 * ZOOM_LVL_BASE; // part of selection sprites is drawn outside the selected area (in particular: terraforming)
2009 
2010  /* For halftile foundations on SLOPE_STEEP_S the sprite extents some more towards the top */
2011  MarkAllViewportsDirty(l - OVERLAY_WIDTH, t - OVERLAY_WIDTH - TILE_HEIGHT * ZOOM_LVL_BASE, r + OVERLAY_WIDTH, b + OVERLAY_WIDTH);
2012 
2013  /* haven't we reached the topmost tile yet? */
2014  if (top_x != x_start) {
2015  top_x -= TILE_SIZE;
2016  } else {
2017  top_y += TILE_SIZE;
2018  }
2019 
2020  /* the way the bottom tile changes is different when we reach the bottommost tile */
2021  if (bot_y != y_end) {
2022  bot_y += TILE_SIZE;
2023  } else {
2024  bot_x -= TILE_SIZE;
2025  }
2026  } while (bot_x >= top_x);
2027  } else { // Selecting in a 45 degrees rotated (diagonal) rectangle.
2028  /* a_size, b_size describe a rectangle with rotated coordinates */
2029  int a_size = x_size + y_size, b_size = x_size - y_size;
2030 
2031  int interval_a = a_size < 0 ? -(int)TILE_SIZE : (int)TILE_SIZE;
2032  int interval_b = b_size < 0 ? -(int)TILE_SIZE : (int)TILE_SIZE;
2033 
2034  for (int a = -interval_a; a != a_size + interval_a; a += interval_a) {
2035  for (int b = -interval_b; b != b_size + interval_b; b += interval_b) {
2036  uint x = (_thd.pos.x + (a + b) / 2) / TILE_SIZE;
2037  uint y = (_thd.pos.y + (a - b) / 2) / TILE_SIZE;
2038 
2039  if (x < MapMaxX() && y < MapMaxY()) {
2040  MarkTileDirtyByTile(TileXY(x, y));
2041  }
2042  }
2043  }
2044  }
2045 }
2046 
2047 
2048 void SetSelectionRed(bool b)
2049 {
2050  _thd.make_square_red = b;
2052 }
2053 
2062 static bool CheckClickOnViewportSign(const ViewPort *vp, int x, int y, const ViewportSign *sign)
2063 {
2064  bool small = (vp->zoom >= ZOOM_LVL_OUT_16X);
2065  int sign_half_width = ScaleByZoom((small ? sign->width_small : sign->width_normal) / 2, vp->zoom);
2066  int sign_height = ScaleByZoom(VPSM_TOP + (small ? FONT_HEIGHT_SMALL : FONT_HEIGHT_NORMAL) + VPSM_BOTTOM, vp->zoom);
2067 
2068  x = ScaleByZoom(x - vp->left, vp->zoom) + vp->virtual_left;
2069  y = ScaleByZoom(y - vp->top, vp->zoom) + vp->virtual_top;
2070 
2071  return y >= sign->top && y < sign->top + sign_height &&
2072  x >= sign->center - sign_half_width && x < sign->center + sign_half_width;
2073 }
2074 
2075 static bool CheckClickOnTown(const ViewPort *vp, int x, int y)
2076 {
2077  if (!HasBit(_display_opt, DO_SHOW_TOWN_NAMES)) return false;
2078 
2079  const Town *t;
2080  FOR_ALL_TOWNS(t) {
2081  if (CheckClickOnViewportSign(vp, x, y, &t->cache.sign)) {
2082  ShowTownViewWindow(t->index);
2083  return true;
2084  }
2085  }
2086 
2087  return false;
2088 }
2089 
2090 static bool CheckClickOnStation(const ViewPort *vp, int x, int y)
2091 {
2093 
2094  const BaseStation *st;
2095  FOR_ALL_BASE_STATIONS(st) {
2096  /* Check whether the base station is a station or a waypoint */
2097  bool is_station = Station::IsExpected(st);
2098 
2099  /* Don't check if the display options are disabled */
2100  if (!HasBit(_display_opt, is_station ? DO_SHOW_STATION_NAMES : DO_SHOW_WAYPOINT_NAMES)) continue;
2101 
2102  /* Don't check if competitor signs are not shown and the sign isn't owned by the local company */
2103  if (!HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS) && _local_company != st->owner && st->owner != OWNER_NONE) continue;
2104 
2105  if (CheckClickOnViewportSign(vp, x, y, &st->sign)) {
2106  if (is_station) {
2108  } else {
2110  }
2111  return true;
2112  }
2113  }
2114 
2115  return false;
2116 }
2117 
2118 
2119 static bool CheckClickOnSign(const ViewPort *vp, int x, int y)
2120 {
2121  /* Signs are turned off, or they are transparent and invisibility is ON, or company is a spectator */
2123 
2124  const Sign *si;
2125  FOR_ALL_SIGNS(si) {
2126  /* If competitor signs are hidden, don't check signs that aren't owned by local company */
2127  if (!HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS) && _local_company != si->owner && si->owner != OWNER_DEITY) continue;
2128  if (si->owner == OWNER_DEITY && _game_mode != GM_EDITOR) continue;
2129 
2130  if (CheckClickOnViewportSign(vp, x, y, &si->sign)) {
2131  HandleClickOnSign(si);
2132  return true;
2133  }
2134  }
2135 
2136  return false;
2137 }
2138 
2139 
2140 static bool CheckClickOnLandscape(const ViewPort *vp, int x, int y)
2141 {
2142  Point pt = TranslateXYToTileCoord(vp, x, y);
2143 
2144  if (pt.x != -1) return ClickTile(TileVirtXY(pt.x, pt.y));
2145  return true;
2146 }
2147 
2148 static void PlaceObject()
2149 {
2150  Point pt;
2151  Window *w;
2152 
2153  pt = GetTileBelowCursor();
2154  if (pt.x == -1) return;
2155 
2156  if ((_thd.place_mode & HT_DRAG_MASK) == HT_POINT) {
2157  pt.x += TILE_SIZE / 2;
2158  pt.y += TILE_SIZE / 2;
2159  }
2160 
2161  _tile_fract_coords.x = pt.x & TILE_UNIT_MASK;
2162  _tile_fract_coords.y = pt.y & TILE_UNIT_MASK;
2163 
2164  w = _thd.GetCallbackWnd();
2165  if (w != NULL) w->OnPlaceObject(pt, TileVirtXY(pt.x, pt.y));
2166 }
2167 
2168 
2169 bool HandleViewportClicked(const ViewPort *vp, int x, int y)
2170 {
2171  const Vehicle *v = CheckClickOnVehicle(vp, x, y);
2172 
2173  if (_thd.place_mode & HT_VEHICLE) {
2174  if (v != NULL && VehicleClicked(v)) return true;
2175  }
2176 
2177  /* Vehicle placement mode already handled above. */
2178  if ((_thd.place_mode & HT_DRAG_MASK) != HT_NONE) {
2179  PlaceObject();
2180  return true;
2181  }
2182 
2183  if (CheckClickOnTown(vp, x, y)) return true;
2184  if (CheckClickOnStation(vp, x, y)) return true;
2185  if (CheckClickOnSign(vp, x, y)) return true;
2186  bool result = CheckClickOnLandscape(vp, x, y);
2187 
2188  if (v != NULL) {
2189  DEBUG(misc, 2, "Vehicle %d (index %d) at %p", v->unitnumber, v->index, v);
2191  v = v->First();
2192  if (_ctrl_pressed && v->owner == _local_company) {
2193  StartStopVehicle(v, true);
2194  } else {
2196  }
2197  }
2198  return true;
2199  }
2200  return result;
2201 }
2202 
2203 void RebuildViewportOverlay(Window *w)
2204 {
2205  if (w->viewport->overlay != NULL &&
2206  w->viewport->overlay->GetCompanyMask() != 0 &&
2207  w->viewport->overlay->GetCargoMask() != 0) {
2208  w->viewport->overlay->RebuildCache();
2209  w->SetDirty();
2210  }
2211 }
2212 
2222 bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
2223 {
2224  /* The slope cannot be acquired outside of the map, so make sure we are always within the map. */
2225  if (z == -1) {
2226  if ( x >= 0 && x <= (int)MapSizeX() * (int)TILE_SIZE - 1
2227  && y >= 0 && y <= (int)MapSizeY() * (int)TILE_SIZE - 1) {
2228  z = GetSlopePixelZ(x, y);
2229  } else {
2230  z = TileHeightOutsideMap(x / (int)TILE_SIZE, y / (int)TILE_SIZE);
2231  }
2232  }
2233 
2234  Point pt = MapXYZToViewport(w->viewport, x, y, z);
2236 
2237  if (w->viewport->dest_scrollpos_x == pt.x && w->viewport->dest_scrollpos_y == pt.y) return false;
2238 
2239  if (instant) {
2240  w->viewport->scrollpos_x = pt.x;
2241  w->viewport->scrollpos_y = pt.y;
2242  RebuildViewportOverlay(w);
2243  }
2244 
2245  w->viewport->dest_scrollpos_x = pt.x;
2246  w->viewport->dest_scrollpos_y = pt.y;
2247  return true;
2248 }
2249 
2257 bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
2258 {
2259  return ScrollWindowTo(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, -1, w, instant);
2260 }
2261 
2268 bool ScrollMainWindowToTile(TileIndex tile, bool instant)
2269 {
2270  return ScrollMainWindowTo(TileX(tile) * TILE_SIZE + TILE_SIZE / 2, TileY(tile) * TILE_SIZE + TILE_SIZE / 2, -1, instant);
2271 }
2272 
2278 {
2279  TileIndex old;
2280 
2281  old = _thd.redsq;
2282  _thd.redsq = tile;
2283 
2284  if (tile != old) {
2285  if (tile != INVALID_TILE) MarkTileDirtyByTile(tile);
2286  if (old != INVALID_TILE) MarkTileDirtyByTile(old);
2287  }
2288 }
2289 
2295 void SetTileSelectSize(int w, int h)
2296 {
2297  _thd.new_size.x = w * TILE_SIZE;
2298  _thd.new_size.y = h * TILE_SIZE;
2299  _thd.new_outersize.x = 0;
2300  _thd.new_outersize.y = 0;
2301 }
2302 
2303 void SetTileSelectBigSize(int ox, int oy, int sx, int sy)
2304 {
2305  _thd.offs.x = ox * TILE_SIZE;
2306  _thd.offs.y = oy * TILE_SIZE;
2307  _thd.new_outersize.x = sx * TILE_SIZE;
2308  _thd.new_outersize.y = sy * TILE_SIZE;
2309 }
2310 
2312 static HighLightStyle GetAutorailHT(int x, int y)
2313 {
2314  return HT_RAIL | _autorail_piece[x & TILE_UNIT_MASK][y & TILE_UNIT_MASK];
2315 }
2316 
2321 {
2322  this->pos.x = 0;
2323  this->pos.y = 0;
2324  this->new_pos.x = 0;
2325  this->new_pos.y = 0;
2326 }
2327 
2333 {
2334  return (this->place_mode & HT_DIAGONAL) != 0 && _ctrl_pressed && _left_button_down;
2335 }
2336 
2342 {
2343  return FindWindowById(this->window_class, this->window_number);
2344 }
2345 
2346 
2347 
2356 {
2357  int x1;
2358  int y1;
2359 
2360  HighLightStyle new_drawstyle = HT_NONE;
2361  bool new_diagonal = false;
2362 
2363  if ((_thd.place_mode & HT_DRAG_MASK) == HT_SPECIAL) {
2364  x1 = _thd.selend.x;
2365  y1 = _thd.selend.y;
2366  if (x1 != -1) {
2367  int x2 = _thd.selstart.x & ~TILE_UNIT_MASK;
2368  int y2 = _thd.selstart.y & ~TILE_UNIT_MASK;
2369  x1 &= ~TILE_UNIT_MASK;
2370  y1 &= ~TILE_UNIT_MASK;
2371 
2372  if (_thd.IsDraggingDiagonal()) {
2373  new_diagonal = true;
2374  } else {
2375  if (x1 >= x2) Swap(x1, x2);
2376  if (y1 >= y2) Swap(y1, y2);
2377  }
2378  _thd.new_pos.x = x1;
2379  _thd.new_pos.y = y1;
2380  _thd.new_size.x = x2 - x1;
2381  _thd.new_size.y = y2 - y1;
2382  if (!new_diagonal) {
2383  _thd.new_size.x += TILE_SIZE;
2384  _thd.new_size.y += TILE_SIZE;
2385  }
2386  new_drawstyle = _thd.next_drawstyle;
2387  }
2388  } else if ((_thd.place_mode & HT_DRAG_MASK) != HT_NONE) {
2389  Point pt = GetTileBelowCursor();
2390  x1 = pt.x;
2391  y1 = pt.y;
2392  if (x1 != -1) {
2393  switch (_thd.place_mode & HT_DRAG_MASK) {
2394  case HT_RECT:
2395  new_drawstyle = HT_RECT;
2396  break;
2397  case HT_POINT:
2398  new_drawstyle = HT_POINT;
2399  x1 += TILE_SIZE / 2;
2400  y1 += TILE_SIZE / 2;
2401  break;
2402  case HT_RAIL:
2403  /* Draw one highlighted tile in any direction */
2404  new_drawstyle = GetAutorailHT(pt.x, pt.y);
2405  break;
2406  case HT_LINE:
2407  switch (_thd.place_mode & HT_DIR_MASK) {
2408  case HT_DIR_X: new_drawstyle = HT_LINE | HT_DIR_X; break;
2409  case HT_DIR_Y: new_drawstyle = HT_LINE | HT_DIR_Y; break;
2410 
2411  case HT_DIR_HU:
2412  case HT_DIR_HL:
2413  new_drawstyle = (pt.x & TILE_UNIT_MASK) + (pt.y & TILE_UNIT_MASK) <= TILE_SIZE ? HT_LINE | HT_DIR_HU : HT_LINE | HT_DIR_HL;
2414  break;
2415 
2416  case HT_DIR_VL:
2417  case HT_DIR_VR:
2418  new_drawstyle = (pt.x & TILE_UNIT_MASK) > (pt.y & TILE_UNIT_MASK) ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
2419  break;
2420 
2421  default: NOT_REACHED();
2422  }
2423  _thd.selstart.x = x1 & ~TILE_UNIT_MASK;
2424  _thd.selstart.y = y1 & ~TILE_UNIT_MASK;
2425  break;
2426  default:
2427  NOT_REACHED();
2428  break;
2429  }
2430  _thd.new_pos.x = x1 & ~TILE_UNIT_MASK;
2431  _thd.new_pos.y = y1 & ~TILE_UNIT_MASK;
2432  }
2433  }
2434 
2435  /* redraw selection */
2436  if (_thd.drawstyle != new_drawstyle ||
2437  _thd.pos.x != _thd.new_pos.x || _thd.pos.y != _thd.new_pos.y ||
2438  _thd.size.x != _thd.new_size.x || _thd.size.y != _thd.new_size.y ||
2439  _thd.outersize.x != _thd.new_outersize.x ||
2440  _thd.outersize.y != _thd.new_outersize.y ||
2441  _thd.diagonal != new_diagonal) {
2442  /* Clear the old tile selection? */
2444 
2445  _thd.drawstyle = new_drawstyle;
2446  _thd.pos = _thd.new_pos;
2447  _thd.size = _thd.new_size;
2448  _thd.outersize = _thd.new_outersize;
2449  _thd.diagonal = new_diagonal;
2450  _thd.dirty = 0xff;
2451 
2452  /* Draw the new tile selection? */
2453  if ((new_drawstyle & HT_DRAG_MASK) != HT_NONE) SetSelectionTilesDirty();
2454  }
2455 }
2456 
2464 static inline void ShowMeasurementTooltips(StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_cond = TCC_LEFT_CLICK)
2465 {
2466  if (!_settings_client.gui.measure_tooltip) return;
2467  GuiShowTooltips(_thd.GetCallbackWnd(), str, paramcount, params, close_cond);
2468 }
2469 
2472 {
2473  _thd.select_method = method;
2474  _thd.select_proc = process;
2475  _thd.selend.x = TileX(tile) * TILE_SIZE;
2476  _thd.selstart.x = TileX(tile) * TILE_SIZE;
2477  _thd.selend.y = TileY(tile) * TILE_SIZE;
2478  _thd.selstart.y = TileY(tile) * TILE_SIZE;
2479 
2480  /* Needed so several things (road, autoroad, bridges, ...) are placed correctly.
2481  * In effect, placement starts from the centre of a tile
2482  */
2483  if (method == VPM_X_OR_Y || method == VPM_FIX_X || method == VPM_FIX_Y) {
2484  _thd.selend.x += TILE_SIZE / 2;
2485  _thd.selend.y += TILE_SIZE / 2;
2486  _thd.selstart.x += TILE_SIZE / 2;
2487  _thd.selstart.y += TILE_SIZE / 2;
2488  }
2489 
2490  HighLightStyle others = _thd.place_mode & ~(HT_DRAG_MASK | HT_DIR_MASK);
2491  if ((_thd.place_mode & HT_DRAG_MASK) == HT_RECT) {
2492  _thd.place_mode = HT_SPECIAL | others;
2493  _thd.next_drawstyle = HT_RECT | others;
2494  } else if (_thd.place_mode & (HT_RAIL | HT_LINE)) {
2495  _thd.place_mode = HT_SPECIAL | others;
2496  _thd.next_drawstyle = _thd.drawstyle | others;
2497  } else {
2498  _thd.place_mode = HT_SPECIAL | others;
2499  _thd.next_drawstyle = HT_POINT | others;
2500  }
2502 }
2503 
2504 void VpSetPlaceSizingLimit(int limit)
2505 {
2506  _thd.sizelimit = limit;
2507 }
2508 
2515 {
2516  uint64 distance = DistanceManhattan(from, to) + 1;
2517 
2518  _thd.selend.x = TileX(to) * TILE_SIZE;
2519  _thd.selend.y = TileY(to) * TILE_SIZE;
2520  _thd.selstart.x = TileX(from) * TILE_SIZE;
2521  _thd.selstart.y = TileY(from) * TILE_SIZE;
2522  _thd.next_drawstyle = HT_RECT;
2523 
2524  /* show measurement only if there is any length to speak of */
2525  if (distance > 1) ShowMeasurementTooltips(STR_MEASURE_LENGTH, 1, &distance, TCC_HOVER);
2526 }
2527 
2528 static void VpStartPreSizing()
2529 {
2530  _thd.selend.x = -1;
2532 }
2533 
2539 {
2540  int fxpy = _tile_fract_coords.x + _tile_fract_coords.y;
2541  int sxpy = (_thd.selend.x & TILE_UNIT_MASK) + (_thd.selend.y & TILE_UNIT_MASK);
2542  int fxmy = _tile_fract_coords.x - _tile_fract_coords.y;
2543  int sxmy = (_thd.selend.x & TILE_UNIT_MASK) - (_thd.selend.y & TILE_UNIT_MASK);
2544 
2545  switch (mode) {
2546  default: NOT_REACHED();
2547  case 0: // end piece is lower right
2548  if (fxpy >= 20 && sxpy <= 12) return HT_DIR_HL;
2549  if (fxmy < -3 && sxmy > 3) return HT_DIR_VR;
2550  return HT_DIR_Y;
2551 
2552  case 1:
2553  if (fxmy > 3 && sxmy < -3) return HT_DIR_VL;
2554  if (fxpy <= 12 && sxpy >= 20) return HT_DIR_HU;
2555  return HT_DIR_Y;
2556 
2557  case 2:
2558  if (fxmy > 3 && sxmy < -3) return HT_DIR_VL;
2559  if (fxpy >= 20 && sxpy <= 12) return HT_DIR_HL;
2560  return HT_DIR_X;
2561 
2562  case 3:
2563  if (fxmy < -3 && sxmy > 3) return HT_DIR_VR;
2564  if (fxpy <= 12 && sxpy >= 20) return HT_DIR_HU;
2565  return HT_DIR_X;
2566  }
2567 }
2568 
2582 static bool SwapDirection(HighLightStyle style, TileIndex start_tile, TileIndex end_tile)
2583 {
2584  uint start_x = TileX(start_tile);
2585  uint start_y = TileY(start_tile);
2586  uint end_x = TileX(end_tile);
2587  uint end_y = TileY(end_tile);
2588 
2589  switch (style & HT_DRAG_MASK) {
2590  case HT_RAIL:
2591  case HT_LINE: return (end_x > start_x || (end_x == start_x && end_y > start_y));
2592 
2593  case HT_RECT:
2594  case HT_POINT: return (end_x != start_x && end_y < start_y);
2595  default: NOT_REACHED();
2596  }
2597 
2598  return false;
2599 }
2600 
2616 static int CalcHeightdiff(HighLightStyle style, uint distance, TileIndex start_tile, TileIndex end_tile)
2617 {
2618  bool swap = SwapDirection(style, start_tile, end_tile);
2619  uint h0, h1; // Start height and end height.
2620 
2621  if (start_tile == end_tile) return 0;
2622  if (swap) Swap(start_tile, end_tile);
2623 
2624  switch (style & HT_DRAG_MASK) {
2625  case HT_RECT: {
2626  static const TileIndexDiffC heightdiff_area_by_dir[] = {
2627  /* Start */ {1, 0}, /* Dragging east */ {0, 0}, // Dragging south
2628  /* End */ {0, 1}, /* Dragging east */ {1, 1} // Dragging south
2629  };
2630 
2631  /* In the case of an area we can determine whether we were dragging south or
2632  * east by checking the X-coordinates of the tiles */
2633  byte style_t = (byte)(TileX(end_tile) > TileX(start_tile));
2634  start_tile = TILE_ADD(start_tile, ToTileIndexDiff(heightdiff_area_by_dir[style_t]));
2635  end_tile = TILE_ADD(end_tile, ToTileIndexDiff(heightdiff_area_by_dir[2 + style_t]));
2636  }
2637  FALLTHROUGH;
2638 
2639  case HT_POINT:
2640  h0 = TileHeight(start_tile);
2641  h1 = TileHeight(end_tile);
2642  break;
2643  default: { // All other types, this is mostly only line/autorail
2644  static const HighLightStyle flip_style_direction[] = {
2646  };
2647  static const TileIndexDiffC heightdiff_line_by_dir[] = {
2648  /* Start */ {1, 0}, {1, 1}, /* HT_DIR_X */ {0, 1}, {1, 1}, // HT_DIR_Y
2649  /* Start */ {1, 0}, {0, 0}, /* HT_DIR_HU */ {1, 0}, {1, 1}, // HT_DIR_HL
2650  /* Start */ {1, 0}, {1, 1}, /* HT_DIR_VL */ {0, 1}, {1, 1}, // HT_DIR_VR
2651 
2652  /* Start */ {0, 1}, {0, 0}, /* HT_DIR_X */ {1, 0}, {0, 0}, // HT_DIR_Y
2653  /* End */ {0, 1}, {0, 0}, /* HT_DIR_HU */ {1, 1}, {0, 1}, // HT_DIR_HL
2654  /* End */ {1, 0}, {0, 0}, /* HT_DIR_VL */ {0, 0}, {0, 1}, // HT_DIR_VR
2655  };
2656 
2657  distance %= 2; // we're only interested if the distance is even or uneven
2658  style &= HT_DIR_MASK;
2659 
2660  /* To handle autorail, we do some magic to be able to use a lookup table.
2661  * Firstly if we drag the other way around, we switch start&end, and if needed
2662  * also flip the drag-position. Eg if it was on the left, and the distance is even
2663  * that means the end, which is now the start is on the right */
2664  if (swap && distance == 0) style = flip_style_direction[style];
2665 
2666  /* Use lookup table for start-tile based on HighLightStyle direction */
2667  byte style_t = style * 2;
2668  assert(style_t < lengthof(heightdiff_line_by_dir) - 13);
2669  h0 = TileHeight(TILE_ADD(start_tile, ToTileIndexDiff(heightdiff_line_by_dir[style_t])));
2670  uint ht = TileHeight(TILE_ADD(start_tile, ToTileIndexDiff(heightdiff_line_by_dir[style_t + 1])));
2671  h0 = max(h0, ht);
2672 
2673  /* Use lookup table for end-tile based on HighLightStyle direction
2674  * flip around side (lower/upper, left/right) based on distance */
2675  if (distance == 0) style_t = flip_style_direction[style] * 2;
2676  assert(style_t < lengthof(heightdiff_line_by_dir) - 13);
2677  h1 = TileHeight(TILE_ADD(end_tile, ToTileIndexDiff(heightdiff_line_by_dir[12 + style_t])));
2678  ht = TileHeight(TILE_ADD(end_tile, ToTileIndexDiff(heightdiff_line_by_dir[12 + style_t + 1])));
2679  h1 = max(h1, ht);
2680  break;
2681  }
2682  }
2683 
2684  if (swap) Swap(h0, h1);
2685  return (int)(h1 - h0) * TILE_HEIGHT_STEP;
2686 }
2687 
2688 static const StringID measure_strings_length[] = {STR_NULL, STR_MEASURE_LENGTH, STR_MEASURE_LENGTH_HEIGHTDIFF};
2689 
2696 static void CheckUnderflow(int &test, int &other, int mult)
2697 {
2698  if (test >= 0) return;
2699 
2700  other += mult * test;
2701  test = 0;
2702 }
2703 
2711 static void CheckOverflow(int &test, int &other, int max, int mult)
2712 {
2713  if (test <= max) return;
2714 
2715  other += mult * (test - max);
2716  test = max;
2717 }
2718 
2720 static void CalcRaildirsDrawstyle(int x, int y, int method)
2721 {
2722  HighLightStyle b;
2723 
2724  int dx = _thd.selstart.x - (_thd.selend.x & ~TILE_UNIT_MASK);
2725  int dy = _thd.selstart.y - (_thd.selend.y & ~TILE_UNIT_MASK);
2726  uint w = abs(dx) + TILE_SIZE;
2727  uint h = abs(dy) + TILE_SIZE;
2728 
2729  if (method & ~(VPM_RAILDIRS | VPM_SIGNALDIRS)) {
2730  /* We 'force' a selection direction; first four rail buttons. */
2731  method &= ~(VPM_RAILDIRS | VPM_SIGNALDIRS);
2732  int raw_dx = _thd.selstart.x - _thd.selend.x;
2733  int raw_dy = _thd.selstart.y - _thd.selend.y;
2734  switch (method) {
2735  case VPM_FIX_X:
2736  b = HT_LINE | HT_DIR_Y;
2737  x = _thd.selstart.x;
2738  break;
2739 
2740  case VPM_FIX_Y:
2741  b = HT_LINE | HT_DIR_X;
2742  y = _thd.selstart.y;
2743  break;
2744 
2745  case VPM_FIX_HORIZONTAL:
2746  if (dx == -dy) {
2747  /* We are on a straight horizontal line. Determine the 'rail'
2748  * to build based the sub tile location. */
2750  } else {
2751  /* We are not on a straight line. Determine the rail to build
2752  * based on whether we are above or below it. */
2753  b = dx + dy >= (int)TILE_SIZE ? HT_LINE | HT_DIR_HU : HT_LINE | HT_DIR_HL;
2754 
2755  /* Calculate where a horizontal line through the start point and
2756  * a vertical line from the selected end point intersect and
2757  * use that point as the end point. */
2758  int offset = (raw_dx - raw_dy) / 2;
2759  x = _thd.selstart.x - (offset & ~TILE_UNIT_MASK);
2760  y = _thd.selstart.y + (offset & ~TILE_UNIT_MASK);
2761 
2762  /* 'Build' the last half rail tile if needed */
2763  if ((offset & TILE_UNIT_MASK) > (TILE_SIZE / 2)) {
2764  if (dx + dy >= (int)TILE_SIZE) {
2765  x += (dx + dy < 0) ? (int)TILE_SIZE : -(int)TILE_SIZE;
2766  } else {
2767  y += (dx + dy < 0) ? (int)TILE_SIZE : -(int)TILE_SIZE;
2768  }
2769  }
2770 
2771  /* Make sure we do not overflow the map! */
2772  CheckUnderflow(x, y, 1);
2773  CheckUnderflow(y, x, 1);
2774  CheckOverflow(x, y, (MapMaxX() - 1) * TILE_SIZE, 1);
2775  CheckOverflow(y, x, (MapMaxY() - 1) * TILE_SIZE, 1);
2776  assert(x >= 0 && y >= 0 && x <= (int)(MapMaxX() * TILE_SIZE) && y <= (int)(MapMaxY() * TILE_SIZE));
2777  }
2778  break;
2779 
2780  case VPM_FIX_VERTICAL:
2781  if (dx == dy) {
2782  /* We are on a straight vertical line. Determine the 'rail'
2783  * to build based the sub tile location. */
2784  b = (x & TILE_UNIT_MASK) > (y & TILE_UNIT_MASK) ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
2785  } else {
2786  /* We are not on a straight line. Determine the rail to build
2787  * based on whether we are left or right from it. */
2788  b = dx < dy ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
2789 
2790  /* Calculate where a vertical line through the start point and
2791  * a horizontal line from the selected end point intersect and
2792  * use that point as the end point. */
2793  int offset = (raw_dx + raw_dy + (int)TILE_SIZE) / 2;
2794  x = _thd.selstart.x - (offset & ~TILE_UNIT_MASK);
2795  y = _thd.selstart.y - (offset & ~TILE_UNIT_MASK);
2796 
2797  /* 'Build' the last half rail tile if needed */
2798  if ((offset & TILE_UNIT_MASK) > (TILE_SIZE / 2)) {
2799  if (dx - dy < 0) {
2800  y += (dx > dy) ? (int)TILE_SIZE : -(int)TILE_SIZE;
2801  } else {
2802  x += (dx < dy) ? (int)TILE_SIZE : -(int)TILE_SIZE;
2803  }
2804  }
2805 
2806  /* Make sure we do not overflow the map! */
2807  CheckUnderflow(x, y, -1);
2808  CheckUnderflow(y, x, -1);
2809  CheckOverflow(x, y, (MapMaxX() - 1) * TILE_SIZE, -1);
2810  CheckOverflow(y, x, (MapMaxY() - 1) * TILE_SIZE, -1);
2811  assert(x >= 0 && y >= 0 && x <= (int)(MapMaxX() * TILE_SIZE) && y <= (int)(MapMaxY() * TILE_SIZE));
2812  }
2813  break;
2814 
2815  default:
2816  NOT_REACHED();
2817  }
2818  } else if (TileVirtXY(_thd.selstart.x, _thd.selstart.y) == TileVirtXY(x, y)) { // check if we're only within one tile
2819  if (method & VPM_RAILDIRS) {
2820  b = GetAutorailHT(x, y);
2821  } else { // rect for autosignals on one tile
2822  b = HT_RECT;
2823  }
2824  } else if (h == TILE_SIZE) { // Is this in X direction?
2825  if (dx == (int)TILE_SIZE) { // 2x1 special handling
2826  b = (Check2x1AutoRail(3)) | HT_LINE;
2827  } else if (dx == -(int)TILE_SIZE) {
2828  b = (Check2x1AutoRail(2)) | HT_LINE;
2829  } else {
2830  b = HT_LINE | HT_DIR_X;
2831  }
2832  y = _thd.selstart.y;
2833  } else if (w == TILE_SIZE) { // Or Y direction?
2834  if (dy == (int)TILE_SIZE) { // 2x1 special handling
2835  b = (Check2x1AutoRail(1)) | HT_LINE;
2836  } else if (dy == -(int)TILE_SIZE) { // 2x1 other direction
2837  b = (Check2x1AutoRail(0)) | HT_LINE;
2838  } else {
2839  b = HT_LINE | HT_DIR_Y;
2840  }
2841  x = _thd.selstart.x;
2842  } else if (w > h * 2) { // still count as x dir?
2843  b = HT_LINE | HT_DIR_X;
2844  y = _thd.selstart.y;
2845  } else if (h > w * 2) { // still count as y dir?
2846  b = HT_LINE | HT_DIR_Y;
2847  x = _thd.selstart.x;
2848  } else { // complicated direction
2849  int d = w - h;
2850  _thd.selend.x = _thd.selend.x & ~TILE_UNIT_MASK;
2851  _thd.selend.y = _thd.selend.y & ~TILE_UNIT_MASK;
2852 
2853  /* four cases. */
2854  if (x > _thd.selstart.x) {
2855  if (y > _thd.selstart.y) {
2856  /* south */
2857  if (d == 0) {
2858  b = (x & TILE_UNIT_MASK) > (y & TILE_UNIT_MASK) ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
2859  } else if (d >= 0) {
2860  x = _thd.selstart.x + h;
2861  b = HT_LINE | HT_DIR_VL;
2862  } else {
2863  y = _thd.selstart.y + w;
2864  b = HT_LINE | HT_DIR_VR;
2865  }
2866  } else {
2867  /* west */
2868  if (d == 0) {
2870  } else if (d >= 0) {
2871  x = _thd.selstart.x + h;
2872  b = HT_LINE | HT_DIR_HL;
2873  } else {
2874  y = _thd.selstart.y - w;
2875  b = HT_LINE | HT_DIR_HU;
2876  }
2877  }
2878  } else {
2879  if (y > _thd.selstart.y) {
2880  /* east */
2881  if (d == 0) {
2883  } else if (d >= 0) {
2884  x = _thd.selstart.x - h;
2885  b = HT_LINE | HT_DIR_HU;
2886  } else {
2887  y = _thd.selstart.y + w;
2888  b = HT_LINE | HT_DIR_HL;
2889  }
2890  } else {
2891  /* north */
2892  if (d == 0) {
2893  b = (x & TILE_UNIT_MASK) > (y & TILE_UNIT_MASK) ? HT_LINE | HT_DIR_VL : HT_LINE | HT_DIR_VR;
2894  } else if (d >= 0) {
2895  x = _thd.selstart.x - h;
2896  b = HT_LINE | HT_DIR_VR;
2897  } else {
2898  y = _thd.selstart.y - w;
2899  b = HT_LINE | HT_DIR_VL;
2900  }
2901  }
2902  }
2903  }
2904 
2906  TileIndex t0 = TileVirtXY(_thd.selstart.x, _thd.selstart.y);
2907  TileIndex t1 = TileVirtXY(x, y);
2908  uint distance = DistanceManhattan(t0, t1) + 1;
2909  byte index = 0;
2910  uint64 params[2];
2911 
2912  if (distance != 1) {
2913  int heightdiff = CalcHeightdiff(b, distance, t0, t1);
2914  /* If we are showing a tooltip for horizontal or vertical drags,
2915  * 2 tiles have a length of 1. To bias towards the ceiling we add
2916  * one before division. It feels more natural to count 3 lengths as 2 */
2917  if ((b & HT_DIR_MASK) != HT_DIR_X && (b & HT_DIR_MASK) != HT_DIR_Y) {
2918  distance = CeilDiv(distance, 2);
2919  }
2920 
2921  params[index++] = distance;
2922  if (heightdiff != 0) params[index++] = heightdiff;
2923  }
2924 
2925  ShowMeasurementTooltips(measure_strings_length[index], index, params);
2926  }
2927 
2928  _thd.selend.x = x;
2929  _thd.selend.y = y;
2930  _thd.next_drawstyle = b;
2931 }
2932 
2941 {
2942  int sx, sy;
2943  HighLightStyle style;
2944 
2945  if (x == -1) {
2946  _thd.selend.x = -1;
2947  return;
2948  }
2949 
2950  /* Special handling of drag in any (8-way) direction */
2951  if (method & (VPM_RAILDIRS | VPM_SIGNALDIRS)) {
2952  _thd.selend.x = x;
2953  _thd.selend.y = y;
2954  CalcRaildirsDrawstyle(x, y, method);
2955  return;
2956  }
2957 
2958  /* Needed so level-land is placed correctly */
2959  if ((_thd.next_drawstyle & HT_DRAG_MASK) == HT_POINT) {
2960  x += TILE_SIZE / 2;
2961  y += TILE_SIZE / 2;
2962  }
2963 
2964  sx = _thd.selstart.x;
2965  sy = _thd.selstart.y;
2966 
2967  int limit = 0;
2968 
2969  switch (method) {
2970  case VPM_X_OR_Y: // drag in X or Y direction
2971  if (abs(sy - y) < abs(sx - x)) {
2972  y = sy;
2973  style = HT_DIR_X;
2974  } else {
2975  x = sx;
2976  style = HT_DIR_Y;
2977  }
2978  goto calc_heightdiff_single_direction;
2979 
2980  case VPM_X_LIMITED: // Drag in X direction (limited size).
2981  limit = (_thd.sizelimit - 1) * TILE_SIZE;
2982  FALLTHROUGH;
2983 
2984  case VPM_FIX_X: // drag in Y direction
2985  x = sx;
2986  style = HT_DIR_Y;
2987  goto calc_heightdiff_single_direction;
2988 
2989  case VPM_Y_LIMITED: // Drag in Y direction (limited size).
2990  limit = (_thd.sizelimit - 1) * TILE_SIZE;
2991  FALLTHROUGH;
2992 
2993  case VPM_FIX_Y: // drag in X direction
2994  y = sy;
2995  style = HT_DIR_X;
2996 
2997 calc_heightdiff_single_direction:;
2998  if (limit > 0) {
2999  x = sx + Clamp(x - sx, -limit, limit);
3000  y = sy + Clamp(y - sy, -limit, limit);
3001  }
3003  TileIndex t0 = TileVirtXY(sx, sy);
3004  TileIndex t1 = TileVirtXY(x, y);
3005  uint distance = DistanceManhattan(t0, t1) + 1;
3006  byte index = 0;
3007  uint64 params[2];
3008 
3009  if (distance != 1) {
3010  /* With current code passing a HT_LINE style to calculate the height
3011  * difference is enough. However if/when a point-tool is created
3012  * with this method, function should be called with new_style (below)
3013  * instead of HT_LINE | style case HT_POINT is handled specially
3014  * new_style := (_thd.next_drawstyle & HT_RECT) ? HT_LINE | style : _thd.next_drawstyle; */
3015  int heightdiff = CalcHeightdiff(HT_LINE | style, 0, t0, t1);
3016 
3017  params[index++] = distance;
3018  if (heightdiff != 0) params[index++] = heightdiff;
3019  }
3020 
3021  ShowMeasurementTooltips(measure_strings_length[index], index, params);
3022  }
3023  break;
3024 
3025  case VPM_X_AND_Y_LIMITED: // Drag an X by Y constrained rect area.
3026  limit = (_thd.sizelimit - 1) * TILE_SIZE;
3027  x = sx + Clamp(x - sx, -limit, limit);
3028  y = sy + Clamp(y - sy, -limit, limit);
3029  FALLTHROUGH;
3030 
3031  case VPM_X_AND_Y: // drag an X by Y area
3033  static const StringID measure_strings_area[] = {
3034  STR_NULL, STR_NULL, STR_MEASURE_AREA, STR_MEASURE_AREA_HEIGHTDIFF
3035  };
3036 
3037  TileIndex t0 = TileVirtXY(sx, sy);
3038  TileIndex t1 = TileVirtXY(x, y);
3039  uint dx = Delta(TileX(t0), TileX(t1)) + 1;
3040  uint dy = Delta(TileY(t0), TileY(t1)) + 1;
3041  byte index = 0;
3042  uint64 params[3];
3043 
3044  /* If dragging an area (eg dynamite tool) and it is actually a single
3045  * row/column, change the type to 'line' to get proper calculation for height */
3046  style = (HighLightStyle)_thd.next_drawstyle;
3047  if (_thd.IsDraggingDiagonal()) {
3048  /* Determine the "area" of the diagonal dragged selection.
3049  * We assume the area is the number of tiles along the X
3050  * edge and the number of tiles along the Y edge. However,
3051  * multiplying these two numbers does not give the exact
3052  * number of tiles; basically we are counting the black
3053  * squares on a chess board and ignore the white ones to
3054  * make the tile counts at the edges match up. There is no
3055  * other way to make a proper count though.
3056  *
3057  * First convert to the rotated coordinate system. */
3058  int dist_x = TileX(t0) - TileX(t1);
3059  int dist_y = TileY(t0) - TileY(t1);
3060  int a_max = dist_x + dist_y;
3061  int b_max = dist_y - dist_x;
3062 
3063  /* Now determine the size along the edge, but due to the
3064  * chess board principle this counts double. */
3065  a_max = abs(a_max + (a_max > 0 ? 2 : -2)) / 2;
3066  b_max = abs(b_max + (b_max > 0 ? 2 : -2)) / 2;
3067 
3068  /* We get a 1x1 on normal 2x1 rectangles, due to it being
3069  * a seen as two sides. As the result for actual building
3070  * will be the same as non-diagonal dragging revert to that
3071  * behaviour to give it a more normally looking size. */
3072  if (a_max != 1 || b_max != 1) {
3073  dx = a_max;
3074  dy = b_max;
3075  }
3076  } else if (style & HT_RECT) {
3077  if (dx == 1) {
3078  style = HT_LINE | HT_DIR_Y;
3079  } else if (dy == 1) {
3080  style = HT_LINE | HT_DIR_X;
3081  }
3082  }
3083 
3084  if (dx != 1 || dy != 1) {
3085  int heightdiff = CalcHeightdiff(style, 0, t0, t1);
3086 
3087  params[index++] = dx - (style & HT_POINT ? 1 : 0);
3088  params[index++] = dy - (style & HT_POINT ? 1 : 0);
3089  if (heightdiff != 0) params[index++] = heightdiff;
3090  }
3091 
3092  ShowMeasurementTooltips(measure_strings_area[index], index, params);
3093  }
3094  break;
3095 
3096  default: NOT_REACHED();
3097  }
3098 
3099  _thd.selend.x = x;
3100  _thd.selend.y = y;
3101 }
3102 
3108 {
3110 
3111  /* stop drag mode if the window has been closed */
3112  Window *w = _thd.GetCallbackWnd();
3113  if (w == NULL) {
3115  return ES_HANDLED;
3116  }
3117 
3118  /* while dragging execute the drag procedure of the corresponding window (mostly VpSelectTilesWithMethod() ) */
3119  if (_left_button_down) {
3120  w->OnPlaceDrag(_thd.select_method, _thd.select_proc, GetTileBelowCursor());
3121  return ES_HANDLED;
3122  }
3123 
3124  /* mouse button released..
3125  * keep the selected tool, but reset it to the original mode. */
3127  HighLightStyle others = _thd.place_mode & ~(HT_DRAG_MASK | HT_DIR_MASK);
3128  if ((_thd.next_drawstyle & HT_DRAG_MASK) == HT_RECT) {
3129  _thd.place_mode = HT_RECT | others;
3130  } else if (_thd.select_method & VPM_SIGNALDIRS) {
3131  _thd.place_mode = HT_RECT | others;
3132  } else if (_thd.select_method & VPM_RAILDIRS) {
3133  _thd.place_mode = (_thd.select_method & ~VPM_RAILDIRS) ? _thd.next_drawstyle : (HT_RAIL | others);
3134  } else {
3135  _thd.place_mode = HT_POINT | others;
3136  }
3137  SetTileSelectSize(1, 1);
3138 
3139  w->OnPlaceMouseUp(_thd.select_method, _thd.select_proc, _thd.selend, TileVirtXY(_thd.selstart.x, _thd.selstart.y), TileVirtXY(_thd.selend.x, _thd.selend.y));
3140 
3141  return ES_HANDLED;
3142 }
3143 
3152 {
3153  SetObjectToPlace(icon, pal, mode, w->window_class, w->window_number);
3154 }
3155 
3156 #include "table/animcursors.h"
3157 
3166 void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowClass window_class, WindowNumber window_num)
3167 {
3168  if (_thd.window_class != WC_INVALID) {
3169  /* Undo clicking on button and drag & drop */
3170  Window *w = _thd.GetCallbackWnd();
3171  /* Call the abort function, but set the window class to something
3172  * that will never be used to avoid infinite loops. Setting it to
3173  * the 'next' window class must not be done because recursion into
3174  * this function might in some cases reset the newly set object to
3175  * place or not properly reset the original selection. */
3176  _thd.window_class = WC_INVALID;
3177  if (w != NULL) w->OnPlaceObjectAbort();
3178  }
3179 
3180  /* Mark the old selection dirty, in case the selection shape or colour changes */
3182 
3183  SetTileSelectSize(1, 1);
3184 
3185  _thd.make_square_red = false;
3186 
3187  if (mode == HT_DRAG) { // HT_DRAG is for dragdropping trains in the depot window
3188  mode = HT_NONE;
3190  } else {
3192  }
3193 
3194  _thd.place_mode = mode;
3195  _thd.window_class = window_class;
3196  _thd.window_number = window_num;
3197 
3198  if ((mode & HT_DRAG_MASK) == HT_SPECIAL) { // special tools, like tunnels or docks start with presizing mode
3199  VpStartPreSizing();
3200  }
3201 
3202  if ((icon & ANIMCURSOR_FLAG) != 0) {
3203  SetAnimatedMouseCursor(_animcursors[icon & ~ANIMCURSOR_FLAG]);
3204  } else {
3205  SetMouseCursor(icon, pal);
3206  }
3207 
3208 }
3209 
3212 {
3214 }
3215 
3216 Point GetViewportStationMiddle(const ViewPort *vp, const Station *st)
3217 {
3218  int x = TileX(st->xy) * TILE_SIZE;
3219  int y = TileY(st->xy) * TILE_SIZE;
3220  int z = GetSlopePixelZ(Clamp(x, 0, MapSizeX() * TILE_SIZE - 1), Clamp(y, 0, MapSizeY() * TILE_SIZE - 1));
3221 
3222  Point p = RemapCoords(x, y, z);
3223  p.x = UnScaleByZoom(p.x - vp->virtual_left, vp->zoom) + vp->left;
3224  p.y = UnScaleByZoom(p.y - vp->virtual_top, vp->zoom) + vp->top;
3225  return p;
3226 }
3227 
3232 };
3233 
3236 #ifdef WITH_SSE
3237  { &ViewportSortParentSpritesSSE41Checker, &ViewportSortParentSpritesSSE41 },
3238 #endif
3240 };
3241 
3244 {
3245  for (uint i = 0; i < lengthof(_vp_sprite_sorters); i++) {
3246  if (_vp_sprite_sorters[i].fct_checker()) {
3247  _vp_sprite_sorter = _vp_sprite_sorters[i].fct_sorter;
3248  break;
3249  }
3250  }
3251  assert(_vp_sprite_sorter != NULL);
3252 }
EventState
State of handling an event.
Definition: window_type.h:701
void ViewportAddVehicles(DrawPixelInfo *dpi)
Add the vehicle sprites that should be drawn at a part of the screen.
Definition: vehicle.cpp:1103
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
Definition: main_gui.cpp:143
Functions related to OTTD&#39;s strings.
static TileType GetTileType(TileIndex tile)
Get the tiletype of a given tile.
Definition: tile_map.h:89
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you&#39;ve selected it...
Definition: viewport_type.h:97
Y direction.
bool measure_tooltip
show a permanent tooltip when dragging tools
Definition: settings_type.h:91
static bool IsHalftileSlope(Slope s)
Checks for non-continuous slope on halftile foundations.
Definition: slope_func.h:49
static void DrawAutorailSelection(const TileInfo *ti, uint autorail_type)
Draws autorail highlights.
Definition: viewport.cpp:977
static const PaletteID PALETTE_SEL_TILE_RED
makes a square red. is used when removing rails or other stuff
Definition: sprites.h:1534
static void Swap(T &a, T &b)
Type safe swap operation.
Definition: math_func.hpp:277
the north corner of the tile is raised
Definition: slope_type.h:55
Corner
Enumeration of tile corners.
Definition: slope_type.h:24
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:20
static const uint TILE_PIXELS
Pixel distance between tile columns/rows in #ZOOM_LVL_BASE.
Definition: tile_type.h:17
WindowNumber window_number
The WindowNumber of the window that is responsible for the selection mode.
static int SearchMapEdge(Point &curr_tile, int &iter, int iter_limit, int offset, int sy_limit, ContinueMapEdgeSearch continue_criteria)
Searches, starting at the given tile, by applying the given offset to iter, for a no longer visible t...
Definition: viewport.cpp:1693
uint8 max_heightlevel
maximum allowed heightlevel
static uint MapSizeX()
Get the size of the map along the X.
Definition: map_func.h:74
static const int MAX_TILE_EXTENT_RIGHT
Maximum right extent of tile relative to north corner.
Definition: viewport.cpp:99
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
bool ContinueMapEdgeSearch(int iter, int iter_limit, int sy, int sy_limit)
Continue criteria for the SearchMapEdge function.
Definition: viewport.cpp:1673
bool IsDraggingDiagonal()
Is the user dragging a &#39;diagonal rectangle&#39;?
Definition: viewport.cpp:2332
int32 zmin
minimal world Z coordinate of bounding box
int32 zmax
maximal world Z coordinate of bounding box
static const PaletteID PALETTE_TO_TRANSPARENT
This sets the sprite to transparent.
Definition: sprites.h:1566
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
Definition: window.cpp:1854
void ShowWaypointWindow(const Waypoint *wp)
Show the window for the given waypoint.
int virtual_left
Virtual left coordinate.
Definition: viewport_type.h:30
int32 top
minimal screen Y coordinate of sprite (= y + sprite->y_offs), reference point for child sprites ...
void InitializeWindowViewport(Window *w, int x, int y, int width, int height, uint32 follow_flags, ZoomLevel zoom)
Initialize viewport of the window for use.
Definition: viewport.cpp:212
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:2582
Begin for iteration.
Definition: zoom_type.h:23
Data about how and where to blit pixels.
Definition: gfx_type.h:156
static uint MapSizeY()
Get the size of the map along the Y.
Definition: map_func.h:84
Horizontally center the text.
Definition: gfx_func.h:99
Tile information, used while rendering the tile.
Definition: tile_cmd.h:44
Sprite combining will start with the next unclipped sprite.
Definition: viewport.cpp:143
SpriteCombineMode
Mode of "sprite combining".
Definition: viewport.cpp:141
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:387
Point pos
Location, in tile "units", of the northern tile of the selected area.
No special mouse mode.
Definition: window_gui.h:897
Point pos
logical mouse position
Definition: gfx_type.h:119
All zoomlevels below or equal to this, will result in details on the screen, like road-work...
Definition: zoom_type.h:45
area of land of limited size
Definition: viewport_type.h:83
void(* VpSpriteSorter)(ParentSpriteToSortVector *psd)
Type for the actual viewport sprite sorter.
ZoomLevelByte zoom_max
maximum zoom out level
The mask to for the main sprite.
Definition: sprites.h:1519
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:1533
uint32 GetCompanyMask()
Get a bitmask of the currently shown companies.
Definition: linkgraph_gui.h:67
uint32 GetCargoMask()
Get a bitmask of the currently shown cargoes.
Definition: linkgraph_gui.h:64
signs
Definition: transparency.h:25
byte _display_opt
What do we want to draw/do?
int left
x position of left edge of the window
Definition: window_gui.h:312
End for iteration.
Definition: zoom_type.h:30
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Definition: window.cpp:78
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
Zoom out (get helicopter view).
Definition: viewport_type.h:64
static int GetTilePixelZ(TileIndex tile)
Get bottom height of the tile.
Definition: tile_map.h:287
int height
Screen height of the viewport.
Definition: viewport_type.h:28
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
int32 y
screen Y coordinate of sprite
Definition: viewport.cpp:117
Display waypoint names.
Definition: openttd.h:48
void HandleZoomMessage(Window *w, const ViewPort *vp, byte widget_zoom_in, byte widget_zoom_out)
Update the status of the zoom-buttons according to the zoom-level of the viewport.
Definition: viewport.cpp:506
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:83
static bool IsInsideMM(const T x, const uint min, const uint max)
Checks if a value is in an interval.
Definition: math_func.hpp:266
vertical right
static bool ContinueUpperMapEdgeSearch(int iter, int iter_limit, int sy, int sy_limit)
Continue criteria for searching a no-longer-visible tile in positive direction, starting at some tile...
Definition: viewport.cpp:1678
VpSorterChecker fct_checker
The check function.
Definition: viewport.cpp:3230
TileType
The different types of tiles.
Definition: tile_type.h:42
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:577
static int UnScaleByZoomLower(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL)
Definition: zoom_func.h:61
int next
next child to draw (-1 at the end)
Definition: viewport.cpp:126
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Dragging an object.
Definition: window_gui.h:898
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1105
The passed event is not handled.
Definition: window_type.h:703
X direction.
Display station names.
Definition: openttd.h:44
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:53
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
Definition: viewport.cpp:2295
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:37
drag only in X axis
Definition: viewport_type.h:80
Data structure describing a sprite.
Definition: spritecache.h:18
Slope tileh
Slope of the tile.
Definition: tile_cmd.h:47
Sprite combining is active. AddSortableSpriteToDraw outputs child sprites.
Definition: viewport.cpp:144
Drag only in X axis with limited size.
Definition: viewport_type.h:86
static const AnimCursor *const _animcursors[]
This is an array of pointers to all the animated cursor definitions we have above.
Definition: animcursors.h:87
similar to VMP_RAILDIRS, but with different cursor
Definition: viewport_type.h:89
bool IsInUse() const
Check whether the base station currently is in use; in use means that it is not scheduled for deletio...
void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition: misc_gui.cpp:742
Slope GetTilePixelSlopeOutsideMap(int x, int y, int *h)
Return the slope of a given tile outside the map.
Definition: tile_map.cpp:141
static void CheckUnderflow(int &test, int &other, int mult)
Check for underflowing the map.
Definition: viewport.cpp:2696
Point size
Size, in tile "units", of the white/red selection area.
virtual void SetPixel(void *video, int x, int y, uint8 colour)=0
Draw a pixel with a given colour on the video-buffer.
bool population_in_label
show the population of a town in his label?
drag only in Y axis
Definition: viewport_type.h:81
Drag only in Y axis with limited size.
Definition: viewport_type.h:87
Functions related to vehicles.
static const int MAX_TILE_EXTENT_LEFT
Maximum left extent of tile relative to north corner.
Definition: viewport.cpp:98
int virtual_height
height << zoom
Definition: viewport_type.h:33
Point new_size
New value for size; used to determine whether to redraw the selection.
static void ShowMeasurementTooltips(StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_cond=TCC_LEFT_CLICK)
Displays the measurement tooltips when selecting multiple tiles.
Definition: viewport.cpp:2464
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:207
Vehicle data structure.
Definition: vehicle_base.h:212
Point new_pos
New value for pos; used to determine whether to redraw the selection.
int top
y position of top edge of the window
Definition: window_gui.h:313
static bool IsExpected(const BaseStation *st)
Helper for checking whether the given station is of this type.
static bool IsInsideBS(const T x, const uint base, const uint size)
Checks if a value is between a window started at some base point.
Definition: math_func.hpp:250
void Clear()
Remove all items from the list.
Display town names.
Definition: openttd.h:43
static int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL) When shifting right...
Definition: zoom_func.h:24
const T * Begin() const
Get the pointer to the first item (const)
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
int foundation[FOUNDATION_PART_END]
Foundation sprites (index into parent_sprites_to_draw).
Definition: viewport.cpp:166
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
Definition: gfx_func.h:87
static bool IsSteepSlope(Slope s)
Checks if a slope is steep.
Definition: slope_func.h:38
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
Definition: openttd.h:49
Zoom in (get more detailed view).
Definition: viewport_type.h:63
Maximum number of sprites that can be loaded at a given time.
Definition: sprites.h:1518
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
The client is spectating.
Definition: company_type.h:37
void Draw(const DrawPixelInfo *dpi) const
Draw the linkgraph overlay or some part of it, in the area given.
SpriteCombineMode combine_sprites
Current mode of "sprite combining".
Definition: viewport.cpp:164
Second part (halftile foundation)
Definition: viewport.cpp:133
static Corner GetHalftileSlopeCorner(Slope s)
Returns the leveled halftile of a halftile slope.
Definition: slope_func.h:150
WindowClass
Window classes.
Definition: window_type.h:39
ParentSpriteToSortVector parent_sprites_to_sort
Parent sprite pointer array used for sorting.
Definition: viewport.cpp:159
The most basic (normal) sprite.
Definition: gfx_type.h:298
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:758
Invalid window.
Definition: window_type.h:684
virtual void OnPlaceObjectAbort()
The user cancelled a tile highlight mode that has been set.
Definition: window_gui.h:748
How all blitters should look like.
Definition: base.hpp:30
static Slope SlopeWithOneCornerRaised(Corner corner)
Returns the slope with a specific corner raised.
Definition: slope_func.h:101
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:57
void StartSpriteCombine()
Starts a block of sprites, which are "combined" into a single bounding box.
Definition: viewport.cpp:785
Functions related to signs.
void UpdatePosition(int center, int top, StringID str, StringID str_small=STR_NULL)
Update the position of the viewport sign.
Definition: viewport.cpp:1314
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:26
vertical left
uint32 population
Current population of people.
Definition: town.h:47
Presizing mode (docks, tunnels).
Definition: window_gui.h:900
void RebuildCache()
Rebuild the cache and recalculate which links and stations to be shown.
const T * End() const
Get the pointer behind the last valid item (const)
Functions related to the vehicle&#39;s GUIs.
Left margin.
Definition: viewport_type.h:41
int z
Height.
Definition: tile_cmd.h:49
Window * GetCallbackWnd()
Get the window that started the current highlighting.
Definition: viewport.cpp:2341
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:15
FoundationPart foundation_part
Currently active foundation for ground sprite drawing.
Definition: viewport.cpp:167
void MarkDirty(ZoomLevel maxzoom=ZOOM_LVL_MAX) const
Mark the sign dirty in all viewports.
Definition: viewport.cpp:1341
int32 x
screen X coordinate of sprite
Definition: viewport.cpp:116
Highlight/sprite information for autorail.
HighLightStyle place_mode
Method which is used to place the selection.
Functions, definitions and such used only by the GUI.
TileIndex GetNorthernBridgeEnd(TileIndex t)
Finds the northern end of a bridge starting at a middle tile.
Definition: bridge_map.cpp:41
static Waypoint * From(BaseStation *st)
Converts a BaseStation to SpecializedStation with type checking.
Display signs.
Definition: openttd.h:45
Point foundation_offset[FOUNDATION_PART_END]
Pixel offset for ground sprites on the foundations.
Definition: viewport.cpp:169
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:177
Right margin.
Definition: viewport_type.h:42
T * Append(uint to_add=1)
Append an item and return it.
CompanyByte _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
Functions related to (drawing on) viewports.
void MarkTileDirtyByTileOutsideMap(int x, int y)
Mark a (virtual) tile outside the map dirty for repaint.
Definition: viewport.cpp:1920
The object is owned by a superuser / goal script.
Definition: company_type.h:29
Declaration of linkgraph overlay GUI.
bool freeform_edges
allow terraforming the tiles at the map edges
Data structure for an opened window.
Definition: window_gui.h:271
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:36
Data structure storing rendering information.
Definition: viewport.cpp:153
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
Definition: tile_map.h:154
void EndSpriteCombine()
Terminates a block of sprites started by StartSpriteCombine.
Definition: viewport.cpp:795
static bool IsBridgeAbove(TileIndex t)
checks if a bridge is set above the ground of this tile
Definition: bridge_map.h:45
Point TranslateXYToTileCoord(const ViewPort *vp, int x, int y, bool clamp_to_map)
Translate screen coordinate in a viewport to a tile coordinate.
Definition: viewport.cpp:405
dragging items in the depot windows
ViewportSign sign
NOSAVE: Dimensions of sign.
static HighLightStyle GetAutorailHT(int x, int y)
returns the best autorail highlight type from map coordinates
Definition: viewport.cpp:2312
Point selstart
The location where the dragging started.
Main window; Window numbers:
Definition: window_type.h:46
byte sizelimit
Whether the selection is limited in length, and what the maximum length is.
First part (normal foundation or no foundation)
Definition: viewport.cpp:132
Point selend
The location where the drag currently ends.
uint x
X position of the tile in unit coordinates.
Definition: tile_cmd.h:45
Every AddSortableSpriteToDraw start its own bounding box.
Definition: viewport.cpp:142
int16 y_offs
Number of pixels to shift the sprite downwards.
Definition: spritecache.h:22
ViewportSign sign
Location of name sign, UpdateVirtCoord updates this.
Definition: town.h:48
TileIndex tile
Tile index.
Definition: tile_cmd.h:48
UnitID unitnumber
unit number, for display purposes only
Definition: vehicle_base.h:291
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:177
int32 ymin
minimal world Y coordinate of bounding box
uint Length() const
Get the number of items in the list.
int32 first_child
the first child to draw.
masks the drag-direction
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Definition: viewport.cpp:3211
static T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
Definition: math_func.hpp:97
Number of zoom levels.
Definition: zoom_type.h:32
int32 top
The top of the sign.
Definition: viewport_type.h:50
void SetRedErrorSquare(TileIndex tile)
Set a tile to display a red error square.
Definition: viewport.cpp:2277
void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process)
highlighting tiles while only going over them with the mouse
Definition: viewport.cpp:2471
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:3166
int32 x
screen X coordinate of sprite
void MarkAllViewportsDirty(int left, int top, int right, int bottom)
Mark all viewports that display an area as dirty (in need of repaint).
Definition: viewport.cpp:1872
Point offs
Offset, in tile "units", for the blue coverage area from the selected area&#39;s northern tile...
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:18
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
Definition: viewport_type.h:78
static int ClampXYToMap(Point &curr_tile, int &iter, int iter_limit, int start, int &other_ref, int other_value, int vp_value, int other_limit, int vp_top, int vp_bottom)
Determine the clamping of either the X or Y coordinate to the map.
Definition: viewport.cpp:1718
end marker
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
Draw a sprite in a viewport.
Definition: gfx.cpp:806
bool _left_button_down
Is left mouse button pressed?
Definition: gfx.cpp:39
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:180
drag in X or Y direction
Definition: viewport_type.h:79
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:76
static const CursorID ANIMCURSOR_FLAG
Flag for saying a cursor sprite is an animated cursor.
Definition: sprites.h:1466
static ViewportSSCSS _vp_sprite_sorters[]
List of sorters ordered from best to worst.
Definition: viewport.cpp:3235
static void ViewportDrawChk(const ViewPort *vp, int left, int top, int right, int bottom)
Make sure we don&#39;t draw a too big area at a time.
Definition: viewport.cpp:1610
Definition of base types and functions in a cross-platform compatible way.
Location information about a sign as seen on the viewport.
Definition: viewport_type.h:48
static void ViewportDrawBoundingBoxes(const ParentSpriteToSortVector *psd)
Draws the bounding boxes of all ParentSprites.
Definition: viewport.cpp:1456
static void ViewportSortParentSprites(ParentSpriteToSortVector *psdv)
Sort parent sprites pointer array.
Definition: viewport.cpp:1379
A number of safeguards to prevent using unsafe methods.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:247
static void SetSelectionTilesDirty()
Marks the selected tiles as dirty.
Definition: viewport.cpp:1937
Base of waypoints.
static void CheckOverflow(int &test, int &other, int max, int mult)
Check for overflowing the map.
Definition: viewport.cpp:2711
rectangle (stations, depots, ...)
uint y
Y position of the tile in unit coordinates.
Definition: tile_cmd.h:46
int32 y
screen Y coordinate of sprite
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:316
ViewportPlaceMethod select_method
The method which governs how tiles are selected.
void StartStopVehicle(const Vehicle *v, bool texteffect)
Executes CMD_START_STOP_VEHICLE for given vehicle.
Data structure for a window viewport.
Definition: window_gui.h:258
static Slope GetTilePixelSlope(TileIndex tile, int *h)
Return the slope of a given tile.
Definition: tile_map.h:273
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in #ZOOM_LVL_BASE.
Definition: tile_type.h:18
int32 scrollpos_x
Currently shown x coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition: window_gui.h:260
int32 xmin
minimal world X coordinate of bounding box
HighLightStyle drawstyle
Lower bits 0-3 are reserved for detailed highlight information.
uint16 width_normal
The width when not zoomed out (normal font)
Definition: viewport_type.h:51
static void DrawTileSelectionRect(const TileInfo *ti, PaletteID pal)
Draws a selection rectangle on a tile.
Definition: viewport.cpp:917
Map accessor functions for bridges.
bool IsInsideRotatedRectangle(int x, int y)
Checks whether a point is inside the selected a diagonal rectangle given by _thd.size and _thd...
Definition: viewport.cpp:822
static Slope SlopeWithThreeCornersRaised(Corner corner)
Returns the slope with all except one corner raised.
Definition: slope_func.h:208
int virtual_width
width << zoom
Definition: viewport_type.h:32
The tile has no ownership.
Definition: company_type.h:27
static const PaletteID PALETTE_SEL_TILE_BLUE
This draws a blueish square (catchment areas for example)
Definition: sprites.h:1535
Sizing mode.
Definition: window_gui.h:899
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:499
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
static int CalcHeightdiff(HighLightStyle style, uint distance, TileIndex start_tile, TileIndex end_tile)
Calculates height difference between one tile and another.
Definition: viewport.cpp:2616
StationFacilityByte facilities
The facilities that this station has.
void SetDirtyBlocks(int left, int top, int right, int bottom)
This function extends the internal _invalid_rect rectangle as it now contains the rectangle defined b...
Definition: gfx.cpp:1418
bool smooth_scroll
smooth scroll viewports
Definition: settings_type.h:90
autorail (one piece), lower bits: direction
static int GetViewportY(Point tile)
Returns the y coordinate in the viewport coordinate system where the given tile is painted...
Definition: viewport.cpp:1086
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:147
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, INVALID_VEHICLE otherwise.
Definition: window_gui.h:259
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
static void 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:648
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2257
Also allow &#39;diagonal rectangles&#39;. Only usable in combination with HT_RECT or HT_POINT.
void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Window *w)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
Definition: viewport.cpp:3151
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
Vehicle * First() const
Get the first vehicle of this vehicle chain.
Definition: vehicle_base.h:595
Point new_outersize
New value for outersize; used to determine whether to redraw the selection.
drag only in horizontal direction
Definition: viewport_type.h:84
void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
Draws the projection of a parallelepiped.
Definition: gfx.cpp:278
ViewPort * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
Definition: viewport.cpp:385
int32 dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:263
const SubSprite * sub
only draw a rectangular part of the sprite
Definition: viewport.cpp:123
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:688
static Slope RemoveHalftileSlope(Slope s)
Removes a halftile slope from a slope.
Definition: slope_func.h:62
void ShowStationViewWindow(StationID station)
Opens StationViewWindow for given station.
bool make_square_red
Whether to give a tile a red selection.
uint16 height
Height of the sprite.
Definition: spritecache.h:19
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:139
static const int MAX_TILE_EXTENT_TOP
Maximum top extent of tile relative to north corner (not considering bridges).
Definition: viewport.cpp:100
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:959
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:39
point (lower land, raise land, level land, ...)
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:699
static HighLightStyle Check2x1AutoRail(int mode)
returns information about the 2x1 piece to be build.
Definition: viewport.cpp:2538
int32 center
The center position of the sign.
Definition: viewport_type.h:49
static void MarkViewportDirty(const ViewPort *vp, int left, int top, int right, int bottom)
Marks a viewport as dirty for repaint if it displays (a part of) the area the needs to be repainted...
Definition: viewport.cpp:1836
const SubSprite * sub
only draw a rectangular part of the sprite
ViewportDragDropSelectionProcess select_proc
The procedure that has to be called when the selection is done.
void SetMouseCursor(CursorID sprite, PaletteID pal)
Assign a single non-animated sprite to the cursor.
Definition: gfx.cpp:1617
OwnerByte owner
The owner of this station.
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset)
Mark a tile given by its index dirty for repaint.
Definition: viewport.cpp:1904
Mask for the tile drag-type modes.
void UpdateTileSelection()
Updates tile highlighting for all cases.
Definition: viewport.cpp:2355
static uint ScaleByMapSize1D(uint n)
Scales the given value by the maps circumference, where the given value is for a 256 by 256 map...
Definition: map_func.h:138
A pair-construct of a TileIndexDiff.
Definition: map_type.h:58
int * last_foundation_child[FOUNDATION_PART_END]
Tail of ChildSprite list of the foundations. (index into child_screen_sprites_to_draw) ...
Definition: viewport.cpp:168
int left
Screen coordinate left egde of the viewport.
Definition: viewport_type.h:25
static const int TILE_HEIGHT_STEP
One Z unit tile height difference is displayed as 50m.
Definition: viewport_func.h:21
void DrawViewport() const
Draw the viewport of this window.
Definition: viewport.cpp:1652
ZoomLevelByte zoom_min
minimum zoom out level
static TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)
Return the offset between to tiles from a TileIndexDiffC struct.
Definition: map_func.h:232
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:810
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
Definition: gfx.cpp:1630
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
uint16 width
Width of the sprite.
Definition: spritecache.h:20
Functions related to companies.
default
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:196
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
int32 dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:262
area of land in X and Y directions
Definition: viewport_type.h:82
static bool ViewportSortParentSpritesChecker()
This fallback sprite checker always exists.
Definition: viewport.cpp:1373
Bottom margin.
Definition: viewport_type.h:44
static void AddChildSpriteToFoundation(SpriteID image, PaletteID pal, const SubSprite *sub, FoundationPart foundation_part, int extra_offs_x, int extra_offs_y)
Adds a child sprite to the active foundation.
Definition: viewport.cpp:552
Parent sprite that should be drawn.
static uint TilePixelHeightOutsideMap(int x, int y)
Returns the tile height for a coordinate outside map.
Definition: tile_map.h:77
GUISettings gui
settings related to the GUI
SpriteID image
sprite to draw
Invisible tiles at the SW and SE border.
Definition: tile_type.h:50
Base class for all vehicles.
Data structure for viewport, display of a part of the world.
Definition: viewport_type.h:24
static void DrawTileSelection(const TileInfo *ti)
Checks if the specified tile is selected and if so draws selection using correct selectionstyle.
Definition: viewport.cpp:1011
static void ViewportAddLandscape()
Add the landscape to the viewport, i.e.
Definition: viewport.cpp:1095
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:19
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
Window * z_front
The window in front of us in z-order.
Definition: window_gui.h:333
static const byte _string_colourmap[17]
Colour mapping for TextColour.
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:159
bool diagonal
Whether the dragged area is a 45 degrees rotated rectangle.
void HandleClickOnSign(const Sign *si)
Handle clicking on a sign.
Definition: signs_gui.cpp:555
Helper class for getting the best sprite sorter.
Definition: viewport.cpp:3229
static int GetBridgePixelHeight(TileIndex tile)
Get the height (&#39;z&#39;) of a bridge in pixels.
Definition: bridge_map.h:84
bool(* VpSorterChecker)()
Type for method for checking whether a viewport sprite sorter exists.
TileIndex redsq
The tile that has to get a red selection.
static const int MAX_TILE_EXTENT_BOTTOM
Maximum bottom extent of tile relative to north corner (worst case: SLOPE_STEEP_N).
Definition: viewport.cpp:101
int32 ymax
maximal world Y coordinate of bounding box
static void AddTileSpriteToDraw(SpriteID image, PaletteID pal, int32 x, int32 y, int z, const SubSprite *sub=NULL, int extra_offs_x=0, int extra_offs_y=0)
Schedules a tile sprite for drawing.
Definition: viewport.cpp:527
Top margin.
Definition: viewport_type.h:43
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:217
int32 xmax
maximal world X coordinate of bounding box
when a sprite is to be displayed transparently, this bit needs to be set.
Definition: sprites.h:1508
OwnerByte owner
Which company owns the vehicle?
Definition: vehicle_base.h:273
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:83
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
Definition: viewport.cpp:2940
TileIndex xy
Base tile of the station.
void Reset()
Reset tile highlighting.
Definition: viewport.cpp:2320
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:899
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Functions related to zooming.
static Point InverseRemapCoords(int x, int y)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Definition: landscape.h:112
Slope
Enumeration for the slope-type.
Definition: slope_type.h:50
Neither foundation nor groundsprite drawn yet.
Definition: viewport.cpp:131
const TileTypeProcs *const _tile_type_procs[16]
Tile callback functions for each type of tile.
Definition: landscape.cpp:61
TownCache cache
Container for all cacheable data.
Definition: town.h:58
static uint MapMaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition: map_func.h:113
Town data structure.
Definition: town.h:55
void VpSetPresizeRange(TileIndex from, TileIndex to)
Highlights all tiles between a set of two tiles.
Definition: viewport.cpp:2514
int16 x_offs
Number of pixels to shift the sprite to the right.
Definition: spritecache.h:21
Used to only draw a part of the sprite.
Definition: gfx_type.h:219
Vehicle * CheckClickOnVehicle(const ViewPort *vp, int x, int y)
Find the vehicle close to the clicked coordinates.
Definition: vehicle.cpp:1161
byte max_bridge_height
maximum height of bridges
virtual void * MoveTo(void *video, int x, int y)=0
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
static const uint TILE_UNIT_MASK
For masking in/out the inner-tile world coordinate units.
Definition: tile_type.h:16
static const uint MAX_BUILDING_PIXELS
Maximum height of a building in pixels in #ZOOM_LVL_BASE. (Also applies to "bridge buildings" on the ...
Definition: tile_type.h:20
Functions related to OTTD&#39;s landscape.
int32 z_pos
z coordinate.
Definition: vehicle_base.h:270
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2268
void OffsetGroundSprite(int x, int y)
Called when a foundation has been drawn for the current tile.
Definition: viewport.cpp:616
VpSpriteSorter fct_sorter
The sorting function.
Definition: viewport.cpp:3231
uint32 CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:21
Coordinates of a point in 2D.
used for autorail highlighting (longer stretches), lower bits: direction
a steep slope falling to south (from north)
Definition: slope_type.h:71
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:604
Colours _company_colours[MAX_COMPANIES]
NOSAVE: can be determined from company structs.
Definition: company_cmd.cpp:48
static uint TileHeight(TileIndex tile)
Returns the height of a tile.
Definition: tile_map.h:31
The colour translation of GRF&#39;s strings.
special mode used for highlighting while dragging (and for tunnels/docks)
static bool CheckClickOnViewportSign(const ViewPort *vp, int x, int y, const ViewportSign *sign)
Test whether a sign is below the mouse.
Definition: viewport.cpp:2062
EventState VpHandlePlaceSizingDrag()
Handle the mouse while dragging for placement/resizing.
Definition: viewport.cpp:3107
Index of the small font in the font tables.
Definition: gfx_type.h:205
Zoomed 16 times out.
Definition: zoom_type.h:28
static uint SlopeToSpriteOffset(Slope s)
Returns the Sprite offset for a given Slope.
Definition: slope_func.h:417
ConstructionSettings construction
construction of things in-game
Colour value is already a real palette colour index, not an index of a StringColour.
Definition: gfx_type.h:270
uint TileHeightOutsideMap(int x, int y)
Returns the tile height for a coordinate outside map.
Definition: tile_map.cpp:25
HighLightStyle
Highlighting draw styles.
Functions related to waypoints.
DrawTileProc * draw_tile_proc
Called to render the tile and its contents to the screen.
Definition: tile_cmd.h:145
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:843
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:114
drag only in vertical direction
Definition: viewport_type.h:85
vehicle is accepted as target as well (bitmask)
ZoomLevel zoom
The zoom level of the viewport.
Definition: viewport_type.h:35
horizontal lower
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:314
Metadata about the current highlighting.
int32 x_pos
x coordinate.
Definition: vehicle_base.h:268
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
void InitializeSpriteSorter()
Choose the "best" sprite sorter and set _vp_sprite_sorter.
Definition: viewport.cpp:3243
Types related to sprite sorting.
PaletteID pal
palette to use
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:85
Base of the town class.
const T * Get(uint index) const
Get the pointer to item "number" (const)
int virtual_top
Virtual top coordinate.
Definition: viewport_type.h:31
The normal zoom level.
Definition: zoom_type.h:24
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:1219
int32 left
minimal screen X coordinate of sprite (= x + sprite->x_offs), reference point for child sprites ...
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:695
horizontal upper
WindowClass window_class
Window class.
Definition: window_gui.h:306
Specification of a rectangle with absolute coordinates of all edges.
WindowClass window_class
The WindowClass of the window that is responsible for the selection mode.
virtual void OnPlaceObject(Point pt, TileIndex tile)
The user clicked some place on the map when a tile highlight mode has been set.
Definition: window_gui.h:736
The passed event is handled.
Definition: window_type.h:702
int32 y_pos
y coordinate.
Definition: vehicle_base.h:269
uint16 width_small
The width when zoomed out (small font)
Definition: viewport_type.h:52
static uint MapMaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition: map_func.h:104
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
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:581
static bool IsInvisibilitySet(TransparencyOption to)
Check if the invisibility option bit is set and if we aren&#39;t in the game menu (there&#39;s never transpar...
Definition: transparency.h:61
FoundationPart
Enumeration of multi-part foundations.
Definition: viewport.cpp:130
Functions related to tile highlights.
HighLightStyle next_drawstyle
Queued, but not yet drawn style.
Window functions not directly related to making/drawing windows.
all rail directions
Definition: viewport_type.h:88
int top
Screen coordinate top edge of the viewport.
Definition: viewport_type.h:26
static void ViewportDrawDirtyBlocks()
Draw/colour the blocks that have been redrawn.
Definition: viewport.cpp:1476
Point outersize
Size, in tile "units", of the blue coverage area excluding the side of the selected area...
Makes the background transparent if set.
Definition: window_gui.h:29
#define TILE_ADD(x, y)
Adds to tiles together.
Definition: map_func.h:246
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:321
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1349
Base classes/functions for stations.
static T Delta(const T a, const T b)
Returns the (absolute) difference between two (scalar) variables.
Definition: math_func.hpp:232
bool comparison_done
Used during sprite sorting: true if sprite has been compared with all other sprites.
static bool ContinueLowerMapEdgeSearch(int iter, int iter_limit, int sy, int sy_limit)
Continue criteria for searching a no-longer-visible tile in negative direction, starting at some tile...
Definition: viewport.cpp:1676
int32 scrollpos_y
Currently shown y coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition: window_gui.h:261
static bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
Definition: vehicle_func.h:91
const SubSprite * sub
only draw a rectangular part of the sprite
Definition: viewport.cpp:115
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:2222
Base class for all station-ish types.
Station data structure.
Definition: station_base.h:446
static bool IsTransparencySet(TransparencyOption to)
Check if the transparency option bit is set and if we aren&#39;t in the game menu (there&#39;s never transpar...
Definition: transparency.h:50
Factory to &#39;query&#39; all available blitters.
byte dirty
Whether the build station window needs to redraw due to the changed selection.
static uint TilePixelHeight(TileIndex tile)
Returns the height of a tile in pixels.
Definition: tile_map.h:64
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition: map_func.h:165
static Corner OppositeCorner(Corner corner)
Returns the opposite corner.
Definition: slope_func.h:186
This file defines all the the animated cursors.
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:769
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:315
void UpdateViewportPosition(Window *w)
Update the viewport position being displayed.
Definition: viewport.cpp:1787
#define FOR_ALL_WINDOWS_FROM_BACK_FROM(w, start)
Iterate over all windows.
Definition: window_gui.h:881
static int GetTileMaxPixelZ(TileIndex tile)
Get top height of the tile.
Definition: tile_map.h:299
Base class for signs.
static void CalcRaildirsDrawstyle(int x, int y, int method)
while dragging
Definition: viewport.cpp:2720
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:201
int width
Screen width of the viewport.
Definition: viewport_type.h:27