1

/* $Id$ */

     2

     3

/** @file ai_tile.hpp Everything to query and manipulate tiles. */

     4

     5

#ifndef AI_TILE_HPP

     6

#define AI_TILE_HPP

     7

     8

#include "ai_abstractlist.hpp"

     9

#include "ai_error.hpp"

    10

    11

/**

    12

 * Class that handles all tile related functions.

    13

 */

    14

class AITile : public AIObject {

    15

public:

    16

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

    17

    18

	/**

    19

	 * Error messages related to modifying tiles.

    20

	 */

    21

	enum ErrorMessages {

    22

    23

		/** Base for tile related errors */

    24

		ERR_TILE_BASE = AIError::ERR_CAT_TILE << AIError::ERR_CAT_BIT_SIZE,

    25

    26

		/** Tile can't be raised any higher */

    27

		ERR_TILE_TOO_HIGH,                     // [STR_1003_ALREADY_AT_SEA_LEVEL]

    28

    29

		/** Tile can't be lowered any lower */

    30

		ERR_TILE_TOO_LOW,                      // [STR_1003_ALREADY_AT_SEA_LEVEL]

    31

	};

    32

    33

	/**

    34

	 * Enumeration for the slope-type (from slopes.h).

    35

	 *

    36

	 * This enumeration use the chars N, E, S, W corresponding the

    37

	 *  direction North, East, South and West. The top corner of a tile

    38

	 *  is the north-part of the tile.

    39

	 */

    40

	enum Slope {

    41

		SLOPE_FLAT     = 0x00,                                  //!< A flat tile

    42

		SLOPE_W        = 0x01,                                  //!< The west corner of the tile is raised

    43

		SLOPE_S        = 0x02,                                  //!< The south corner of the tile is raised

    44

		SLOPE_E        = 0x04,                                  //!< The east corner of the tile is raised

    45

		SLOPE_N        = 0x08,                                  //!< The north corner of the tile is raised

    46

		SLOPE_STEEP    = 0x10,                                  //!< Indicates the slope is steep

    47

		SLOPE_NW       = SLOPE_N | SLOPE_W,                     //!< North and west corner are raised

    48

		SLOPE_SW       = SLOPE_S | SLOPE_W,                     //!< South and west corner are raised

    49

		SLOPE_SE       = SLOPE_S | SLOPE_E,                     //!< South and east corner are raised

    50

		SLOPE_NE       = SLOPE_N | SLOPE_E,                     //!< North and east corner are raised

    51

		SLOPE_EW       = SLOPE_E | SLOPE_W,                     //!< East and west corner are raised

    52

		SLOPE_NS       = SLOPE_N | SLOPE_S,                     //!< North and south corner are raised

    53

		SLOPE_ELEVATED = SLOPE_N | SLOPE_E | SLOPE_S | SLOPE_W, //!< All corner are raised, similar to SLOPE_FLAT

    54

		SLOPE_NWS      = SLOPE_N | SLOPE_W | SLOPE_S,           //!< North, west and south corner are raised

    55

		SLOPE_WSE      = SLOPE_W | SLOPE_S | SLOPE_E,           //!< West, south and east corner are raised

    56

		SLOPE_SEN      = SLOPE_S | SLOPE_E | SLOPE_N,           //!< South, east and north corner are raised

    57

		SLOPE_ENW      = SLOPE_E | SLOPE_N | SLOPE_W,           //!< East, north and west corner are raised

    58

		SLOPE_STEEP_W  = SLOPE_STEEP | SLOPE_NWS,               //!< A steep slope falling to east (from west)

    59

		SLOPE_STEEP_S  = SLOPE_STEEP | SLOPE_WSE,               //!< A steep slope falling to north (from south)

    60

		SLOPE_STEEP_E  = SLOPE_STEEP | SLOPE_SEN,               //!< A steep slope falling to west (from east)

    61

		SLOPE_STEEP_N  = SLOPE_STEEP | SLOPE_ENW                //!< A steep slope falling to south (from north)

    62

	};

    63

    64

	/**

    65

	 * Check if this tile is buildable, i.e. no things on it that needs

    66

	 *  demolishing.

    67

	 * @param tile The tile to check on.

    68

	 * @pre AIMap::IsValidTile(tile).

    69

	 * @return True if it is buildable, false if not.

    70

	 * @note Road and rail are considered buildable.

    71

	 */

    72

	static bool IsBuildable(TileIndex tile);

    73

    74

	/**

    75

	 * Check if this tile is buildable in a rectangle around a tile, with the

    76

	 *  entry in the list as top-left.

    77

	 * @param tile The tile to check on.

    78

	 * @param width The width of the rectangle.

    79

	 * @param height The height of the rectangle.

    80

	 * @pre AIMap::IsValidTile(tile).

    81

	 * @return True if it is buildable, false if not.

    82

	 * @note Road and rail are considered buildable.

    83

	 */

    84

	static bool IsBuildableRectangle(TileIndex tile, uint width, uint height);

    85

    86

