1

/* $Id$ */

     2

     3

/** @file ai_tilelist_valuator.hpp all the valuators for AITileList */

     4

     5

#ifndef AI_TILELIST_VALUATOR_HPP

     6

#define AI_TILELIST_VALUATOR_HPP

     7

     8

#include "ai_abstractlist.hpp"

     9

    10

/**

    11

 * Check if tiles are buildable for entries in an AITileList instance.

    12

 * @note Resulting items are of the type bool (0 = not buildable, 1 = buildable).

    13

 * @note Can only operate on an AITileList instance.

    14

 * @ingroup AITileList

    15

 */

    16

class AITileList_vBuildable : public AIAbstractList::Valuator {

    17

public:

    18

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

    19

    20

private:

    21

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

    22

	int32 Valuate(int32 tile) const;

    23

};

    24

    25

/**

    26

 * Check if tiles are water-tiles for entries in an AITileList instance.

    27

 * @note Resulting items are of the type bool (0 = not water-tile, 1 = water-tile).

    28

 * @note Can only operate on an AITileList instance.

    29

 * @ingroup AITileList

    30

 */

    31

class AITileList_vWater : public AIAbstractList::Valuator {

    32

public:

    33

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

    34

    35

private:

    36

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

    37

	int32 Valuate(int32 tile) const;

    38

};

    39

    40

/**

    41

 * Check if tiles are buildable in a rectangle around entries in an AITileList instance, with the entry in the list as top-left.

    42

 * @note Resulting items are of the type bool (0 = not buildable, 1 = buildable).

    43

 * @note Can only operate on an AITileList instance.

    44

 * @ingroup AITileList

    45

 */

    46

class AITileList_vBuildableRectangle : public AIAbstractList::Valuator {

    47

public:

    48

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

    49

    50

	/**

    51

	 * @param width The width of the rectangle.

    52

	 * @param height The height of the rectangle.

    53

	 */

    54

	AITileList_vBuildableRectangle(uint width, uint height) :

    55

		width(width),

    56

		height(height)

    57

	{}

    58

    59

private:

    60

	uint width, height;

    61

    62

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

    63

	int32 Valuate(int32 tile) const;

    64

};

    65

    66

/**

    67

 * Check how tiles in an AITileList instance are sloped.

    68

 * @note Resulting items are of the type int32 (0 = flat, > 1 = slope).

    69

 * @note Can only operate on an AITileList instance.

    70

 * @ingroup AITileList

    71

 */

    72

class AITileList_vSlope : public AIAbstractList::Valuator {

    73

public:

    74

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

    75

    76

private:

    77

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

    78

	int32 Valuate(int32 tile) const;

    79

};

    80

    81

/**

    82

 * Check the height of the tiles in an AITileList instance.

    83

 * @note Resulting items are of the type int32 (height, ranging from 0 to 15).

    84

 * @note Can only operate on an AITileList instance.

    85

 * @ingroup AITileList

    86

 */

    87

class AITileList_vHeight : public AIAbstractList::Valuator {

    88

public:

    89

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

    90

    91

private:

    92

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

    93

	int32 Valuate(int32 tile) const;

    94

};

    95

    96

/**

    97

 * Count for each entry in AITileList the amount of neighbours that contain road.

    98

 *   This is a value between 0 and 4, as it only check horizontal and vertical.

    99

 * @note Resulting items are of the type int32 (the amount of neighbour road tiles, value between 0 and 4).

   100

 * @note Can only operate on an AITileList instance.

   101

 * @ingroup AITileList

   102

 */

   103

class AITileList_vNeighbourRoadCount : public AIAbstractList::Valuator {

   104

public:

   105

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

   106

   107

private:

   108

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

   109

	int32 Valuate(int32 tile) const;

   110

};

   111

   112

/**

   113

 * Check if the tiles in AITileList have a piece of road on them.

   114

 * @note Resulting items are of the type bool (0 = no road, 1 = road).

   115

 * @note Can only operate on an AITileList instance.

   116

 * @ingroup AITileList

   117

 */

   118

class AITileList_vRoadTile : public AIAbstractList::Valuator {

   119

public:

   120

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

   121

   122

private:

