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

	/**

    16

	 * The name of the class, needed by several sub-processes.

    17

	 */

    18

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

    19

    20

	/**

    21

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

    22

	 * can be used to traverse a tile. This excludes road depots and

    23

	 * 'normal' road stations, but includes drive through stations.

    24

	 * @param tile the tile to check.

    25

	 * @pre AIMap::IsValidTile(tile).

    26

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

    27

	 */

    28

	static bool IsRoadTile(TileIndex tile);

    29

    30

	/**

    31

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

    32

	 * @param tile the tile to check.

    33

	 * @pre AIMap::IsValidTile(tile).

    34

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

    35

	 */

    36

	static bool IsRoadDepotTile(TileIndex tile);

    37

    38

	/**

    39

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

    40

	 * @param tile the tile to check.

    41

	 * @pre AIMap::IsValidTile(tile).

    42

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

    43

	 */

    44

	static bool IsRoadStationTile(TileIndex tile);

    45

    46

	/**

    47

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

    48

	 * road station.

    49

	 * @param tile the tile to check.

    50

	 * @pre AIMap::IsValidTile(tile).

    51

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

    52

	 */

    53

	static bool IsDriveThroughRoadStationTile(TileIndex tile);

    54

    55

	/**

    56

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

    57

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

    58

	 * center of the second tile.

    59

	 * @param t1 the source tile.

    60

	 * @param t2 the destination tile.

    61

	 * @pre AIMap::IsValidTile(t1).

    62

	 * @pre AIMap::IsValidTile(t2).

    63

	 * @pre t1 and t2 are directly neighbouring tiles.

    64

	 * @return true if and only if a road vehicle can go from t1 to t2.

    65

	 */

    66

	static bool AreRoadTilesConnected(TileIndex t1, TileIndex t2);

    67

    68

	/**

    69

	 * Count how many neighbours are road.

    70

	 * @param tile the tile to check on.

    71

	 * @pre AIMap::IsValidTile(tile).

    72

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

    73

	 */

    74

	static int32 GetNeighbourRoadCount(TileIndex tile);

    75

    76

	/**

    77

	 * Gets the tile in front of a road depot.

    78

	 * @param depot the road depot tile.

    79

	 * @pre IsRoadDepotTile(depot).

    80

	 * @return the tile in front of the depot.

    81

	 */

    82

	static TileIndex GetRoadDepotFrontTile(TileIndex depot);

    83

    84

	/**

    85

	 * Gets the tile in front of a road station.

    86

	 * @param station the road station tile.

    87

	 * @pre IsRoadStationTile(station).

    88

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

    89

	 */

    90

	static TileIndex GetRoadStationFrontTile(TileIndex station);

    91

    92

	/**

    93

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

    94

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

    95

	 * GetTileInFrontOfStation, the other with this function.

    96

	 * @param station the road station tile.

    97

	 * @pre IsDriveThroughRoadStationTile(station).

    98

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

    99

	 */

   100

	static TileIndex GetDriveThroughBackTile(TileIndex station);

   101

   102

	/**

   103

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

   104

	 * center of tile end.

   105

	 * @param start the start tile of the road.

   106

	 * @param end   the end tile of the road.

   107

	 * @pre start is not equal to end

   108

	 * @pre AIMap::IsValidTile(start).

   109

	 * @pre AIMap::IsValidTile(end).

   110

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

   111

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

   112

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

   113

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

   114

	 */

   115

	static bool BuildRoad(TileIndex start, TileIndex end);

   116

   117

	/**

   118

	 * Builds a road from the edge of tile start to the

   119

	 * edge of tile end (both included).

   120

	 * @param start the start tile of the road.

   121

	 * @param end   the end tile of the road.

   122

	 * @pre start is not equal to end

   123

	 * @pre AIMap::IsValidTile(start).

   124

	 * @pre AIMap::IsValidTile(end).

   125

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

   126

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

   127

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

   128

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

   129

	 */

   130

	static bool BuildRoadFull(TileIndex start, TileIndex end);

   131

   132

	/**

   133

	 * Builds a road depot.

   134

	 * @param tile  place to build the depot.

   135

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

   136

	 * @pre AIMap::IsValidTile(tile).

   137

	 * @pre AIMap::IsValidTile(front).

   138

	 * @pre tile is not equal to front

   139

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

   140

	 */

   141

	static bool BuildRoadDepot(TileIndex tile, TileIndex front);

   142

   143

	/**

   144

	 * Builds a road bus or truck station.

   145

	 * @param tile  place to build the depot.

   146

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

   147

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

   148

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

   149

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

   150

	 * @pre AIMap::IsValidTile(tile).

   151

	 * @pre AIMap::IsValidTile(front).

   152

	 * @pre tile is not equal to front

   153

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

   154

	 */

   155

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

   156

   157

	/**

   158

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

   159

	 * center of tile end.

   160

	 * @param start the start tile of the road.

   161

	 * @param end   the end tile of the road.

   162

	 * @pre AIMap::IsValidTile(start).

   163

	 * @pre AIMap::IsValidTile(end).

   164

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

   165

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

   166

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

   167

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

   168

	 */

   169

	static bool RemoveRoad(TileIndex start, TileIndex end);

   170

   171

	/**

   172

	 * Removes a road from the edge of tile start to the

   173

	 * edge of tile end (both included).

   174

	 * @param start the start tile of the road.

   175

	 * @param end   the end tile of the road.

   176

	 * @pre AIMap::IsValidTile(start).

   177

	 * @pre AIMap::IsValidTile(end).

   178

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

   179

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

   180

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

   181

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

   182

	 */

   183

	static bool RemoveRoadFull(TileIndex start, TileIndex end);

   184

   185

	/**

   186

	 * Removes a road depot.

   187

	 * @param tile place to remove the depot from.

   188

	 * @pre AIMap::IsValidTile(tile).

   189

	 * @pre tile is a road depot.

   190

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

   191

	 */

   192

	static bool RemoveRoadDepot(TileIndex tile);

   193

   194

	/**

   195

	 * Removes a road bus or truck station.

   196

	 * @param tile place to remove the station from.

   197

	 * @pre AIMap::IsValidTile(tile).

   198

	 * @pre tile is a road station.

   199

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

   200

	 */

   201

	static bool RemoveRoadStation(TileIndex tile);

   202

};

   203

   204

#endif /* AI_ROAD_HPP */