1

/* $Id$ */

     2

     3

#ifndef NPF_H

     4

#define NPF_H

     5

     6

#include "openttd.h"

     7

#include "aystar.h"

     8

#include "vehicle.h"

     9

#include "pbs.h"

    10

#include "tile.h"

    11

#include "variables.h"

    12

    13

//mowing grass

    14

enum {

    15

	NPF_HASH_BITS = 12, /* The size of the hash used in pathfinding. Just changing this value should be sufficient to change the hash size. Should be an even value. */

    16

	/* Do no change below values */

    17

	NPF_HASH_SIZE = 1 << NPF_HASH_BITS,

    18

	NPF_HASH_HALFBITS = NPF_HASH_BITS / 2,

    19

	NPF_HASH_HALFMASK = (1 << NPF_HASH_HALFBITS) - 1

    20

};

    21

    22

enum {

    23

	/** This penalty is the equivalent of "inifite", which means that paths that

    24

	 * get this penalty will be chosen, but only if there is no other route

    25

	 * without it. Be careful with not applying this penalty to often, or the

    26

	 * total path cost might overflow..

    27

	 * For now, this is just a Very Big Penalty, we might actually implement

    28

	 * this in a nicer way :-)

    29

	 */

    30

	NPF_INFINITE_PENALTY = 1000 * NPF_TILE_LENGTH

    31

};

    32

    33

typedef struct NPFFindStationOrTileData { /* Meant to be stored in AyStar.targetdata */

    34

	TileIndex dest_coords; /* An indication of where the station is, for heuristic purposes, or the target tile */

    35

	int station_index; /* station index we're heading for, or -1 when we're heading for a tile */

    36

} NPFFindStationOrTileData;

    37

    38

enum { /* Indices into AyStar.userdata[] */

    39

	NPF_TYPE = 0, /* Contains a TransportTypes value */

    40

	NPF_OWNER, /* Contains an Owner value */

    41

	NPF_RAILTYPE, /* Contains the RailType value of the engine when NPF_TYPE == TRANSPORT_RAIL. Unused otherwise. */

    42

	NPF_PBS_MODE, /* Contains the pbs mode, see pbs.h */

    43

};

    44

    45

enum { /* Indices into AyStarNode.userdata[] */

    46

	NPF_TRACKDIR_CHOICE = 0, /* The trackdir chosen to get here */

    47

	NPF_NODE_FLAGS,

    48

};

    49

    50

typedef enum { /* Flags for AyStarNode.userdata[NPF_NODE_FLAGS]. Use NPFGetBit() and NPFGetBit() to use them. */

    51

	NPF_FLAG_SEEN_SIGNAL, /* Used to mark that a signal was seen on the way, for rail only */

    52

	NPF_FLAG_REVERSE, /* Used to mark that this node was reached from the second start node, if applicable */

    53

	NPF_FLAG_LAST_SIGNAL_RED, /* Used to mark that the last signal on this path was red */

    54

	NPF_FLAG_PBS_EXIT, /* Used to mark tracks inside a pbs block, for rail only, for the end node, this is set when the path found goes through a pbs block */

    55

	NPF_FLAG_PBS_BLOCKED, /* Used to mark that this path crosses another pbs path */

    56

	NPF_FLAG_PBS_RED, /* Used to mark that this path goes through a red exit-pbs signal */

    57

	NPF_FLAG_PBS_CHOICE, /* Used to mark that the train has had a choice on this path */

    58

	NPF_FLAG_PBS_TARGET_SEEN, /* Used to mark that a target tile has been passed on this path */

    59

} NPFNodeFlag;

    60

    61

typedef struct NPFFoundTargetData { /* Meant to be stored in AyStar.userpath */

    62

	uint best_bird_dist; /* The best heuristic found. Is 0 if the target was found */

    63

	uint best_path_dist; /* The shortest path. Is (uint)-1 if no path is found */

    64

	Trackdir best_trackdir; /* The trackdir that leads to the shortest path/closest birds dist */

    65

	AyStarNode node; /* The node within the target the search led us to */

    66

	PathNode path;

    67

} NPFFoundTargetData;

    68

    69

/* These functions below are _not_ re-entrant, in favor of speed! */

    70

    71

/* Will search from the given tile and direction, for a route to the given

    72

 * station for the given transport type. See the declaration of

    73

 * NPFFoundTargetData above for the meaning of the result. */

    74

NPFFoundTargetData NPFRouteToStationOrTile(TileIndex tile, Trackdir trackdir, NPFFindStationOrTileData* target, TransportType type, Owner owner, RailType railtype, byte pbs_mode);

    75

    76

/* Will search as above, but with two start nodes, the second being the

    77

 * reverse. Look at the NPF_FLAG_REVERSE flag in the result node to see which

    78

 * direction was taken (NPFGetBit(result.node, NPF_FLAG_REVERSE)) */

    79

NPFFoundTargetData NPFRouteToStationOrTileTwoWay(TileIndex tile1, Trackdir trackdir1, TileIndex tile2, Trackdir trackdir2, NPFFindStationOrTileData* target, TransportType type, Owner owner, RailType railtype, byte pbs_mode);

    80

    81

/* Will search a route to the closest depot. */

    82

    83

/* Search using breadth first. Good for little track choice and inaccurate

    84

 * heuristic, such as railway/road.*/

    85

NPFFoundTargetData NPFRouteToDepotBreadthFirst(TileIndex tile, Trackdir trackdir, TransportType type, Owner owner, RailType railtype);

    86

/* Same as above but with two start nodes, the second being the reverse. Call

    87

 * NPFGetBit(result.node, NPF_FLAG_REVERSE) to see from which node the path

    88

 * orginated. All pathfs from the second node will have the given

    89

 * reverse_penalty applied (NPF_TILE_LENGTH is the equivalent of one full

    90

 * tile).

    91

 */

    92

NPFFoundTargetData NPFRouteToDepotBreadthFirstTwoWay(TileIndex tile1, Trackdir trackdir1, TileIndex tile2, Trackdir trackdir2, TransportType type, Owner owner, RailType railtype, uint reverse_penalty);

    93

/* Search by trying each depot in order of Manhattan Distance. Good for lots

    94

 * of choices and accurate heuristics, such as water. */

    95

NPFFoundTargetData NPFRouteToDepotTrialError(TileIndex tile, Trackdir trackdir, TransportType type, Owner owner, RailType railtype);

    96

    97

void NPFFillWithOrderData(NPFFindStationOrTileData* fstd, Vehicle* v);

    98

    99

   100

/*

   101

 * Functions to manipulate the various NPF related flags on an AyStarNode.

   102

 */

   103

   104

/**

   105

 * Returns the current value of the given flag on the given AyStarNode.

   106

 */

   107

static inline bool NPFGetFlag(const AyStarNode* node, NPFNodeFlag flag)

   108

{

   109

	return HASBIT(node->user_data[NPF_NODE_FLAGS], flag);

   110

}

   111

   112

/**

   113

 * Sets the given flag on the given AyStarNode to the given value.

   114

 */

   115

static inline void NPFSetFlag(AyStarNode* node, NPFNodeFlag flag, bool value)

   116

{

   117

	if (value)

   118

		SETBIT(node->user_data[NPF_NODE_FLAGS], flag);

   119

	else

   120

		CLRBIT(node->user_data[NPF_NODE_FLAGS], flag);

   121

}

   122

   123

#endif /* NPF_H */