src/viewport_func.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file viewport_func.h Functions related to (drawing on) viewports. */
   9
  10 #ifndef VIEWPORT_FUNC_H
  11 #define VIEWPORT_FUNC_H
  12
  13 #include "gfx_type.h"
  14 #include "viewport_type.h"
  15 #include "window_type.h"
  16 #include "tile_map.h"
  17 #include "station_type.h"
  18
  19 static const int TILE_HEIGHT_STEP = 50; ///< One Z unit tile height difference is displayed as 50m.
  20
  21 void SetSelectionRed(bool);
  22
  23 void DeleteWindowViewport(Window *w);
  24 void InitializeWindowViewport(Window *w, int x, int y, int width, int height, uint32 follow_flags, ZoomLevel zoom);
  25 ViewPort *IsPtInWindowViewport(const Window *w, int x, int y);
  26 Point TranslateXYToTileCoord(const ViewPort *vp, int x, int y, bool clamp_to_map = true);
  27 Point GetTileBelowCursor();
  28 void UpdateViewportPosition(Window *w);
  29
  30 void MarkAllViewportsDirty(int left, int top, int right, int bottom);
  31
  32 bool DoZoomInOutWindow(ZoomStateChange how, Window *w);
  33 void ZoomInOrOutToCursorWindow(bool in, Window * w);
  34 Point GetTileZoomCenterWindow(bool in, Window * w);
  35 void FixTitleGameZoom();
  36 void HandleZoomMessage(Window *w, const ViewPort *vp, byte widget_zoom_in, byte widget_zoom_out);
  37
  38 /**
  39  * Zoom a viewport as far as possible in the given direction.
  40  * @param how Zooming direction.
  41  * @param w   Window owning the viewport.
  42  * @pre \a how should not be #ZOOM_NONE.
  43  */
  44 static inline void MaxZoomInOut(ZoomStateChange how, Window *w)
  45 {
  46         while (DoZoomInOutWindow(how, w)) {};
  47 }
  48
  49 void OffsetGroundSprite(int x, int y);
  50
  51 void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub = nullptr, int extra_offs_x = 0, int extra_offs_y = 0);
  52 void DrawGroundSpriteAt(SpriteID image, PaletteID pal, int32 x, int32 y, int z, const SubSprite *sub = nullptr, int extra_offs_x = 0, int extra_offs_y = 0);
  53 void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int w, int h, int dz, int z, bool transparent = false, int bb_offset_x = 0, int bb_offset_y = 0, int bb_offset_z = 0, const SubSprite *sub = nullptr);
  54 void AddChildSpriteScreen(SpriteID image, PaletteID pal, int x, int y, bool transparent = false, const SubSprite *sub = nullptr, bool scale = true);
  55 void ViewportAddString(const DrawPixelInfo *dpi, ZoomLevel small_from, const ViewportSign *sign, StringID string_normal, StringID string_small, StringID string_small_shadow, uint64 params_1, uint64 params_2 = 0, Colours colour = INVALID_COLOUR);
  56
  57
  58 void StartSpriteCombine();
  59 void EndSpriteCombine();
  60
  61 bool HandleViewportClicked(const ViewPort *vp, int x, int y);
  62 void SetRedErrorSquare(TileIndex tile);
  63 void SetTileSelectSize(int w, int h);
  64 void SetTileSelectBigSize(int ox, int oy, int sx, int sy);
  65
  66 void ViewportDoDraw(const ViewPort *vp, int left, int top, int right, int bottom);
  67
  68 bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant = false);
  69 bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant = false);
  70
  71 void RebuildViewportOverlay(Window *w);
  72
  73 bool ScrollMainWindowToTile(TileIndex tile, bool instant = false);
  74 bool ScrollMainWindowTo(int x, int y, int z = -1, bool instant = false);
  75
  76 void UpdateAllVirtCoords();
  77 void ClearAllCachedNames();
  78
  79 extern Point _tile_fract_coords;
  80
  81 void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override);
  82
  83 /**
  84  * Mark a tile given by its index dirty for repaint.
  85  * @param tile The tile to mark dirty.
  86  * @param bridge_level_offset Height of bridge on tile to also mark dirty. (Height level relative to north corner.)
  87  * @ingroup dirty
  88  */
  89 static inline void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset = 0)
  90 {
  91         MarkTileDirtyByTile(tile, bridge_level_offset, TileHeight(tile));
  92 }
  93
  94 Point GetViewportStationMiddle(const ViewPort *vp, const Station *st);
  95
  96 struct Station;
  97 struct Town;
  98
  99 void SetViewportCatchmentStation(const Station *st, bool sel);
 100 void SetViewportCatchmentTown(const Town *t, bool sel);
 101
 102 #endif /* VIEWPORT_FUNC_H */