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 "rail.h"

    12

#include "variables.h"

    13

    14

//mowing grass

    15

enum {

    16

	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. */

    17

	/* Do no change below values */

    18

	NPF_HASH_SIZE = 1 << NPF_HASH_BITS,

    19

	NPF_HASH_HALFBITS = NPF_HASH_BITS / 2,

    20

	NPF_HASH_HALFMASK = (1 << NPF_HASH_HALFBITS) - 1

    21

};

    22

    23

enum {

    24

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

    25

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

    26

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

    27

	 * total path cost might overflow..

    28

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

    29

	 * this in a nicer way :-)

    30

	 */

    31

	NPF_INFINITE_PENALTY = 1000 * NPF_TILE_LENGTH

    32

};

    33

    34

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

    35

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

    36

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

    37

} NPFFindStationOrTileData;

    38

    39

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

    40

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

    41

	NPF_OWNER, /* Contains an Owner value */

    42

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

    43

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

    44

};

    45

    46

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

    47

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

    48

	NPF_NODE_FLAGS,

    49

};

    50

    51

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

    52

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

    53

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

    54

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

    55

	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 */

    56

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

    57

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

    58

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

    59

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

    60

} NPFNodeFlag;

    61

    62

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

    63

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

    64

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

    65

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

    66

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

    67

	PathNode path;

    68

} NPFFoundTargetData;

    69

    70

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

    71

    72

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

    73

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

    74

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

    75

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

    76

    77

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

    78

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

    79

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

    80

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

    81

    82

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

    83

    84

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

    85

 * heuristic, such as railway/road.*/

    86

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

    87

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

    88

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

    89

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

    90

 * reverse_penalty applied (NPF_TILE_LENGTH is the equivalent of one full

    91

 * tile).

    92

 */

    93

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

    94

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

    95

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

    96

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

    97

    98

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

    99

   100

   101

/*

   102

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

   103

 */

   104

   105

/**

   106

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

   107

 */

   108

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

   109

{

   110

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

   111

}

   112

   113

/**

   114

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

   115

 */

   116

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

   117

{

   118

	if (value)

   119

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

   120

	else

   121

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

   122

}

   123

   124

#endif /* NPF_H */