1

/* $Id$ */

     2

     3

/** @file npf.h */

     4

     5

#ifndef NPF_H

     6

#define NPF_H

     7

     8

#include "aystar.h"

     9

#include "station.h"

    10

#include "vehicle_type.h"

    11

#include "tile_type.h"

    12

#include "track_type.h"

    13

#include "core/bitmath_func.hpp"

    14

    15

/* mowing grass */

    16

enum {

    17

	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.

    18

	/* Do no change below values */

    19

	NPF_HASH_SIZE = 1 << NPF_HASH_BITS,

    20

	NPF_HASH_HALFBITS = NPF_HASH_BITS / 2,

    21

	NPF_HASH_HALFMASK = (1 << NPF_HASH_HALFBITS) - 1

    22

};

    23

    24

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

    25

 * to include npf.h */

    26

enum {

    27

	NPF_TILE_LENGTH = 100

    28

};

    29

    30

enum {

    31

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

    32

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

    33

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

    34

	 * total path cost might overflow..

    35

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

    36

	 * this in a nicer way :-)

    37

	 */

    38

	NPF_INFINITE_PENALTY = 1000 * NPF_TILE_LENGTH

    39

};

    40

    41

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

    42

struct NPFFindStationOrTileData {

    43

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

    44

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

    45

};

    46

    47

/* Indices into AyStar.userdata[] */

    48

enum {

    49

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

    50

	NPF_SUB_TYPE,  ///< Contains the sub transport type

    51

	NPF_OWNER,     ///< Contains an Owner value

    52

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

    53

};

    54

    55

/* Indices into AyStarNode.userdata[] */

    56

enum {

    57

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

    58

	NPF_NODE_FLAGS,

    59

};

    60

    61

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

    62

enum NPFNodeFlag {

    63

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

    64

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

    65

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

    66

};

    67

    68

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

    69

struct NPFFoundTargetData {

    70

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

    71

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

    72

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

    73

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

    74

};

    75

    76

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

    77

    78

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

    79

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

    80

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

    81

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

    82

    83

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

    84

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

    85

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

    86

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

    87

    88

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

    89

    90

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

    91

 * heuristic, such as railway/road.*/

    92

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

    93

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

    94

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

    95

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

    96

 * reverse_penalty applied (NPF_TILE_LENGTH is the equivalent of one full

    97

 * tile).

    98

 */

    99

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

   100

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

   101

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

   102

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

   103

   104

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

   105

   106

   107

/*

   108

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

   109

 */

   110

   111

/**

   112

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

   113

 */

   114

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

   115

{

   116

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

   117

}

   118

   119

/**

   120

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

   121

 */

   122

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

   123

{

   124

	if (value)

   125

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

   126

	else

   127

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

   128

}

   129

   130

#endif /* NPF_H */