OpenTTD Source: src/viewport.cpp Source File

OpenTTD Source 1.11.0-RC1

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