src/landscape.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file landscape.h Functions related to OTTD's landscape. */
  11
  12 #ifndef LANDSCAPE_H
  13 #define LANDSCAPE_H
  14
  15 #include "core/geometry_type.hpp"
  16 #include "tile_cmd.h"
  17
  18 static const uint SNOW_LINE_MONTHS = 12; ///< Number of months in the snow line table.
  19 static const uint SNOW_LINE_DAYS   = 32; ///< Number of days in each month in the snow line table.
  20
  21 /**
  22  * Structure describing the height of the snow line each day of the year
  23  * @ingroup SnowLineGroup
  24  */
  25 struct SnowLine {
  26         byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS]; ///< Height of the snow line each day of the year
  27         byte highest_value; ///< Highest snow line of the year
  28         byte lowest_value;  ///< Lowest snow line of the year
  29 };
  30
  31 bool IsSnowLineSet();
  32 void SetSnowLine(byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS]);
  33 byte GetSnowLine();
  34 byte HighestSnowLine();
  35 byte LowestSnowLine();
  36 void ClearSnowLine();
  37
  38 uint GetPartialZ(int x, int y, Slope corners);
  39 uint GetSlopeZ(int x, int y);
  40 void GetSlopeZOnEdge(Slope tileh, DiagDirection edge, int *z1, int *z2);
  41 int GetSlopeZInCorner(Slope tileh, Corner corner);
  42 Slope GetFoundationSlope(TileIndex tile, uint *z);
  43
  44 /**
  45  * Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
  46  * @param x X world or tile coordinate (runs in SW direction in the 2D view).
  47  * @param y Y world or tile coordinate (runs in SE direction in the 2D view).
  48  * @param z Z world or tile coordinate (runs in N direction in the 2D view).
  49  * @return Equivalent coordinate in the 2D view.
  50  * @see RemapCoords2
  51  */
  52 static inline Point RemapCoords(int x, int y, int z)
  53 {
  54         Point pt;
  55         pt.x = (y - x) * 2;
  56         pt.y = y + x - z;
  57         return pt;
  58 }
  59
  60 /**
  61  * Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
  62  * Same as #RemapCoords, except the Z coordinate is read from the map.
  63  * @param x X world or tile coordinate (runs in SW direction in the 2D view).
  64  * @param y Y world or tile coordinate (runs in SE direction in the 2D view).
  65  * @return Equivalent coordinate in the 2D view.
  66  * @see RemapCoords
  67  */
  68 static inline Point RemapCoords2(int x, int y)
  69 {
  70         return RemapCoords(x, y, GetSlopeZ(x, y));
  71 }
  72
  73 /**
  74  * Map 2D viewport or smallmap coordinate to 3D world or tile coordinate.
  75  * Function assumes <tt>z == 0</tt>. For other values of \p z, add \p z to \a y before the call.
  76  * @param x X coordinate of the 2D coordinate.
  77  * @param y Y coordinate of the 2D coordinate.
  78  * @return X and Y components of equivalent world or tile coordinate.
  79  * @note Inverse of #RemapCoords function. Smaller values may get rounded.
  80  */
  81 static inline Point InverseRemapCoords(int x, int y)
  82 {
  83         Point pt = {(y * 2 - x) >> 2, (y * 2 + x) >> 2};
  84         return pt;
  85 }
  86
  87 uint ApplyFoundationToSlope(Foundation f, Slope *s);
  88 void DrawFoundation(TileInfo *ti, Foundation f);
  89 bool HasFoundationNW(TileIndex tile, Slope slope_here, uint z_here);
  90 bool HasFoundationNE(TileIndex tile, Slope slope_here, uint z_here);
  91
  92 void DoClearSquare(TileIndex tile);
  93 void RunTileLoop();
  94
  95 void InitializeLandscape();
  96 void GenerateLandscape(byte mode);
  97
  98 #endif /* LANDSCAPE_H */