1

/* $Id$ */

     2

     3

/** @file ai_road.hpp Everything to query and build roads. */

     4

     5

#ifndef AI_ROAD_HPP

     6

#define AI_ROAD_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all road related functions.

    12

 */

    13

class AIRoad : public AIObject {

    14

public:

    15

	static const char *GetClassName() { return "AIRoad"; }

    16

    17

	/**

    18

	 * Checks whether the given tile is actually a tile with road that can be

    19

	 *  used to traverse a tile. This excludes road depots and 'normal' road

    20

	 *  stations, but includes drive through stations.

    21

	 * @param tile The tile to check.

    22

	 * @pre AIMap::IsValidTile(tile).

    23

	 * @return True if and only if the tile has road.

    24

	 */

    25

	static bool IsRoadTile(TileIndex tile);

    26

    27

	/**

    28

	 * Checks whether the given tile is actually a tile with a road depot.

    29

	 * @param tile The tile to check.

    30

	 * @pre AIMap::IsValidTile(tile).

    31

	 * @return True if and only if the tile has a road depot.

    32

	 */

    33

	static bool IsRoadDepotTile(TileIndex tile);

    34

    35

	/**

    36

	 * Checks whether the given tile is actually a tile with a road station.

    37

	 * @param tile The tile to check.

    38

	 * @pre AIMap::IsValidTile(tile).

    39

	 * @return True if and only if the tile has a road station.

    40

	 */

    41

	static bool IsRoadStationTile(TileIndex tile);

    42

    43

	/**

    44

	 * Checks whether the given tile is actually a tile with a drive through

    45

	 *  road station.

    46

	 * @param tile The tile to check.

    47

	 * @pre AIMap::IsValidTile(tile).

    48

	 * @return True if and only if the tile has a drive through road station.

    49

	 */

    50

	static bool IsDriveThroughRoadStationTile(TileIndex tile);

    51

    52

	/**

    53

	 * Checks whether the given tiles are directly connected, i.e. whether

    54

	 *  a road vehicle can travel from the center of the first tile to the

    55

	  * center of the second tile.

    56

	 * @param tile_from The source tile.

    57

	 * @param tile_to The destination tile.

    58

	 * @pre AIMap::IsValidTile(tile_from).

    59

	 * @pre AIMap::IsValidTile(tile_to).

    60

	 * @pre 'tile_from' and 'tile_to' are directly neighbouring tiles.

    61

	 * @return True if and only if a road vehicle can go from tile_from to tile_to.

    62

	 */

    63

	static bool AreRoadTilesConnected(TileIndex tile_from, TileIndex tile_to);

    64

    65

	/**

    66

	 * Count how many neighbours are road.

    67

	 * @param tile The tile to check on.

    68

	 * @pre AIMap::IsValidTile(tile).

    69

	 * @return 0 means no neighbour road; max value is 4.

    70

	 */

    71

	static int32 GetNeighbourRoadCount(TileIndex tile);

    72

    73

	/**

    74

	 * Gets the tile in front of a road depot.

    75

	 * @param depot The road depot tile.

    76

	 * @pre IsRoadDepotTile(depot).

    77

	 * @return The tile in front of the depot.

    78

	 */

    79

	static TileIndex GetRoadDepotFrontTile(TileIndex depot);

    80

    81

	/**

    82

	 * Gets the tile in front of a road station.

    83

	 * @param station The road station tile.

    84

	 * @pre IsRoadStationTile(station).

    85

	 * @return The tile in front of the road station.

    86

	 */

    87

	static TileIndex GetRoadStationFrontTile(TileIndex station);

    88

    89

	/**

    90

	 * Gets the tile at the back of a drive through road station.

    91

	 *  So, one side of the drive through station is retrieved with

    92

	 *  GetTileInFrontOfStation, the other with this function.

    93

	 * @param station The road station tile.

    94

	 * @pre IsDriveThroughRoadStationTile(station).

    95

	 * @return The tile at the back of the drive through road station.

    96

	 */

    97

	static TileIndex GetDriveThroughBackTile(TileIndex station);

    98

    99

	/**

   100

	 * Builds a road from the center of tile start to the center of tile end.

   101

	 * @param start The start tile of the road.

   102

	 * @param end The end tile of the road.

   103

	 * @pre 'start' is not equal to 'end'.

   104

	 * @pre AIMap::IsValidTile(start).

   105

	 * @pre AIMap::IsValidTile(end).

   106

	 * @pre 'start' and 'end' are in a straight line, i.e.

   107

	 *  AIMap::GetTileX(start) == AIMap::GetTileX(end) or

   108

	 *  AIMap::GetTileY(start) == AIMap::GetTileY(end).

   109

	 * @return Whether the road has been/can be build or not.

   110

	 */

