src/bridge_map.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file bridge_map.h Map accessor functions for bridges. */
   9
  10 #ifndef BRIDGE_MAP_H
  11 #define BRIDGE_MAP_H
  12
  13 #include "rail_map.h"
  14 #include "road_map.h"
  15 #include "bridge.h"
  16 #include "water_map.h"
  17
  18 /**
  19  * Checks if this is a bridge, instead of a tunnel
  20  * @param t The tile to analyze
  21  * @pre IsTileType(t, MP_TUNNELBRIDGE)
  22  * @return true if the structure is a bridge one
  23  */
  24 static inline bool IsBridge(TileIndex t)
  25 {
  26         assert(IsTileType(t, MP_TUNNELBRIDGE));
  27         return HasBit(_m[t].m5, 7);
  28 }
  29
  30 /**
  31  * checks if there is a bridge on this tile
  32  * @param t The tile to analyze
  33  * @return true if a bridge is present
  34  */
  35 static inline bool IsBridgeTile(TileIndex t)
  36 {
  37         return IsTileType(t, MP_TUNNELBRIDGE) && IsBridge(t);
  38 }
  39
  40 /**
  41  * checks if a bridge is set above the ground of this tile
  42  * @param t The tile to analyze
  43  * @return true if a bridge is detected above
  44  */
  45 static inline bool IsBridgeAbove(TileIndex t)
  46 {
  47         return GB(_m[t].type, 2, 2) != 0;
  48 }
  49
  50 /**
  51  * Determines the type of bridge on a tile
  52  * @param t The tile to analyze
  53  * @pre IsBridgeTile(t)
  54  * @return The bridge type
  55  */
  56 static inline BridgeType GetBridgeType(TileIndex t)
  57 {
  58         assert(IsBridgeTile(t));
  59         return GB(_me[t].m6, 2, 4);
  60 }
  61
  62 /**
  63  * Get the axis of the bridge that goes over the tile. Not the axis or the ramp.
  64  * @param t The tile to analyze
  65  * @pre IsBridgeAbove(t)
  66  * @return the above mentioned axis
  67  */
  68 static inline Axis GetBridgeAxis(TileIndex t)
  69 {
  70         assert(IsBridgeAbove(t));
  71         return (Axis)(GB(_m[t].type, 2, 2) - 1);
  72 }
  73
  74 TileIndex GetNorthernBridgeEnd(TileIndex t);
  75 TileIndex GetSouthernBridgeEnd(TileIndex t);
  76 TileIndex GetOtherBridgeEnd(TileIndex t);
  77
  78 int GetBridgeHeight(TileIndex tile);
  79 /**
  80  * Get the height ('z') of a bridge in pixels.
  81  * @param tile the bridge ramp tile to get the bridge height from
  82  * @return the height of the bridge in pixels
  83  */
  84 static inline int GetBridgePixelHeight(TileIndex tile)
  85 {
  86         return GetBridgeHeight(tile) * TILE_HEIGHT;
  87 }
  88
  89 /**
  90  * Remove the bridge over the given axis.
  91  * @param t the tile to remove the bridge from
  92  * @param a the axis of the bridge to remove
  93  */
  94 static inline void ClearSingleBridgeMiddle(TileIndex t, Axis a)
  95 {
  96         ClrBit(_m[t].type, 2 + a);
  97 }
  98
  99 /**
 100  * Removes bridges from the given, that is bridges along the X and Y axis.
 101  * @param t the tile to remove the bridge from
 102  */
 103 static inline void ClearBridgeMiddle(TileIndex t)
 104 {
 105         ClearSingleBridgeMiddle(t, AXIS_X);
 106         ClearSingleBridgeMiddle(t, AXIS_Y);
 107 }
 108
 109 /**
 110  * Set that there is a bridge over the given axis.
 111  * @param t the tile to add the bridge to
 112  * @param a the axis of the bridge to add
 113  */
 114 static inline void SetBridgeMiddle(TileIndex t, Axis a)
 115 {
 116         SetBit(_m[t].type, 2 + a);
 117 }
 118
 119 /**
 120  * Generic part to make a bridge ramp for both roads and rails.
 121  * @param t          the tile to make a bridge ramp
 122  * @param o          the new owner of the bridge ramp
 123  * @param bridgetype the type of bridge this bridge ramp belongs to
 124  * @param d          the direction this ramp must be facing
 125  * @param tt         the transport type of the bridge
 126  * @note this function should not be called directly.
 127  */
 128 static inline void MakeBridgeRamp(TileIndex t, Owner o, BridgeType bridgetype, DiagDirection d, TransportType tt)
 129 {
 130         SetTileType(t, MP_TUNNELBRIDGE);
 131         SetTileOwner(t, o);
 132         SetDockingTile(t, false);
 133         _m[t].m2 = 0;
 134         _m[t].m3 = 0;
 135         _m[t].m4 = INVALID_ROADTYPE;
 136         _m[t].m5 = 1 << 7 | tt << 2 | d;
 137         SB(_me[t].m6, 2, 4, bridgetype);
 138         _me[t].m7 = 0;
 139         _me[t].m8 = INVALID_ROADTYPE << 6;
 140 }
 141
 142 /**
 143  * Make a bridge ramp for roads.
 144  * @param t          the tile to make a bridge ramp
 145  * @param o          the new owner of the bridge ramp
 146  * @param owner_road the new owner of the road on the bridge
 147  * @param owner_tram the new owner of the tram on the bridge
 148  * @param bridgetype the type of bridge this bridge ramp belongs to
 149  * @param d          the direction this ramp must be facing
 150  * @param road_rt    the road type of the bridge
 151  * @param tram_rt    the tram type of the bridge
 152  */
 153 static inline void MakeRoadBridgeRamp(TileIndex t, Owner o, Owner owner_road, Owner owner_tram, BridgeType bridgetype, DiagDirection d, RoadType road_rt, RoadType tram_rt)
 154 {
 155         MakeBridgeRamp(t, o, bridgetype, d, TRANSPORT_ROAD);
 156         SetRoadOwner(t, RTT_ROAD, owner_road);
 157         if (owner_tram != OWNER_TOWN) SetRoadOwner(t, RTT_TRAM, owner_tram);
 158         SetRoadTypes(t, road_rt, tram_rt);
 159 }
 160
 161 /**
 162  * Make a bridge ramp for rails.
 163  * @param t          the tile to make a bridge ramp
 164  * @param o          the new owner of the bridge ramp
 165  * @param bridgetype the type of bridge this bridge ramp belongs to
 166  * @param d          the direction this ramp must be facing
 167  * @param rt         the rail type of the bridge
 168  */
 169 static inline void MakeRailBridgeRamp(TileIndex t, Owner o, BridgeType bridgetype, DiagDirection d, RailType rt)
 170 {
 171         MakeBridgeRamp(t, o, bridgetype, d, TRANSPORT_RAIL);
 172         SetRailType(t, rt);
 173 }
 174
 175 /**
 176  * Make a bridge ramp for aqueducts.
 177  * @param t          the tile to make a bridge ramp
 178  * @param o          the new owner of the bridge ramp
 179  * @param d          the direction this ramp must be facing
 180  */
 181 static inline void MakeAqueductBridgeRamp(TileIndex t, Owner o, DiagDirection d)
 182 {
 183         MakeBridgeRamp(t, o, 0, d, TRANSPORT_WATER);
 184 }
 185
 186 #endif /* BRIDGE_MAP_H */