1

/* $Id$ */

     2

     3

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

     4

/** @defgroup AITileList AITileList - Valuators and lists working on/with AITileList */

     5

     6

#ifndef AI_TILELIST_HPP

     7

#define AI_TILELIST_HPP

     8

     9

#include "ai_abstractlist.hpp"

    10

#include "../../industry.h"

    11

    12

/**

    13

 * Creates an empty list, in which you can add tiles.

    14

 * @ingroup AITileList

    15

 */

    16

class AITileList : public AIAbstractList {

    17

public:

    18

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

    19

    20

private:

    21

	const char *GetListName() const { return "AITileList"; }

    22

    23

private:

    24

	/**

    25

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

    26

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

    27

	 * @param t1 one of the corners of the rectangle.

    28

	 * @param t2 the other corner of the rectangle.

    29

	 */

    30

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

    31

    32

public:

    33

	/**

    34

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

    35

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

    36

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

    37

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

    38

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

    39

	 */

    40

	void AddRectangle(TileIndex tile_from, TileIndex tile_to);

    41

    42

	/**

    43

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

    44

	 * @param tile the tile to add.

    45

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

    46

	 */

    47

	void AddTile(TileIndex tile);

    48

    49

	/**

    50

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

    51

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

    52

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

    53

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

    54

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

    55

	 */

    56

	void RemoveRectangle(TileIndex tile_from, TileIndex tile_to);

    57

    58

	/**

    59

	 * Remove a tile from the list.

    60

	 * @param tile the tile to remove.

    61

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

    62

	 */

    63

	void RemoveTile(TileIndex tile);

    64

};

    65

    66

/**

    67

 * Creates a list of tiles that will accept cargo for the given industry.

    68

 * @note If a simular industry is close, it might happen that this industry receives the cargo.

    69

 * @ingroup AITileList

    70

 */

    71

class AITileList_IndustryAccepting : public AITileList {

    72

public:

    73

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

    74

    75

	/**

    76

	 * @param industry_id The industry to create the AITileList around.

    77

	 * @param radius The radius of the station you will be using.

    78

	 */

    79

	AITileList_IndustryAccepting(IndustryID industry_id, uint radius);

    80

};

    81

    82

/**

    83

 * Creates a list of tiles which the industry checks to see if a station is

    84

 *  there to receive cargo produced by this industry.

    85

 * @ingroup AITileList

    86

 */

    87

class AITileList_IndustryProducing : public AITileList {

    88

public:

    89

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

    90

    91

	/**

    92

	 * @param industry_id The industry to create the AITileList around.

    93

	 * @param radius The radius of the station you will be using.

    94

	 */

    95

	AITileList_IndustryProducing(IndustryID industry_id, uint radius);

    96

};

    97

    98

#endif /* AI_TILELIST_HPP */