From 21c3dd11bdc0574a1ac7d7c0c7094b6ab82b8044 Mon Sep 17 00:00:00 2001 From: alberth Date: Sat, 6 Feb 2010 09:30:30 +0000 Subject: (svn r19027) -Doc: Document RemapCoords functions. --- src/landscape.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'src') diff --git a/src/landscape.h b/src/landscape.h index cc64b0cf1..d439f9171 100644 --- a/src/landscape.h +++ b/src/landscape.h @@ -41,6 +41,14 @@ void GetSlopeZOnEdge(Slope tileh, DiagDirection edge, int *z1, int *z2); 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 @@ static inline Point RemapCoords(int x, int y, int z) 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)); -- cgit v1.2.3-70-g09d2