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

 * Roads are always build from tile center to tile center.

    14

 * Furthermore stations and depots need to be build on tiles

    15

 * that already have road on them. For depots and non-drive

    16

 * through stations that means that only one roadbit may be

    17

 * built at the location. The advantage of this method is

    18

 * that the AI does not need to think about pointing the

    19

 * exit of the depots and roadstations towards the correct

    20

 * direction. For drive-through roadstops this works about

    21

 * the same, though they have to be built on straight roads.

    22

 */

    23

class AIRoad : public AIObject {

    24

public:

    25

	/**

    26

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

    27

	 */

    28

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

    29

    30

	/**

    31

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

    32

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

    33

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

    34

	 * @param tile the tile to check.

    35

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    36

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

    37

	 */

    38

	bool IsRoadTile(TileIndex tile);

    39

    40

	/**

    41

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

    42

	 * @param tile the tile to check.

    43

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    44

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

    45

	 */

    46

	bool IsRoadDepotTile(TileIndex tile);

    47

    48

	/**

    49

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

    50

	 * @param tile the tile to check.

    51

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    52

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

    53

	 */

    54

	bool IsRoadStationTile(TileIndex tile);

    55

    56

	/**

    57

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

    58

	 * road station.

    59

	 * @param tile the tile to check.

    60

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    61

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

    62

	 */

    63

	bool IsDriveThroughRoadStationTile(TileIndex tile);

    64

    65

	/**

    66

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

    67

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

    68

	 * center of the second tile.

    69

	 * @param t1 the source tile.

    70

	 * @param t2 the destination tile.

    71

	 * @pre t1 is always positive and smaller than AIMap::GetMapSize().

    72

	 * @pre t2 is always positive and smaller than AIMap::GetMapSize().

    73

	 * @pre t1 and t2 are directly neighbouring tiles.

    74

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

    75

	 */

    76

	bool AreRoadTilesConnected(TileIndex t1, TileIndex t2);

    77

    78

	/**

    79

	 * Count how many neighbours are road.

    80

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    81

	 * @param tile the tile to check on.

    82

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

    83

	 */

    84

	static int32 GetNeighbourRoadCount(TileIndex tile);

    85

    86

	/**

    87

	 * Gets the tile in front of a road depot.

    88

	 * @param depot the road depot tile.

    89

	 * @pre IsRoadDepotTile(depot).

    90

	 * @return the tile in front of the depot.

    91

	 */

    92

	TileIndex GetRoadDepotFrontTile(TileIndex depot);

    93

    94

	/**

    95

	 * Gets the tile in front of a road station.

    96

	 * @param station the road station tile.

    97

	 * @pre IsRoadStationTile(station).

    98

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

    99

	 */

   100

	TileIndex GetRoadStationFrontTile(TileIndex station);

   101

   102

	/**

   103

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

   104

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

   105

	 * GetTileInFrontOfStation, the other with this function.

   106

	 * @param station the road station tile.

   107

	 * @pre IsDriveThroughRoadStationTile(station).

   108

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

   109

	 */

   110

	TileIndex GetDriveThroughBackTile(TileIndex station);

   111

   112

	/**

   113

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

   114

	 * center of tile end.

   115

	 * @param start the start tile of the road.

   116

	 * @param end   the end tile of the road.

   117

	 * @pre start is not equal to end

   118

	 * @pre start is always positive and smaller than AIMap::GetMapSize().

   119

	 * @pre end is always positive and smaller than AIMap::GetMapSize().

   120

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

   121

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

   122

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

   123

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

   124

	 */

   125

	bool BuildRoad(TileIndex start, TileIndex end);

   126

   127

	/**

   128

	 * Builds a road depot.

   129

	 * @param tile  place to build the depot.

   130

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

   131

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

   132

	 * @pre front is always positive and smaller than AIMap::GetMapSize().

   133

	 * @pre tile is not equal to front

   134

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

   135

	 */

   136

	bool BuildRoadDepot(TileIndex tile, TileIndex front);

   137

   138

	/**

   139

	 * Builds a road bus or truck station.

   140

	 * @param tile  place to build the depot.

   141

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

   142

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

   143

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

   144

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

   145

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

   146

	 * @pre front is always positive and smaller than AIMap::GetMapSize().

   147

	 * @pre tile is not equal to front

   148

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

   149

	 */

   150

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

   151

   152

	/**

   153

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

   154

	 * center of tile end.

   155

	 * @param start the start tile of the road.

   156

	 * @param end   the end tile of the road.

   157

	 * @pre start is always positive and smaller than AIMap::GetMapSize().

   158

	 * @pre end is always positive and smaller than AIMap::GetMapSize().

   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

	bool RemoveRoad(TileIndex start, TileIndex end);

   165

   166

	/**

   167

	 * Removes a road depot.

   168

	 * @param tile place to remove the depot from.

   169

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

   170

	 * @pre tile is a road depot.

   171

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

   172

	 */

   173

	bool RemoveRoadDepot(TileIndex tile);

   174

   175

	/**

   176

	 * Removes a road bus or truck station.

   177

	 * @param tile place to remove the station from.

   178

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

   179

	 * @pre tile is a road station.

   180

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

   181

	 */

   182

	bool RemoveRoadStation(TileIndex tile);

   183

};

   184

   185

#endif /* AI_ROAD_HPP */