src/tunnel_map.cpp
author skidd13
Tue, 20 Nov 2007 14:11:19 +0000
changeset 8428 f8300c908bd9
parent 7819 694a7dacd30a
child 8579 3efbb430092e
child 9723 eee46cb39750
permissions -rw-r--r--
(svn r11485) -Codechange: Remove the doubled function ToggleBitT and rename the remaining to fit with the naming style
3154
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
     1
/* $Id$ */
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
     2
6918
5589c415e28f (svn r9558) -Documentation: doxygen and comment changes: 'T' now. Almost done
belugas
parents: 5835
diff changeset
     3
/** @file tunnel_map.cpp */
5589c415e28f (svn r9558) -Documentation: doxygen and comment changes: 'T' now. Almost done
belugas
parents: 5835
diff changeset
     4
3154
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
     5
#include "stdafx.h"
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
     6
#include "openttd.h"
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
     7
#include "tile.h"
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
     8
#include "tunnel_map.h"
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
     9
6985
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    10
/**
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    11
 * Gets the other end of the tunnel. Where a vehicle would reappear when it
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    12
 * enters at the given tile.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    13
 * @param tile the tile to search from.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    14
 * @return the tile of the other end of the tunnel.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    15
 */
3154
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    16
TileIndex GetOtherTunnelEnd(TileIndex tile)
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    17
{
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    18
	DiagDirection dir = GetTunnelDirection(tile);
4559
c853d2440065 (svn r6406) -Codechange: Rename TileOffsByDir to TileOffsByDiagDir because it accepts
Darkvater
parents: 4291
diff changeset
    19
	TileIndexDiff delta = TileOffsByDiagDir(dir);
3154
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    20
	uint z = GetTileZ(tile);
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    21
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    22
	dir = ReverseDiagDir(dir);
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    23
	do {
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    24
		tile += delta;
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    25
	} while (
3184
7405329343ce (svn r3830) Move IsTunnelTile() from tile.h to tunnel_map.h and add IsTunnel(), which just checks for a tunnel, but not the tile type as IsTunnelTile() does
tron
parents: 3156
diff changeset
    26
		!IsTunnelTile(tile) ||
3154
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    27
		GetTunnelDirection(tile) != dir ||
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    28
		GetTileZ(tile) != z
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    29
	);
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    30
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    31
	return tile;
a8fffb204d0e (svn r3777) Add some functions to handle tunnels
tron
parents:
diff changeset
    32
}
3156
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    33
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    34
6985
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    35
/**
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    36
 * Is there a tunnel in the way in the given direction?
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    37
 * @param tile the tile to search from.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    38
 * @param z    the 'z' to search on.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    39
 * @param dir  the direction to start searching to.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    40
 * @return true if and only if there is a tunnel.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    41
 */
7498
ce6588257e8d (svn r10258) -Codechange: as we are now using int64 all over the place, it's better to use int64 variables in the string generating too instead of packing them into two int32s.
rubidium
parents: 6985
diff changeset
    42
bool IsTunnelInWayDir(TileIndex tile, uint z, DiagDirection dir)
3156
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    43
{
4559
c853d2440065 (svn r6406) -Codechange: Rename TileOffsByDir to TileOffsByDiagDir because it accepts
Darkvater
parents: 4291
diff changeset
    44
	TileIndexDiff delta = TileOffsByDiagDir(dir);
3156
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    45
	uint height;
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    46
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    47
	do {
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    48
		tile -= delta;
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    49
		height = GetTileZ(tile);
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    50
	} while (z < height);
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    51
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    52
	return
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    53
		z == height &&
3184
7405329343ce (svn r3830) Move IsTunnelTile() from tile.h to tunnel_map.h and add IsTunnel(), which just checks for a tunnel, but not the tile type as IsTunnelTile() does
tron
parents: 3156
diff changeset
    54
		IsTunnelTile(tile) &&
3156
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    55
		GetTunnelDirection(tile) == dir;
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    56
}
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    57
6985
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    58
/**
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    59
 * Is there a tunnel in the way in any direction?
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    60
 * @param tile the tile to search from.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    61
 * @param z the 'z' to search on.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    62
 * @return true if and only if there is a tunnel.
6fd300b20503 (svn r9670) -Documentation: add documentation to some the _map files.
rubidium
parents: 6918
diff changeset
    63
 */
3156
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    64
bool IsTunnelInWay(TileIndex tile, uint z)
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    65
{
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    66
	return
7819
694a7dacd30a (svn r10686) -Fix [FS#1058]: determining whether there is a tunnel going under the lowered area is only needed in two directions instead of all four, so take the directions (one for each axis) to the nearest border (along the given axis). Furthermore GetTileZ did much more than absolutely necessary.
rubidium
parents: 7498
diff changeset
    67
		IsTunnelInWayDir(tile, z, (TileX(tile) > (MapMaxX() / 2)) ? DIAGDIR_NE : DIAGDIR_SW) ||
694a7dacd30a (svn r10686) -Fix [FS#1058]: determining whether there is a tunnel going under the lowered area is only needed in two directions instead of all four, so take the directions (one for each axis) to the nearest border (along the given axis). Furthermore GetTileZ did much more than absolutely necessary.
rubidium
parents: 7498
diff changeset
    68
		IsTunnelInWayDir(tile, z, (TileY(tile) > (MapMaxY() / 2)) ? DIAGDIR_NW : DIAGDIR_SE);
3156
028b6756b279 (svn r3779) Move CheckTunnelInWay() to a more appropriate place, invert its result and give it a less ambiguous name (IsTunnelInWay)
tron
parents: 3154
diff changeset
    69
}