Mercurial > hg > openttd
changeset 14468:f93871351d9b draft
(svn r19027) -Doc: Document RemapCoords functions.
author | alberth <alberth@openttd.org> |
---|---|
date | Sat, 06 Feb 2010 09:30:30 +0000 |
parents | d9843f2c7674 |
children | 804eda4ac1f3 |
files | src/landscape.h |
diffstat | 1 files changed, 16 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/src/landscape.h +++ b/src/landscape.h @@ -41,6 +41,14 @@ int GetSlopeZInCorner(Slope tileh, Corner corner); Slope GetFoundationSlope(TileIndex tile, uint *z); +/** + * Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap. + * @param x X world or tile coordinate (runs in SW direction in the 2D view). + * @param y Y world or tile coordinate (runs in SE direction in the 2D view). + * @param z Z world or tile coordinate (runs in N direction in the 2D view). + * @return Equivalent coordinate in the 2D view. + * @see RemapCoords2 + */ static inline Point RemapCoords(int x, int y, int z) { Point pt; @@ -49,6 +57,14 @@ return pt; } +/** + * Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap. + * Same as #RemapCoords, except the Z coordinate is read from the map. + * @param x X world or tile coordinate (runs in SW direction in the 2D view). + * @param y Y world or tile coordinate (runs in SE direction in the 2D view). + * @return Equivalent coordinate in the 2D view. + * @see RemapCoords + */ static inline Point RemapCoords2(int x, int y) { return RemapCoords(x, y, GetSlopeZ(x, y));