1

/* $Id$ */

     2

     3

/** @file npf.h New A* pathfinder. */

     4

     5

#ifndef NPF_H

     6

#define NPF_H

     7

     8

#include "aystar.h"

     9

#include "station_type.h"

    10

#include "rail_type.h"

    11

#include "player_type.h"

    12

#include "vehicle_type.h"

    13

#include "tile_type.h"

    14

#include "track_type.h"

    15

#include "core/bitmath_func.hpp"

    16

#include "transport_type.h"

    17

    18

/* mowing grass */

    19

enum {

    20

	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.

    21

	/* Do no change below values */

    22

	NPF_HASH_SIZE = 1 << NPF_HASH_BITS,

    23

	NPF_HASH_HALFBITS = NPF_HASH_BITS / 2,

    24

	NPF_HASH_HALFMASK = (1 << NPF_HASH_HALFBITS) - 1

    25

};

    26

    27

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

    28

 * to include npf.h */

    29

enum {

    30

	NPF_TILE_LENGTH = 100

    31

};

    32

    33

enum {

    34

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

    35

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

    36

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

    37

	 * total path cost might overflow..

    38

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

    39

	 * this in a nicer way :-)

    40

	 */

    41

	NPF_INFINITE_PENALTY = 1000 * NPF_TILE_LENGTH

    42

};

    43

    44

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

    45

struct NPFFindStationOrTileData {

    46

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

    47

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

    48

};

    49

    50

/* Indices into AyStar.userdata[] */

    51

enum {

    52

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

    53

	NPF_SUB_TYPE,  ///< Contains the sub transport type

    54

	NPF_OWNER,     ///< Contains an Owner value

    55

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

    56

};

    57

    58

/* Indices into AyStarNode.userdata[] */

    59

enum {

    60

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

    61

	NPF_NODE_FLAGS,

    62

};

    63

    64

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

    65

enum NPFNodeFlag {

    66

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

    67

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

    68

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

    69

	NPF_FLAG_IGNORE_START_TILE, ///< Used to mark that the start tile is invalid, and searching should start from the second tile on

    70

};

    71

    72

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

    73

struct NPFFoundTargetData {

    74

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

    75

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

    76

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

    77

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

    78

};

    79

    80

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

    81

    82

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

    83

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

    84

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

    85

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

    86

    87

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

    88

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

    89

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

    90

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

    91

    92

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

    93

    94

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

    95

 * heuristic, such as railway/road.*/

    96

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

    97

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

    98

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

    99

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

   100

 * reverse_penalty applied (NPF_TILE_LENGTH is the equivalent of one full

   101

 * tile).

   102

 */

   103

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

   104

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

   105

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

   106

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

   107

   108

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

   109

   110

   111

/*

   112

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

   113

 */

   114

   115

/**

   116

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

   117

 */

   118

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

   119

{

   120

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

   121

}

   122

   123

/**

   124

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

   125

 */

   126

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

   127

{

   128

	if (value)

   129

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

   130

	else

   131

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

   132

}

   133

   134

#endif /* NPF_H */