OpenTTD Source
20241108-master-g80f628063a
|
Handling of all viewports. More...
#include "stdafx.h"
#include "core/backup_type.hpp"
#include "landscape.h"
#include "viewport_func.h"
#include "station_base.h"
#include "waypoint_base.h"
#include "town.h"
#include "signs_base.h"
#include "signs_func.h"
#include "vehicle_base.h"
#include "vehicle_gui.h"
#include "blitter/factory.hpp"
#include "strings_func.h"
#include "zoom_func.h"
#include "vehicle_func.h"
#include "company_func.h"
#include "waypoint_func.h"
#include "window_func.h"
#include "tilehighlight_func.h"
#include "window_gui.h"
#include "linkgraph/linkgraph_gui.h"
#include "viewport_kdtree.h"
#include "town_kdtree.h"
#include "viewport_sprite_sorter.h"
#include "bridge_map.h"
#include "company_base.h"
#include "command_func.h"
#include "network/network_func.h"
#include "framerate_type.h"
#include "viewport_cmd.h"
#include <forward_list>
#include <stack>
#include "table/strings.h"
#include "table/string_colours.h"
#include "safeguards.h"
#include "table/autorail.h"
#include "table/animcursors.h"
Go to the source code of this file.
Data Structures | |
struct | StringSpriteToDraw |
struct | TileSpriteToDraw |
struct | ChildScreenSpriteToDraw |
struct | ViewportDrawer |
Data structure storing rendering information. More... | |
struct | ViewportSSCSS |
Helper class for getting the best sprite sorter. More... | |
Typedefs | |
typedef std::vector< TileSpriteToDraw > | TileSpriteToDrawVector |
typedef std::vector< StringSpriteToDraw > | StringSpriteToDrawVector |
typedef std::vector< ParentSpriteToDraw > | ParentSpriteToDrawVector |
typedef std::vector< ChildScreenSpriteToDraw > | ChildScreenSpriteToDrawVector |
Enumerations | |
enum | FoundationPart { FOUNDATION_PART_NONE = 0xFF , FOUNDATION_PART_NORMAL = 0 , FOUNDATION_PART_HALFTILE = 1 , FOUNDATION_PART_END } |
Enumeration of multi-part foundations. More... | |
enum | SpriteCombineMode { SPRITE_COMBINE_NONE , SPRITE_COMBINE_PENDING , SPRITE_COMBINE_ACTIVE } |
Mode of "sprite combining". More... | |
enum | TileHighlightType { THT_NONE , THT_WHITE , THT_BLUE , THT_RED } |
Functions | |
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. More... | |
static Point | MapXYZToViewport (const Viewport *vp, int x, int y, int z) |
void | DeleteWindowViewport (Window *w) |
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. More... | |
static void | DoSetViewportPosition (Window::IteratorToFront it, int left, int top, int width, int height) |
static void | SetViewportPosition (Window *w, int x, int y) |
Viewport * | IsPtInWindowViewport (const Window *w, int x, int y) |
Is a xy position inside the viewport of the window? More... | |
Point | TranslateXYToTileCoord (const Viewport *vp, int x, int y, bool clamp_to_map) |
Translate screen coordinate in a viewport to underlying tile coordinate. More... | |
static Point | GetTileFromScreenXY (int x, int y, int zoom_x, int zoom_y) |
Point | GetTileBelowCursor () |
Point | GetTileZoomCenterWindow (bool in, Window *w) |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
void | OffsetGroundSprite (int x, int y) |
Called when a foundation has been drawn for the current tile. More... | |
static void | AddCombinedSprite (SpriteID image, PaletteID pal, int x, int y, int z, const SubSprite *sub) |
Adds a child sprite to a parent sprite. More... | |
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. More... | |
void | StartSpriteCombine () |
Starts a block of sprites, which are "combined" into a single bounding box. More... | |
void | EndSpriteCombine () |
Terminates a block of sprites started by StartSpriteCombine. More... | |
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 end. More... | |
bool | IsInsideRotatedRectangle (int x, int y) |
Checks whether a point is inside the selected a diagonal rectangle given by _thd.size and _thd.pos. More... | |
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. More... | |
static void | AddStringToDraw (int x, int y, StringID string, Colours colour, uint16_t width) |
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. More... | |
static void | DrawTileSelectionRect (const TileInfo *ti, PaletteID pal) |
Draws a selection rectangle on a tile. More... | |
static bool | IsPartOfAutoLine (int px, int py) |
static void | DrawAutorailSelection (const TileInfo *ti, uint autorail_type) |
Draws autorail highlights. More... | |
static TileHighlightType | GetTileHighlightType (TileIndex t) |
Get tile highlight type of coverage area for a given tile. More... | |
static void | DrawTileHighlightType (const TileInfo *ti, TileHighlightType tht) |
Draw tile highlight for coverage area highlight. More... | |
static void | HighlightTownLocalAuthorityTiles (const TileInfo *ti) |
Highlights tiles insede local authority of selected towns. More... | |
static void | DrawTileSelection (const TileInfo *ti) |
Checks if the specified tile is selected and if so draws selection using correct selectionstyle. More... | |
static int | GetViewportY (Point tile) |
Returns the y coordinate in the viewport coordinate system where the given tile is painted. More... | |
static void | ViewportAddLandscape () |
Add the landscape to the viewport, i.e. More... | |
void | ViewportAddString (const DrawPixelInfo *dpi, ZoomLevel small_from, const ViewportSign *sign, StringID string_normal, StringID string_small, StringID string_small_shadow, Colours colour) |
Add a string to draw in the viewport. More... | |
static Rect | ExpandRectWithViewportSignMargins (Rect r, ZoomLevel zoom) |
static void | ViewportAddKdtreeSigns (DrawPixelInfo *dpi) |
static void | ViewportDrawTileSprites (const TileSpriteToDrawVector *tstdv) |
static bool | ViewportSortParentSpritesChecker () |
This fallback sprite checker always exists. | |
static void | ViewportSortParentSprites (ParentSpriteToSortVector *psdv) |
Sort parent sprites pointer array replicating the way original sorter did it. | |
static void | ViewportDrawParentSprites (const ParentSpriteToSortVector *psd, const ChildScreenSpriteToDrawVector *csstdv) |
static void | ViewportDrawBoundingBoxes (const ParentSpriteToSortVector *psd) |
Draws the bounding boxes of all ParentSprites. More... | |
static void | ViewportDrawDirtyBlocks () |
Draw/colour the blocks that have been redrawn. | |
static void | ViewportDrawStrings (ZoomLevel zoom, const StringSpriteToDrawVector *sstdv) |
void | ViewportDoDraw (const Viewport *vp, int left, int top, int right, int bottom) |
static void | ViewportDraw (const Viewport *vp, int left, int top, int right, int bottom) |
static void | ClampViewportToMap (const Viewport *vp, int *scroll_x, int *scroll_y) |
Ensure that a given viewport has a valid scroll position. More... | |
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. More... | |
void | UpdateViewportPosition (Window *w, uint32_t delta_ms) |
Update the viewport position being displayed. More... | |
bool | MarkAllViewportsDirty (int left, int top, int right, int bottom) |
Mark all viewports that display an area as dirty (in need of repaint). More... | |
void | ConstrainAllViewportsZoom () |
void | MarkTileDirtyByTile (TileIndex tile, int bridge_level_offset, int tile_height_override) |
Mark a tile given by its index dirty for repaint. More... | |
static void | SetSelectionTilesDirty () |
Marks the selected tiles as dirty. More... | |
void | SetSelectionRed (bool b) |
static bool | CheckClickOnViewportSign (const Viewport *vp, int x, int y, const ViewportSign *sign) |
Test whether a sign is below the mouse. More... | |
static bool | CheckClickOnViewportSign (const Viewport *vp, int x, int y) |
Check whether any viewport sign was clicked, and dispatch the click. More... | |
void | RebuildViewportKdtree () |
static bool | CheckClickOnLandscape (const Viewport *vp, int x, int y) |
static void | PlaceObject () |
bool | HandleViewportClicked (const Viewport *vp, int x, int y) |
void | RebuildViewportOverlay (Window *w) |
bool | ScrollWindowTo (int x, int y, int z, Window *w, bool instant) |
Scrolls the viewport in a window to a given location. More... | |
bool | ScrollWindowToTile (TileIndex tile, Window *w, bool instant) |
Scrolls the viewport in a window to a given location. More... | |
bool | ScrollMainWindowToTile (TileIndex tile, bool instant) |
Scrolls the viewport of the main window to a given location. More... | |
void | SetRedErrorSquare (TileIndex tile) |
Set a tile to display a red error square. More... | |
void | SetTileSelectSize (int w, int h) |
Highlight w by h tiles at the cursor. More... | |
void | SetTileSelectBigSize (int ox, int oy, int sx, int sy) |
static HighLightStyle | GetAutorailHT (int x, int y) |
returns the best autorail highlight type from map coordinates | |
void | UpdateTileSelection () |
Updates tile highlighting for all cases. More... | |
static void | ShowMeasurementTooltips (StringID str, uint paramcount) |
Displays the measurement tooltips when selecting multiple tiles. More... | |
static void | HideMeasurementTooltips () |
void | VpStartPlaceSizing (TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process) |
highlighting tiles while only going over them with the mouse | |
void | VpStartDragging (ViewportDragDropSelectionProcess process) |
Drag over the map while holding the left mouse down. | |
void | VpSetPlaceSizingLimit (int limit) |
void | VpSetPresizeRange (TileIndex from, TileIndex to) |
Highlights all tiles between a set of two tiles. More... | |
static void | VpStartPreSizing () |
static HighLightStyle | Check2x1AutoRail (int mode) |
returns information about the 2x1 piece to be build. More... | |
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. More... | |
static int | CalcHeightdiff (HighLightStyle style, uint distance, TileIndex start_tile, TileIndex end_tile) |
Calculates height difference between one tile and another. More... | |
static void | CheckUnderflow (int &test, int &other, int mult) |
Check for underflowing the map. More... | |
static void | CheckOverflow (int &test, int &other, int max, int mult) |
Check for overflowing the map. More... | |
static void | CalcRaildirsDrawstyle (int x, int y, int method) |
while dragging | |
void | VpSelectTilesWithMethod (int x, int y, ViewportPlaceMethod method) |
Selects tiles while dragging. More... | |
EventState | VpHandlePlaceSizingDrag () |
Handle the mouse while dragging for placement/resizing. More... | |
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 area selection, object placement, etc. More... | |
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 area selection, object placement, etc. More... | |
void | ResetObjectToPlace () |
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows). | |
Point | GetViewportStationMiddle (const Viewport *vp, const Station *st) |
void | InitializeSpriteSorter () |
Choose the "best" sprite sorter and set _vp_sprite_sorter. | |
CommandCost | CmdScrollViewport (DoCommandFlag flags, TileIndex tile, ViewportScrollTarget target, uint32_t ref) |
Scroll players main viewport. More... | |
void | MarkCatchmentTilesDirty () |
static void | SetWindowDirtyForViewportCatchment () |
static void | ClearViewportCatchment () |
void | SetViewportCatchmentStation (const Station *st, bool sel) |
Select or deselect station for coverage area highlight. More... | |
void | SetViewportCatchmentWaypoint (const Waypoint *wp, bool sel) |
Select or deselect waypoint for coverage area highlight. More... | |
void | SetViewportCatchmentTown (const Town *t, bool sel) |
Select or deselect town for coverage area highlight. More... | |
Variables | |
Point | _tile_fract_coords |
ViewportSignKdtree _viewport_sign_kdtree & | Kdtree_ViewportSignXYFunc |
static int | _viewport_sign_maxwidth = 0 |
static const int | MAX_TILE_EXTENT_LEFT = ZOOM_BASE * TILE_PIXELS |
Maximum left extent of tile relative to north corner. | |
static const int | MAX_TILE_EXTENT_RIGHT = ZOOM_BASE * TILE_PIXELS |
Maximum right extent of tile relative to north corner. | |
static const int | MAX_TILE_EXTENT_TOP = ZOOM_BASE * MAX_BUILDING_PIXELS |
Maximum top extent of tile relative to north corner (not considering bridges). | |
static const int | MAX_TILE_EXTENT_BOTTOM = ZOOM_BASE * (TILE_PIXELS + 2 * TILE_HEIGHT) |
Maximum bottom extent of tile relative to north corner (worst case: SLOPE_STEEP_N). | |
constexpr int | LAST_CHILD_NONE = -1 |
There is no last_child to fill. | |
constexpr int | LAST_CHILD_PARENT = -2 |
Fill last_child of the most recent parent sprite. | |
static ViewportDrawer | _vd |
TileHighlightData | _thd |
static TileInfo | _cur_ti |
bool | _draw_bounding_boxes = false |
bool | _draw_dirty_blocks = false |
uint | _dirty_block_colour = 0 |
static VpSpriteSorter | _vp_sprite_sorter = nullptr |
static Point | _vp_move_offs |
static const HighLightStyle | _autorail_type [6][2] |
const Station * | _viewport_highlight_station |
Currently selected station for coverage area highlight. | |
const Waypoint * | _viewport_highlight_waypoint |
Currently selected waypoint for coverage area highlight. | |
const Town * | _viewport_highlight_town |
Currently selected town for coverage area highlight. | |
static const StringID | measure_strings_length [] = {STR_NULL, STR_MEASURE_LENGTH, STR_MEASURE_LENGTH_HEIGHTDIFF} |
static ViewportSSCSS | _vp_sprite_sorters [] |
List of sorters ordered from best to worst. More... | |
Handling of all viewports.
* The in-game coordinate system looks like this * * * * ^ Z * * | * * | * * | * * | * * / \ * * / \ * * / \ * * / \ * * X < > Y * *
Definition in file viewport.cpp.
enum FoundationPart |
Enumeration of multi-part foundations.
Definition at line 142 of file viewport.cpp.
enum SpriteCombineMode |
Mode of "sprite combining".
Enumerator | |
---|---|
SPRITE_COMBINE_NONE | Every AddSortableSpriteToDraw start its own bounding box. |
SPRITE_COMBINE_PENDING | Sprite combining will start with the next unclipped sprite. |
SPRITE_COMBINE_ACTIVE | Sprite combining is active. AddSortableSpriteToDraw outputs child sprites. |
Definition at line 153 of file viewport.cpp.
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.
image | the image to draw. |
pal | the provided palette. |
x | sprite x-offset (screen coordinates) relative to parent sprite. |
y | sprite y-offset (screen coordinates) relative to parent sprite. |
transparent | if true, switch the palette between the provided palette and the transparent palette, |
sub | Only draw a part of the sprite. |
scale | if true, scale offsets to base zoom level. |
relative | if true, draw sprite relative to parent sprite offsets. |
Definition at line 827 of file viewport.cpp.
Referenced by DrawCommonTileSeq().
|
static |
Adds a child sprite to the active foundation.
The pixel offset of the sprite relative to the ParentSprite is the sum of the offset passed to OffsetGroundSprite() and extra_offs_?.
image | the image to draw. |
pal | the provided palette. |
sub | Only draw a part of the sprite. |
foundation_part | Foundation part. |
extra_offs_x | Pixel X offset for the sprite position. |
extra_offs_y | Pixel Y offset for the sprite position. |
Definition at line 540 of file viewport.cpp.
References IsInsideMM().
|
static |
Adds a child sprite to a parent sprite.
In contrast to "AddChildSpriteScreen()" the sprite position is in world coordinates
image | the image to draw. |
pal | the provided palette. |
x | position x of the sprite. |
y | position y of the sprite. |
z | position z of the sprite. |
sub | Only draw a part of the sprite. |
Definition at line 631 of file viewport.cpp.
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.
The bounding box extends from (x + bb_offset_x, y + bb_offset_y, z + bb_offset_z) to (x + w - 1, y + h - 1, z + dz - 1), both corners included. Bounding boxes with bb_offset_x == w or bb_offset_y == h or bb_offset_z == dz are allowed and produce thin slices.
image | the image to combine and draw, |
pal | the provided palette, |
x | position X (world) of the sprite, |
y | position Y (world) of the sprite, |
w | bounding box extent towards positive X (world), |
h | bounding box extent towards positive Y (world), |
dz | bounding box extent towards positive Z (world), |
z | position Z (world) of the sprite, |
transparent | if true, switch the palette between the provided palette and the transparent palette, |
bb_offset_x | bounding box extent towards negative X (world), |
bb_offset_y | bounding box extent towards negative Y (world), |
bb_offset_z | bounding box extent towards negative Z (world) |
sub | Only draw a part of the sprite. |
Definition at line 671 of file viewport.cpp.
Referenced by DrawCommonTileSeq().
|
static |
Schedules a tile sprite for drawing.
image | the image to draw. |
pal | the provided palette. |
x | position x (world coordinates) of the sprite. |
y | position y (world coordinates) of the sprite. |
z | position z (world coordinates) of the sprite. |
sub | Only draw a part of the sprite. |
extra_offs_x | Pixel X offset for the sprite position. |
extra_offs_y | Pixel Y offset for the sprite position. |
Definition at line 515 of file viewport.cpp.
|
static |
Calculates height difference between one tile and another.
Multiplies the result to suit the standard given by TILE_HEIGHT_STEP.
To correctly get the height difference we need the direction we are dragging in, as well as with what kind of tool we are dragging. For example a horizontal autorail tool that starts in bottom and ends at the top of a tile will need the maximum of SW, S and SE, N corners respectively. This is handled by the lookup table below See _tileoffs_by_dir in map.cpp for the direction enums if you can't figure out the values yourself.
style | Highlighting style of the drag. This includes direction and style (autorail, rect, etc.) |
distance | Number of tiles dragged, important for horizontal/vertical drags, ignored for others. |
start_tile | Start tile of the drag operation. |
end_tile | End tile of the drag operation. |
Definition at line 2884 of file viewport.cpp.
References DIR_S, DIR_SE, DIR_SW, HT_DIR_END, HT_DIR_HL, HT_DIR_HU, HT_DIR_MASK, HT_DIR_VL, HT_DIR_VR, HT_DIR_X, HT_DIR_Y, HT_DRAG_MASK, HT_POINT, HT_RECT, Swap(), SwapDirection(), TILE_HEIGHT_STEP, TileAdd(), TileAddByDir(), TileHeight(), TileX(), and ToTileIndexDiff().
|
static |
returns information about the 2x1 piece to be build.
The lower bits (0-3) are the track type.
Definition at line 2806 of file viewport.cpp.
|
static |
Check whether any viewport sign was clicked, and dispatch the click.
vp | the clicked viewport |
x | X position of click |
y | Y position of click |
Definition at line 2217 of file viewport.cpp.
|
static |
Test whether a sign is below the mouse.
vp | the clicked viewport |
x | X position of click |
y | Y position of click |
sign | the sign to check |
Definition at line 2199 of file viewport.cpp.
|
static |
Check for overflowing the map.
test | the variable to test for overflowing |
other | the other variable to update to keep the line |
max | the maximum value for the test variable |
mult | the constant to multiply the difference by for other |
Definition at line 2988 of file viewport.cpp.
|
static |
Check for underflowing the map.
test | the variable to test for underflowing |
other | the other variable to update to keep the line |
mult | the constant to multiply the difference by for other |
Definition at line 2973 of file viewport.cpp.
|
static |
Clamp the smooth scroll to a maxmimum speed and distance based on time elapsed.
Every 30ms, we move 1/4th of the distance, to give a smooth movement experience. But we never go over the max_scroll speed.
delta_ms | Time elapsed since last update. | |
delta_hi | The distance to move in highest dimension (can't be zero). | |
delta_lo | The distance to move in lowest dimension. | |
[out] | delta_hi_clamped | The clamped distance to move in highest dimension. |
[out] | delta_lo_clamped | The clamped distance to move in lowest dimension. |
A tile is 64 pixels in width at 1x zoom; viewport coordinates are in 4x zoom.
Definition at line 1889 of file viewport.cpp.
References TILE_PIXELS.
|
inlinestatic |
Ensure that a given viewport has a valid scroll position.
There must be a visible piece of the map in the center of the viewport. If there isn't, the viewport will be scrolled to nearest such location.
Definition at line 1857 of file viewport.cpp.
References InverseRemapCoords2(), RemapCoords2(), Viewport::virtual_height, and Viewport::virtual_width.
CommandCost CmdScrollViewport | ( | DoCommandFlag | flags, |
TileIndex | tile, | ||
ViewportScrollTarget | target, | ||
uint32_t | ref | ||
) |
Scroll players main viewport.
flags | type of operation |
tile | tile to center viewport on |
target | ViewportScrollTarget of scroll target |
ref | company or client id depending on the target |
Definition at line 3549 of file viewport.cpp.
References _current_company, _local_company, _network_own_client_id, CMD_ERROR, DC_EXEC, OWNER_DEITY, ResetObjectToPlace(), ScrollMainWindowToTile(), VST_CLIENT, VST_COMPANY, and VST_EVERYONE.
|
static |
Draws autorail highlights.
Definition at line 968 of file viewport.cpp.
References FOUNDATION_PART_HALFTILE, FOUNDATION_PART_NORMAL, GetHalftileSlopeCorner(), IsHalftileSlope(), OppositeCorner(), RemoveHalftileSlope(), SlopeWithThreeCornersRaised(), and TileInfo::tileh.
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.
If the current tile is drawn on top of a foundation the sprite is added as child sprite to the "foundation"-ParentSprite.
image | the image to draw. |
pal | the provided palette. |
sub | Only draw a part of the sprite. |
extra_offs_x | Pixel X offset for the sprite position. |
extra_offs_y | Pixel Y offset for the sprite position. |
Definition at line 587 of file viewport.cpp.
References DrawGroundSpriteAt().
Referenced by DrawCommonTileSeq(), DrawRoadOverlays(), and DrawSeaWater().
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.
If the current tile is drawn on top of a foundation the sprite is added as child sprite to the "foundation"-ParentSprite.
image | the image to draw. |
pal | the provided palette. |
x | position x (world coordinates) of the sprite relative to current tile. |
y | position y (world coordinates) of the sprite relative to current tile. |
z | position z (world coordinates) of the sprite relative to current tile. |
sub | Only draw a part of the sprite. |
extra_offs_x | Pixel X offset for the sprite position. |
extra_offs_y | Pixel Y offset for the sprite position. |
Definition at line 564 of file viewport.cpp.
Referenced by DrawGroundSprite().
|
static |
Draws sprites between ground sprite and everything above.
The sprite is either drawn as TileSprite or as ChildSprite of the active foundation.
image | the image to draw. |
pal | the provided palette. |
ti | TileInfo Tile that is being drawn |
z_offset | Z offset relative to the groundsprite. Only used for the sprite position, not for sprite sorting. |
foundation_part | Foundation part the sprite belongs to. |
extra_offs_x | Pixel X offset for the sprite position. |
extra_offs_y | Pixel Y offset for the sprite position. |
Definition at line 890 of file viewport.cpp.
|
static |
Draw tile highlight for coverage area highlight.
Definition at line 1050 of file viewport.cpp.
|
static |
Checks if the specified tile is selected and if so draws selection using correct selectionstyle.
Definition at line 1099 of file viewport.cpp.
References HighlightTownLocalAuthorityTiles().
Draws a selection rectangle on a tile.
Definition at line 908 of file viewport.cpp.
References GetHalftileSlopeCorner(), IsHalftileSlope(), IsValidTile(), TileInfo::tile, and TileInfo::tileh.
void EndSpriteCombine | ( | ) |
Terminates a block of sprites started by StartSpriteCombine.
Take a look there for details.
Definition at line 777 of file viewport.cpp.
|
static |
Get tile highlight type of coverage area for a given tile.
t | Tile that is being drawn |
Definition at line 1014 of file viewport.cpp.
References _viewport_highlight_station, GetStationIndex(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, IsTileType(), and MP_STATION.
|
static |
Returns the y coordinate in the viewport coordinate system where the given tile is painted.
tile | Any tile. |
Definition at line 1180 of file viewport.cpp.
References TILE_PIXELS, and TilePixelHeightOutsideMap().
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.
This will update their status and invalidate accordingly
w | Window pointer to the window that has the zoom buttons |
vp | pointer to the viewport whose zoom-level the buttons represent |
widget_zoom_in | widget index for window with zoom-in button |
widget_zoom_out | widget index for window with zoom-out button |
Definition at line 494 of file viewport.cpp.
References _settings_client, ClientSettings::gui, Window::SetWidgetDirty(), Window::SetWidgetDisabledState(), Viewport::zoom, GUISettings::zoom_max, and GUISettings::zoom_min.
Referenced by MainToolbarWindow::OnInvalidateData(), ScenarioEditorToolbarWindow::OnInvalidateData(), and ExtraViewportWindow::OnInvalidateData().
|
static |
Highlights tiles insede local authority of selected towns.
Definition at line 1065 of file viewport.cpp.
Referenced by DrawTileSelection().
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.
w | Window to use/display the viewport in |
x | Offset of left edge of viewport with respect to left edge window w |
y | Offset of top edge of viewport with respect to top edge window w |
width | Width of the viewport |
height | Height of the viewport |
focus | Either the tile index or vehicle ID to focus. |
zoom | Zoomlevel to display |
Definition at line 222 of file viewport.cpp.
Referenced by NWidgetViewport::InitializeViewport().
|
static |
Check if the parameter "check" is inside the interval between begin and end, including both begin and end.
begin
or end
is the biggest does not matter. This method will account for that. begin | The begin of the interval. |
end | The end of the interval. |
check | The value to check. |
Definition at line 792 of file viewport.cpp.
References Swap().
bool IsInsideRotatedRectangle | ( | int | x, |
int | y | ||
) |
Checks whether a point is inside the selected a diagonal rectangle given by _thd.size and _thd.pos.
x | The x coordinate of the point to be checked. |
y | The y coordinate of the point to be checked. |
Definition at line 804 of file viewport.cpp.
Is a xy position inside the viewport of the window?
w | Window to examine its viewport |
x | X coordinate of the xy position |
y | Y coordinate of the xy position |
nullptr
is returned. Definition at line 411 of file viewport.cpp.
void OffsetGroundSprite | ( | int | x, |
int | y | ||
) |
Called when a foundation has been drawn for the current tile.
Successive ground sprites for the current tile will be drawn as child sprites of the "foundation"-ParentSprite, not as TileSprites.
x | sprite x-offset (screen coordinates) of ground sprites relative to the "foundation"-ParentSprite. |
y | sprite y-offset (screen coordinates) of ground sprites relative to the "foundation"-ParentSprite. |
Definition at line 599 of file viewport.cpp.
bool ScrollMainWindowToTile | ( | TileIndex | tile, |
bool | instant | ||
) |
Scrolls the viewport of the main window to a given location.
tile | Desired tile to center on. |
instant | Jump to the location instead of slowly moving to it. |
Definition at line 2515 of file viewport.cpp.
References ScrollMainWindowTo(), TILE_SIZE, TileX(), and TileY().
Referenced by CmdScrollViewport(), and StoryBookWindow::OnPageElementClick().
bool ScrollWindowTo | ( | int | x, |
int | y, | ||
int | z, | ||
Window * | w, | ||
bool | instant | ||
) |
Scrolls the viewport in a window to a given location.
x | Desired x location of the map to scroll to (world coordinate). |
y | Desired y location of the map to scroll to (world coordinate). |
z | Desired z location of the map to scroll to (world coordinate). Use -1 to scroll to the height of the map at the x, y location. |
w | Window containing the viewport. |
instant | Jump to the location instead of slowly moving to it. |
Definition at line 2469 of file viewport.cpp.
Referenced by ScrollWindowToTile().
Scrolls the viewport in a window to a given location.
tile | Desired tile to center on. |
w | Window containing the viewport. |
instant | Jump to the location instead of slowly moving to it. |
Definition at line 2504 of file viewport.cpp.
References ScrollWindowTo(), TILE_SIZE, TileX(), and TileY().
Referenced by WaypointWindow::OnInvalidateData(), IndustryViewWindow::OnResize(), NewsWindow::OnResize(), TownViewWindow::OnResize(), and WaypointWindow::OnResize().
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 area selection, object placement, etc.
icon | New shape of the mouse cursor. |
pal | Palette to use. |
mode | Mode to perform. |
window_class | Window class of the window requesting the mode change. |
window_num | Number of the window in its class requesting the mode change. |
Definition at line 3450 of file viewport.cpp.
Referenced by _GenerateWorld(), ResetObjectToPlace(), and SetObjectToPlaceWnd().
void SetObjectToPlaceWnd | ( | CursorID | icon, |
PaletteID | pal, | ||
HighLightStyle | mode, | ||
Window * | w | ||
) |
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile area selection, object placement, etc.
icon | New shape of the mouse cursor. |
pal | Palette to use. |
mode | Mode to perform. |
w | Window requesting the mode change. |
Definition at line 3435 of file viewport.cpp.
References SetObjectToPlace(), Window::window_class, and Window::window_number.
Referenced by OrdersWindow::OrderClick_Goto().
void SetRedErrorSquare | ( | TileIndex | tile | ) |
Set a tile to display a red error square.
tile | Tile that should show the red error square. |
Definition at line 2524 of file viewport.cpp.
void SetTileSelectSize | ( | int | w, |
int | h | ||
) |
Highlight w by h tiles at the cursor.
w | Width of the highlighted tiles rectangle. |
h | Height of the highlighted tiles rectangle. |
Definition at line 2542 of file viewport.cpp.
Referenced by BuildRailStationWindow::OnPaint(), and ScenarioEditorLandscapeGenerationWindow::OnPaint().
void SetViewportCatchmentStation | ( | const Station * | st, |
bool | sel | ||
) |
Select or deselect station for coverage area highlight.
Selecting a station will deselect a town.
*st | Station in question |
sel | Select or deselect given station |
Definition at line 3618 of file viewport.cpp.
Referenced by BuildAirToolbarWindow::OnPlaceObjectAbort(), and BuildRailToolbarWindow::OnPlaceObjectAbort().
void SetViewportCatchmentTown | ( | const Town * | t, |
bool | sel | ||
) |
Select or deselect town for coverage area highlight.
Selecting a town will deselect a station.
*t | Town in question |
sel | Select or deselect given town |
Definition at line 3658 of file viewport.cpp.
void SetViewportCatchmentWaypoint | ( | const Waypoint * | wp, |
bool | sel | ||
) |
Select or deselect waypoint for coverage area highlight.
Selecting a waypoint will deselect a town.
*wp | Waypoint in question |
sel | Select or deselect given waypoint |
Definition at line 3638 of file viewport.cpp.
Referenced by BuildRailToolbarWindow::OnPlaceObjectAbort().
|
inlinestatic |
Displays the measurement tooltips when selecting multiple tiles.
str | String to be displayed |
paramcount | number of params to deal with |
Definition at line 2710 of file viewport.cpp.
References _settings_client, ClientSettings::gui, GuiShowTooltips(), and GUISettings::measure_tooltip.
void StartSpriteCombine | ( | ) |
Starts a block of sprites, which are "combined" into a single bounding box.
Subsequent calls to AddSortableSpriteToDraw will be drawn into the same bounding box. That is: The first sprite that is not clipped by the viewport defines the bounding box, and the following sprites will be child sprites to that one.
That implies:
The block is terminated by EndSpriteCombine.
You cannot nest "combined" blocks.
Definition at line 767 of file viewport.cpp.
|
static |
Check if the direction of start and end tile should be swapped based on the dragging-style.
Default directions are: in the case of a line (HT_RAIL, HT_LINE): DIR_NE, DIR_NW, DIR_N, DIR_E in the case of a rect (HT_RECT, HT_POINT): DIR_S, DIR_E For example dragging a rectangle area from south to north should be swapped to north-south (DIR_S) to obtain the same results with less code. This is what the return value signifies.
style | HighLightStyle dragging style |
start_tile | start tile of drag |
end_tile | end tile of drag |
Definition at line 2850 of file viewport.cpp.
References HT_DRAG_MASK, HT_LINE, HT_POINT, HT_RAIL, HT_RECT, TileX(), and TileY().
Referenced by CalcHeightdiff().
Translate screen coordinate in a viewport to underlying tile coordinate.
Returns exact point of the map that is visible in the given place of the viewport (3D perspective), height of tiles and foundations matter.
vp | Viewport that contains the (x, y) screen coordinate |
x | Screen x coordinate, distance in pixels from the left edge of viewport frame |
y | Screen y coordinate, distance in pixels from the top edge of viewport frame |
clamp_to_map | Clamp the coordinate outside of the map to the closest, non-void tile within the map |
Definition at line 435 of file viewport.cpp.
void UpdateTileSelection | ( | ) |
Updates tile highlighting for all cases.
Uses _thd.selstart and _thd.selend and _thd.place_mode (set elsewhere) to determine _thd.pos and _thd.size Also drawstyle is determined. Uses _thd.new.* as a buffer and calls SetSelectionTilesDirty() twice, Once for the old and once for the new selection. _thd is TileHighlightData, found in viewport.h
Definition at line 2602 of file viewport.cpp.
Referenced by StationJoinerNeeded().
void UpdateViewportPosition | ( | Window * | w, |
uint32_t | delta_ms | ||
) |
Update the viewport position being displayed.
w | Window owning the viewport. |
Definition at line 1916 of file viewport.cpp.
References ViewportData::follow_vehicle, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), INVALID_VEHICLE, and Window::viewport.
Referenced by UpdateWindows().
|
static |
Add the landscape to the viewport, i.e.
all ground tiles and buildings.
Definition at line 1189 of file viewport.cpp.
void ViewportAddString | ( | const DrawPixelInfo * | dpi, |
ZoomLevel | small_from, | ||
const ViewportSign * | sign, | ||
StringID | string_normal, | ||
StringID | string_small, | ||
StringID | string_small_shadow, | ||
Colours | colour | ||
) |
Add a string to draw in the viewport.
dpi | current viewport area |
small_from | Zoomlevel from when the small font should be used |
sign | sign position and dimension |
string_normal | String for normal and 2x zoom level |
string_small | String for 4x and 8x zoom level |
string_small_shadow | Shadow string for 4x and 8x zoom level; or #STR_NULL if no shadow |
colour | colour of the sign background; or INVALID_COLOUR if transparent |
Definition at line 1311 of file viewport.cpp.
References ViewportSign::center, FS_NORMAL, FS_SMALL, GetCharacterHeight(), ScaleByZoom(), WidgetDimensions::scaled, ViewportSign::top, ViewportSign::width_normal, and ViewportSign::width_small.
|
static |
Draws the bounding boxes of all ParentSprites.
psd | Array of ParentSprites |
Definition at line 1673 of file viewport.cpp.
References DrawBox(), and RemapCoords().
EventState VpHandlePlaceSizingDrag | ( | ) |
Handle the mouse while dragging for placement/resizing.
Definition at line 3381 of file viewport.cpp.
References _special_mouse_mode, ES_NOT_HANDLED, WSM_DRAGGING, and WSM_SIZING.
void VpSelectTilesWithMethod | ( | int | x, |
int | y, | ||
ViewportPlaceMethod | method | ||
) |
Selects tiles while dragging.
x | X coordinate of end of selection |
y | Y coordinate of end of selection |
method | modifies the way tiles are selected. Possible methods are VPM_* in viewport.h |
Definition at line 3216 of file viewport.cpp.
Highlights all tiles between a set of two tiles.
Used in dock and tunnel placement
from | TileIndex of the first tile to highlight |
to | TileIndex of the last tile to highlight |
Definition at line 2777 of file viewport.cpp.
References DistanceManhattan().
|
static |
Definition at line 951 of file viewport.cpp.
|
static |
List of sorters ordered from best to worst.
Definition at line 3522 of file viewport.cpp.
Referenced by InitializeSpriteSorter().