1

/* $Id$ */

     2

     3

/** @file waypoint.h */

     4

     5

#ifndef WAYPOINT_H

     6

#define WAYPOINT_H

     7

     8

#include "oldpool.h"

     9

#include "rail_map.h"

    10

    11

struct Waypoint {

    12

	TileIndex xy;      ///< Tile of waypoint

    13

	WaypointID index;  ///< Index of waypoint

    14

    15

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

    16

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

    17

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

    18

    19

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

    20

	Date build_date;   ///< Date of construction

    21

    22

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

    23

	uint32 grfid;      ///< ID of GRF file

    24

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

    25

    26

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

    27

};

    28

    29

DECLARE_OLD_POOL(Waypoint, Waypoint, 3, 8000)

    30

    31

/**

    32

 * Check if a Waypoint really exists.

    33

 * @param wp Waypoint to query

    34

 * @return the validity of the waypoint

    35

 */

    36

static inline bool IsValidWaypoint(const Waypoint *wp)

    37

{

    38

	return wp->xy != 0;

    39

}

    40

    41

static inline bool IsValidWaypointID(WaypointID index)

    42

{

    43

	return index < GetWaypointPoolSize() && IsValidWaypoint(GetWaypoint(index));

    44

}

    45

    46

void DestroyWaypoint(Waypoint *wp);

    47

    48

static inline void DeleteWaypoint(Waypoint *wp)

    49

{

    50

	DestroyWaypoint(wp);

    51

	wp->xy = 0;

    52

}

    53

    54

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

    55

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

    56

    57

    58

/**

    59

 * Fetch a waypoint by tile

    60

 * @param tile Tile of waypoint

    61

 * @return Waypoint

    62

 */

    63

static inline Waypoint *GetWaypointByTile(TileIndex tile)

    64

{

    65

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

    66

	return GetWaypoint(GetWaypointIndex(tile));

    67

}

    68

    69

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

    70

Station *ComposeWaypointStation(TileIndex tile);

    71

void ShowRenameWaypointWindow(const Waypoint *cp);

    72

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

    73

void FixOldWaypoints();

    74

void UpdateAllWaypointSigns();

    75

void AfterLoadWaypoints();

    76

    77

#endif /* WAYPOINT_H */