1

/* $Id$ */

     2

     3

/** @file npf.h */

     4

     5

#ifndef NPF_H

     6

#define NPF_H

     7

     8

#include "openttd.h"

     9

#include "aystar.h"

    10

#include "station.h"

    11

#include "vehicle.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

/* For new pathfinding. Define here so it is globally available without having

    24

 * to include npf.h */

    25

enum {

    26

	NPF_TILE_LENGTH = 100

    27

};

    28

    29

enum {

    30

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

    31

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

    32

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

    33

	 * total path cost might overflow..

    34

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

    35

	 * this in a nicer way :-)

    36

	 */

    37

	NPF_INFINITE_PENALTY = 1000 * NPF_TILE_LENGTH

    38

};

    39

    40

/* Meant to be stored in AyStar.targetdata */

    41

struct NPFFindStationOrTileData {

    42

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

    43

	StationID station_index; ///< station index we're heading for, or INVALID_STATION when we're heading for a tile

    44

};

    45

    46

/* Indices into AyStar.userdata[] */

    47

enum {

    48

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

    49

	NPF_SUB_TYPE,  ///< Contains the sub transport type

    50

	NPF_OWNER,     ///< Contains an Owner value

    51

	NPF_RAILTYPES, ///< Contains a bitmask the compatible RailTypes of the engine when NPF_TYPE == TRANSPORT_RAIL. Unused otherwise.

    52

};

    53

    54

/* Indices into AyStarNode.userdata[] */

    55

enum {

    56

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

    57

	NPF_NODE_FLAGS,

    58

};

    59

    60

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

    61

enum NPFNodeFlag {

    62

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

    63

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

    64

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

    65

};

    66

    67

/* Meant to be stored in AyStar.userpath */

    68

struct NPFFoundTargetData {

    69

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

    70

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

    71

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

    72

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

    73

};

    74

    75

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

    76

    77

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

    78

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

    79

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

    80

NPFFoundTargetData NPFRouteToStationOrTile(TileIndex tile, Trackdir trackdir, NPFFindStationOrTileData* target, TransportType type, uint sub_type, Owner owner, RailTypeMask railtypes);

    81

    82

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

    83

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

    84

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

    85

NPFFoundTargetData NPFRouteToStationOrTileTwoWay(TileIndex tile1, Trackdir trackdir1, TileIndex tile2, Trackdir trackdir2, NPFFindStationOrTileData* target, TransportType type, uint sub_type, Owner owner, RailTypeMask railtypes);

    86

    87

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

    88

    89

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

    90

 * heuristic, such as railway/road.*/

    91

NPFFoundTargetData NPFRouteToDepotBreadthFirst(TileIndex tile, Trackdir trackdir, TransportType type, uint sub_type, Owner owner, RailTypeMask railtypes);

    92

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

    93

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

    94

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

    95

 * reverse_penalty applied (NPF_TILE_LENGTH is the equivalent of one full

    96

 * tile).

    97

 */

    98

NPFFoundTargetData NPFRouteToDepotBreadthFirstTwoWay(TileIndex tile1, Trackdir trackdir1, TileIndex tile2, Trackdir trackdir2, TransportType type, uint sub_type, Owner owner, RailTypeMask railtypes, uint reverse_penalty);

    99

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

   100

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

   101

NPFFoundTargetData NPFRouteToDepotTrialError(TileIndex tile, Trackdir trackdir, TransportType type, uint sub_type, Owner owner, RailTypeMask railtypes);

   102

   103

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

   104

   105

   106

/*

   107

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

   108

 */

   109

   110

/**

   111

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

   112

 */

   113

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

   114

{

   115

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

   116

}

   117

   118

/**

   119

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

   120

 */

   121

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

   122

{

   123

	if (value)

   124

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

   125

	else

   126

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

   127

}

   128

   129

#endif /* NPF_H */