src/signal_map.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file signal_map.h Slightly cooked access to signals on the map */
  11
  12 #ifndef SIGNAL_MAP_H
  13 #define SIGNAL_MAP_H
  14
  15 #include "stdafx.h"
  16 #include "signal_type.h"
  17 #include "map/rail.h"
  18 #include "pathfinder/pos.h"
  19
  20 /**
  21  * Sets the state of the signal along the given trackdir.
  22  */
  23 static inline void SetSignalState(TileIndex tile, Trackdir trackdir, SignalState state)
  24 {
  25         if (IsRailwayTile(tile)) {
  26                 SetSignalStateByTrackdir(tile, trackdir, state);
  27         } else {
  28                 maptile_set_tunnel_signal_state(tile, TrackdirToExitdir(trackdir) == GetTunnelBridgeDirection(tile), state);
  29         }
  30 }
  31
  32
  33 /**
  34  * Checks for the presence of signals along the given trackdir.
  35  */
  36 static inline bool HasSignalAlongPos(const RailPathPos &pos)
  37 {
  38         if (pos.in_wormhole()) {
  39                 return false;
  40         } else if (IsRailwayTile(pos.tile)) {
  41                 return HasSignalOnTrackdir(pos.tile, pos.td);
  42         } else if (maptile_is_rail_tunnel(pos.tile)) {
  43                 return maptile_has_tunnel_signal(pos.tile, TrackdirToExitdir(pos.td) == GetTunnelBridgeDirection(pos.tile));
  44         } else {
  45                 return false;
  46         }
  47 }
  48
  49 /**
  50  * Checks for the presence of signals against the given trackdir.
  51  */
  52 static inline bool HasSignalAgainstPos(const RailPathPos &pos)
  53 {
  54         if (pos.in_wormhole()) {
  55                 return false;
  56         } else if (IsRailwayTile(pos.tile)) {
  57                 return HasSignalOnTrackdir(pos.tile, ReverseTrackdir(pos.td));
  58         } else if (maptile_is_rail_tunnel(pos.tile)) {
  59                 return maptile_has_tunnel_signal(pos.tile, TrackdirToExitdir(pos.td) != GetTunnelBridgeDirection(pos.tile));
  60         } else {
  61                 return false;
  62         }
  63 }
  64
  65 /**
  66  * Checks for the presence of signals along or against the given trackdir.
  67  */
  68 static inline bool HasSignalOnPos(const RailPathPos &pos)
  69 {
  70         if (pos.in_wormhole()) {
  71                 return false;
  72         } else if (IsRailwayTile(pos.tile)) {
  73                 return HasSignalOnTrack(pos.tile, TrackdirToTrack(pos.td));
  74         } else if (maptile_is_rail_tunnel(pos.tile)) {
  75                 return maptile_has_tunnel_signals(pos.tile);
  76         } else {
  77                 return false;
  78         }
  79 }
  80
  81 static inline SignalType GetSignalType(const RailPathPos &pos)
  82 {
  83         assert(HasSignalOnPos(pos));
  84         return IsRailwayTile(pos.tile) ? GetSignalType(pos.tile, TrackdirToTrack(pos.td)) : maptile_get_tunnel_signal_type(pos.tile);
  85 }
  86
  87 /**
  88  * Gets the state of the signal along the given trackdir.
  89  */
  90 static inline SignalState GetSignalStateByPos(const RailPathPos &pos)
  91 {
  92         return IsRailwayTile(pos.tile) ? GetSignalStateByTrackdir(pos.tile, pos.td) :
  93                 maptile_get_tunnel_signal_state(pos.tile, TrackdirToExitdir(pos.td) == GetTunnelBridgeDirection(pos.tile));
  94 }
  95
  96
  97 /**
  98  * Is a pbs signal present along the trackdir?
  99  * @param tile the tile to check
 100  * @param td the trackdir to check
 101  */
 102 static inline bool HasPbsSignalOnTrackdir(TileIndex tile, Trackdir td)
 103 {
 104         return IsRailwayTile(tile) ?
 105                         HasSignalOnTrackdir(tile, td) && IsPbsSignal(GetSignalType(tile, TrackdirToTrack(td))) :
 106                         maptile_is_rail_tunnel(tile) && maptile_has_tunnel_signal(tile, TrackdirToExitdir(td) == GetTunnelBridgeDirection(tile)) && IsPbsSignal(maptile_get_tunnel_signal_type(tile));
 107 }
 108
 109 /**
 110  * Is a pbs signal present along the trackdir?
 111  * @param pos the position to check
 112  */
 113 static inline bool HasPbsSignalAlongPos(const RailPathPos &pos)
 114 {
 115         return !pos.in_wormhole() && HasPbsSignalOnTrackdir(pos.tile, pos.td);
 116 }
 117
 118 /**
 119  * Is a pbs signal present against the trackdir?
 120  * @param pos the position to check
 121  */
 122 static inline bool HasPbsSignalAgainstPos(const RailPathPos &pos)
 123 {
 124         return !pos.in_wormhole() && HasPbsSignalOnTrackdir(pos.tile, ReverseTrackdir(pos.td));
 125 }
 126
 127
 128 /**
 129  * Is a one-way signal blocking the trackdir? A one-way signal on the
 130  * trackdir against will block, but signals on both trackdirs won't.
 131  * @param tile the tile to check
 132  * @param td the trackdir to check
 133  */
 134 static inline bool HasOnewaySignalBlockingTrackdir(TileIndex tile, Trackdir td)
 135 {
 136         if (IsRailwayTile(tile)) {
 137                 return HasSignalOnTrackdir(tile, ReverseTrackdir(td)) &&
 138                         !HasSignalOnTrackdir(tile, td) && IsOnewaySignal(GetSignalType(tile, TrackdirToTrack(td)));
 139         } else if (maptile_is_rail_tunnel(tile)) {
 140                 return maptile_has_tunnel_signal(tile, TrackdirToExitdir(td) != GetTunnelBridgeDirection(tile));
 141         } else {
 142                 return false;
 143         }
 144 }
 145
 146 /**
 147  * Is a one-way signal blocking the trackdir? A one-way signal on the
 148  * trackdir against will block, but signals on both trackdirs won't.
 149  * @param pos the position to check
 150  */
 151 static inline bool HasOnewaySignalBlockingPos(const RailPathPos &pos)
 152 {
 153         return !pos.in_wormhole() && HasOnewaySignalBlockingTrackdir(pos.tile, pos.td);
 154 }
 155
 156 #endif /* SIGNAL_MAP_H */