landscape.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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef LANDSCAPE_H
#define LANDSCAPE_H
 
#include "core/geometry_type.hpp"
#include "tile_cmd.h"
 
static const uint SNOW_LINE_MONTHS = 12; 
static const uint SNOW_LINE_DAYS   = 32; 
 
struct SnowLine {
  uint8_t table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS]; 
  uint8_t highest_value = 0; 
  uint8_t lowest_value = UINT8_MAX; 
};
 
bool IsSnowLineSet();
void SetSnowLine(std::unique_ptr<SnowLine> &&snow_line);
uint8_t GetSnowLine();
uint8_t HighestSnowLine();
uint8_t LowestSnowLine();
void ClearSnowLine();
 
bool IsMapSurroundedByWater();
 
int GetSlopeZInCorner(Slope tileh, Corner corner);
std::tuple<Slope, int> GetFoundationSlope(TileIndex tile);
 
uint GetPartialPixelZ(int x, int y, Slope corners);
int GetSlopePixelZ(int x, int y, bool ground_vehicle = false);
int GetSlopePixelZOutsideMap(int x, int y);
void GetSlopePixelZOnEdge(Slope tileh, DiagDirection edge, int &z1, int &z2);
 
inline int GetSlopePixelZInCorner(Slope tileh, Corner corner)
{
  return GetSlopeZInCorner(tileh, corner) * TILE_HEIGHT;
}
 
inline std::tuple<Slope, int> GetFoundationPixelSlope(TileIndex tile)
{
  auto [s, z] = GetFoundationSlope(tile);
  return {s, z * TILE_HEIGHT};
}
 
inline Point RemapCoords(int x, int y, int z)
{
  Point pt;
  pt.x = (y - x) * 2 * ZOOM_BASE;
  pt.y = (y + x - z) * ZOOM_BASE;
  return pt;
}
 
inline Point RemapCoords2(int x, int y)
{
  return RemapCoords(x, y, GetSlopePixelZ(x, y, false));
}
 
inline Point InverseRemapCoords(int x, int y)
{
  Point pt = {(y * 2 - x) >> (2 + ZOOM_BASE_SHIFT), (y * 2 + x) >> (2 + ZOOM_BASE_SHIFT)};
  return pt;
}
 
Point InverseRemapCoords2(int x, int y, bool clamp_to_map = false, bool *clamped = nullptr);
 
uint ApplyFoundationToSlope(Foundation f, Slope &s);
inline uint ApplyPixelFoundationToSlope(Foundation f, Slope &s)
{
  return ApplyFoundationToSlope(f, s) * TILE_HEIGHT;
}
 
void DrawFoundation(TileInfo *ti, Foundation f);
bool HasFoundationNW(TileIndex tile, Slope slope_here, uint z_here);
bool HasFoundationNE(TileIndex tile, Slope slope_here, uint z_here);
 
void DoClearSquare(TileIndex tile);
void RunTileLoop();
 
void InitializeLandscape();
bool GenerateLandscape(uint8_t mode);
 
#endif /* LANDSCAPE_H */