1

/* $Id$ */

     2

     3

#ifndef WAYPOINT_H

     4

#define WAYPOINT_H

     5

     6

#include "pool.h"

     7

     8

struct Waypoint {

     9

	TileIndex xy;      ///< Tile of waypoint

    10

	uint16 index;      ///< Index of waypoint

    11

    12

	uint16 town_index; ///< Town associated with the waypoint

    13

	byte town_cn;      ///< The Nth waypoint for this town (consecutive number)

    14

	StringID string;   ///< If this is zero (i.e. no custom name), town + town_cn is used for naming

    15

    16

	ViewportSign sign; ///< Dimensions of sign (not saved)

    17

	uint16 build_date; ///< Date of construction

    18

    19

	byte stat_id;      ///< ID of waypoint within the waypoint class (not saved)

    20

	uint32 grfid;      ///< ID of GRF file

    21

	byte localidx;     ///< Index of station within GRF file

    22

    23

	byte deleted;      ///< Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is deleted.

    24

};

    25

    26

enum {

    27

	RAIL_TYPE_WAYPOINT = 0xC4,

    28

	RAIL_WAYPOINT_TRACK_MASK = 1,

    29

};

    30

    31

extern MemoryPool _waypoint_pool;

    32

    33

/**

    34

 * Get the pointer to the waypoint with index 'index'

    35

 */

    36

static inline Waypoint *GetWaypoint(uint index)

    37

{

    38

	return (Waypoint*)GetItemFromPool(&_waypoint_pool, index);

    39

}

    40

    41

/**

    42

 * Get the current size of the WaypointPool

    43

 */

    44

static inline uint16 GetWaypointPoolSize(void)

    45

{

    46

	return _waypoint_pool.total_items;

    47

}

    48

    49

static inline bool IsWaypointIndex(uint index)

    50

{

    51

	return index < GetWaypointPoolSize();

    52

}

    53

    54

#define FOR_ALL_WAYPOINTS_FROM(wp, start) for (wp = GetWaypoint(start); wp != NULL; wp = (wp->index + 1 < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1) : NULL)

    55

#define FOR_ALL_WAYPOINTS(wp) FOR_ALL_WAYPOINTS_FROM(wp, 0)

    56

    57

static inline bool IsRailWaypoint(TileIndex tile)

    58

{

    59

	return (_m[tile].m5 & 0xFC) == 0xC4;

    60

}

    61

    62

/**

    63

 * Fetch a waypoint by tile

    64

 * @param tile Tile of waypoint

    65

 * @return Waypoint

    66

 */

    67

static inline Waypoint *GetWaypointByTile(TileIndex tile)

    68

{

    69

	assert(IsTileType(tile, MP_RAILWAY) && IsRailWaypoint(tile));

    70

	return GetWaypoint(_m[tile].m2);

    71

}

    72

    73

int32 RemoveTrainWaypoint(TileIndex tile, uint32 flags, bool justremove);

    74

Station *ComposeWaypointStation(TileIndex tile);

    75

void ShowRenameWaypointWindow(const Waypoint *cp);

    76

void DrawWaypointSprite(int x, int y, int image, RailType railtype);

    77

void FixOldWaypoints(void);

    78

void UpdateAllWaypointSigns(void);

    79

void UpdateAllWaypointCustomGraphics(void);

    80

    81

#endif /* WAYPOINT_H */