84#include "viewport_kdtree.h"
94#include <forward_list>
99#include "table/strings.h"
104Point _tile_fract_coords;
108static int _viewport_sign_maxwidth = 0;
161typedef std::vector<TileSpriteToDraw> TileSpriteToDrawVector;
162typedef std::vector<StringSpriteToDraw> StringSpriteToDrawVector;
163typedef std::vector<ParentSpriteToDraw> ParentSpriteToDrawVector;
164typedef std::vector<ChildScreenSpriteToDraw> ChildScreenSpriteToDrawVector;
173 StringSpriteToDrawVector string_sprites_to_draw;
174 TileSpriteToDrawVector tile_sprites_to_draw;
175 ParentSpriteToDrawVector parent_sprites_to_draw;
177 ChildScreenSpriteToDrawVector child_screen_sprites_to_draw;
195bool _draw_bounding_boxes =
false;
196bool _draw_dirty_blocks =
false;
197uint _dirty_block_colour = 0;
200static Point MapXYZToViewport(
const Viewport &vp,
int x,
int y,
int z)
219 int width,
int height, std::variant<TileIndex, VehicleID> focus,
ZoomLevel zoom)
223 auto vp = std::make_unique<ViewportData>();
225 vp->left = x + w->
left;
226 vp->top = y + w->
top;
237 if (std::holds_alternative<VehicleID>(focus)) {
240 vp->follow_vehicle = std::get<VehicleID>(focus);
244 TileIndex tile = std::get<TileIndex>(focus);
251 pt.
x -= vp->virtual_width / 2;
253 pt.
y -= vp->virtual_height / 2;
259 vp->follow_vehicle = VehicleID::Invalid();
262 vp->scrollpos_x = pt.
x;
263 vp->scrollpos_y = pt.
y;
264 vp->dest_scrollpos_x = pt.
x;
265 vp->dest_scrollpos_y = pt.
y;
267 vp->overlay =
nullptr;
269 vp->virtual_left = 0;
275static Point _vp_move_offs;
279 for (; !it.IsEnd(); ++it) {
281 if (left + width > w->
left &&
283 top + height > w->
top &&
286 if (left < w->left) {
287 DoSetViewportPosition(it, left, top, w->
left - left, height);
288 DoSetViewportPosition(it, left + (w->
left - left), top, width - (w->
left - left), height);
293 DoSetViewportPosition(it, left, top, (w->
left + w->
width - left), height);
294 DoSetViewportPosition(it, left + (w->
left + w->
width - left), top, width - (w->
left + w->
width - left), height);
299 DoSetViewportPosition(it, left, top, width, (w->
top - top));
300 DoSetViewportPosition(it, left, top + (w->
top - top), width, height - (w->
top - top));
305 DoSetViewportPosition(it, left, top, width, (w->
top + w->
height - top));
306 DoSetViewportPosition(it, left, top + (w->
top + w->
height - top), width, height - (w->
top + w->
height - top));
315 int xo = _vp_move_offs.
x;
316 int yo = _vp_move_offs.
y;
318 if (
abs(xo) >= width ||
abs(yo) >= height) {
324 GfxScroll(left, top, width, height, xo, yo);
343static void SetViewportPosition(
Window *w,
int x,
int y)
349 int left, top, width, height;
365 if (old_top == 0 && old_left == 0)
return;
367 _vp_move_offs.
x = old_left;
368 _vp_move_offs.
y = old_top;
380 i = left + width - _screen.width;
381 if (i >= 0) width -= i;
389 i = top + height - _screen.height;
390 if (i >= 0) height -= i;
395 DoSetViewportPosition(it, left, top, width, height);
410 if (w->
viewport ==
nullptr)
return nullptr;
433 Point pt = { -1, -1 };
445static Point GetTileFromScreenXY(
int x,
int y,
int zoom_x,
int zoom_y)
456Point GetTileBelowCursor()
458 return GetTileFromScreenXY(_cursor.
pos.
x, _cursor.
pos.
y, _cursor.
pos.
x, _cursor.
pos.
y);
475 return GetTileFromScreenXY(_cursor.
pos.
x, _cursor.
pos.
y, x + vp.
left, y + vp.
top);
516 ts.
x = pt.
x + extra_offs_x;
517 ts.
y = pt.
y + extra_offs_y;
534 assert(
IsInsideMM(foundation_part, 0, FOUNDATION_PART_END));
535 assert(_vd.
foundation[foundation_part] != -1);
565 AddTileSpriteToDraw(image, pal, _cur_ti.
x + x, _cur_ti.
y + y, _cur_ti.
z + z, sub, extra_offs_x * ZOOM_BASE, extra_offs_y * ZOOM_BASE);
601 default: NOT_REACHED();
628 if (pt.
x + spr->
x_offs >= _vd.dpi.left + _vd.dpi.width ||
630 pt.
y + spr->
y_offs >= _vd.dpi.top + _vd.dpi.height ||
665 int32_t left, right, top, bottom;
688 int tmp_left, tmp_top, tmp_x = pt.
x, tmp_y = pt.
y;
691 if (image == SPR_EMPTY_BOUNDING_BOX) {
698 left = tmp_left = (pt.
x += spr->
x_offs);
699 right = (pt.
x + spr->
width );
700 top = tmp_top = (pt.
y += spr->
y_offs);
704 if (_draw_bounding_boxes && (image != SPR_EMPTY_BOUNDING_BOX)) {
713 if (left >= _vd.dpi.left + _vd.dpi.width ||
714 right <= _vd.dpi.left ||
715 top >= _vd.dpi.top + _vd.dpi.height ||
716 bottom <= _vd.dpi.top) {
791 if (begin > end) std::swap(begin, end);
792 return begin <= check && check <= end;
805 int a = ((x - _thd.
pos.
x) + (y - _thd.
pos.
y));
806 int b = ((x - _thd.
pos.
x) - (y - _thd.
pos.
y));
837 int32_t child_id =
static_cast<int32_t
>(_vd.child_screen_sprites_to_draw.size());
839 _vd.child_screen_sprites_to_draw[_vd.last_child].next = child_id;
841 _vd.parent_sprites_to_draw.back().first_child = child_id;
848 cs.x = scale ? x * ZOOM_BASE : x;
849 cs.y = scale ? y * ZOOM_BASE : y;
850 cs.relative = relative;
858 _vd.last_child = child_id;
921 SpriteID sel2 = SPR_HALFTILE_SELECTION_FLAT + halftile_corner;
926 sel = SPR_HALFTILE_SELECTION_DOWN;
930 sel += opposite_corner;
937static bool IsPartOfAutoLine(
int px,
int py)
947 case HT_DIR_HU:
return px == -py || px == -py - 16;
948 case HT_DIR_HL:
return px == -py || px == -py + 16;
949 case HT_DIR_VL:
return px == py || px == py + 16;
950 case HT_DIR_VR:
return px == py || px == py - 16;
983 static const uint _lower_rail[4] = { 5U, 2U, 4U, 3U };
985 if (autorail_type != _lower_rail[halftile_corner]) {
992 offset = _AutorailTilehSprite[autorail_tileh][autorail_type];
994 image = SPR_AUTORAIL_BASE + offset;
997 image = SPR_AUTORAIL_BASE - offset;
1004enum TileHighlightType : uint8_t {
1033 TileHighlightType type = THT_RED;
1036 if (st->TileIsInCatchment(t))
return THT_BLUE;
1060 case THT_NONE:
break;
1075 if (_town_local_authority_kdtree.
Count() == 0)
return;
1141 if ((halftile_corner == CORNER_W) || (halftile_corner == CORNER_E)) z +=
TILE_HEIGHT;
1142 if (halftile_corner != CORNER_S) {
1153 }
else if (IsPartOfAutoLine(ti->
x, ti->
y)) {
1171 if (!is_redsq && (tht == THT_NONE || tht == THT_RED) && _thd.
outersize.
x > 0 &&
1197 assert(_vd.dpi.top <= _vd.dpi.top + _vd.dpi.height);
1198 assert(_vd.dpi.left <= _vd.dpi.left + _vd.dpi.width);
1216 int left_column = (upper_left.
y - upper_left.
x) / (
int)
TILE_SIZE - 2;
1217 int right_column = (upper_right.
y - upper_right.
x) / (
int)
TILE_SIZE + 2;
1225 int row = (upper_left.
x + upper_left.
y) / (
int)
TILE_SIZE - 2;
1226 bool last_row =
false;
1227 for (; !last_row; row++) {
1229 for (
int column = left_column; column <= right_column; column++) {
1231 if ((row + column) % 2 != 0)
continue;
1234 tilecoord.
x = (row - column) / 2;
1235 tilecoord.
y = (row + column) / 2;
1236 assert(column == tilecoord.
y - tilecoord.
x);
1237 assert(row == tilecoord.
y + tilecoord.
x);
1269 int min_visible_height = viewport_y - (_vd.dpi.top + _vd.dpi.height);
1270 bool tile_visible = min_visible_height <= 0;
1289 if ((tilecoord.
x <= 0 || tilecoord.
y <= 0) && min_visible_height < potential_bridge_height +
MAX_TILE_EXTENT_TOP) last_row =
false;
1317 int left = dpi->left;
1319 int right = left + dpi->width;
1320 int bottom = top + dpi->height;
1326 if (bottom < sign->top ||
1327 top > sign->
top + sign_height ||
1328 right < sign->center - sign_half_width ||
1329 left > sign->
center + sign_half_width) {
1339 const int max_tw = _viewport_sign_maxwidth / 2 + 1;
1344 r.right += expand_x;
1346 r.bottom += expand_y;
1363 StringID stringid_town_city = stringid_town;
1368 for (
const Town *t : towns) {
1369 std::string *str =
ViewportAddString(dpi, &t->cache.sign, flags, INVALID_COLOUR);
1370 if (str ==
nullptr)
continue;
1372 if (t->larger_town) {
1373 *str =
GetString(stringid_town_city, t->index, t->cache.population);
1375 *str =
GetString(stringid_town, t->index, t->cache.population);
1395 for (
const Sign *si : signs) {
1398 if (str ==
nullptr)
continue;
1400 *str =
GetString(STR_SIGN_NAME, si->index);
1418 if (str ==
nullptr)
continue;
1421 *str =
GetString(small ? STR_STATION_NAME : STR_VIEWPORT_STATION, st->index, st->facilities);
1423 *str =
GetString(STR_WAYPOINT_NAME, st->index);
1430 Rect search_rect{ dpi->left, dpi->top, dpi->left + dpi->width, dpi->top + dpi->height };
1431 search_rect = ExpandRectWithViewportSignMargins(search_rect, dpi->zoom);
1440 std::vector<const BaseStation *> stations;
1441 std::vector<const Town *> towns;
1442 std::vector<const Sign *> signs;
1445 switch (item.type) {
1446 case ViewportSignKdtreeItem::VKI_STATION: {
1447 if (!show_stations) break;
1448 const BaseStation *st = BaseStation::Get(std::get<StationID>(item.id));
1451 StationFacilities facilities = st->facilities;
1452 if (facilities.None()) facilities = STATION_FACILITY_GHOST;
1454 if (!facilities.Any(_facility_display_opt)) break;
1457 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
1459 stations.push_back(st);
1463 case ViewportSignKdtreeItem::VKI_WAYPOINT: {
1464 if (!show_waypoints) break;
1465 const BaseStation *st = BaseStation::Get(std::get<StationID>(item.id));
1468 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
1470 stations.push_back(st);
1474 case ViewportSignKdtreeItem::VKI_TOWN:
1475 if (!show_towns) break;
1476 towns.push_back(Town::Get(std::get<TownID>(item.id)));
1479 case ViewportSignKdtreeItem::VKI_SIGN: {
1480 if (!show_signs) break;
1481 const Sign *si = Sign::Get(std::get<SignID>(item.id));
1486 if (!show_competitors && _local_company != si->owner && si->owner != OWNER_DEITY) break;
1488 signs.push_back(si);
1528 if (str_small.empty()) str_small = str;
1556 if (w->
viewport ==
nullptr)
continue;
1559 if (vp.
zoom <= maxzoom) {
1560 assert(vp.
width != 0);
1567static void ViewportDrawTileSprites(
const TileSpriteToDrawVector *tstdv)
1583 if (psdv->size() < 2)
return;
1592 const uint32_t ORDER_COMPARED = UINT32_MAX;
1593 const uint32_t ORDER_RETURNED = UINT32_MAX - 1;
1594 std::stack<ParentSpriteToDraw *> sprite_order;
1595 uint32_t next_order = 0;
1597 std::forward_list<std::pair<int64_t, ParentSpriteToDraw *>> sprite_list;
1600 for (
auto p = psdv->rbegin(); p != psdv->rend(); p++) {
1601 sprite_list.emplace_front((*p)->xmin + (*p)->ymin, *p);
1602 sprite_order.push(*p);
1603 (*p)->order = next_order++;
1608 std::vector<ParentSpriteToDraw *> preceding;
1609 auto preceding_prev = sprite_list.begin();
1610 auto out = psdv->begin();
1612 while (!sprite_order.empty()) {
1614 auto s = sprite_order.top();
1618 if (s->order == ORDER_RETURNED)
continue;
1621 if (s->order == ORDER_COMPARED) {
1623 s->order = ORDER_RETURNED;
1637 auto ssum = std::max(s->xmax, s->xmin) + std::max(s->ymax, s->ymin);
1638 auto prev = sprite_list.before_begin();
1639 auto x = sprite_list.begin();
1640 while (x != sprite_list.end() && ((*x).first <= ssum)) {
1641 auto p = (*x).second;
1644 x = sprite_list.erase_after(prev);
1651 if (s->xmax < p->xmin || s->ymax < p->ymin || s->zmax < p->zmin)
continue;
1652 if (s->xmin <= p->xmax &&
1653 s->ymin <= p->ymax &&
1654 s->zmin <= p->zmax) {
1655 if (s->xmin + s->xmax + s->ymin + s->ymax + s->zmin + s->zmax <=
1656 p->xmin + p->xmax + p->ymin + p->ymax + p->zmin + p->zmax) {
1660 preceding.push_back(p);
1661 preceding_prev = p_prev;
1664 if (preceding.empty()) {
1667 s->order = ORDER_RETURNED;
1672 if (preceding.size() == 1) {
1673 auto p = preceding[0];
1675 if (p->xmax <= s->xmax && p->ymax <= s->ymax && p->zmax <= s->zmax) {
1676 p->order = ORDER_RETURNED;
1677 s->order = ORDER_RETURNED;
1678 sprite_list.erase_after(preceding_prev);
1687 return a->order > b->order;
1690 s->order = ORDER_COMPARED;
1691 sprite_order.push(s);
1693 for (
auto p: preceding) {
1694 p->order = next_order++;
1695 sprite_order.push(p);
1701static void ViewportDrawParentSprites(
const ParentSpriteToSortVector *psd,
const ChildScreenSpriteToDrawVector *csstdv)
1704 if (ps->image != SPR_EMPTY_BOUNDING_BOX)
DrawSpriteViewport(ps->image, ps->pal, ps->x, ps->y, ps->sub);
1706 int child_idx = ps->first_child;
1707 while (child_idx >= 0) {
1709 child_idx = cs->
next;
1732 pt2.
x - pt1.
x, pt2.
y - pt1.
y,
1733 pt3.
x - pt1.
x, pt3.
y - pt1.
y,
1734 pt4.
x - pt1.
x, pt4.
y - pt1.
y);
1753 uint8_t bo =
UnScaleByZoom(dpi->left + dpi->top, dpi->zoom) & 1;
1755 for (
int i = (bo ^= 1); i < right; i += 2) blitter->
SetPixel(dst, i, 0, colour);
1756 dst = blitter->
MoveTo(dst, 0, 1);
1757 }
while (--bottom > 0);
1760static void ViewportDrawStrings(
ZoomLevel zoom,
const StringSpriteToDrawVector *sstdv)
1771 if (ss.colour != INVALID_COLOUR)
DrawFrameRect(x, y, x + w - 1, y + h - 1, ss.colour, {});
1778 if (ss.colour != INVALID_COLOUR) colour =
GetColourGradient(ss.colour, SHADE_LIGHTER).ToTextColour();
1785 int shadow_offset = 0;
1796void ViewportDoDraw(
const Viewport &vp,
int left,
int top,
int right,
int bottom)
1798 _vd.dpi.zoom = vp.
zoom;
1803 _vd.dpi.width = (right - left) & mask;
1804 _vd.dpi.height = (bottom - top) & mask;
1805 _vd.dpi.left = left & mask;
1806 _vd.dpi.top = top & mask;
1807 _vd.dpi.pitch = _cur_dpi->pitch;
1819 ViewportAddKdtreeSigns(&_vd.dpi);
1821 DrawTextEffects(&_vd.dpi);
1823 if (!_vd.tile_sprites_to_draw.empty()) ViewportDrawTileSprites(&_vd.tile_sprites_to_draw);
1825 for (
auto &psd : _vd.parent_sprites_to_draw) {
1842 if (vp.overlay !=
nullptr && vp.overlay->GetCargoMask() != 0 && vp.overlay->GetCompanyMask().Any()) {
1846 vp.overlay->Draw(&dp);
1849 if (!_vd.string_sprites_to_draw.empty()) {
1853 ViewportDrawStrings(zoom, &_vd.string_sprites_to_draw);
1856 _vd.string_sprites_to_draw.clear();
1857 _vd.tile_sprites_to_draw.clear();
1858 _vd.parent_sprites_to_draw.clear();
1860 _vd.child_screen_sprites_to_draw.clear();
1863static inline void ViewportDraw(
const Viewport &vp,
int left,
int top,
int right,
int bottom)
1865 if (right <= vp.
left || bottom <= vp.
top)
return;
1869 if (left < vp.
left) left = vp.
left;
1874 if (top < vp.
top) top = vp.
top;
1894 dpi->left += this->
left;
1895 dpi->top += this->
top;
1897 ViewportDraw(*this->
viewport, dpi->left, dpi->top, dpi->left + dpi->width, dpi->top + dpi->height);
1899 dpi->left -= this->
left;
1900 dpi->top -= this->
top;
1945static void ClampSmoothScroll(uint32_t delta_ms, int64_t delta_hi, int64_t delta_lo,
int &delta_hi_clamped,
int &delta_lo_clamped)
1948 constexpr int PIXELS_PER_TILE =
TILE_PIXELS * 2 * ZOOM_BASE;
1950 assert(delta_hi != 0);
1953 int64_t delta_left = delta_hi * std::pow(0.75, delta_ms / 30.0);
1958 delta_hi_clamped =
Clamp(delta_hi - delta_left, -max_scroll, max_scroll);
1960 delta_lo_clamped = delta_lo * delta_hi_clamped / delta_hi;
1963 if (delta_hi_clamped == 0) {
1964 delta_hi_clamped = delta_hi > 0 ? 1 : -1;
1945static void ClampSmoothScroll(uint32_t delta_ms, int64_t delta_hi, int64_t delta_lo,
int &delta_hi_clamped,
int &delta_lo_clamped) {
…}
1983 SetViewportPosition(w, pt.
x, pt.
y);
1994 bool update_overlay =
false;
1995 if (delta_x != 0 || delta_y != 0) {
1997 int delta_x_clamped;
1998 int delta_y_clamped;
2000 if (
abs(delta_x) >
abs(delta_y)) {
2001 ClampSmoothScroll(delta_ms, delta_x, delta_y, delta_x_clamped, delta_y_clamped);
2003 ClampSmoothScroll(delta_ms, delta_y, delta_x, delta_y_clamped, delta_x_clamped);
2026 if (update_overlay) RebuildViewportOverlay(w);
2047 if (right <= 0)
return false;
2050 if (bottom <= 0)
return false;
2084 if (w->viewport !=
nullptr) {
2085 assert(w->viewport->width != 0);
2093void ConstrainAllViewportsZoom()
2096 if (w->viewport ==
nullptr)
continue;
2099 if (zoom != w->viewport->zoom) {
2132 int x_size = _thd.
size.
x;
2133 int y_size = _thd.
size.
y;
2136 int x_start = _thd.
pos.
x;
2137 int y_start = _thd.
pos.
y;
2141 x_start += _thd.
offs.
x;
2143 y_start += _thd.
offs.
y;
2149 assert(x_size >= 0);
2150 assert(y_size >= 0);
2159 assert((x_end | y_end | x_start | y_start) %
TILE_SIZE == 0);
2180 int top_y = y_start;
2201 static const int OVERLAY_WIDTH = 4 * ZOOM_BASE;
2207 if (top_x != x_start) {
2214 if (bot_y != y_end) {
2219 }
while (bot_x >= top_x);
2222 int a_size = x_size + y_size, b_size = x_size - y_size;
2227 for (
int a = -interval_a; a != a_size + interval_a; a += interval_a) {
2228 for (
int b = -interval_b; b != b_size + interval_b; b += interval_b) {
2241void SetSelectionRed(
bool b)
2261 return y >= sign->
top && y < sign->
top + sign_height &&
2262 x >= sign->
center - sign_half_width && x < sign->
center + sign_half_width;
2275 if (_game_mode == GM_MENU)
return false;
2280 Rect search_rect{ x - 1, y - 1, x + 1, y + 1 };
2281 search_rect = ExpandRectWithViewportSignMargins(search_rect, vp.
zoom);
2291 Town *t =
nullptr, *last_t =
nullptr;
2292 Sign *si =
nullptr, *last_si =
nullptr;
2296 switch (item.type) {
2297 case ViewportSignKdtreeItem::VKI_STATION: {
2298 if (!show_stations) break;
2299 st = BaseStation::Get(std::get<StationID>(item.id));
2300 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
2302 StationFacilities facilities = st->facilities;
2303 if (facilities.None()) facilities = STATION_FACILITY_GHOST;
2304 if (!facilities.Any(_facility_display_opt)) break;
2306 if (CheckClickOnViewportSign(vp, x, y, &st->sign)) last_st = st;
2310 case ViewportSignKdtreeItem::VKI_WAYPOINT:
2311 if (!show_waypoints) break;
2312 st = BaseStation::Get(std::get<StationID>(item.id));
2313 if (!show_competitors && _local_company != st->owner && st->owner != OWNER_NONE) break;
2314 if (CheckClickOnViewportSign(vp, x, y, &st->sign)) last_st = st;
2317 case ViewportSignKdtreeItem::VKI_TOWN:
2318 if (!show_towns) break;
2319 t = Town::Get(std::get<TownID>(item.id));
2320 if (CheckClickOnViewportSign(vp, x, y, &t->cache.sign)) last_t = t;
2323 case ViewportSignKdtreeItem::VKI_SIGN:
2324 if (!show_signs) break;
2325 si = Sign::Get(std::get<SignID>(item.id));
2326 if (!show_competitors && _local_company != si->owner && si->owner != OWNER_DEITY) break;
2327 if (CheckClickOnViewportSign(vp, x, y, &si->sign)) last_si = si;
2336 if (last_st !=
nullptr) {
2343 }
else if (last_t !=
nullptr) {
2344 ShowTownViewWindow(last_t->index);
2346 }
else if (last_si !=
nullptr) {
2358 item.type = VKI_STATION;
2375 item.type = VKI_WAYPOINT;
2392 item.type = VKI_TOWN;
2409 item.type = VKI_SIGN;
2414 item.center = sign->sign.
center;
2415 item.top = sign->sign.
top;
2418 _viewport_sign_maxwidth = std::max<int>({_viewport_sign_maxwidth, sign->sign.
width_normal, sign->sign.
width_small});
2423void RebuildViewportKdtree()
2426 _viewport_sign_maxwidth = 0;
2428 std::vector<ViewportSignKdtreeItem> items;
2436 if (wp->sign.kdtree_valid) items.push_back(ViewportSignKdtreeItem::MakeWaypoint(wp->index));
2439 for (
const Town *town :
Town::Iterate()) {
2443 for (
const Sign *sign :
Sign::Iterate()) {
2444 if (sign->sign.
kdtree_valid) items.push_back(ViewportSignKdtreeItem::MakeSign(sign->
index));
2447 _viewport_sign_kdtree.
Build(items.begin(), items.end());
2451static bool CheckClickOnLandscape(
const Viewport &vp,
int x,
int y)
2459static void PlaceObject()
2464 pt = GetTileBelowCursor();
2465 if (pt.
x == -1)
return;
2480bool HandleViewportClicked(
const Viewport &vp,
int x,
int y)
2495 bool result = CheckClickOnLandscape(vp, x, y);
2512void RebuildViewportOverlay(
Window *w)
2514 if (w->
viewport->overlay !=
nullptr &&
2515 w->
viewport->overlay->GetCompanyMask().Any() &&
2516 w->
viewport->overlay->GetCargoMask() != 0) {
2546 if (w->
viewport->dest_scrollpos_x == pt.
x && w->
viewport->dest_scrollpos_y == pt.
y)
return false;
2551 RebuildViewportOverlay(w);
2612void SetTileSelectBigSize(
int ox,
int oy,
int sx,
int sy)
2672 bool new_diagonal =
false;
2678 int x2 = _thd.
selstart.
x & ~TILE_UNIT_MASK;
2679 int y2 = _thd.
selstart.
y & ~TILE_UNIT_MASK;
2680 x1 &= ~TILE_UNIT_MASK;
2681 y1 &= ~TILE_UNIT_MASK;
2684 new_diagonal =
true;
2686 if (x1 >= x2) std::swap(x1, x2);
2687 if (y1 >= y2) std::swap(y1, y2);
2693 if (!new_diagonal) {
2700 Point pt = GetTileBelowCursor();
2732 default: NOT_REACHED();
2740 _thd.
new_pos.
x = x1 & ~TILE_UNIT_MASK;
2741 _thd.
new_pos.
y = y1 & ~TILE_UNIT_MASK;
2777static void HideMeasurementTooltips()
2828void VpSetPlaceSizingLimit(
int limit)
2852 HideMeasurementTooltips();
2856static void VpStartPreSizing()
2868 int fxpy = _tile_fract_coords.
x + _tile_fract_coords.
y;
2870 int fxmy = _tile_fract_coords.
x - _tile_fract_coords.
y;
2874 default: NOT_REACHED();
2876 if (fxpy >= 20 && sxpy <= 12)
return HT_DIR_HL;
2877 if (fxmy < -3 && sxmy > 3)
return HT_DIR_VR;
2881 if (fxmy > 3 && sxmy < -3)
return HT_DIR_VL;
2882 if (fxpy <= 12 && sxpy >= 20)
return HT_DIR_HU;
2886 if (fxmy > 3 && sxmy < -3)
return HT_DIR_VL;
2887 if (fxpy >= 20 && sxpy <= 12)
return HT_DIR_HL;
2891 if (fxmy < -3 && sxmy > 3)
return HT_DIR_VR;
2892 if (fxpy <= 12 && sxpy >= 20)
return HT_DIR_HU;
2912 uint start_x =
TileX(start_tile);
2913 uint start_y =
TileY(start_tile);
2914 uint end_x =
TileX(end_tile);
2915 uint end_y =
TileY(end_tile);
2919 case HT_LINE:
return (end_x > start_x || (end_x == start_x && end_y > start_y));
2922 case HT_POINT:
return (end_x != start_x && end_y < start_y);
2923 default: NOT_REACHED();
2949 if (start_tile == end_tile)
return 0;
2950 if (swap) std::swap(start_tile, end_tile);
2974 static const std::pair<TileIndexDiffC, TileIndexDiffC> start_heightdiff_line_by_dir[] = {
2982 static const std::pair<TileIndexDiffC, TileIndexDiffC> end_heightdiff_line_by_dir[] = {
2990 static_assert(std::size(start_heightdiff_line_by_dir) ==
HT_DIR_END);
2991 static_assert(std::size(end_heightdiff_line_by_dir) ==
HT_DIR_END);
3001 if (swap && distance == 0) style = flip_style_direction[style];
3004 auto get_height = [](
auto &tile,
auto &heightdiffs) {
3011 h0 = get_height(start_tile, start_heightdiff_line_by_dir[style]);
3015 if (distance == 0) style = flip_style_direction[style];
3016 h1 = get_height(end_tile, end_heightdiff_line_by_dir[style]);
3021 if (swap) std::swap(h0, h1);
3033 if (test >= 0)
return;
3035 other += mult * test;
3048 if (test <= max)
return;
3050 other += mult * (test - max);
3093 int offset = (raw_dx - raw_dy) / 2;
3094 x = _thd.
selstart.
x - (offset & ~TILE_UNIT_MASK);
3095 y = _thd.
selstart.
y + (offset & ~TILE_UNIT_MASK);
3128 int offset = (raw_dx + raw_dy + (int)
TILE_SIZE) / 2;
3129 x = _thd.
selstart.
x - (offset & ~TILE_UNIT_MASK);
3130 y = _thd.
selstart.
y - (offset & ~TILE_UNIT_MASK);
3177 }
else if (w > h * 2) {
3180 }
else if (h > w * 2) {
3194 }
else if (d >= 0) {
3205 }
else if (d >= 0) {
3218 }
else if (d >= 0) {
3229 }
else if (d >= 0) {
3245 if (distance == 1) {
3246 HideMeasurementTooltips();
3253 distance =
CeilDiv(distance, 2);
3256 if (heightdiff == 0) {
3307 if (
abs(sy - y) <
abs(sx - x)) {
3314 goto calc_heightdiff_single_direction;
3323 goto calc_heightdiff_single_direction;
3333calc_heightdiff_single_direction:;
3335 x = sx +
Clamp(x - sx, -limit, limit);
3336 y = sy +
Clamp(y - sy, -limit, limit);
3343 if (distance == 1) {
3344 HideMeasurementTooltips();
3353 if (heightdiff == 0) {
3364 x = sx +
Clamp(x - sx, -limit, limit);
3365 y = sy +
Clamp(y - sy, -limit, limit);
3391 int a_max = dist_x + dist_y;
3392 int b_max = dist_y - dist_x;
3396 a_max =
abs(a_max + (a_max > 0 ? 2 : -2)) / 2;
3397 b_max =
abs(b_max + (b_max > 0 ? 2 : -2)) / 2;
3403 if (a_max != 1 || b_max != 1) {
3410 }
else if (dy == 1) {
3415 if (dx != 1 || dy != 1) {
3421 if (heightdiff == 0) {
3430 default: NOT_REACHED();
3482 HideMeasurementTooltips();
3523 HideMeasurementTooltips();
3584 { &ViewportSortParentSpritesSSE41Checker, &ViewportSortParentSpritesSSE41 },
3593 if (sprite_sorter.fct_checker()) {
3594 _vp_sprite_sorter = sprite_sorter.fct_sorter;
3598 assert(_vp_sprite_sorter !=
nullptr);
3632void MarkCatchmentTilesDirty()
3657static void SetWindowDirtyForViewportCatchment()
3664static void ClearViewportCatchment()
3666 MarkCatchmentTilesDirty();
3680 SetWindowDirtyForViewportCatchment();
3682 ClearViewportCatchment();
3684 MarkCatchmentTilesDirty();
3686 MarkCatchmentTilesDirty();
3700 SetWindowDirtyForViewportCatchment();
3702 ClearViewportCatchment();
3704 MarkCatchmentTilesDirty();
3706 MarkCatchmentTilesDirty();
3720 SetWindowDirtyForViewportCatchment();
3722 ClearViewportCatchment();
This file defines all the the animated cursors.
static const AnimCursor *const _animcursors[]
This is an array of pointers to all the animated cursor definitions we have above.
Highlight/sprite information for autorail.
Class for backupping variables and making sure they are restored later.
debug_inline constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
TileIndex GetNorthernBridgeEnd(TileIndex t)
Finds the northern end of a bridge starting at a middle tile.
Map accessor functions for bridges.
int GetBridgePixelHeight(TileIndex tile)
Get the height ('z') of a bridge in pixels.
bool IsBridgeAbove(Tile t)
checks if a bridge is set above the ground of this tile
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Set()
Set all bits.
Iterator to iterate over all tiles belonging to a bitmaptilearea.
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
How all blitters should look like.
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...
virtual void SetPixel(void *video, int x, int y, PixelColour colour)=0
Draw a pixel with a given colour on the video-buffer.
Common return value for all commands.
Container for an encoded string, created by GetEncodedString.
K-dimensional tree, specialised for 2-dimensional space.
void Build(It begin, It end)
Clear and rebuild the tree from a new sequence of elements,.
size_t Count() const
Get number of elements stored in tree.
void FindContained(CoordT x1, CoordT y1, CoordT x2, CoordT y2, const Outputter &outputter) const
Find all items contained within the given rectangle.
T FindNearest(CoordT x, CoordT y) const
Find the element closest to given coordinate, in Manhattan distance.
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Execute
execute the given command
Definition of stuff that is very close to a company, like the company struct itself.
TypedIndexContainer< std::array< Colours, MAX_COMPANIES >, CompanyID > _company_colours
NOSAVE: can be determined from company structs.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
CompanyID _current_company
Company currently doing an action.
Functions related to companies.
static constexpr Owner OWNER_DEITY
The object is owned by a superuser / goal script.
static constexpr Owner OWNER_NONE
The tile has no ownership.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23)
Factory to 'query' all available blitters.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Types for recording game performance data.
@ PFE_DRAWWORLD
Time spent drawing world viewports in GUI.
void SetMouseCursor(CursorID sprite, PaletteID pal)
Assign a single non-animated sprite to the cursor.
bool _left_button_down
Is left mouse button pressed?
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
bool _ctrl_pressed
Is Ctrl pressed?
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
Draw a sprite in a viewport.
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
Draws the projection of a parallelepiped.
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
@ Normal
The most basic (normal) sprite.
@ FS_SMALL
Index of the small font in the font tables.
@ FS_NORMAL
Index of the normal font in the font tables.
uint32_t CursorID
The number of the cursor (sprite)
@ SA_HOR_CENTER
Horizontally center the text.
uint32_t PaletteID
The number of the palette.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
bool MarkAllViewportsDirty(int left, int top, int right, int bottom)
Mark all viewports that display an area as dirty (in need of repaint).
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
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.
void MarkDirty(ZoomLevel maxzoom=ZoomLevel::Max) const
Mark the sign dirty in all viewports.
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.
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
void RedrawScreenRect(int left, int top, int right, int bottom)
Repaints a specific rectangle of the screen.
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
static void SetSelectionTilesDirty()
Marks the selected tiles as dirty.
const TileTypeProcs *const _tile_type_procs[16]
Tile callback functions for each type of tile.
Point InverseRemapCoords2(int x, int y, bool clamp_to_map, bool *clamped)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
int GetSlopePixelZ(int x, int y, bool ground_vehicle)
Return world Z coordinate of a given point of a tile.
Functions related to OTTD's landscape.
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.
Point RemapCoords2(int x, int y)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
Point InverseRemapCoords(int x, int y)
Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
Declaration of linkgraph overlay GUI.
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
TileIndex TileAddByDir(TileIndex tile, Direction dir)
Adds a Direction to a tile.
static debug_inline TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)
Return the offset between two tiles from a TileIndexDiffC struct.
constexpr TileIndex TileAdd(TileIndex tile, TileIndexDiff offset)
Adds a given offset to a tile.
static debug_inline uint TileY(TileIndex tile)
Get the Y component of a tile.
static debug_inline uint TileX(TileIndex tile)
Get the X component of a tile.
static debug_inline TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
constexpr 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.
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
constexpr T abs(const T a)
Returns the absolute value of (scalar) variable.
constexpr T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
constexpr T Delta(const T a, const T b)
Returns the (absolute) difference between two (scalar) variables.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
void GuiShowTooltips(Window *parent, EncodedString &&text, TooltipCloseCondition close_tooltip)
Shows a tooltip.
ClientID _network_own_client_id
Our client identifier.
Network functions used by other parts of OpenTTD.
ClientID
'Unique' identifier to be given to clients
@ DO_SHOW_TOWN_NAMES
Display town names.
@ DO_SHOW_COMPETITOR_SIGNS
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
@ DO_SHOW_SIGNS
Display signs.
@ DO_SHOW_WAYPOINT_NAMES
Display waypoint names.
@ DO_SHOW_STATION_NAMES
Display station names.
PixelColour GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
ClientSettings _settings_client
The current settings for this game.
Functions related to signs.
void HandleClickOnSign(const Sign *si)
Handle clicking on a sign.
Slope SlopeWithThreeCornersRaised(Corner corner)
Returns the slope with all except one corner raised.
Corner OppositeCorner(Corner corner)
Returns the opposite corner.
static constexpr Corner GetHalftileSlopeCorner(Slope s)
Returns the leveled halftile of a halftile slope.
static constexpr Slope RemoveHalftileSlope(Slope s)
Removes a halftile slope from a slope.
uint SlopeToSpriteOffset(Slope s)
Returns the Sprite offset for a given Slope.
static constexpr bool IsSteepSlope(Slope s)
Checks if a slope is steep.
static constexpr bool IsHalftileSlope(Slope s)
Checks for non-continuous slope on halftile foundations.
Slope SlopeWithOneCornerRaised(Corner corner)
Returns the slope with a specific corner raised.
Corner
Enumeration of tile corners.
Slope
Enumeration for the slope-type.
@ SLOPE_N
the north corner of the tile is raised
@ SLOPE_STEEP_N
a steep slope falling to south (from north)
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
static constexpr uint32_t MAX_SPRITES
Masks needed for sprite operations.
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...
static const CursorID ANIMCURSOR_FLAG
Flag for saying a cursor sprite is an animated cursor.
static const PaletteID PALETTE_SEL_TILE_RED
makes a square red. is used when removing rails or other stuff
static constexpr uint32_t SPRITE_MASK
The mask to for the main sprite.
static constexpr uint8_t PALETTE_MODIFIER_TRANSPARENT
when a sprite is to be displayed transparently, this bit needs to be set.
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
static const PaletteID PALETTE_SEL_TILE_BLUE
This draws a blueish square (catchment areas for example)
static const PaletteID PALETTE_TO_TRANSPARENT
This sets the sprite to transparent.
Base classes/functions for stations.
void ShowStationViewWindow(StationID station)
Opens StationViewWindow for given station.
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition of base types and functions in a cross-platform compatible way.
The colour translation of GRF's strings.
static constexpr PixelColour _string_colourmap[17]
Colour mapping for TextColour.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
Base class for all station-ish types.
TileIndex xy
Base tile of the station.
bool IsInUse() const
Check whether the base station currently is in use; in use means that it is not scheduled for deletio...
TrackedViewportSign sign
NOSAVE: Dimensions of sign.
int next
next child to draw (-1 at the end)
const SubSprite * sub
only draw a rectangular part of the sprite
GUISettings gui
settings related to the GUI
uint8_t max_bridge_height
maximum height of bridges
Point pos
logical mouse position
Data about how and where to blit pixels.
uint8_t dist_local_authority
distance for town local authority, default 20
bool population_in_label
show the population of a town in its label?
bool measure_tooltip
show a permanent tooltip when dragging tools
ZoomLevel zoom_min
minimum zoom out level
bool smooth_scroll
smooth scroll viewports
ZoomLevel zoom_max
maximum zoom out level
EconomySettings economy
settings to change the economy
ConstructionSettings construction
construction of things in-game
static uint SizeY()
Get the size of the map along the Y.
static debug_inline uint SizeX()
Get the size of the map along the X.
static uint ScaleBySize1D(uint n)
Scales the given value by the maps circumference, where the given value is for a 256 by 256 map.
static uint MaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
static debug_inline uint MaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
TileIndex tile
The base tile of the area.
Parent sprite that should be drawn.
const SubSprite * sub
only draw a rectangular part of the sprite
int32_t zmin
minimal world Z coordinate of bounding box
SpriteID image
sprite to draw
int32_t xmax
maximal world X coordinate of bounding box
int32_t ymax
maximal world Y coordinate of bounding box
int32_t x
screen X coordinate of sprite
int32_t y
screen Y coordinate of sprite
int32_t first_child
the first child to draw.
int32_t zmax
maximal world Z coordinate of bounding box
int32_t xmin
minimal world X coordinate of bounding box
int32_t ymin
minimal world Y coordinate of bounding box
PaletteID pal
palette to use
int32_t left
minimal screen X coordinate of sprite (= x + sprite->x_offs), reference point for child sprites
int32_t top
minimal screen Y coordinate of sprite (= y + sprite->y_offs), reference point for child sprites
Colour for pixel/line drawing.
static Titem * Get(auto index)
Returns Titem with given index.
static size_t GetNumItems()
Returns number of valid items in the pool.
Tindex index
Index of this pool item.
Specification of a rectangle with absolute coordinates of all edges.
static bool IsExpected(const BaseStation *st)
Helper for checking whether the given station is of this type.
static Station * Get(auto index)
Gets station with given index.
static Waypoint * From(BaseStation *st)
Converts a BaseStation to SpecializedStation with type checking.
Coord3D< int8_t > offset
Relative position of sprite from bounding box.
Coord3D< int8_t > origin
Position of northern corner within tile.
Coord3D< uint8_t > extent
Size of bounding box.
Data structure describing a sprite.
uint16_t width
Width of the sprite.
uint16_t height
Height of the sprite.
int16_t y_offs
Number of pixels to shift the sprite downwards.
int16_t x_offs
Number of pixels to shift the sprite to the right.
BitmapTileArea catchment_tiles
NOSAVE: Set of individual tiles covered by catchment area.
Used to only draw a part of the sprite.
Metadata about the current highlighting.
TileIndex redsq
The tile that has to get a red selection.
Point new_pos
New value for pos; used to determine whether to redraw the selection.
Window * GetCallbackWnd()
Get the window that started the current highlighting.
bool make_square_red
Whether to give a tile a red selection.
bool IsDraggingDiagonal()
Is the user dragging a 'diagonal rectangle'?
ViewportDragDropSelectionProcess select_proc
The procedure that has to be called when the selection is done.
Point selstart
The location where the dragging started.
Point new_outersize
New value for outersize; used to determine whether to redraw the selection.
HighLightStyle drawstyle
Lower bits 0-3 are reserved for detailed highlight information.
HighLightStyle place_mode
Method which is used to place the selection.
WindowClass window_class
The WindowClass of the window that is responsible for the selection mode.
uint8_t dirty
Whether the build station window needs to redraw due to the changed selection.
Point offs
Offset, in tile "units", for the blue coverage area from the selected area's northern tile.
Point size
Size, in tile "units", of the white/red selection area.
uint8_t sizelimit
Whether the selection is limited in length, and what the maximum length is.
Point pos
Location, in tile "units", of the northern tile of the selected area.
Point outersize
Size, in tile "units", of the blue coverage area excluding the side of the selected area.
bool diagonal
Whether the dragged area is a 45 degrees rotated rectangle.
void Reset()
Reset tile highlighting.
Point selend
The location where the drag currently ends.
Point new_size
New value for size; used to determine whether to redraw the selection.
bool freeze
Freeze highlight in place.
HighLightStyle next_drawstyle
Queued, but not yet drawn style.
ViewportPlaceMethod select_method
The method which governs how tiles are selected.
WindowNumber window_number
The WindowNumber of the window that is responsible for the selection mode.
Tile information, used while rendering the tile.
Slope tileh
Slope of the tile.
TileIndex tile
Tile index.
int32_t y
screen Y coordinate of sprite
int32_t x
screen X coordinate of sprite
const SubSprite * sub
only draw a rectangular part of the sprite
DrawTileProc * draw_tile_proc
Called to render the tile and its contents to the screen.
TrackedViewportSign sign
Location of name sign, UpdateVirtCoord updates this.
TileIndex xy
town center tile
TownCache cache
Container for all cacheable data.
bool show_zone
NOSAVE: mark town to show the local authority zone in the viewports.
StationList stations_near
NOSAVE: List of nearby stations.
bool kdtree_valid
Are the sign data valid for use with the _viewport_sign_kdtree?
int32_t z_pos
z coordinate.
Vehicle * First() const
Get the first vehicle of this vehicle chain.
int32_t y_pos
y coordinate.
int32_t x_pos
x coordinate.
Owner owner
Which company owns the vehicle?
UnitID unitnumber
unit number, for display purposes only
Data structure for a window viewport.
void CancelFollow(const Window &viewport_window)
Cancel viewport vehicle following, and raise follow location widget if needed.
int32_t dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
int32_t scrollpos_y
Currently shown y coordinate (virtual screen coordinate of topleft corner of the viewport).
int32_t dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, VehicleID::Invalid() otherwise.
int32_t scrollpos_x
Currently shown x coordinate (virtual screen coordinate of topleft corner of the viewport).
Data structure storing rendering information.
int foundation[FOUNDATION_PART_END]
Foundation sprites (index into parent_sprites_to_draw).
int last_foundation_child[FOUNDATION_PART_END]
Tail of ChildSprite list of the foundations. (index into child_screen_sprites_to_draw)
ParentSpriteToSortVector parent_sprites_to_sort
Parent sprite pointer array used for sorting.
Point foundation_offset[FOUNDATION_PART_END]
Pixel offset for ground sprites on the foundations.
SpriteCombineMode combine_sprites
Current mode of "sprite combining".
FoundationPart foundation_part
Currently active foundation for ground sprite drawing.
Helper class for getting the best sprite sorter.
VpSorterChecker fct_checker
The check function.
VpSpriteSorter fct_sorter
The sorting function.
Location information about a sign as seen on the viewport.
int32_t center
The center position of the sign.
uint16_t width_small
The width when zoomed out (small font)
uint16_t width_normal
The width when not zoomed out (normal font)
void UpdatePosition(int center, int top, std::string_view str, std::string_view str_small={})
Update the position of the viewport sign.
int32_t top
The top of the sign.
Data structure for viewport, display of a part of the world.
int top
Screen coordinate top edge of the viewport.
int width
Screen width of the viewport.
ZoomLevel zoom
The zoom level of the viewport.
int virtual_top
Virtual top coordinate.
int virtual_left
Virtual left coordinate.
int virtual_width
width << zoom
int left
Screen coordinate left edge of the viewport.
int height
Screen height of the viewport.
int virtual_height
height << zoom
Representation of a waypoint.
Number to differentiate different windows of the same class.
Iterator to iterate all valid Windows.
Data structure for an opened window.
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
std::unique_ptr< ViewportData > viewport
Pointer to viewport data, if present.
void RaiseWidgetWhenLowered(WidgetID widget_index)
Marks a widget as raised and dirty (redraw), when it is marked as lowered.
virtual void OnPlaceObjectAbort()
The user cancelled a tile highlight mode that has been set.
WindowClass window_class
Window class.
void DrawViewport() const
Draw the viewport of this window.
virtual void OnPlaceObject(Point pt, TileIndex tile)
The user clicked some place on the map when a tile highlight mode has been set.
int left
x position of left edge of the window
int top
y position of top edge of the window
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.
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.
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
AllWindows< false > Iterate
Iterate all windows in whatever order is easiest.
int height
Height of the window (number of pixels down in y direction)
int width
width of the window (number of pixels to the right in x direction)
WindowNumber window_number
Window number within the window class.
std::tuple< Slope, int > GetTilePixelSlopeOutsideMap(int x, int y)
Return the slope of a given tile, also for tiles outside the map (virtual "black" tiles).
int GetTilePixelZ(TileIndex tile)
Get bottom height of the tile.
int GetTileMaxPixelZ(TileIndex tile)
Get top height of the tile.
static debug_inline TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
std::tuple< Slope, int > GetTilePixelSlope(TileIndex tile)
Return the slope of a given tile.
bool IsValidTile(Tile tile)
Checks if a tile is valid.
uint TilePixelHeight(Tile tile)
Returns the height of a tile in pixels.
uint TilePixelHeightOutsideMap(int x, int y)
Returns the height of a tile in pixels, also for tiles outside the map (virtual "black" tiles).
static debug_inline bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
static debug_inline uint TileHeight(Tile tile)
Returns the height of a tile.
uint TileHeightOutsideMap(int x, int y)
Returns the height of a tile, also for tiles outside the map (virtual "black" tiles).
static constexpr uint TILE_UNIT_MASK
For masking in/out the inner-tile world coordinate units.
static constexpr uint MAX_BUILDING_PIXELS
Maximum height of a building in pixels in ZOOM_BASE. (Also applies to "bridge buildings" on the bridg...
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
static constexpr uint TILE_SIZE
Tile size in world coordinates.
static constexpr uint TILE_PIXELS
Pixel distance between tile columns/rows in ZOOM_BASE.
static constexpr uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in ZOOM_BASE.
TileType
The different types of tiles.
@ MP_STATION
A tile of a station.
@ MP_HOUSE
A house by a town.
@ MP_VOID
Invisible tiles at the SW and SE border.
Functions related to tile highlights.
HighLightStyle
Highlighting draw styles.
@ HT_LINE
used for autorail highlighting (longer stretches), lower bits: direction
@ HT_DIR_HL
horizontal lower
@ HT_DIR_HU
horizontal upper
@ HT_DRAG
dragging items in the depot windows
@ HT_DIAGONAL
Also allow 'diagonal rectangles'. Only usable in combination with HT_RECT or HT_POINT.
@ HT_POINT
point (lower land, raise land, level land, ...)
@ HT_RECT
rectangle (stations, depots, ...)
@ HT_DIR_MASK
masks the drag-direction
@ HT_RAIL
autorail (one piece), lower bits: direction
@ HT_DRAG_MASK
Mask for the tile drag-type modes.
@ HT_VEHICLE
vehicle is accepted as target as well (bitmask)
@ HT_DIR_VR
vertical right
@ HT_SPECIAL
special mode used for highlighting while dragging (and for tunnels/docks)
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold.
Declarations for accessing the k-d tree of towns.
TownID GetTownIndex(Tile t)
Get the index of which town this house/street is attached to.
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...
uint8_t _display_opt
What do we want to draw/do?
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...
void ViewportAddVehicles(DrawPixelInfo *dpi)
Add the vehicle sprites that should be drawn at a part of the screen.
Vehicle * CheckClickOnVehicle(const Viewport &vp, int x, int y)
Find the vehicle close to the clicked coordinates.
Base class for all vehicles.
Functions related to vehicles.
bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
void StartStopVehicle(const Vehicle *v, bool texteffect)
Executes CMD_START_STOP_VEHICLE for given vehicle.
Functions related to the vehicle's GUIs.
static void HighlightTownLocalAuthorityTiles(const TileInfo *ti)
Highlights tiles insede local authority of selected towns.
std::string * ViewportAddString(const DrawPixelInfo *dpi, const ViewportSign *sign, ViewportStringFlags flags, Colours colour)
Add a string to draw in the current viewport.
static void CheckOverflow(int &test, int &other, int max, int mult)
Check for overflowing the map.
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
FoundationPart
Enumeration of multi-part foundations.
@ FOUNDATION_PART_NONE
Neither foundation nor groundsprite drawn yet.
@ FOUNDATION_PART_HALFTILE
Second part (halftile foundation)
@ FOUNDATION_PART_NORMAL
First part (normal foundation or no foundation)
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
CommandCost CmdScrollViewport(DoCommandFlags flags, TileIndex tile, ViewportScrollTarget target, uint32_t ref)
Scroll players main viewport.
static void ViewportAddStationStrings(DrawPixelInfo *dpi, const std::vector< const BaseStation * > &stations, bool small)
Add station strings to a viewport.
void OffsetGroundSprite(int x, int y)
Called when a foundation has been drawn for the current tile.
constexpr int LAST_CHILD_NONE
There is no last_child to fill.
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
static void ViewportAddSignStrings(DrawPixelInfo *dpi, const std::vector< const Sign * > &signs, bool small)
Add sign strings to a viewport.
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...
constexpr int LAST_CHILD_PARENT
Fill last_child of the most recent parent sprite.
static const int MAX_TILE_EXTENT_TOP
Maximum top extent of tile relative to north corner (not considering bridges).
static void ShowMeasurementTooltips(EncodedString &&text)
Displays the measurement tooltips when selecting multiple tiles.
static const int MAX_TILE_EXTENT_LEFT
Maximum left extent of tile relative to north corner.
bool IsInsideRotatedRectangle(int x, int y)
Checks whether a point is inside the selected a diagonal rectangle given by _thd.size and _thd....
static int CalcHeightdiff(HighLightStyle style, uint distance, TileIndex start_tile, TileIndex end_tile)
Calculates height difference between one tile and another.
static void DrawTileSelectionRect(const TileInfo *ti, PaletteID pal)
Draws a selection rectangle on a tile.
void StartSpriteCombine()
Starts a block of sprites, which are "combined" into a single bounding box.
void InitializeSpriteSorter()
Choose the "best" sprite sorter and set _vp_sprite_sorter.
static const ViewportSSCSS _vp_sprite_sorters[]
List of sorters ordered from best to worst.
static void AddCombinedSprite(SpriteID image, PaletteID pal, int x, int y, int z, const SubSprite *sub)
Adds a child sprite to a parent sprite.
static int GetViewportY(Point tile)
Returns the y coordinate in the viewport coordinate system where the given tile is painted.
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 HighLightStyle GetAutorailHT(int x, int y)
returns the best autorail highlight type from map coordinates
static void ClampSmoothScroll(uint32_t delta_ms, int64_t delta_hi, int64_t delta_lo, int &delta_hi_clamped, int &delta_lo_clamped)
Clamp the smooth scroll to a maxmimum speed and distance based on time elapsed.
static void DrawTileSelection(const TileInfo *ti)
Checks if the specified tile is selected and if so draws selection using correct selectionstyle.
static TileHighlightType GetTileHighlightType(TileIndex t)
Get tile highlight type of coverage area for a given tile.
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...
Point TranslateXYToTileCoord(const Viewport &vp, int x, int y, bool clamp_to_map)
Translate screen coordinate in a viewport to underlying tile coordinate.
static void DrawAutorailSelection(const TileInfo *ti, uint autorail_type)
Draws autorail highlights.
SpriteCombineMode
Mode of "sprite combining".
@ SPRITE_COMBINE_PENDING
Sprite combining will start with the next unclipped sprite.
@ SPRITE_COMBINE_ACTIVE
Sprite combining is active. AddSortableSpriteToDraw outputs child sprites.
@ SPRITE_COMBINE_NONE
Every AddSortableSpriteToDraw start its own bounding box.
static void DrawTileHighlightType(const TileInfo *ti, TileHighlightType tht)
Draw tile highlight for coverage area highlight.
static void ViewportDrawBoundingBoxes(const ParentSpriteToSortVector *psd)
Draws the bounding boxes of all ParentSprites.
static void ViewportAddTownStrings(DrawPixelInfo *dpi, const std::vector< const Town * > &towns, bool small)
Add town strings to a viewport.
void SetViewportCatchmentWaypoint(const Waypoint *wp, bool sel)
Select or deselect waypoint for coverage area highlight.
void SetRedErrorSquare(TileIndex tile)
Set a tile to display a red error square.
static void ViewportSortParentSprites(ParentSpriteToSortVector *psdv)
Sort parent sprites pointer array replicating the way original sorter did it.
void VpSetPresizeRange(TileIndex from, TileIndex to)
Highlights all tiles between a set of two tiles.
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
EventState VpHandlePlaceSizingDrag()
Handle the mouse while dragging for placement/resizing.
Viewport * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int z, const SpriteBounds &bounds, bool transparent, const SubSprite *sub)
Draw a (transparent) sprite at given coordinates with a given bounding box.
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...
void EndSpriteCombine()
Terminates a block of sprites started by StartSpriteCombine.
static const int MAX_TILE_EXTENT_RIGHT
Maximum right extent of tile relative to north corner.
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.
static void CheckUnderflow(int &test, int &other, int mult)
Check for underflowing the map.
static bool ViewportSortParentSpritesChecker()
This fallback sprite checker always exists.
void DrawGroundSpriteAt(SpriteID image, PaletteID pal, int32_t x, int32_t 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.
void VpStartDragging(ViewportDragDropSelectionProcess process)
Drag over the map while holding the left mouse down.
void UpdateTileSelection()
Updates tile highlighting for all cases.
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.
static const int MAX_TILE_EXTENT_BOTTOM
Maximum bottom extent of tile relative to north corner (worst case: SLOPE_STEEP_N).
static bool CheckClickOnViewportSign(const Viewport &vp, int x, int y, const ViewportSign *sign)
Test whether a sign is below the mouse.
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
void SetViewportCatchmentTown(const Town *t, bool sel)
Select or deselect town for coverage area highlight.
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.
void InitializeWindowViewport(Window *w, int x, int y, int width, int height, std::variant< TileIndex, VehicleID > focus, ZoomLevel zoom)
Initialize viewport of the window for use.
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.
static void CalcRaildirsDrawstyle(int x, int y, int method)
while dragging
static HighLightStyle Check2x1AutoRail(int mode)
returns information about the 2x1 piece to be build.
static void ViewportDrawDirtyBlocks()
Draw/colour the blocks that have been redrawn.
void HandleZoomMessage(Window *w, const Viewport &vp, WidgetID widget_zoom_in, WidgetID widget_zoom_out)
Update the status of the zoom-buttons according to the zoom-level of the viewport.
void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process)
highlighting tiles while only going over them with the mouse
static void ClampViewportToMap(const Viewport &vp, int *scroll_x, int *scroll_y)
Ensure that a given viewport has a valid scroll position.
static void AddTileSpriteToDraw(SpriteID image, PaletteID pal, int32_t x, int32_t y, int z, const SubSprite *sub=nullptr, int extra_offs_x=0, int extra_offs_y=0)
Schedules a tile sprite for drawing.
static void ViewportAddLandscape()
Add the landscape to the viewport, i.e.
static std::string & AddStringToDraw(int x, int y, Colours colour, ViewportStringFlags flags, uint16_t width)
Add a string to draw to a viewport.
const Station * _viewport_highlight_station
Currently selected station for coverage area highlight.
const Town * _viewport_highlight_town
Currently selected town for coverage area highlight.
void UpdateViewportPosition(Window *w, uint32_t delta_ms)
Update the viewport position being displayed.
const Waypoint * _viewport_highlight_waypoint
Currently selected waypoint for coverage area highlight.
bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Command definitions related to viewports.
Functions related to (drawing on) viewports.
static const int TILE_HEIGHT_STEP
One Z unit tile height difference is displayed as 50m.
Types related to sprite sorting.
bool(* VpSorterChecker)()
Type for method for checking whether a viewport sprite sorter exists.
void(* VpSpriteSorter)(ParentSpriteToSortVector *psd)
Type for the actual viewport sprite sorter.
ViewportScrollTarget
Target of the viewport scrolling GS method.
@ VST_EVERYONE
All players.
@ VST_COMPANY
All players in specific company.
@ VST_CLIENT
Single player.
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
@ VPM_FIX_Y
drag only in Y axis
@ VPM_Y_LIMITED
Drag only in Y axis with limited size.
@ VPM_X_AND_Y_LIMITED
area of land of limited size
@ VPM_FIX_VERTICAL
drag only in vertical direction
@ VPM_X_LIMITED
Drag only in X axis with limited size.
@ VPM_X_AND_Y
area of land in X and Y directions
@ VPM_FIX_HORIZONTAL
drag only in horizontal direction
@ VPM_FIX_X
drag only in X axis
@ VPM_SIGNALDIRS
similar to VMP_RAILDIRS, but with different cursor
@ VPM_X_OR_Y
drag in X or Y direction
@ VPM_RAILDIRS
all rail directions
@ ZOOM_IN
Zoom in (get more detailed view).
@ ZOOM_OUT
Zoom out (get helicopter view).
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you've selected it.
@ ColourRect
Draw a colour rect around the sign.
@ Small
Draw using the small font.
@ Shadow
Draw an extra text shadow. Should only be used with ViewportStringFlag::Small, as normal font already...
@ TransparentRect
Draw a transparent rect around the sign.
@ TextColour
Draw text in colour.
Functions related to waypoints.
void ShowWaypointWindow(const Waypoint *wp)
Show the window for the given waypoint.
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Window * GetMainWindow()
Get the main window, i.e.
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Window functions not directly related to making/drawing windows.
Functions, definitions and such used only by the GUI.
@ Transparent
Makes the background transparent if set.
@ WSM_DRAGDROP
Drag&drop an object.
@ WSM_DRAGGING
Dragging mode (trees).
@ WSM_PRESIZE
Presizing mode (docks, tunnels).
@ WSM_NONE
No special mouse mode.
EventState
State of handling an event.
@ ES_HANDLED
The passed event is handled.
@ ES_NOT_HANDLED
The passed event is not handled.
WindowClass
Window classes.
@ WC_INVALID
Invalid window.
@ WC_WAYPOINT_VIEW
Waypoint view; Window numbers:
@ WC_STATION_VIEW
Station view; Window numbers:
@ WC_MAIN_WINDOW
Main window; Window numbers:
@ WC_TOWN_VIEW
Town view; Window numbers:
@ WC_TOOLTIPS
Tooltip window; Window numbers:
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
Functions related to zooming.
int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZoomLevel::Min) When shifting right,...
int UnScaleByZoomLower(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZoomLevel::Min)
int UnScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZoomLevel::Min) When shifting right,...
ZoomLevel
All zoom levels we know.
@ Begin
Begin for iteration.
@ Out4x
Zoomed 4 times out.