1

/* $Id$ */

     2

     3

/** @file ai_tilelist.hpp a simple tilelist which you can manipulate */

     4

     5

#ifndef AI_TILELIST_HPP

     6

#define AI_TILELIST_HPP

     7

     8

#include "ai_abstractlist.hpp"

     9

    10

/**

    11

 * Class that creates a simple list of tiles which you can manipulate.

    12

 */

    13

class AITileList : public AIAbstractList {

    14

public:

    15

	/**

    16

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

    17

	 */

    18

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

    19

    20

private:

    21

	/**

    22

	 * Make sure t1.x is smaller than t2.x and t1.y is smaller than t2.y.

    23

	 * They are swapped to ensure they are after calling this function.

    24

	 */

    25

	void FixRectangleSpan(TileIndex &t1, TileIndex &t2);

    26

    27

public:

    28

    29

	/**

    30

	 * Adds the rectangle between tile_from and tile_to to the to-be-evaluated tiles.

    31

	 * @param tile_from one corner of the tiles to add.

    32

	 * @param tile_to the other corner of the tiles to add.

    33

	 * @pre tile_from is below AIMap::GetMapSize().

    34

	 * @pre tile_to is below AIMap::GetMapSize().

    35

	 */

    36

	void AddRectangle(TileIndex tile_from, TileIndex tile_to);

    37

    38

	/**

    39

	 * Add a tile to the to-be-evaluated tiles.

    40

	 * @param tile the tile to add.

    41

	 * @pre tile is below AIMap::GetMapSize().

    42

	 */

    43

	void AddTile(TileIndex tile);

    44

    45

	/**

    46

	 * Remove the tiles inside the rectangle between tile_from and tile_to form the list.

    47

	 * @param tile_from one corner of the tiles to remove.

    48

	 * @param tile_to the other corner of the files to remove.

    49

	 * @pre tile_from is below AIMap::GetMapSize().

    50

	 * @pre tile_to is below AIMap::GetMapSize().

    51

	 */

    52

	void RemoveRectangle(TileIndex tile_from, TileIndex tile_to);

    53

    54

	/**

    55

	 * Remove a tile from the list.

    56

	 * @param tile the tile to remove.

    57

	 * @pre tile is below AIMap::GetMapSize().

    58

	 */

    59

	void RemoveTile(TileIndex tile);

    60

};

    61

    62

#endif /* AI_TILELIST_HPP */