1

/* $Id$ */

     2

     3

/** @file ai_map.hpp Everything to query and manipulate map metadata. */

     4

     5

#ifndef AI_MAP_HPP

     6

#define AI_MAP_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all map related functions.

    12

 */

    13

class AIMap : public AIObject {

    14

public:

    15

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

    16

    17

	/**

    18

	 * Checks whether the given tile is valid.

    19

	 * @param tile The tile to check.

    20

	 * @return True is the tile it within the boundaries of the map.

    21

	 */

    22

	static bool IsValidTile(TileIndex tile);

    23

    24

	/**

    25

	 * Gets the number of tiles in the map.

    26

	 * @return The size of the map in tiles.

    27

	 * @post Return value is always positive.

    28

	 */

    29

	static TileIndex GetMapSize();

    30

    31

	/**

    32

	 * Gets the amount of tiles along the SW and NE border.

    33

	 * @return The length along the SW and NE borders.

    34

	 * @post Return value is always positive.

    35

	 */

    36

	static uint32 GetMapSizeX();

    37

    38

	/**

    39

	 * Gets the amount of tiles along the SE and NW border.

    40

	 * @return The length along the SE and NW borders.

    41

	 * @post Return value is always positive.

    42

	 */

    43

	static uint32 GetMapSizeY();

    44

    45

	/**

    46

	 * Gets the place along the SW/NE border (X-value).

    47

	 * @param tile The tile to get the X-value of.

    48

	 * @pre IsValidTile(tile).

    49

	 * @return The X-value.

    50

	 * @post Return value is always lower than GetMapSizeX().

    51

	 */

    52

	static uint32 GetTileX(TileIndex tile);

    53

    54

	/**

    55

	 * Gets the place along the SE/NW border (Y-value).

    56

	 * @param tile The tile to get the Y-value of.

    57

	 * @pre IsValidTile(tile).

    58

	 * @return The Y-value.

    59

	 * @post Return value is always lower than GetMapSizeY().

    60

	 */

    61

	static uint32 GetTileY(TileIndex tile);

    62

    63

	/**

    64

	 * Gets the TileIndex given a x,y-coordinate.

    65

	 * @param x The X coordinate.

    66

	 * @param y The Y coordinate.

    67

	 * @pre x < GetMapSizeX().

    68

	 * @pre y < GetMapSizeY().

    69

	 * @return The TileIndex for the given (x,y) coordinate.

    70

	 */

    71

	static TileIndex GetTileIndex(uint32 x, uint32 y);

    72

    73

	/**

    74

	 * Calculates the Manhattan distance; the difference of

    75

	 *  the X and Y added together.

    76

	 * @param tile_from The start tile.

    77

	 * @param tile_to The destination tile.

    78

	 * @pre IsValidTile(tile_from).

    79

	 * @pre IsValidTile(tile_to).

    80

	 * @return The Manhattan distance between the tiles.

    81

	 */

    82

	static uint32 DistanceManhattan(TileIndex tile_from, TileIndex tile_to);

    83

    84

	/**

    85

	 * Calculates the distance between two tiles via 1D calculation.

    86

	 *  This means the distance between X or the distance between Y, depending

    87

	 *  on which one is bigger.

    88

	 * @param tile_from The start tile.

    89

	 * @param tile_to The destination tile.

    90

	 * @pre IsValidTile(tile_from).

    91

	 * @pre IsValidTile(tile_to).

    92

	 * @return The maximum distance between the tiles.

    93

	 */

    94

	static uint32 DistanceMax(TileIndex tile_from, TileIndex tile_to);

    95

    96

	/**

    97

	 * The squared distance between the two tiles.

    98

	 *  This is the distance is the length of the shortest straight line

    99

	 *  between both points.

   100

	 * @param tile_from The start tile.

   101

	 * @param tile_to The destination tile.

   102

	 * @pre IsValidTile(tile_from).

   103

	 * @pre IsValidTile(tile_to).

   104

	 * @return The squared distance between the tiles.

   105

	 */

   106

	static uint32 DistanceSquare(TileIndex tile_from, TileIndex tile_to);

   107

   108

	/**

   109

	 * Calculates the shortest distance to the edge.

   110

	 * @param tile From where the distance has to be calculated.

   111

	 * @pre IsValidTile(tile).

   112

	 * @return The distances to the closest edge.

   113

	 */

   114

	static uint32 DistanceFromEdge(TileIndex tile);

   115

};

   116

   117

#endif /* AI_MAP_HPP */