   123

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

   124

	int32 Valuate(int32 tile) const;

   125

};

   126

   127

/**

   128

 * Get the amount of estimated accepted cargo for all tiles in AITileList.

   129

 * If this value is >= 8, it means it will accept this cargo. For passengers

   130

 *  and mail it is also a good indicator how much cargo would be brought to

   131

 *  the station.

   132

 * @post Values < 8 means this tile does not accept this cargo.

   133

 * @note Resulting items are of the type int32 (indicating acceptance).

   134

 * @note Can only operate on an AITileList instance.

   135

 * @ingroup AITileList

   136

 */

   137

class AITileList_vCargoAcceptance : public AIAbstractList::Valuator {

   138

public:

   139

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

   140

   141

	/**

   142

	 * @param cargo_id The cargo to check the acceptance for.

   143

	 * @param width The width of your station.

   144

	 * @param height The height of your station.

   145

	 * @param radius The radius of your station-type.

   146

	 */

   147

	AITileList_vCargoAcceptance(CargoID cargo_id, uint width, uint height, uint radius) :

   148

		cargo_id(cargo_id),

   149

		width(width),

   150

		height(height),

   151

		radius(radius)

   152

	{}

   153

   154

private:

   155

	CargoID cargo_id;

   156

	uint width, height, radius;

   157

   158

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

   159

	int32 Valuate(int32 tile) const;

   160

};

   161

   162

/**

   163

 * Get the amount of tiles producing cargo for all tiles in AITileList.

   164

 *  This counts the tiles that produce this cargo. It doesn't give any

   165

 *  indication about the amount it will be producing.

   166

 * @note Town(houses) are not included in the value.

   167

 * @note Resulting items are of the type int32 (indicating tiles of production).

   168

 * @note Can only operate on an AITileList instance.

   169

 * @ingroup AITileList

   170

 */

   171

class AITileList_vCargoProduction : public AIAbstractList::Valuator {

   172

public:

   173

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

   174

   175

	/**

   176

	 * @param cargo_id The cargo to check the production for.

   177

	 * @param width The width of your station.

   178

	 * @param height The height of your station.

   179

	 * @param radius The radius of your station-type.

   180

	 */

   181

	AITileList_vCargoProduction(CargoID cargo_id, uint width, uint height, uint radius) :

   182

		cargo_id(cargo_id),

   183

		width(width),

   184

		height(height),

   185

		radius(radius)

   186

	{}

   187

   188

private:

   189

	CargoID cargo_id;

   190

	uint width, height, radius;

   191

   192

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

   193

	int32 Valuate(int32 tile) const;

   194

};

   195

   196

/**

   197

 * Get the manhattan distance to a tile for entries in an AITileList instance.

   198

 * @note Resulting items are of the type uint32.

   199

 * @note Can only operate on an AITileList instance.

   200

 * @ingroup AITileList

   201

 */

   202

class AITileList_vDistanceManhattanToTile : public AIAbstractList::Valuator {

   203

public:

   204

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

   205

   206

	/**

   207

	 * @param tile The tile to get the distance to.

   208

	 */

   209

	AITileList_vDistanceManhattanToTile(TileIndex tile) :

   210

		tile(tile)

   211

	{}

   212

   213

private:

   214

	TileIndex tile;

   215

   216

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

   217

	int32 Valuate(int32 station) const;

   218

};

   219

   220

/**

   221

 * Get the square distance to a tile for entries in an AITileList instance.

   222

 * @note Resulting items are of the type uint32.

   223

 * @note Can only operate on an AITileList instance.

   224

 * @ingroup AITileList

   225

 */

   226

class AITileList_vDistanceSquareToTile : public AIAbstractList::Valuator {

   227

public:

   228

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

   229

   230

	/**

   231

	 * @param tile The tile to get the distance to.

   232

	 */

   233

	AITileList_vDistanceSquareToTile(TileIndex tile) :

   234

		tile(tile)

   235

	{}

   236

   237

private:

   238

	TileIndex tile;

   239

   240

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

   241

	int32 Valuate(int32 station) const;

   242

};

   243

   244

   245

#endif /* AI_TILELIST_VALUATOR_HPP */