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

	/**

    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

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

    25

	 * @param t2 the other corner of the rectangle.

    26

	 */

    27

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

    28

    29

public:

    30

	/**

    31

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

    32

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

    33

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

    34

	 * @pre AIMap::IsValidTile(tile_from).

    35

	 * @pre AIMap::IsValidTile(tile_to).

    36

	 */

    37

	void AddRectangle(TileIndex tile_from, TileIndex tile_to);

    38

    39

	/**

    40

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

    41

	 * @param tile the tile to add.

    42

	 * @pre AIMap::IsValidTile(tile).

    43

	 */

    44

	void AddTile(TileIndex tile);

    45

    46

	/**

    47

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

    48

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

    49

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

    50

	 * @pre AIMap::IsValidTile(tile_from).

    51

	 * @pre AIMap::IsValidTile(tile_to).

    52

	 */

    53

	void RemoveRectangle(TileIndex tile_from, TileIndex tile_to);

    54

    55

	/**

    56

	 * Remove a tile from the list.

    57

	 * @param tile the tile to remove.

    58

	 * @pre AIMap::IsValidTile(tile).

    59

	 */

    60

	void RemoveTile(TileIndex tile);

    61

};

    62

    63

/**

    64

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

    65

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

    66

 * @ingroup AITileList

    67

 */

    68

class AITileList_IndustryAccepting : public AITileList {

    69

public:

    70

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

    71

    72

	/**

    73

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

    74

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

    75

	 */

    76

	AITileList_IndustryAccepting(IndustryID industry_id, uint radius);

    77

};

    78

    79

/**

    80

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

    81

 *  there to receive cargo produced by this industry.

    82

 * @ingroup AITileList

    83

 */

    84

class AITileList_IndustryProducing : public AITileList {

    85

public:

    86

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

    87

    88

	/**

    89

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

    90

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

    91

	 */

    92

	AITileList_IndustryProducing(IndustryID industry_id, uint radius);

    93

};

    94

    95

#endif /* AI_TILELIST_HPP */