tron@3189: /* $Id$ */
tron@3189: 
glx@9574: /** @file bridge_map.h Map accessor functions for bridges. */
belugas@6449: 
tron@3189: #ifndef BRIDGE_MAP_H
tron@3189: #define BRIDGE_MAP_H
tron@3189: 
tron@3196: #include "direction.h"
tron@3189: #include "macros.h"
tron@3189: #include "map.h"
tron@3189: #include "rail.h"
tron@3234: #include "road_map.h"
tron@3189: #include "tile.h"
tron@3189: 
tron@3189: 
glx@9574: /**
glx@9574:  * Checks if this is a bridge, instead of a tunnel
glx@9574:  * @param t The tile to analyze
glx@9574:  * @pre IsTileType(t, MP_TUNNELBRIDGE)
glx@9574:  * @return true if the structure is a bridge one
glx@9574:  */
tron@3234: static inline bool IsBridge(TileIndex t)
tron@3234: {
tron@3369: 	assert(IsTileType(t, MP_TUNNELBRIDGE));
tron@3234: 	return HASBIT(_m[t].m5, 7);
tron@3234: }
tron@3234: 
glx@9574: /**
glx@9574:  * checks if there is a bridge on this tile
glx@9574:  * @param t The tile to analyze
glx@9574:  * @return true if a bridge is present
glx@9574:  */
tron@3234: static inline bool IsBridgeTile(TileIndex t)
tron@3234: {
tron@3234: 	return IsTileType(t, MP_TUNNELBRIDGE) && IsBridge(t);
tron@3234: }
tron@3234: 
glx@9574: /**
glx@9574:  * checks for the possibility that a bridge may be on this tile
glx@9574:  * These are in fact all the tile types on which a bridge can be found
glx@9574:  * @param t The tile to analyze
glx@9574:  * @return true if a bridge migh be present
glx@9574:  */
celestar@5573: static inline bool MayHaveBridgeAbove(TileIndex t)
tron@3214: {
celestar@5573: 	return
celestar@5573: 		IsTileType(t, MP_CLEAR) ||
celestar@5573: 		IsTileType(t, MP_RAILWAY) ||
celestar@5573: 		IsTileType(t, MP_STREET) ||
celestar@5573: 		IsTileType(t, MP_WATER) ||
celestar@5573: 		IsTileType(t, MP_TUNNELBRIDGE) ||
celestar@5573: 		IsTileType(t, MP_UNMOVABLE);
tron@3225: }
tron@3225: 
glx@9574: /**
glx@9574:  * checks if a bridge is set above the ground of this tile
glx@9574:  * @param t The tile to analyze
glx@9574:  * @pre MayHaveBridgeAbove(t)
glx@9574:  * @return true if a bridge is detected above
glx@9574:  */
celestar@5573: static inline bool IsBridgeAbove(TileIndex t)
celestar@3933: {
celestar@5573: 	assert(MayHaveBridgeAbove(t));
belugas@5847: 	return GB(_m[t].m6, 6, 2) != 0;
tron@3231: }
tron@3231: 
tron@3231: 
tron@3231: /**
tron@3231:  * Determines the type of bridge on a tile
glx@9574:  * @param t The tile to analyze
glx@9574:  * @pre IsBridgeTile(t)
tron@3231:  * @return The bridge type
tron@3231:  */
tron@3369: static inline uint GetBridgeType(TileIndex t)
tron@3231: {
tron@3369: 	assert(IsBridgeTile(t));
tron@3369: 	return GB(_m[t].m2, 4, 4);
tron@3231: }
tron@3231: 
tron@3214: 
tron@3196: /**
tron@3196:  * Get the direction pointing onto the bridge
glx@9574:  * @param t The tile to analyze
glx@9574:  * @pre IsBridgeTile(t)
belugas@6449:  * @return the above mentionned direction
tron@3196:  */
tron@3196: static inline DiagDirection GetBridgeRampDirection(TileIndex t)
tron@3196: {
celestar@5573: 	assert(IsBridgeTile(t));
celestar@5573: 	return (DiagDirection)GB(_m[t].m5, 0, 2);
tron@3196: }
tron@3196: 
tron@3196: 
glx@9574: /**
glx@9574:  * Get the axis of the bridge that goes over the tile. Not the axis or the ramp.
glx@9574:  * @param t The tile to analyze
glx@9574:  * @pre IsBridgeAbove(t)
glx@9574:  * @return the above mentioned axis
glx@9574:  */
tron@3225: static inline Axis GetBridgeAxis(TileIndex t)
tron@3225: {
celestar@5573: 	assert(IsBridgeAbove(t));
belugas@5847: 	return (Axis)(GB(_m[t].m6, 6, 2) - 1);
tron@3225: }
tron@3225: 
tron@3225: 
glx@9574: /**
glx@9574:  * Get the transport type of the bridge's ramp.
glx@9574:  * @param t The ramp tile to analyze
glx@9574:  * @pre IsBridgeTile(t)
glx@9574:  * @return the transport type of the bridge
glx@9574:  */
tron@3234: static inline TransportType GetBridgeTransportType(TileIndex t)
tron@3234: {
tron@3369: 	assert(IsBridgeTile(t));
celestar@5573: 	return (TransportType)GB(_m[t].m5, 2, 2);
tron@3977: }
tron@3977: 
tron@3977: 
glx@9574: /**
glx@9574:  * Does the bridge ramp lie in a snow or desert area?
glx@9574:  * @param t The ramp tile to analyze
glx@9574:  * @pre IsBridgeTile(t)
glx@9574:  * @return true if and only if in a snow or desert area
glx@9574:  */
rubidium@5661: static inline bool HasBridgeSnowOrDesert(TileIndex t)
rubidium@5661: {
rubidium@5661: 	assert(IsBridgeTile(t));
rubidium@5661: 	return HASBIT(_m[t].m4, 7);
rubidium@5661: }
rubidium@5661: 
rubidium@5661: 
glx@9574: /**
glx@9574:  * Sets whether the bridge ramp lies in a snow or desert area.
glx@9574:  * @param t              The ramp tile to set (un)make a snow/desert area
glx@9574:  * @param snow_or_desert Make (true) or unmake the tile a snow/desert area
glx@9574:  * @pre IsBridgeTile(t)
glx@9574:  */
rubidium@5661: static inline void SetBridgeSnowOrDesert(TileIndex t, bool snow_or_desert)
rubidium@5661: {
rubidium@5661: 	assert(IsBridgeTile(t));
rubidium@5661: 	SB(_m[t].m4, 7, 1, snow_or_desert);
rubidium@5661: }
rubidium@5661: 
tron@3214: /**
tron@3225:  * Finds the end of a bridge in the specified direction starting at a middle tile
glx@9574:  * @param t the bridge tile to find the bridge ramp for
glx@9574:  * @param d the direction to search in
tron@3225:  */
glx@9574: TileIndex GetBridgeEnd(TileIndex t, DiagDirection d);
tron@3225: 
tron@3225: /**
celestar@5573:  * Finds the northern end of a bridge starting at a middle tile
glx@9574:  * @param t the bridge tile to find the bridge ramp for
celestar@5573:  */
celestar@5573: TileIndex GetNorthernBridgeEnd(TileIndex t);
celestar@5573: 
celestar@5573: /**
tron@3225:  * Finds the southern end of a bridge starting at a middle tile
glx@9574:  * @param t the bridge tile to find the bridge ramp for
tron@3225:  */
tron@3225: TileIndex GetSouthernBridgeEnd(TileIndex t);
tron@3225: 
tron@3225: 
tron@3225: /**
tron@3214:  * Starting at one bridge end finds the other bridge end
glx@9574:  * @param t the bridge ramp tile to find the other bridge ramp for
tron@3214:  */
glx@9574: TileIndex GetOtherBridgeEnd(TileIndex t);
tron@3214: 
glx@9574: /**
glx@9574:  * Get the height ('z') of a bridge in pixels.
glx@9574:  * @param tile the bridge ramp tile to get the bridge height from
glx@9574:  * @return the height of the bridge in pixels
glx@9574:  */
celestar@5573: uint GetBridgeHeight(TileIndex tile);
tron@3214: 
glx@9574: /**
glx@9574:  * Remove the bridge over the given axis.
glx@9574:  * @param t the tile to remove the bridge from
glx@9574:  * @param a the axis of the bridge to remove
glx@9574:  * @pre MayHaveBridgeAbove(t)
glx@9574:  */
celestar@5573: static inline void ClearSingleBridgeMiddle(TileIndex t, Axis a)
tron@3189: {
celestar@5573: 	assert(MayHaveBridgeAbove(t));
belugas@5847: 	CLRBIT(_m[t].m6, 6 + a);
tron@3189: }
tron@3189: 
celestar@5573: 
glx@9574: /**
glx@9574:  * Removes bridges from the given, that is bridges along the X and Y axis.
glx@9574:  * @param t the tile to remove the bridge from
glx@9574:  * @pre MayHaveBridgeAbove(t)
glx@9574:  */
celestar@5573: static inline void ClearBridgeMiddle(TileIndex t)
tron@3189: {
celestar@5573: 	ClearSingleBridgeMiddle(t, AXIS_X);
celestar@5573: 	ClearSingleBridgeMiddle(t, AXIS_Y);
tron@3977: }
tron@3977: 
glx@9574: /**
glx@9574:  * Set that there is a bridge over the given axis.
glx@9574:  * @param t the tile to add the bridge to
glx@9574:  * @param a the axis of the bridge to add
glx@9574:  * @pre MayHaveBridgeAbove(t)
glx@9574:  */
celestar@5573: static inline void SetBridgeMiddle(TileIndex t, Axis a)
tron@3977: {
celestar@5573: 	assert(MayHaveBridgeAbove(t));
belugas@5847: 	SETBIT(_m[t].m6, 6 + a);
tron@3189: }
tron@3189: 
tron@3209: 
glx@9574: /**
glx@9574:  * Generic part to make a bridge ramp for both roads and rails.
glx@9574:  * @param t          the tile to make a bridge ramp
glx@9574:  * @param o          the new owner of the bridge ramp
glx@9574:  * @param bridgetype the type of bridge this bridge ramp belongs to
glx@9574:  * @param d          the direction this ramp must be facing
glx@9574:  * @param tt         the transport type of the bridge
glx@9574:  * @note this function should not be called directly.
glx@9574:  */
tron@3209: static inline void MakeBridgeRamp(TileIndex t, Owner o, uint bridgetype, DiagDirection d, TransportType tt)
tron@3209: {
tron@3209: 	SetTileType(t, MP_TUNNELBRIDGE);
tron@3209: 	SetTileOwner(t, o);
tron@3209: 	_m[t].m2 = bridgetype << 4;
tron@3209: 	_m[t].m4 = 0;
celestar@5573: 	_m[t].m5 = 1 << 7 | tt << 2 | d;
tron@3209: }
tron@3209: 
glx@9574: /**
glx@9574:  * Make a bridge ramp for roads.
glx@9574:  * @param t          the tile to make a bridge ramp
glx@9574:  * @param o          the new owner of the bridge ramp
glx@9574:  * @param bridgetype the type of bridge this bridge ramp belongs to
glx@9574:  * @param d          the direction this ramp must be facing
glx@9574:  */
tron@3209: static inline void MakeRoadBridgeRamp(TileIndex t, Owner o, uint bridgetype, DiagDirection d)
tron@3209: {
tron@3209: 	MakeBridgeRamp(t, o, bridgetype, d, TRANSPORT_ROAD);
tron@3209: 	_m[t].m3 = 0;
tron@3209: }
tron@3209: 
glx@9574: /**
glx@9574:  * Make a bridge ramp for rails.
glx@9574:  * @param t          the tile to make a bridge ramp
glx@9574:  * @param o          the new owner of the bridge ramp
glx@9574:  * @param bridgetype the type of bridge this bridge ramp belongs to
glx@9574:  * @param d          the direction this ramp must be facing
glx@9574:  * @param r          the rail type of the bridge
glx@9574:  */
tron@3209: static inline void MakeRailBridgeRamp(TileIndex t, Owner o, uint bridgetype, DiagDirection d, RailType r)
tron@3209: {
tron@3209: 	MakeBridgeRamp(t, o, bridgetype, d, TRANSPORT_RAIL);
tron@3209: 	_m[t].m3 = r;
tron@3209: }
tron@3209: 
tron@3209: 
peter1138@4666: #endif /* BRIDGE_MAP_H */