	/**

    87

	 * Check if a tile is water.

    88

	 * @param tile The tile to check on.

    89

	 * @pre AIMap::IsValidTile(tile).

    90

	 * @return True if it is water, false if not.

    91

	 */

    92

	static bool IsWater(TileIndex tile);

    93

    94

	/**

    95

	 * Get the slope of a tile.

    96

	 * @param tile The tile to check on.

    97

	 * @pre AIMap::IsValidTile(tile).

    98

	 * @return 0 means flat, others indicate internal state of slope.

    99

	 */

   100

	static int32 GetSlope(TileIndex tile);

   101

   102

	/**

   103

	 * Get the height of the tile.

   104

	 * @param tile The tile to check on.

   105

	 * @pre AIMap::IsValidTile(tile).

   106

	 * @return The height of the tile, ranging from 0 to 15.

   107

	 */

   108

	static int32 GetHeight(TileIndex tile);

   109

   110

	/**

   111

	 * Check how much cargo this tile accepts.

   112

	 *  It creates a radius around the tile, and adds up all acceptance of this

   113

	 *   cargo.

   114

	 * @param tile The tile to check on.

   115

	 * @param cargo_type The cargo to check the acceptance of.

   116

	 * @param width The width of the station.

   117

	 * @param height The height of the station.

   118

	 * @param radius The radius of the station.

   119

	 * @pre AIMap::IsValidTile(tile).

   120

	 * @return Value below 8 means no acceptance; the more the better.

   121

	 */

   122

	static int32 GetCargoAcceptance(TileIndex tile, CargoID cargo_type, uint width, uint height, uint radius);

   123

   124

	/**

   125

	 * Checks how many tiles in the radius produces this cargo.

   126

	 *  It creates a radius around the tile, and adds up all tiles that produce

   127

	 *  this cargo.

   128

	 * @param tile The tile to check on.

   129

	 * @param cargo_type The cargo to check the production of.

   130

	 * @param width The width of the station.

   131

	 * @param height The height of the station.

   132

	 * @param radius The radius of the station.

   133

	 * @pre AIMap::IsValidTile(tile).

   134

	 * @return The tiles that produce this cargo within radius of the tile.

   135

	 * @note Town(houses) are not included in the value.

   136

	 */

   137

	static int32 GetCargoProduction(TileIndex tile, CargoID cargo_type, uint width, uint height, uint radius);

   138

   139

	/**

   140

	 * Get the manhattan distance from the tile to the tile.

   141

	 * @param tile_from The tile to get the distance to.

   142

	 * @param tile_to The tile to get the distance to.

   143

	 * @return The distance between the two tiles.

   144

	 */

   145

	static int32 GetDistanceManhattanToTile(TileIndex tile_from, TileIndex tile_to);

   146

   147

	/**

   148

	 * Get the square distance from the tile to the tile.

   149

	 * @param tile_from The tile to get the distance to.

   150

	 * @param tile_to The tile to get the distance to.

   151

	 * @return The distance between the two tiles.

   152

	 */

   153

	static int32 GetDistanceSquareToTile(TileIndex tile_from, TileIndex tile_to);

   154

   155

	/**

   156

	 * Raise the given corners of the tile. The corners can be combined,

   157

	 *  for example: SLOPE_N | SLOPE_W (= SLOPE_NW)

   158

	 * @param tile The tile to raise.

   159

	 * @param slope Corners to raise (SLOPE_xxx).

   160

	 * @pre AIMap::IsValidTile(tile).

   161

	 * @exception AIError::ERR_AREA_NOT_CLEAR

   162

	 * @exception AIError::ERR_TOO_CLOSE_TO_EDGE

   163

	 * @exception AITile::ERR_TILE_TOO_HIGH

   164

	 * @return 0 means failed, 1 means success.

   165

	 */

   166

	static bool RaiseTile(TileIndex tile, int32 slope);

   167

   168

	/**

   169

	 * Lower the given corners of the tile. The corners can be combined,

   170

	 *  for example: SLOPE_N | SLOPE_W (= SLOPE_NW)

   171

	 * @param tile The tile to lower.

   172

	 * @param slope Corners to lower (SLOPE_xxx).

   173

	 * @pre AIMap::IsValidTile(tile).

   174

	 * @exception AIError::ERR_AREA_NOT_CLEAR

   175

	 * @exception AIError::ERR_TOO_CLOSE_TO_EDGE

   176

	 * @exception AITile::ERR_TILE_TOO_LOW

   177

	 * @return 0 means failed, 1 means success.

   178

	 */

   179

	static bool LowerTile(TileIndex tile, int32 slope);

   180

   181

	/**

   182

	 * Destroy everything on the given tile.

   183

	 * @param tile The tile to demolish.

   184

	 * @pre AIMap::IsValidTile(tile).

   185

	 * @exception AIError::ERR_AREA_NOT_CLEAR

   186

	 * @return True if and only if the tile was demolished.

   187

	 */

   188

	static bool DemolishTile(TileIndex tile);

   189

};

   190

   191

#endif /* AI_TILE_HPP */