   111

	static bool BuildRoad(TileIndex start, TileIndex end);

   112

   113

	/**

   114

	 * Builds a road from the edge of tile start to the edge of tile end (both

   115

	 *  included).

   116

	 * @param start The start tile of the road.

   117

	 * @param end The end tile of the road.

   118

	 * @pre 'start' is not equal to 'end'.

   119

	 * @pre AIMap::IsValidTile(start).

   120

	 * @pre AIMap::IsValidTile(end).

   121

	 * @pre 'start' and 'end' are in a straight line, i.e.

   122

	 *  AIMap::GetTileX(start) == AIMap::GetTileX(end) or

   123

	 *  AIMap::GetTileY(start) == AIMap::GetTileY(end).

   124

	 * @return Whether the road has been/can be build or not.

   125

	 */

   126

	static bool BuildRoadFull(TileIndex start, TileIndex end);

   127

   128

	/**

   129

	 * Builds a road depot.

   130

	 * @param tile Place to build the depot.

   131

	 * @param front The tile exactly in front of the depot.

   132

	 * @pre AIMap::IsValidTile(tile).

   133

	 * @pre AIMap::IsValidTile(front).

   134

	 * @pre Tile is not equal to front.

   135

	 * @return Whether the road depot has been/can be build or not.

   136

	 */

   137

	static bool BuildRoadDepot(TileIndex tile, TileIndex front);

   138

   139

	/**

   140

	 * Builds a road bus or truck station.

   141

	 * @param tile Place to build the depot.

   142

	 * @param front The tile exactly in front of the station.

   143

	 *   For drive-through stations either entrance side can be used.

   144

	 * @param truck Whether to build a truck (true) or bus (false) station.

   145

	 * @param drive_through Whether to make the station drive through or not.

   146

	 * @pre AIMap::IsValidTile(tile).

   147

	 * @pre AIMap::IsValidTile(front).

   148

	 * @pre 'tile' is not equal to 'front'.

   149

	 * @return Whether the station has been/can be build or not.

   150

	 */

   151

	static bool BuildRoadStation(TileIndex tile, TileIndex front, bool truck, bool drive_through);

   152

   153

	/**

   154

	 * Removes a road from the center of tile start to the center of tile end.

   155

	 * @param start The start tile of the road.

   156

	 * @param end The end tile of the road.

   157

	 * @pre AIMap::IsValidTile(start).

   158

	 * @pre AIMap::IsValidTile(end).

   159

	 * @pre 'start' and 'end' are in a straight line, i.e.

   160

	 *  AIMap::GetTileX(start) == AIMap::GetTileX(end) or

   161

	 *  AIMap::GetTileY(start) == AIMap::GetTileY(end).

   162

	 * @return Whether the road has been/can be removed or not.

   163

	 */

   164

	static bool RemoveRoad(TileIndex start, TileIndex end);

   165

   166

	/**

   167

	 * Removes a road from the edge of tile start to the edge of tile end (both

   168

	 *  included).

   169

	 * @param start The start tile of the road.

   170

	 * @param end The end tile of the road.

   171

	 * @pre AIMap::IsValidTile(start).

   172

	 * @pre AIMap::IsValidTile(end).

   173

	 * @pre 'start' and 'end' are in a straight line, i.e.

   174

	 *  AIMap::GetTileX(start) == AIMap::GetTileX(end) or

   175

	 *  AIMap::GetTileY(start) == AIMap::GetTileY(end).

   176

	 * @return Whether the road has been/can be removed or not.

   177

	 */

   178

	static bool RemoveRoadFull(TileIndex start, TileIndex end);

   179

   180

	/**

   181

	 * Removes a road depot.

   182

	 * @param tile Place to remove the depot from.

   183

	 * @pre AIMap::IsValidTile(tile).

   184

	 * @pre Tile is a road depot.

   185

	 * @return Whether the road depot has been/can be removed or not.

   186

	 */

   187

	static bool RemoveRoadDepot(TileIndex tile);

   188

   189

	/**

   190

	 * Removes a road bus or truck station.

   191

	 * @param tile Place to remove the station from.

   192

	 * @pre AIMap::IsValidTile(tile).

   193

	 * @pre Tile is a road station.

   194

	 * @return Whether the station has been/can be removed or not.

   195

	 */

   196

	static bool RemoveRoadStation(TileIndex tile);

   197

};

   198

   199

#endif /* AI_ROAD_HPP */