1

/* $Id$ */

     2

     3

/** @file ai_pathfinder.hpp Everything to query and build pathfinders */

     4

     5

#ifndef AI_PATHFINDER_HPP

     6

#define AI_PATHFINDER_HPP

     7

     8

#include "ai_object.hpp"

     9

#include "ai_tilelist.hpp"

    10

    11

/**

    12

 * A class that handles the base pathfinder. It is ment as

    13

 *  parent-class for real implementation so all PFs have a general

    14

 *  interface, but can have different backends.

    15

 */

    16

class AIPathFinder : public AIObject {

    17

public:

    18

	/**

    19

	 * The type of pathfinders known in the game.

    20

	 */

    21

	enum PathFinderType {

    22

		PATHFINDER_ROAD,

    23

		PATHFINDER_RAIL,

    24

	};

    25

    26

	/**

    27

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

    28

	 */

    29

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

    30

    31

	/**

    32

	 * Find a route between 2 points. Any pathfinder might have specific

    33

	 *  functions to calibrate penalties and stuff.

    34

	 * @param start a list of tiles from where we can start.

    35

	 * @param end a list of tiles where we can end.

    36

	 * @return internal structure about how to make the route, or NULL if no route was found.

    37

	 */

    38

	virtual void *FindRoute(AITileList *start, AITileList *end) = 0;

    39

    40

	/**

    41

	 * Build the route as found by FindRoute.

    42

	 * @param result the result 'void *' from FindRoute.

    43

	 * @return true if the route was build, false if anything went wrong.

    44

	 */

    45

	virtual bool BuildRoute(void *result) = 0;

    46

    47

	/**

    48

	 * When you are done with the route result, we have to free it in order to avoid memleaks.

    49

	 * @note Always call this function on the result of FindRoute, even when you ran BuildRoute before!

    50

	 */

    51

	virtual void FreeRoute(void *result) = 0;

    52

    53

	/** Keep the compilers happy */

    54

	virtual ~AIPathFinder() {}

    55

};

    56

    57

#endif /* AI_PATHFINDER_HPP */