1

/* $Id$ */

     2

     3

/** @file ai_map.hpp Everything to query 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

	/**

    16

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

    17

	 */

    18

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

    19

    20

	/**

    21

	 * Checks whether the given tile is valid.

    22

	 * @param t the tile to check.

    23

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

    24

	 */

    25

	bool IsValidTile(TileIndex t);

    26

    27

	/**

    28

	 * Gets the number of tiles in the map.

    29

	 * @return the size of the map in tiles.

    30

	 * @post return value is always positive.

    31

	 */

    32

	TileIndex GetMapSize();

    33

    34

	/**

    35

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

    36

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

    37

	 * @post return value is always positive.

    38

	 */

    39

	uint32 GetMapSizeX();

    40

    41

	/**

    42

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

    43

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

    44

	 * @post return value is always positive.

    45

	 */

    46

	uint32 GetMapSizeY();

    47

    48

	/**

    49

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

    50

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

    51

	 * @pre t has to be valid (use IsValidTile(t)).

    52

	 * @return the X-value.

    53

	 * @post return value is lower than GetMapSizeX().

    54

	 */

    55

	uint32 GetTileX(TileIndex t);

    56

    57

	/**

    58

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

    59

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

    60

	 * @pre t has to be valid (use IsValidTile(t)).

    61

	 * @return the Y-value.

    62

	 * @post return value is lower than GetMapSizeY().

    63

	 */

    64

	uint32 GetTileY(TileIndex t);

    65

    66

	/**

    67

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

    68

	 * @param x the X coordinate.

    69

	 * @param y the Y coordinate.

    70

	 * @pre x has to be lower than GetMapSizeX().

    71

	 * @pre y has to be lower than GetMapSizeY().

    72

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

    73

	 */

    74

	TileIndex GetTileIndex(uint32 x, uint32 y);

    75

    76

	/**

    77

	 * Calculates the Manhattan distance; the difference of

    78

	 * the X and Y added together.

    79

	 * @param t1 the start.

    80

	 * @param t2 the destination.

    81

	 * @pre t1 has to be valid (use IsValidTile(t1)).

    82

	 * @pre t2 has to be valid (use IsValidTile(t2)).

    83

	 * @return the Manhattan distance.

    84

	 */

    85

	uint32 DistanceManhattan(TileIndex t1, TileIndex t2);

    86

    87

	/**

    88

	 * Calculates the distance between xy1 and xy2 via 1D calculation.

    89

	 *  (so the distance between X or the distance between Y, depending

    90

	 *    on which one is bigger).

    91

	 * @param t1 the start.

    92

	 * @param t2 the destination.

    93

	 * @pre t1 has to be valid (use IsValidTile(t1)).

    94

	 * @pre t2 has to be valid (use IsValidTile(t2)).

    95

	 * @return the maximum distance of X and Y.

    96

	 */

    97

	uint32 DistanceMax(TileIndex t1, TileIndex t2);

    98

    99

	/**

   100

	 * The squared distance between the two tiles.

   101

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

   102

	 * line between both points.

   103

	 * @param t1 the start.

   104

	 * @param t2 the destination.

   105

	 * @pre t1 has to be valid (use IsValidTile(t1)).

   106

	 * @pre t2 has to be valid (use IsValidTile(t2)).

   107

	 * @return the distance.

   108

	 */

   109

	uint32 DistanceSquare(TileIndex t1, TileIndex t2);

   110

   111

	/**

   112

	 * Calculates the shortest distance to the edge.

   113

	 * @param t from where the distance has to be calculated.

   114

	 * @pre t has to be valid (use IsValidTile(t)).

   115

	 * @return the distances to the closest edge.

   116

	 */

   117

	uint32 DistanceFromEdge(TileIndex t);

   118

   119

	/**

   120

	 * Destroy everything on the given tile.

   121

	 * @param t the tile to destroy the stuff of.

   122

	 * @pre t has to be valid (use IsValidTile(t)).

   123

	 * @return true if and only if the destruction succeeded

   124

	 */

   125

	bool DemolishTile(TileIndex t);

   126

};

   127

   128

#ifdef DEFINE_SQUIRREL_CLASS

   129

namespace SQConvert {

   130

	/* Allow AIMap to be used as Squirrel parameter */

   131

	template <> AIMap *GetParam(ForceType<AIMap *>, HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AIMap *)instance; }

   132

}; // namespace SQConvert

   133

   134

void SQAIMapRegister(Squirrel *engine) {

   135

	DefSQClass <AIMap> SQAIMap("AIMap");

   136

	SQAIMap.PreRegister(engine);

   137

	SQAIMap.AddConstructor(engine);

   138

   141

	SQAIMap.DefSQMethod(engine, &AIMap::IsValidTile,       "IsValidTile");

   142

	SQAIMap.DefSQMethod(engine, &AIMap::GetMapSize,        "GetMapSize");

   143

	SQAIMap.DefSQMethod(engine, &AIMap::GetMapSizeX,       "GetMapSizeX");

   144

	SQAIMap.DefSQMethod(engine, &AIMap::GetMapSizeY,       "GetMapSizeY");

   145

	SQAIMap.DefSQMethod(engine, &AIMap::GetTileX,          "GetTileX");

   146

	SQAIMap.DefSQMethod(engine, &AIMap::GetTileY,          "GetTileY");

   147

	SQAIMap.DefSQMethod(engine, &AIMap::GetTileIndex,      "GetTileIndex");

   148

	SQAIMap.DefSQMethod(engine, &AIMap::DistanceManhattan, "DistanceManhattan");

   149

	SQAIMap.DefSQMethod(engine, &AIMap::DistanceMax,       "DistanceMax");

   150

	SQAIMap.DefSQMethod(engine, &AIMap::DistanceSquare,    "DistanceSquare");

   151

	SQAIMap.DefSQMethod(engine, &AIMap::DistanceFromEdge,  "DistanceFromEdge");

   152

	SQAIMap.DefSQMethod(engine, &AIMap::DemolishTile,      "DemolishTile");

   153

   154

	SQAIMap.PostRegister(engine);

   155

}

   156

#endif /* DEFINE_SQUIRREL_CLASS */

   157

   158

#endif /* AI_MAP_HPP */