Go to the documentation of this file.
83 #include "viewport_kdtree.h"
93 #include <forward_list>
97 #include "table/strings.h"
102 Point _tile_fract_coords;
106 static int _viewport_sign_maxwidth = 0;
159 typedef std::vector<TileSpriteToDraw> TileSpriteToDrawVector;
160 typedef std::vector<StringSpriteToDraw> StringSpriteToDrawVector;
161 typedef std::vector<ParentSpriteToDraw> ParentSpriteToDrawVector;
162 typedef std::vector<ChildScreenSpriteToDraw> ChildScreenSpriteToDrawVector;
168 StringSpriteToDrawVector string_sprites_to_draw;
169 TileSpriteToDrawVector tile_sprites_to_draw;
170 ParentSpriteToDrawVector parent_sprites_to_draw;
172 ChildScreenSpriteToDrawVector child_screen_sprites_to_draw;
190 bool _draw_bounding_boxes =
false;
191 bool _draw_dirty_blocks =
false;
192 uint _dirty_block_colour = 0;
195 static Point MapXYZToViewport(
const Viewport *vp,
int x,
int y,
int z)
203 void DeleteWindowViewport(
Window *w)
225 int width,
int height, uint32 follow_flags,
ZoomLevel zoom)
243 if (follow_flags & 0x80000000) {
254 pt = MapXYZToViewport(vp, x, y, GetSlopePixelZ(x, y));
262 vp->overlay =
nullptr;
269 static Point _vp_move_offs;
273 for (; !it.IsEnd(); ++it) {
275 if (left + width > w->
left &&
277 top + height > w->
top &&
280 if (left < w->left) {
281 DoSetViewportPosition(it, left, top, w->
left - left, height);
282 DoSetViewportPosition(it, left + (w->
left - left), top, width - (w->
left - left), height);
287 DoSetViewportPosition(it, left, top, (w->
left + w->
width - left), height);
288 DoSetViewportPosition(it, left + (w->
left + w->
width - left), top, width - (w->
left + w->
width - left), height);
293 DoSetViewportPosition(it, left, top, width, (w->
top - top));
294 DoSetViewportPosition(it, left, top + (w->
top - top), width, height - (w->
top - top));
299 DoSetViewportPosition(it, left, top, width, (w->
top + w->
height - top));
300 DoSetViewportPosition(it, left, top + (w->
top + w->
height - top), width, height - (w->
top + w->
height - top));
309 int xo = _vp_move_offs.x;
310 int yo = _vp_move_offs.y;
312 if (
abs(xo) >= width ||
abs(yo) >= height) {
318 GfxScroll(left, top, width, height, xo, yo);
337 static void SetViewportPosition(
Window *w,
int x,
int y)
343 int left, top, width, height;
359 if (old_top == 0 && old_left == 0)
return;
361 _vp_move_offs.x = old_left;
362 _vp_move_offs.y = old_top;
374 i = left + width - _screen.width;
375 if (i >= 0) width -= i;
383 i = top + height - _screen.height;
384 if (i >= 0) height -= i;
389 DoSetViewportPosition(it, left, top, width, height);
429 Point pt = { -1, -1 };
441 static Point GetTileFromScreenXY(
int x,
int y,
int zoom_x,
int zoom_y)
455 Point GetTileBelowCursor()
457 return GetTileFromScreenXY(_cursor.
pos.x, _cursor.
pos.y, _cursor.
pos.x, _cursor.
pos.y);
467 x = ((_cursor.
pos.x - vp->
left) >> 1) + (vp->
width >> 2);
468 y = ((_cursor.
pos.y - vp->
top) >> 1) + (vp->
height >> 2);
474 return GetTileFromScreenXY(_cursor.
pos.x, _cursor.
pos.y, x + vp->
left, y + vp->
top);
515 ts.
x = pt.x + extra_offs_x;
516 ts.
y = pt.y + extra_offs_y;
533 assert(
IsInsideMM(foundation_part, 0, FOUNDATION_PART_END));
534 assert(_vd.
foundation[foundation_part] != -1);
538 int *old_child = _vd.last_child;
541 AddChildSpriteScreen(image, pal, offs.x + extra_offs_x, offs.y + extra_offs_y,
false, sub,
false,
false);
544 _vd.last_child = old_child;
569 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);
605 default: NOT_REACHED();
632 if (pt.x + spr->
x_offs >= _vd.dpi.left + _vd.dpi.width ||
634 pt.y + spr->
y_offs >= _vd.dpi.top + _vd.dpi.height ||
667 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)
669 int32 left, right, top, bottom;
684 _vd.last_child =
nullptr;
687 int tmp_left, tmp_top, tmp_x = pt.x, tmp_y = pt.y;
690 if (image == SPR_EMPTY_BOUNDING_BOX) {
691 left = tmp_left =
RemapCoords(x + w , y + bb_offset_y, z + bb_offset_z).x;
692 right =
RemapCoords(x + bb_offset_x, y + h , z + bb_offset_z).x + 1;
693 top = tmp_top =
RemapCoords(x + bb_offset_x, y + bb_offset_y, z + dz ).y;
694 bottom =
RemapCoords(x + w , y + h , z + bb_offset_z).y + 1;
697 left = tmp_left = (pt.x += spr->
x_offs);
698 right = (pt.x + spr->
width );
699 top = tmp_top = (pt.y += spr->
y_offs);
700 bottom = (pt.y + spr->
height);
703 if (_draw_bounding_boxes && (image != SPR_EMPTY_BOUNDING_BOX)) {
705 left = std::min(left ,
RemapCoords(x + w , y + bb_offset_y, z + bb_offset_z).x);
706 right = std::max(right ,
RemapCoords(x + bb_offset_x, y + h , z + bb_offset_z).x + 1);
707 top = std::min(top ,
RemapCoords(x + bb_offset_x, y + bb_offset_y, z + dz ).y);
708 bottom = std::max(bottom,
RemapCoords(x + w , y + h , z + bb_offset_z).y + 1);
712 if (left >= _vd.dpi.left + _vd.dpi.width ||
713 right <= _vd.dpi.left ||
714 top >= _vd.dpi.top + _vd.dpi.height ||
715 bottom <= _vd.dpi.top) {
729 ps.
xmin = x + bb_offset_x;
730 ps.
xmax = x + std::max(bb_offset_x, w) - 1;
732 ps.
ymin = y + bb_offset_y;
733 ps.
ymax = y + std::max(bb_offset_y, h) - 1;
735 ps.
zmin = z + bb_offset_z;
736 ps.
zmax = z + std::max(bb_offset_z, dz) - 1;
790 if (begin > end)
Swap(begin, end);
791 return begin <= check && check <= end;
802 int dist_a = (_thd.
size.x + _thd.
size.y);
803 int dist_b = (_thd.
size.x - _thd.
size.y);
804 int a = ((x - _thd.
pos.x) + (y - _thd.
pos.y));
805 int b = ((x - _thd.
pos.x) - (y - _thd.
pos.y));
828 if (_vd.last_child ==
nullptr)
return;
836 *_vd.last_child = (uint)_vd.child_screen_sprites_to_draw.size();
842 cs.x = scale ? x * ZOOM_LVL_BASE : x;
843 cs.y = scale ? y * ZOOM_LVL_BASE : y;
844 cs.relative = relative;
852 _vd.last_child = &cs.
next;
855 static void AddStringToDraw(
int x,
int y,
StringID string, uint64 params_1, uint64 params_2, Colours colour, uint16 width)
862 ss.params[0] = params_1;
863 ss.params[1] = params_2;
907 SpriteID sel2 = SPR_HALFTILE_SELECTION_FLAT + halftile_corner;
912 sel = SPR_HALFTILE_SELECTION_DOWN;
916 sel += opposite_corner;
923 static bool IsPartOfAutoLine(
int px,
int py)
933 case HT_DIR_HU:
return px == -py || px == -py - 16;
934 case HT_DIR_HL:
return px == -py || px == -py + 16;
935 case HT_DIR_VL:
return px == py || px == py + 16;
936 case HT_DIR_VR:
return px == py || px == py - 16;
969 static const uint _lower_rail[4] = { 5U, 2U, 4U, 3U };
971 if (autorail_type != _lower_rail[halftile_corner]) {
978 offset = _AutorailTilehSprite[autorail_tileh][autorail_type];
980 image = SPR_AUTORAIL_BASE + offset;
983 image = SPR_AUTORAIL_BASE - offset;
990 enum TileHighlightType {
1015 TileHighlightType type = THT_RED;
1018 if (st->TileIsInCatchment(t))
return THT_BLUE;
1042 case THT_NONE:
break;
1057 if (_town_local_authority_kdtree.
Count() == 0)
return;
1123 if ((halftile_corner == CORNER_W) || (halftile_corner == CORNER_E)) z +=
TILE_HEIGHT;
1124 if (halftile_corner != CORNER_S) {
1135 }
else if (IsPartOfAutoLine(ti->
x, ti->
y)) {
1153 if (!is_redsq && (tht == THT_NONE || tht == THT_RED) && _thd.
outersize.x > 0 &&
1179 assert(_vd.dpi.top <= _vd.dpi.top + _vd.dpi.height);
1180 assert(_vd.dpi.left <= _vd.dpi.left + _vd.dpi.width);
1198 int left_column = (upper_left.y - upper_left.x) / (
int)
TILE_SIZE - 2;
1199 int right_column = (upper_right.y - upper_right.x) / (
int)
TILE_SIZE + 2;
1207 int row = (upper_left.x + upper_left.y) / (
int)
TILE_SIZE - 2;
1208 bool last_row =
false;
1209 for (; !last_row; row++) {
1211 for (
int column = left_column; column <= right_column; column++) {
1213 if ((row + column) % 2 != 0)
continue;
1216 tilecoord.x = (row - column) / 2;
1217 tilecoord.y = (row + column) / 2;
1218 assert(column == tilecoord.y - tilecoord.x);
1219 assert(row == tilecoord.y + tilecoord.x);
1223 _cur_ti = &tile_info;
1229 tile_info.
tile =
TileXY(tilecoord.x, tilecoord.y);
1253 int min_visible_height = viewport_y - (_vd.dpi.top + _vd.dpi.height);
1254 bool tile_visible = min_visible_height <= 0;
1273 if ((tilecoord.x <= 0 || tilecoord.y <= 0) && min_visible_height < potential_bridge_height +
MAX_TILE_EXTENT_TOP) last_row =
false;
1303 bool small = dpi->zoom >= small_from;
1305 int left = dpi->left;
1307 int right = left + dpi->width;
1308 int bottom = top + dpi->height;
1313 if (bottom < sign->top ||
1314 top > sign->
top + sign_height ||
1315 right < sign->center - sign_half_width ||
1316 left > sign->
center + sign_half_width) {
1321 AddStringToDraw(sign->
center - sign_half_width, sign->
top, string_normal, params_1, params_2, colour, sign->
width_normal);
1323 int shadow_offset = 0;
1324 if (string_small_shadow != STR_NULL) {
1326 AddStringToDraw(sign->
center - sign_half_width + shadow_offset, sign->
top, string_small_shadow, params_1, params_2, INVALID_COLOUR, sign->
width_small | 0x8000);
1328 AddStringToDraw(sign->
center - sign_half_width, sign->
top - shadow_offset, string_small, params_1, params_2,
1337 const int max_tw = _viewport_sign_maxwidth / 2 + 1;
1342 r.right += expand_x;
1344 r.bottom += expand_y;
1351 Rect search_rect{ dpi->left, dpi->top, dpi->left + dpi->width, dpi->top + dpi->height };
1352 search_rect = ExpandRectWithViewportSignMargins(search_rect, dpi->zoom);
1364 std::vector<const BaseStation *> stations;
1365 std::vector<const Town *> towns;
1366 std::vector<const Sign *> signs;
1369 switch (item.type) {
1370 case ViewportSignKdtreeItem::VKI_STATION:
1371 if (!show_stations) break;
1372 st = BaseStation::Get(item.id.station);
1375 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
1377 stations.push_back(st);
1380 case ViewportSignKdtreeItem::VKI_WAYPOINT:
1381 if (!show_waypoints) break;
1382 st = BaseStation::Get(item.id.station);
1385 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
1387 stations.push_back(st);
1390 case ViewportSignKdtreeItem::VKI_TOWN:
1391 if (!show_towns) break;
1392 towns.push_back(Town::Get(item.id.town));
1395 case ViewportSignKdtreeItem::VKI_SIGN:
1396 if (!show_signs) break;
1397 si = Sign::Get(item.id.sign);
1402 if (!show_competitors && _local_company != si->owner && si->owner != OWNER_DEITY) break;
1404 signs.push_back(si);
1414 for (
const auto *t : towns) {
1417 STR_VIEWPORT_TOWN_TINY_WHITE, STR_VIEWPORT_TOWN_TINY_BLACK,
1418 t->index, t->cache.population);
1421 for (
const auto *si : signs) {
1428 for (
const auto *st : stations) {
1432 STR_VIEWPORT_STATION, STR_VIEWPORT_STATION_TINY, STR_NULL,
1437 STR_VIEWPORT_WAYPOINT, STR_VIEWPORT_WAYPOINT_TINY, STR_NULL,
1459 GetString(buffer, str,
lastof(buffer));
1464 if (str_small != STR_NULL) {
1465 GetString(buffer, str_small,
lastof(buffer));
1485 zoomlevels[zoom].top = this->top -
ScaleByZoom(1, zoom);
1492 if (vp !=
nullptr && vp->
zoom <= maxzoom) {
1493 assert(vp->
width != 0);
1500 static void ViewportDrawTileSprites(
const TileSpriteToDrawVector *tstdv)
1516 if (psdv->size() < 2)
return;
1525 const uint32 ORDER_COMPARED = UINT32_MAX;
1526 const uint32 ORDER_RETURNED = UINT32_MAX - 1;
1527 std::stack<ParentSpriteToDraw *> sprite_order;
1528 uint32 next_order = 0;
1530 std::forward_list<std::pair<int64, ParentSpriteToDraw *>> sprite_list;
1533 for (
auto p = psdv->rbegin(); p != psdv->rend(); p++) {
1534 sprite_list.push_front(std::make_pair((*p)->xmin + (*p)->ymin, *p));
1535 sprite_order.push(*p);
1536 (*p)->order = next_order++;
1541 std::vector<ParentSpriteToDraw *> preceding;
1542 auto preceding_prev = sprite_list.begin();
1543 auto out = psdv->begin();
1545 while (!sprite_order.empty()) {
1547 auto s = sprite_order.top();
1551 if (s->order == ORDER_RETURNED)
continue;
1554 if (s->order == ORDER_COMPARED) {
1556 s->order = ORDER_RETURNED;
1570 auto ssum = std::max(s->xmax, s->xmin) + std::max(s->ymax, s->ymin);
1571 auto prev = sprite_list.before_begin();
1572 auto x = sprite_list.begin();
1573 while (x != sprite_list.end() && ((*x).first <= ssum)) {
1574 auto p = (*x).second;
1577 x = sprite_list.erase_after(prev);
1584 if (s->xmax < p->xmin || s->ymax < p->ymin || s->zmax < p->zmin)
continue;
1585 if (s->xmin <= p->xmax &&
1586 s->ymin <= p->ymax &&
1587 s->zmin <= p->zmax) {
1588 if (s->xmin + s->xmax + s->ymin + s->ymax + s->zmin + s->zmax <=
1589 p->xmin + p->xmax + p->ymin + p->ymax + p->zmin + p->zmax) {
1593 preceding.push_back(p);
1594 preceding_prev = p_prev;
1597 if (preceding.empty()) {
1600 s->order = ORDER_RETURNED;
1605 if (preceding.size() == 1) {
1606 auto p = preceding[0];
1608 if (p->xmax <= s->xmax && p->ymax <= s->ymax && p->zmax <= s->zmax) {
1609 p->order = ORDER_RETURNED;
1610 s->order = ORDER_RETURNED;
1611 sprite_list.erase_after(preceding_prev);
1620 return a->order > b->order;
1623 s->order = ORDER_COMPARED;
1624 sprite_order.push(s);
1626 for (
auto p: preceding) {
1627 p->order = next_order++;
1628 sprite_order.push(p);
1634 static void ViewportDrawParentSprites(
const ParentSpriteToSortVector *psd,
const ChildScreenSpriteToDrawVector *csstdv)
1637 if (ps->image != SPR_EMPTY_BOUNDING_BOX)
DrawSpriteViewport(ps->image, ps->pal, ps->x, ps->y, ps->sub);
1639 int child_idx = ps->first_child;
1640 while (child_idx >= 0) {
1642 child_idx = cs->
next;
1665 pt2.x - pt1.x, pt2.y - pt1.y,
1666 pt3.x - pt1.x, pt3.y - pt1.y,
1667 pt4.x - pt1.x, pt4.y - pt1.y);
1686 byte bo =
UnScaleByZoom(dpi->left + dpi->top, dpi->zoom) & 1;
1688 for (
int i = (bo ^= 1); i < right; i += 2) blitter->
SetPixel(dst, i, 0, (uint8)colour);
1689 dst = blitter->
MoveTo(dst, 0, 1);
1690 }
while (--bottom > 0);
1693 static void ViewportDrawStrings(
ZoomLevel zoom,
const StringSpriteToDrawVector *sstdv)
1697 bool small =
HasBit(ss.width, 15);
1698 int w =
GB(ss.width, 0, 15);
1706 if (ss.colour != INVALID_COLOUR) {
1719 x, y, x + w - 1, y + h - 1, ss.colour,
1729 void ViewportDoDraw(
const Viewport *vp,
int left,
int top,
int right,
int bottom)
1732 _cur_dpi = &_vd.dpi;
1734 _vd.dpi.zoom = vp->
zoom;
1739 _vd.dpi.width = (right - left) & mask;
1740 _vd.dpi.height = (bottom - top) & mask;
1741 _vd.dpi.left = left & mask;
1742 _vd.dpi.top = top & mask;
1743 _vd.dpi.pitch = old_dpi->pitch;
1744 _vd.last_child =
nullptr;
1754 ViewportAddKdtreeSigns(&_vd.dpi);
1756 DrawTextEffects(&_vd.dpi);
1758 if (_vd.tile_sprites_to_draw.size() != 0) ViewportDrawTileSprites(&_vd.tile_sprites_to_draw);
1760 for (
auto &psd : _vd.parent_sprites_to_draw) {
1781 vp->overlay->
Draw(&dp);
1784 if (_vd.string_sprites_to_draw.size() != 0) {
1788 ViewportDrawStrings(zoom, &_vd.string_sprites_to_draw);
1793 _vd.string_sprites_to_draw.clear();
1794 _vd.tile_sprites_to_draw.clear();
1795 _vd.parent_sprites_to_draw.clear();
1797 _vd.child_screen_sprites_to_draw.clear();
1800 static inline void ViewportDraw(
const Viewport *vp,
int left,
int top,
int right,
int bottom)
1802 if (right <= vp->left || bottom <= vp->top)
return;
1804 if (left >= vp->
left + vp->
width)
return;
1806 if (left < vp->left) left = vp->
left;
1809 if (top >= vp->
top + vp->
height)
return;
1811 if (top < vp->top) top = vp->
top;
1831 dpi->left += this->
left;
1832 dpi->top += this->
top;
1834 ViewportDraw(this->
viewport, dpi->left, dpi->top, dpi->left + dpi->width, dpi->top + dpi->height);
1836 dpi->left -= this->
left;
1837 dpi->top -= this->
top;
1884 SetViewportPosition(w, pt.x, pt.y);
1892 bool update_overlay =
false;
1893 if (delta_x != 0 || delta_y != 0) {
1910 if (update_overlay) RebuildViewportOverlay(w);
1927 right += (1 << vp->
zoom) - 1;
1928 bottom += (1 << vp->
zoom) - 1;
1931 if (right <= 0)
return false;
1934 if (bottom <= 0)
return false;
1969 if (vp !=
nullptr) {
1970 assert(vp->
width != 0);
1978 void ConstrainAllViewportsZoom()
1981 if (w->viewport ==
nullptr)
continue;
1984 if (zoom != w->viewport->zoom) {
2017 int x_size = _thd.
size.x;
2018 int y_size = _thd.
size.y;
2021 int x_start = _thd.
pos.x;
2022 int y_start = _thd.
pos.y;
2026 x_start += _thd.
offs.x;
2028 y_start += _thd.
offs.y;
2034 assert(x_size >= 0);
2035 assert(y_size >= 0);
2044 assert((x_end | y_end | x_start | y_start) %
TILE_SIZE == 0);
2065 int top_y = y_start;
2086 static const int OVERLAY_WIDTH = 4 * ZOOM_LVL_BASE;
2092 if (top_x != x_start) {
2099 if (bot_y != y_end) {
2104 }
while (bot_x >= top_x);
2107 int a_size = x_size + y_size, b_size = x_size - y_size;
2112 for (
int a = -interval_a; a != a_size + interval_a; a += interval_a) {
2113 for (
int b = -interval_b; b != b_size + interval_b; b += interval_b) {
2126 void SetSelectionRed(
bool b)
2146 return y >= sign->
top && y < sign->
top + sign_height &&
2147 x >= sign->
center - sign_half_width && x < sign->
center + sign_half_width;
2160 if (_game_mode == GM_MENU)
return false;
2165 Rect search_rect{ x - 1, y - 1, x + 1, y + 1 };
2166 search_rect = ExpandRectWithViewportSignMargins(search_rect, vp->
zoom);
2176 Town *t =
nullptr, *last_t =
nullptr;
2177 Sign *si =
nullptr, *last_si =
nullptr;
2181 switch (item.type) {
2182 case ViewportSignKdtreeItem::VKI_STATION:
2183 if (!show_stations) break;
2184 st = BaseStation::Get(item.id.station);
2185 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
2186 if (CheckClickOnViewportSign(vp, x, y, &st->sign)) last_st = st;
2189 case ViewportSignKdtreeItem::VKI_WAYPOINT:
2190 if (!show_waypoints) break;
2191 st = BaseStation::Get(item.id.station);
2192 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
2193 if (CheckClickOnViewportSign(vp, x, y, &st->sign)) last_st = st;
2196 case ViewportSignKdtreeItem::VKI_TOWN:
2197 if (!show_towns) break;
2198 t = Town::Get(item.id.town);
2199 if (CheckClickOnViewportSign(vp, x, y, &t->cache.sign)) last_t = t;
2202 case ViewportSignKdtreeItem::VKI_SIGN:
2203 if (!show_signs) break;
2204 si = Sign::Get(item.id.sign);
2205 if (!show_competitors && _local_company != si->owner && si->owner != OWNER_DEITY) break;
2206 if (CheckClickOnViewportSign(vp, x, y, &si->sign)) last_si = si;
2215 if (last_st !=
nullptr) {
2222 }
else if (last_t !=
nullptr) {
2223 ShowTownViewWindow(last_t->index);
2225 }
else if (last_si !=
nullptr) {
2237 item.type = VKI_STATION;
2238 item.id.station = id;
2246 _viewport_sign_maxwidth = std::max<int>(_viewport_sign_maxwidth, st->
sign.
width_normal);
2254 item.type = VKI_WAYPOINT;
2255 item.id.station = id;
2263 _viewport_sign_maxwidth = std::max<int>(_viewport_sign_maxwidth, st->
sign.
width_normal);
2271 item.type = VKI_TOWN;
2288 item.type = VKI_SIGN;
2293 item.center = sign->sign.
center;
2294 item.top = sign->sign.
top;
2297 _viewport_sign_maxwidth = std::max<int>(_viewport_sign_maxwidth, sign->sign.
width_normal);
2302 void RebuildViewportKdtree()
2305 _viewport_sign_maxwidth = 0;
2307 std::vector<ViewportSignKdtreeItem> items;
2315 if (wp->sign.kdtree_valid) items.push_back(ViewportSignKdtreeItem::MakeWaypoint(wp->index));
2319 if (town->cache.sign.kdtree_valid) items.push_back(ViewportSignKdtreeItem::MakeTown(town->index));
2323 if (sign->sign.kdtree_valid) items.push_back(ViewportSignKdtreeItem::MakeSign(sign->index));
2326 _viewport_sign_kdtree.
Build(items.begin(), items.end());
2330 static bool CheckClickOnLandscape(
const Viewport *vp,
int x,
int y)
2334 if (pt.x != -1)
return ClickTile(
TileVirtXY(pt.x, pt.y));
2338 static void PlaceObject()
2343 pt = GetTileBelowCursor();
2344 if (pt.x == -1)
return;
2359 bool HandleViewportClicked(
const Viewport *vp,
int x,
int y)
2374 bool result = CheckClickOnLandscape(vp, x, y);
2391 void RebuildViewportOverlay(
Window *w)
2393 if (w->
viewport->overlay !=
nullptr &&
2416 z = GetSlopePixelZ(x, y);
2430 RebuildViewportOverlay(w);
2491 void SetTileSelectBigSize(
int ox,
int oy,
int sx,
int sy)
2551 bool new_diagonal =
false;
2563 new_diagonal =
true;
2565 if (x1 >= x2)
Swap(x1, x2);
2566 if (y1 >= y2)
Swap(y1, y2);
2572 if (!new_diagonal) {
2579 Point pt = GetTileBelowCursor();
2611 default: NOT_REACHED();
2659 static void HideMeasurementTooltips()
2710 void VpSetPlaceSizingLimit(
int limit)
2734 HideMeasurementTooltips();
2738 static void VpStartPreSizing()
2750 int fxpy = _tile_fract_coords.x + _tile_fract_coords.y;
2752 int fxmy = _tile_fract_coords.x - _tile_fract_coords.y;
2756 default: NOT_REACHED();
2758 if (fxpy >= 20 && sxpy <= 12)
return HT_DIR_HL;
2759 if (fxmy < -3 && sxmy > 3)
return HT_DIR_VR;
2763 if (fxmy > 3 && sxmy < -3)
return HT_DIR_VL;
2764 if (fxpy <= 12 && sxpy >= 20)
return HT_DIR_HU;
2768 if (fxmy > 3 && sxmy < -3)
return HT_DIR_VL;
2769 if (fxpy >= 20 && sxpy <= 12)
return HT_DIR_HL;
2773 if (fxmy < -3 && sxmy > 3)
return HT_DIR_VR;
2774 if (fxpy <= 12 && sxpy >= 20)
return HT_DIR_HU;
2794 uint start_x =
TileX(start_tile);
2795 uint start_y =
TileY(start_tile);
2796 uint end_x =
TileX(end_tile);
2797 uint end_y =
TileY(end_tile);
2801 case HT_LINE:
return (end_x > start_x || (end_x == start_x && end_y > start_y));
2804 case HT_POINT:
return (end_x != start_x && end_y < start_y);
2805 default: NOT_REACHED();
2831 if (start_tile == end_tile)
return 0;
2832 if (swap)
Swap(start_tile, end_tile);
2843 byte style_t = (byte)(
TileX(end_tile) >
TileX(start_tile));
2858 {1, 0}, {1, 1}, {0, 1}, {1, 1},
2859 {1, 0}, {0, 0}, {1, 0}, {1, 1},
2860 {1, 0}, {1, 1}, {0, 1}, {1, 1},
2862 {0, 1}, {0, 0}, {1, 0}, {0, 0},
2863 {0, 1}, {0, 0}, {1, 1}, {0, 1},
2864 {1, 0}, {0, 0}, {0, 0}, {0, 1},
2874 if (swap && distance == 0) style = flip_style_direction[style];
2877 byte style_t = style * 2;
2878 assert(style_t <
lengthof(heightdiff_line_by_dir) - 13);
2881 h0 = std::max(h0, ht);
2885 if (distance == 0) style_t = flip_style_direction[style] * 2;
2886 assert(style_t <
lengthof(heightdiff_line_by_dir) - 13);
2889 h1 = std::max(h1, ht);
2894 if (swap)
Swap(h0, h1);
2898 static const StringID measure_strings_length[] = {STR_NULL, STR_MEASURE_LENGTH, STR_MEASURE_LENGTH_HEIGHTDIFF};
2908 if (test >= 0)
return;
2910 other += mult * test;
2923 if (test <= max)
return;
2925 other += mult * (test - max);
2968 int offset = (raw_dx - raw_dy) / 2;
3003 int offset = (raw_dx + raw_dy + (int)
TILE_SIZE) / 2;
3052 }
else if (w > h * 2) {
3055 }
else if (h > w * 2) {
3069 }
else if (d >= 0) {
3080 }
else if (d >= 0) {
3093 }
else if (d >= 0) {
3104 }
else if (d >= 0) {
3122 if (distance != 1) {
3128 distance =
CeilDiv(distance, 2);
3131 params[index++] = distance;
3132 if (heightdiff != 0) params[index++] = heightdiff;
3181 if (
abs(sy - y) <
abs(sx - x)) {
3188 goto calc_heightdiff_single_direction;
3197 goto calc_heightdiff_single_direction;
3207 calc_heightdiff_single_direction:;
3209 x = sx +
Clamp(x - sx, -limit, limit);
3210 y = sy +
Clamp(y - sy, -limit, limit);
3219 if (distance != 1) {
3227 params[index++] = distance;
3228 if (heightdiff != 0) params[index++] = heightdiff;
3237 x = sx +
Clamp(x - sx, -limit, limit);
3238 y = sy +
Clamp(y - sy, -limit, limit);
3243 static const StringID measure_strings_area[] = {
3244 STR_NULL, STR_NULL, STR_MEASURE_AREA, STR_MEASURE_AREA_HEIGHTDIFF
3270 int a_max = dist_x + dist_y;
3271 int b_max = dist_y - dist_x;
3275 a_max =
abs(a_max + (a_max > 0 ? 2 : -2)) / 2;
3276 b_max =
abs(b_max + (b_max > 0 ? 2 : -2)) / 2;
3282 if (a_max != 1 || b_max != 1) {
3289 }
else if (dy == 1) {
3294 if (dx != 1 || dy != 1) {
3297 params[index++] = dx - (style &
HT_POINT ? 1 : 0);
3298 params[index++] = dy - (style &
HT_POINT ? 1 : 0);
3299 if (heightdiff != 0) params[index++] = heightdiff;
3306 default: NOT_REACHED();
3358 HideMeasurementTooltips();
3399 HideMeasurementTooltips();
3460 { &ViewportSortParentSpritesSSE41Checker, &ViewportSortParentSpritesSSE41 },
3474 assert(_vp_sprite_sorter !=
nullptr);
3508 void MarkCatchmentTilesDirty()
3538 MarkCatchmentTilesDirty();
3541 MarkCatchmentTilesDirty();
3543 MarkCatchmentTilesDirty();
@ DO_SHOW_COMPETITOR_SIGNS
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
@ ES_HANDLED
The passed event is handled.
static Corner OppositeCorner(Corner corner)
Returns the opposite corner.
Iterator to iterate all valid Windows.
@ HT_DIR_HL
horizontal lower
@ MP_HOUSE
A house by a town.
static void CalcRaildirsDrawstyle(int x, int y, int method)
while dragging
Data structure for a window viewport.
@ SPRITE_MASK
The mask to for the main sprite.
StationFacility facilities
The facilities that this station has.
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
SpriteID image
sprite to draw
static bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
Point foundation_offset[FOUNDATION_PART_END]
Pixel offset for ground sprites on the foundations.
int32 x
screen X coordinate of sprite
byte sizelimit
Whether the selection is limited in length, and what the maximum length is.
#define TILE_ADD(x, y)
Adds two tiles together.
static constexpr bool IsInsideMM(const T x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
static void DrawAutorailSelection(const TileInfo *ti, uint autorail_type)
Draws autorail highlights.
Point size
Size, in tile "units", of the white/red selection area.
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
Draws the projection of a parallelepiped.
Point outersize
Size, in tile "units", of the blue coverage area excluding the side of the selected area.
@ WC_INVALID
Invalid window.
static void CheckUnderflow(int &test, int &other, int mult)
Check for underflowing the map.
virtual void SetPixel(void *video, int x, int y, uint8 colour)=0
Draw a pixel with a given colour on the video-buffer.
static Titem * Get(size_t index)
Returns Titem with given index.
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
static const PaletteID PALETTE_SEL_TILE_RED
makes a square red. is used when removing rails or other stuff
@ VST_CLIENT
Single player.
@ VPM_FIX_VERTICAL
drag only in vertical direction
static const int MAX_TILE_EXTENT_LEFT
Maximum left extent of tile relative to north corner.
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.
int32 y
screen Y coordinate of sprite
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
static int UnScaleByZoomLower(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL)
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
EventState VpHandlePlaceSizingDrag()
Handle the mouse while dragging for placement/resizing.
@ ZOOM_OUT
Zoom out (get helicopter view).
static const AnimCursor *const _animcursors[]
This is an array of pointers to all the animated cursor definitions we have above.
int32 zmax
maximal world Z coordinate of bounding box
const TileTypeProcs *const _tile_type_procs[16]
Tile callback functions for each type of tile.
uint x
X position of the tile in unit coordinates.
@ HT_DIR_VR
vertical right
Slope GetTilePixelSlopeOutsideMap(int x, int y, int *h)
Return the slope of a given tile, also for tiles outside the map (virtual "black" tiles).
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
K-dimensional tree, specialised for 2-dimensional space.
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold.
Point offs
Offset, in tile "units", for the blue coverage area from the selected area's northern tile.
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Tile information, used while rendering the tile.
bool _left_button_down
Is left mouse button pressed?
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...
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you've selected it.
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...
const SubSprite * sub
only draw a rectangular part of the sprite
@ ZOOM_LVL_END
End for iteration.
How all blitters should look like.
@ ZOOM_LVL_OUT_16X
Zoomed 16 times out.
static uint TilePixelHeight(TileIndex tile)
Returns the height of a tile in pixels.
static void DrawTileHighlightType(const TileInfo *ti, TileHighlightType tht)
Draw tile highlight for coverage area highlight.
int width
Screen width of the viewport.
ViewportPlaceMethod select_method
The method which governs how tiles are selected.
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.
ViewportData * viewport
Pointer to viewport data, if present.
int height
Screen height of the viewport.
Iterator to iterate over all tiles belonging to a bitmaptilearea.
void SetRedErrorSquare(TileIndex tile)
Set a tile to display a red error square.
int32 scrollpos_y
Currently shown y coordinate (virtual screen coordinate of topleft corner of the viewport).
Point new_size
New value for size; used to determine whether to redraw the selection.
Tindex index
Index of this pool item.
bool IsDraggingDiagonal()
Is the user dragging a 'diagonal rectangle'?
void HandleClickOnSign(const Sign *si)
Handle clicking on a sign.
int top
Screen coordinate top edge of the viewport.
int32 ymin
minimal world Y coordinate of bounding box
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
@ ZOOM_LVL_COUNT
Number of zoom levels.
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
static bool IsHalftileSlope(Slope s)
Checks for non-continuous slope on halftile foundations.
Data structure storing rendering information.
static constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
static const PaletteID PALETTE_TO_TRANSPARENT
This sets the sprite to transparent.
@ FOUNDATION_PART_HALFTILE
Second part (halftile foundation)
uint16 height
Height of the sprite.
Representation of a waypoint.
bool _ctrl_pressed
Is Ctrl pressed?
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.
static Slope RemoveHalftileSlope(Slope s)
Removes a halftile slope from a slope.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
int32 center
The center position of the sign.
int16 x_offs
Number of pixels to shift the sprite to the right.
static const uint TILE_SIZE
Tile size in world coordinates.
CargoTypes GetCargoMask()
Get a bitmask of the currently shown cargoes.
ZoomLevel
All zoom levels we know.
@ VST_COMPANY
All players in specific company.
static Station * Get(size_t index)
Gets station with given index.
@ VPM_FIX_Y
drag only in Y axis
uint y
Y position of the tile in unit coordinates.
ClientSettings _settings_client
The current settings for this game.
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.
TileIndex xy
town center tile
static uint TileY(TileIndex tile)
Get the Y component of a tile.
@ ST_NORMAL
The most basic (normal) sprite.
int32 WindowNumber
Number to differentiate different windows of the same class.
@ WC_STATION_VIEW
Station view; Window numbers:
byte _display_opt
What do we want to draw/do?
int32 top
The top of the sign.
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
int virtual_top
Virtual top coordinate.
Owner owner
Which company owns the vehicle?
Location information about a sign as seen on the viewport.
Owner
Enum for all companies/owners.
int32 x
screen X coordinate of sprite
@ DC_EXEC
execute the given command
Used to only draw a part of the sprite.
void Build(It begin, It end)
Clear and rebuild the tree from a new sequence of elements,.
@ FR_TRANSPARENT
Makes the background transparent if set.
ZoomLevel zoom_max
maximum zoom out level
DrawTileProc * draw_tile_proc
Called to render the tile and its contents to the screen.
Owner owner
The owner of this station.
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
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.
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
bool show_zone
NOSAVE: mark town to show the local authority zone in the viewports.
DoCommandFlag
List of flags for a command.
static TownID GetTownIndex(TileIndex t)
Get the index of which town this house/street is attached to.
int32 xmin
minimal world X coordinate of bounding box
static void ShowMeasurementTooltips(StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_cond=TCC_EXIT_VIEWPORT)
Displays the measurement tooltips when selecting multiple tiles.
size_t Count() const
Get number of elements stored in tree.
static bool CheckClickOnViewportSign(const Viewport *vp, int x, int y, const ViewportSign *sign)
Test whether a sign is below the mouse.
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
@ ZOOM_LVL_BEGIN
Begin for iteration.
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.
static uint SlopeToSpriteOffset(Slope s)
Returns the Sprite offset for a given Slope.
@ SPRITE_COMBINE_ACTIVE
Sprite combining is active. AddSortableSpriteToDraw outputs child sprites.
static int CalcHeightdiff(HighLightStyle style, uint distance, TileIndex start_tile, TileIndex end_tile)
Calculates height difference between one tile and another.
static uint TileX(TileIndex tile)
Get the X component of a tile.
@ FOUNDATION_PART_NORMAL
First part (normal foundation or no foundation)
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.
Vehicle * CheckClickOnVehicle(const Viewport *vp, int x, int y)
Find the vehicle close to the clicked coordinates.
Metadata about the current highlighting.
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
Returns an iterable ensemble of all valid stations of type T.
@ VPM_RAILDIRS
all rail directions
Slope tileh
Slope of the tile.
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
static uint MapSizeX()
Get the size of the map along the X.
bool measure_tooltip
show a permanent tooltip when dragging tools
int * last_foundation_child[FOUNDATION_PART_END]
Tail of ChildSprite list of the foundations. (index into child_screen_sprites_to_draw)
VpSorterChecker fct_checker
The check function.
int foundation[FOUNDATION_PART_END]
Foundation sprites (index into parent_sprites_to_draw).
static TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)
Return the offset between two tiles from a TileIndexDiffC struct.
Slope
Enumeration for the slope-type.
Colours _company_colours[MAX_COMPANIES]
NOSAVE: can be determined from company structs.
@ ZOOM_IN
Zoom in (get more detailed view).
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Data structure for viewport, display of a part of the world.
static const uint TILE_UNIT_MASK
For masking in/out the inner-tile world coordinate units.
TrackedViewportSign sign
NOSAVE: Dimensions of sign.
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
static bool IsSteepSlope(Slope s)
Checks if a slope is steep.
bool IsInsideRotatedRectangle(int x, int y)
Checks whether a point is inside the selected a diagonal rectangle given by _thd.size and _thd....
Common return value for all commands.
static Point InverseRemapCoords(int x, int y)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
@ WSM_PRESIZE
Presizing mode (docks, tunnels).
static T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
Shows a tooltip.
FoundationPart foundation_part
Currently active foundation for ground sprite drawing.
PaletteID pal
palette to use
static uint TileHeight(TileIndex tile)
Returns the height of a tile.
uint32 CursorID
The number of the cursor (sprite)
void UpdateTileSelection()
Updates tile highlighting for all cases.
@ FS_NORMAL
Index of the normal font in the font tables.
void StartStopVehicle(const Vehicle *v, bool texteffect)
Executes CMD_START_STOP_VEHICLE for given vehicle.
void SetMouseCursor(CursorID sprite, PaletteID pal)
Assign a single non-animated sprite to the cursor.
@ MAX_SPRITES
Maximum number of sprites that can be loaded at a given time.
static void SetSelectionTilesDirty()
Marks the selected tiles as dirty.
ParentSpriteToSortVector parent_sprites_to_sort
Parent sprite pointer array used for sorting.
@ VPM_FIX_X
drag only in X axis
static void DrawTileSelectionRect(const TileInfo *ti, PaletteID pal)
Draws a selection rectangle on a tile.
int virtual_left
Virtual left coordinate.
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...
WindowNumber window_number
The WindowNumber of the window that is responsible for the selection mode.
int height
Height of the window (number of pixels down in y direction)
static const CursorID ANIMCURSOR_FLAG
Flag for saying a cursor sprite is an animated cursor.
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
int left
Screen coordinate left edge of the viewport.
static void AddCombinedSprite(SpriteID image, PaletteID pal, int x, int y, int z, const SubSprite *sub)
Adds a child sprite to a parent sprite.
@ FS_SMALL
Index of the small font in the font tables.
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
@ HT_DIAGONAL
Also allow 'diagonal rectangles'. Only usable in combination with HT_RECT or HT_POINT.
bool population_in_label
show the population of a town in its label?
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.
static bool IsExpected(const BaseStation *st)
Helper for checking whether the given station is of this type.
bool(* VpSorterChecker)()
Type for method for checking whether a viewport sprite sorter exists.
ClientID
'Unique' identifier to be given to clients
const SubSprite * sub
only draw a rectangular part of the sprite
static const uint MAX_BUILDING_PIXELS
Maximum height of a building in pixels in #ZOOM_LVL_BASE. (Also applies to "bridge buildings" on the ...
@ ES_NOT_HANDLED
The passed event is not handled.
StationList stations_near
NOSAVE: List of nearby stations.
Corner
Enumeration of tile corners.
@ HT_RAIL
autorail (one piece), lower bits: direction
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...
byte max_bridge_height
maximum height of bridges
TileIndex GetNorthernBridgeEnd(TileIndex t)
Finds the northern end of a bridge starting at a middle tile.
int next
next child to draw (-1 at the end)
void EndSpriteCombine()
Terminates a block of sprites started by StartSpriteCombine.
static uint TilePixelHeightOutsideMap(int x, int y)
Returns the height of a tile in pixels, also for tiles outside the map (virtual "black" tiles).
static void CheckOverflow(int &test, int &other, int max, int mult)
Check for overflowing the map.
virtual void OnPlaceObject(Point pt, TileIndex tile)
The user clicked some place on the map when a tile highlight mode has been set.
static uint TileHeightOutsideMap(int x, int y)
Returns the height of a tile, also for tiles outside the map (virtual "black" tiles).
static const byte _string_colourmap[17]
Colour mapping for TextColour.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
@ TC_IS_PALETTE_COLOUR
Colour value is already a real palette colour index, not an index of a StringColour.
void MarkDirty(ZoomLevel maxzoom=ZOOM_LVL_MAX) const
Mark the sign dirty in all viewports.
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
uint16 width_small
The width when zoomed out (small font)
static void HighlightTownLocalAuthorityTiles(const TileInfo *ti)
Highlights tiles insede local authority of selected towns.
EconomySettings economy
settings to change the economy
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
static void ViewportDrawBoundingBoxes(const ParentSpriteToSortVector *psd)
Draws the bounding boxes of all ParentSprites.
@ DO_SHOW_STATION_NAMES
Display station names.
uint16 width_normal
The width when not zoomed out (normal font)
int32 left
minimal screen X coordinate of sprite (= x + sprite->x_offs), reference point for child sprites
int left
x position of left edge of the window
uint16 width
Width of the sprite.
bool make_square_red
Whether to give a tile a red selection.
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
int32 zmin
minimal world Z coordinate of bounding box
WindowClass
Window classes.
static int DivAwayFromZero(int a, uint b)
Computes (a / b) rounded away from zero.
void RedrawScreenRect(int left, int top, int right, int bottom)
Repaints a specific rectangle of the screen.
static Slope SlopeWithThreeCornersRaised(Corner corner)
Returns the slope with all except one corner raised.
void StartSpriteCombine()
Starts a block of sprites, which are "combined" into a single bounding box.
static Corner GetHalftileSlopeCorner(Slope s)
Returns the leveled halftile of a halftile slope.
Point pos
Location, in tile "units", of the northern tile of the selected area.
int32 first_child
the first child to draw.
void(* VpSpriteSorter)(ParentSpriteToSortVector *psd)
Type for the actual viewport sprite sorter.
@ SPRITE_COMBINE_NONE
Every AddSortableSpriteToDraw start its own bounding box.
SpriteCombineMode combine_sprites
Current mode of "sprite combining".
Point new_outersize
New value for outersize; used to determine whether to redraw the selection.
int virtual_width
width << zoom
Coordinates of a point in 2D.
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
int32 dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
static uint MapSizeY()
Get the size of the map along the Y.
@ WSM_DRAGDROP
Drag&drop an object.
void OffsetGroundSprite(int x, int y)
Called when a foundation has been drawn for the current tile.
static Waypoint * From(BaseStation *st)
Converts a BaseStation to SpecializedStation with type checking.
@ HT_DIR_MASK
masks the drag-direction
static int UnScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL) When shifting right,...
@ ZOOM_LVL_DETAIL
All zoomlevels below or equal to this, will result in details on the screen, like road-work,...
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
void ShowStationViewWindow(StationID station)
Opens StationViewWindow for given station.
const Town * _viewport_highlight_town
Currently selected town for coverage area highlight.
WindowNumber window_number
Window number within the window class.
@ PALETTE_MODIFIER_TRANSPARENT
when a sprite is to be displayed transparently, this bit needs to be set.
void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process)
highlighting tiles while only going over them with the mouse
@ SA_HOR_CENTER
Horizontally center the text.
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Iterable ensemble of all valid Windows.
Point InverseRemapCoords2(int x, int y, bool clamp_to_map, bool *clamped)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
static void ViewportAddLandscape()
Add the landscape to the viewport, i.e.
@ HT_VEHICLE
vehicle is accepted as target as well (bitmask)
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
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.
@ HT_DRAG
dragging items in the depot windows
static HighLightStyle GetAutorailHT(int x, int y)
returns the best autorail highlight type from map coordinates
ClientID _network_own_client_id
Our client identifier.
bool MarkAllViewportsDirty(int left, int top, int right, int bottom)
Mark all viewports that display an area as dirty (in need of repaint).
A pair-construct of a TileIndexDiff.
int32 ymax
maximal world Y coordinate of bounding box
ZoomLevel zoom_min
minimum zoom out level
byte dirty
Whether the build station window needs to redraw due to the changed selection.
byte dist_local_authority
distance for town local authority, default 20
HighLightStyle drawstyle
Lower bits 0-3 are reserved for detailed highlight information.
HighLightStyle place_mode
Method which is used to place the selection.
static const int MAX_TILE_EXTENT_BOTTOM
Maximum bottom extent of tile relative to north corner (worst case: SLOPE_STEEP_N).
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.
CommandCost CmdScrollViewport(DoCommandFlag flags, TileIndex tile, ViewportScrollTarget target, uint32 ref)
Scroll players main viewport.
void VpStartDragging(ViewportDragDropSelectionProcess process)
Drag over the map while holding the left mouse down.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
int32 scrollpos_x
Currently shown x coordinate (virtual screen coordinate of topleft corner of the viewport).
static void ClampViewportToMap(const Viewport *vp, int *scroll_x, int *scroll_y)
Ensure that a given viewport has a valid scroll position.
Point selstart
The location where the dragging started.
CompanyID _current_company
Company currently doing an action.
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...
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Vehicle * First() const
Get the first vehicle of this vehicle chain.
int32 top
minimal screen Y coordinate of sprite (= y + sprite->y_offs), reference point for child sprites
static int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL) When shifting right,...
static Slope SlopeWithOneCornerRaised(Corner corner)
Returns the slope with a specific corner raised.
static uint MapMaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
virtual void OnPlaceObjectAbort()
The user cancelled a tile highlight mode that has been set.
@ MP_VOID
Invisible tiles at the SW and SE border.
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.
static int GetTilePixelZ(TileIndex tile)
Get bottom height of the tile.
virtual void * MoveTo(void *video, int x, int y)=0
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
static size_t GetNumItems()
Returns number of valid items in the pool.
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
@ VPM_Y_LIMITED
Drag only in Y axis with limited size.
bool diagonal
Whether the dragged area is a 45 degrees rotated rectangle.
@ SLOPE_N
the north corner of the tile is raised
static void DrawTileSelection(const TileInfo *ti)
Checks if the specified tile is selected and if so draws selection using correct selectionstyle.
TileType
The different types of tiles.
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
ViewportScrollTarget
Target of the viewport scrolling GS method.
@ HT_LINE
used for autorail highlighting (longer stretches), lower bits: direction
void UpdatePosition(int center, int top, StringID str, StringID str_small=STR_NULL)
Update the position of the viewport sign.
static const PaletteID PALETTE_SEL_TILE_BLUE
This draws a blueish square (catchment areas for example)
TileIndex tile
The base tile of the area.
uint32 PaletteID
The number of the palette.
void Draw(const DrawPixelInfo *dpi)
Draw the linkgraph overlay or some part of it, in the area given.
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...
int32 y
screen Y coordinate of sprite
static ViewportSSCSS _vp_sprite_sorters[]
List of sorters ordered from best to worst.
@ WC_TOOLTIPS
Tooltip window; Window numbers:
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
static int GetViewportY(Point tile)
Returns the y coordinate in the viewport coordinate system where the given tile is painted.
@ OWNER_NONE
The tile has no ownership.
static void ViewportSortParentSprites(ParentSpriteToSortVector *psdv)
Sort parent sprites pointer array replicating the way original sorter did it.
T FindNearest(CoordT x, CoordT y) const
Find the element closest to given coordinate, in Manhattan distance.
@ MP_STATION
A tile of a station.
TownCache cache
Container for all cacheable data.
static StationID GetStationIndex(TileIndex t)
Get StationID from a tile.
EventState
State of handling an event.
bool kdtree_valid
Are the sign data valid for use with the _viewport_sign_kdtree?
@ HT_RECT
rectangle (stations, depots, ...)
@ VPM_FIX_HORIZONTAL
drag only in horizontal direction
void UpdateViewportPosition(Window *w)
Update the viewport position being displayed.
@ VPM_X_AND_Y
area of land in X and Y directions
@ DO_SHOW_SIGNS
Display signs.
void FindContained(CoordT x1, CoordT y1, CoordT x2, CoordT y2, const Outputter &outputter) const
Find all items contained within the given rectangle.
@ WSM_DRAGGING
Dragging mode (trees).
WindowClass window_class
Window class.
int16 y_offs
Number of pixels to shift the sprite downwards.
BitmapTileArea catchment_tiles
NOSAVE: Set of individual tiles covered by catchment area.
static HighLightStyle Check2x1AutoRail(int mode)
returns information about the 2x1 piece to be build.
@ OWNER_DEITY
The object is owned by a superuser / goal script.
@ WC_MAIN_WINDOW
Main window; Window numbers:
TileIndex xy
Base tile of the station.
UnitID unitnumber
unit number, for display purposes only
static int GetTileMaxPixelZ(TileIndex tile)
Get top height of the tile.
@ HT_DRAG_MASK
Mask for the tile drag-type modes.
static uint ScaleByMapSize1D(uint n)
Scales the given value by the maps circumference, where the given value is for a 256 by 256 map.
Base class for all station-ish types.
@ DO_SHOW_TOWN_NAMES
Display town names.
ViewportDragDropSelectionProcess select_proc
The procedure that has to be called when the selection is done.
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
static uint MapMaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
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.
int top
y position of top edge of the window
FoundationPart
Enumeration of multi-part foundations.
static TileHighlightType GetTileHighlightType(TileIndex t)
Get tile highlight type of coverage area for a given tile.
static T abs(const T a)
Returns the absolute value of (scalar) variable.
void DrawViewport() const
Draw the viewport of this window.
Viewport * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
uint32 VehicleID
The type all our vehicle IDs have.
static void ViewportDrawDirtyBlocks()
Draw/colour the blocks that have been redrawn.
HighLightStyle
Highlighting draw styles.
Parent sprite that should be drawn.
const SubSprite * sub
only draw a rectangular part of the sprite
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, INVALID_VEHICLE otherwise.
static void DrawSelectionSprite(SpriteID image, PaletteID pal, const TileInfo *ti, int z_offset, FoundationPart foundation_part, int extra_offs_x=0, int extra_offs_y=0)
Draws sprites between ground sprite and everything above.
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
void SetDirty()
Mark the linkgraph dirty to be rebuilt next time Draw() is called.
#define Debug(name, level, format_string,...)
Ouptut a line of debugging information.
void VpSetPresizeRange(TileIndex from, TileIndex to)
Highlights all tiles between a set of two tiles.
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
#define lengthof(x)
Return the length of an fixed size array.
int width
width of the window (number of pixels to the right in x direction)
@ VPM_X_LIMITED
Drag only in X axis with limited size.
ZoomLevel zoom
The zoom level of the viewport.
void AddChildSpriteScreen(SpriteID image, PaletteID pal, int x, int y, bool transparent, const SubSprite *sub, bool scale, bool relative)
Add a child sprite to a parent sprite.
int32 dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
static int GetBridgePixelHeight(TileIndex tile)
Get the height ('z') of a bridge in pixels.
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
@ VST_EVERYONE
All players.
WindowClass window_class
The WindowClass of the window that is responsible for the selection mode.
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in #ZOOM_LVL_BASE.
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
uint32 GetCompanyMask()
Get a bitmask of the currently shown companies.
static const int TILE_HEIGHT_STEP
One Z unit tile height difference is displayed as 50m.
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.
static bool ViewportSortParentSpritesChecker()
This fallback sprite checker always exists.
@ WC_TOWN_VIEW
Town view; Window numbers:
VpSpriteSorter fct_sorter
The sorting function.
@ ZOOM_LVL_NORMAL
The normal zoom level.
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
bool IsInUse() const
Check whether the base station currently is in use; in use means that it is not scheduled for deletio...
TileIndex tile
Tile index.
ConstructionSettings construction
construction of things in-game
Data structure for an opened window.
static const uint TILE_PIXELS
Pixel distance between tile columns/rows in #ZOOM_LVL_BASE.
static TileType GetTileType(TileIndex tile)
Get the tiletype of a given tile.
static const int MAX_TILE_EXTENT_RIGHT
Maximum right extent of tile relative to north corner.
HighLightStyle next_drawstyle
Queued, but not yet drawn style.
const Station * _viewport_highlight_station
Currently selected station for coverage area highlight.
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
Point TranslateXYToTileCoord(const Viewport *vp, int x, int y, bool clamp_to_map)
Translate screen coordinate in a viewport to underlying tile coordinate.
static const int MAX_TILE_EXTENT_TOP
Maximum top extent of tile relative to north corner (not considering bridges).
void InitializeSpriteSorter()
Choose the "best" sprite sorter and set _vp_sprite_sorter.
int virtual_height
height << zoom
static void Swap(T &a, T &b)
Type safe swap operation.
@ HT_POINT
point (lower land, raise land, level land, ...)
static Slope GetTilePixelSlope(TileIndex tile, int *h)
Return the slope of a given tile.
@ VPM_X_AND_Y_LIMITED
area of land of limited size
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
@ HT_DIR_HU
horizontal upper
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
SpriteCombineMode
Mode of "sprite combining".
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.
static Point RemapCoords2(int x, int y)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
Specification of a rectangle with absolute coordinates of all edges.
Point pos
logical mouse position
Data structure describing a sprite.
@ VPM_X_OR_Y
drag in X or Y direction
@ FOUNDATION_PART_NONE
Neither foundation nor groundsprite drawn yet.
@ DO_SHOW_WAYPOINT_NAMES
Display waypoint names.
void InitializeWindowViewport(Window *w, int x, int y, int width, int height, uint32 follow_flags, ZoomLevel zoom)
Initialize viewport of the window for use.
Point new_pos
New value for pos; used to determine whether to redraw the selection.
#define lastof(x)
Get the last element of an fixed size array.
void ShowWaypointWindow(const Waypoint *wp)
Show the window for the given waypoint.
@ HT_SPECIAL
special mode used for highlighting while dragging (and for tunnels/docks)
Helper class for getting the best sprite sorter.
void ViewportAddVehicles(DrawPixelInfo *dpi)
Add the vehicle sprites that should be drawn at a part of the screen.
TileIndex redsq
The tile that has to get a red selection.
bool freeze
Freeze highlight in place.
@ VPM_SIGNALDIRS
similar to VMP_RAILDIRS, but with different cursor
@ SLOPE_STEEP_N
a steep slope falling to south (from north)
@ PFE_DRAWWORLD
Time spent drawing world viewports in GUI.
@ WSM_NONE
No special mouse mode.
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.
bool smooth_scroll
smooth scroll viewports
GUISettings gui
settings related to the GUI
TrackedViewportSign sign
Location of name sign, UpdateVirtCoord updates this.
static T Delta(const T a, const T b)
Returns the (absolute) difference between two (scalar) variables.
uint16 SignID
The type of the IDs of signs.
Point selend
The location where the drag currently ends.
void SetViewportCatchmentTown(const Town *t, bool sel)
Select or deselect town for coverage area highlight.
Window * GetCallbackWnd()
Get the window that started the current highlighting.
Data about how and where to blit pixels.
void Reset()
Reset tile highlighting.
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
static bool IsBridgeAbove(TileIndex t)
checks if a bridge is set above the ground of this tile
int32 xmax
maximal world X coordinate of bounding box
@ SPRITE_COMBINE_PENDING
Sprite combining will start with the next unclipped sprite.
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
Draw a sprite in a viewport.