viewport_func.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef VIEWPORT_FUNC_H
#define VIEWPORT_FUNC_H
 
#include "gfx_type.h"
#include "sprite.h"
#include "viewport_type.h"
#include "window_type.h"
#include "tile_map.h"
#include "station_type.h"
#include "vehicle_type.h"
 
static const int TILE_HEIGHT_STEP = 50; 
 
void SetSelectionRed(bool);
 
void InitializeWindowViewport(Window *w, int x, int y, int width, int height, std::variant<TileIndex, VehicleID> focus, ZoomLevel zoom);
Viewport *IsPtInWindowViewport(const Window *w, int x, int y);
Point TranslateXYToTileCoord(const Viewport &vp, int x, int y, bool clamp_to_map = true);
Point GetTileBelowCursor();
void UpdateViewportPosition(Window *w, uint32_t delta_ms);
 
bool MarkAllViewportsDirty(int left, int top, int right, int bottom);
 
bool DoZoomInOutWindow(ZoomStateChange how, Window *w);
void ZoomInOrOutToCursorWindow(bool in, Window * w);
void ConstrainAllViewportsZoom();
Point GetTileZoomCenterWindow(bool in, Window * w);
void FixTitleGameZoom(int zoom_adjust = 0);
void HandleZoomMessage(Window *w, const Viewport &vp, WidgetID widget_zoom_in, WidgetID widget_zoom_out);

inline void MaxZoomInOut(ZoomStateChange how, Window *w)
{
  while (DoZoomInOutWindow(how, w)) {};
}
 
void OffsetGroundSprite(int x, int y);
 
void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub = nullptr, int extra_offs_x = 0, int extra_offs_y = 0);
void DrawGroundSpriteAt(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);
void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int z, const SpriteBounds &bounds, bool transparent = false, const SubSprite *sub = nullptr);
void AddChildSpriteScreen(SpriteID image, PaletteID pal, int x, int y, bool transparent = false, const SubSprite *sub = nullptr, bool scale = true, bool relative = true);
std::string *ViewportAddString(const DrawPixelInfo *dpi, const ViewportSign *sign, ViewportStringFlags flags, Colours colour);
 
inline void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, const Coord3D<int32_t> &world, const SpriteBounds &bounds, bool transparent = false, const SubSprite *sub = nullptr)
{
  AddSortableSpriteToDraw(image, pal, world.x, world.y, world.z, bounds, transparent, sub);
}
 
void StartSpriteCombine();
void EndSpriteCombine();
 
bool HandleViewportClicked(const Viewport &vp, int x, int y);
void SetRedErrorSquare(TileIndex tile);
void SetTileSelectSize(int w, int h);
void SetTileSelectBigSize(int ox, int oy, int sx, int sy);
 
void ViewportDoDraw(const Viewport &vp, int left, int top, int right, int bottom);
 
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant = false);
bool ScrollWindowTo(int x, int y, int z, Window *w, bool instant = false);
 
void RebuildViewportOverlay(Window *w);
 
bool ScrollMainWindowToTile(TileIndex tile, bool instant = false);
bool ScrollMainWindowTo(int x, int y, int z = -1, bool instant = false);
 
void UpdateAllVirtCoords();
void ClearAllCachedNames();
 
extern Point _tile_fract_coords;
 
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override);

inline void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset = 0)
{
  MarkTileDirtyByTile(tile, bridge_level_offset, TileHeight(tile));
}
 
Point GetViewportStationMiddle(const Viewport &vp, const Station *st);
 
struct Station;
struct Waypoint;
struct Town;
 
void SetViewportCatchmentStation(const Station *st, bool sel);
void SetViewportStationRect(const Station *st, bool sel);
void SetViewportCatchmentWaypoint(const Waypoint *wp, bool sel);
void SetViewportWaypointRect(const Waypoint *wp, bool sel);
void SetViewportCatchmentTown(const Town *t, bool sel);
void MarkCatchmentTilesDirty();
 
template <class T>
void SetViewportCatchmentSpecializedStation(const T *st, bool sel);
 
template <>
inline void SetViewportCatchmentSpecializedStation(const Station *st, bool sel)
{
  SetViewportCatchmentStation(st, sel);
}
 
template <>
inline void SetViewportCatchmentSpecializedStation(const Waypoint *st, bool sel)
{
  SetViewportCatchmentWaypoint(st, sel);
}
 
#endif /* VIEWPORT_FUNC_H */