tron@3069: /* $Id$ */
tron@3069: 
rubidium@8598: /** @file road_func.h Functions related to roads. */
rubidium@5838: 
rubidium@8598: #ifndef ROAD_FUNC_H
rubidium@8598: #define ROAD_FUNC_H
rubidium@7157: 
rubidium@8609: #include "core/bitmath_func.hpp"
rubidium@8598: #include "road_type.h"
rubidium@8634: #include "direction_func.h"
rubidium@8750: #include "player_type.h"
rubidium@7157: 
rubidium@7157: /**
rubidium@7157:  * Whether the given roadtype is valid.
rubidium@7157:  * @param rt the roadtype to check for validness
rubidium@7157:  * @return true if and only if valid
rubidium@7157:  */
rubidium@7157: static inline bool IsValidRoadType(RoadType rt)
rubidium@7157: {
rubidium@7187: 	return rt == ROADTYPE_ROAD || rt == ROADTYPE_TRAM;
rubidium@7157: }
rubidium@7157: 
rubidium@7157: /**
rubidium@7157:  * Are the given bits pointing to valid roadtypes?
rubidium@7157:  * @param rts the roadtypes to check for validness
rubidium@7157:  * @return true if and only if valid
rubidium@7157:  */
rubidium@7157: static inline bool AreValidRoadTypes(RoadTypes rts)
rubidium@7157: {
skidd13@8424: 	return HasBit(rts, ROADTYPE_ROAD) || HasBit(rts, ROADTYPE_TRAM);
rubidium@7157: }
rubidium@7157: 
rubidium@7157: /**
rubidium@7157:  * Maps a RoadType to the corresponding RoadTypes value
rubidium@7891:  *
rubidium@7891:  * @param rt the roadtype to get the roadtypes from
rubidium@7891:  * @return the roadtypes with the given roadtype
rubidium@7157:  */
rubidium@7157: static inline RoadTypes RoadTypeToRoadTypes(RoadType rt)
rubidium@7157: {
rubidium@7157: 	return (RoadTypes)(1 << rt);
rubidium@7157: }
rubidium@7157: 
rubidium@7891: /**
rubidium@7891:  * Returns the RoadTypes which are not present in the given RoadTypes
rubidium@7891:  *
rubidium@7891:  * This function returns the complement of a given RoadTypes.
rubidium@7891:  *
rubidium@7891:  * @param r The given RoadTypes
rubidium@7891:  * @return The complement of the given RoadTypes
rubidium@7891:  * @note The unused value ROADTYPES_HWAY will be used, too.
rubidium@7891:  */
rubidium@7157: static inline RoadTypes ComplementRoadTypes(RoadTypes r)
rubidium@7157: {
rubidium@7157: 	return (RoadTypes)(ROADTYPES_ALL ^ r);
rubidium@7157: }
rubidium@7157: 
rubidium@5838: 
rubidium@7891: /**
rubidium@7891:  * Calculate the complement of a RoadBits value
rubidium@7891:  *
rubidium@7891:  * Simply flips all bits in the RoadBits value to get the complement
rubidium@7891:  * of the RoadBits.
rubidium@7891:  *
rubidium@7891:  * @param r The given RoadBits value
rubidium@7891:  * @return the complement
rubidium@7891:  */
tron@3103: static inline RoadBits ComplementRoadBits(RoadBits r)
tron@3103: {
KUDr@3900: 	return (RoadBits)(ROAD_ALL ^ r);
tron@3103: }
tron@3103: 
rubidium@7891: /**
rubidium@8137:  * Calculate the mirrored RoadBits
rubidium@8137:  *
rubidium@8137:  * Simply move the bits to their new position.
rubidium@8137:  *
rubidium@8137:  * @param r The given RoadBits value
rubidium@8137:  * @return the mirrored
rubidium@8137:  */
rubidium@8137: static inline RoadBits MirrorRoadBits(RoadBits r)
rubidium@8137: {
rubidium@8137: 	return (RoadBits)(GB(r, 0, 2) << 2 | GB(r, 2, 2));
rubidium@8137: }
rubidium@8137: 
rubidium@8137: /**
rubidium@8137:  * Calculate rotated RoadBits
rubidium@8137:  *
rubidium@8137:  * Move the Roadbits clockwise til they are in their final position.
rubidium@8137:  *
rubidium@8137:  * @param r The given RoadBits value
rubidium@8137:  * @param rot The given Rotation angle
rubidium@8137:  * @return the rotated
rubidium@8137:  */
rubidium@8137: static inline RoadBits RotateRoadBits(RoadBits r, DiagDirDiff rot)
rubidium@8137: {
rubidium@8137: 	for (; rot > (DiagDirDiff)0; rot--){
rubidium@8137: 		r = (RoadBits)(GB(r, 0, 1) << 3 | GB(r, 1, 3));
rubidium@8137: 	}
rubidium@8137: 	return r;
rubidium@8137: }
rubidium@8137: 
rubidium@8137: /**
skidd13@9230:  * Check if we've got a straight road
skidd13@9230:  *
skidd13@9230:  * @param r The given RoadBits
skidd13@9230:  * @return true if we've got a straight road
skidd13@9230:  */
skidd13@9230: static inline bool IsStraightRoad(RoadBits r)
skidd13@9230: {
skidd13@9230: 	return (r == ROAD_X || r == ROAD_Y);
skidd13@9230: }
skidd13@9230: 
skidd13@9230: /**
rubidium@7891:  * Create the road-part which belongs to the given DiagDirection
rubidium@7891:  *
rubidium@7891:  * This function returns a RoadBits value which belongs to
rubidium@7891:  * the given DiagDirection.
rubidium@7891:  *
rubidium@7891:  * @param d The DiagDirection
rubidium@7891:  * @return The result RoadBits which the selected road-part set
rubidium@7891:  */
tron@3146: static inline RoadBits DiagDirToRoadBits(DiagDirection d)
tron@3146: {
belugas@8062: 	return (RoadBits)(ROAD_NW << (3 ^ d));
tron@3146: }
tron@3146: 
rubidium@8732: /**
rubidium@9212:  * Create the road-part which belongs to the given Axis
rubidium@9212:  *
rubidium@9212:  * This function returns a RoadBits value which belongs to
rubidium@9212:  * the given Axis.
rubidium@9212:  *
rubidium@9212:  * @param a The Axis
rubidium@9212:  * @return The result RoadBits which the selected road-part set
rubidium@9212:  */
rubidium@9212: static inline RoadBits AxisToRoadBits(Axis a)
rubidium@9212: {
rubidium@9212: 	return a == AXIS_X ? ROAD_X : ROAD_Y;
rubidium@9212: }
rubidium@9212: 
rubidium@9212: /**
rubidium@8732:  * Finds out, whether given player has all given RoadTypes available
rubidium@8732:  * @param PlayerID ID of player
rubidium@8732:  * @param rts RoadTypes to test
rubidium@8732:  * @return true if player has all requested RoadTypes available
rubidium@8732:  */
rubidium@8732: bool HasRoadTypesAvail(const PlayerID p, const RoadTypes rts);
rubidium@8732: 
rubidium@8732: /**
rubidium@8732:  * Validate functions for rail building.
rubidium@8732:  * @param rt road type to check.
rubidium@8732:  * @return true if the current player may build the road.
rubidium@8732:  */
rubidium@8732: bool ValParamRoadType(const RoadType rt);
rubidium@8732: 
rubidium@8732: /**
rubidium@8732:  * Get the road types the given player can build.
rubidium@8732:  * @param p the player to get the roadtypes for.
rubidium@8732:  * @return the road types.
rubidium@8732:  */
rubidium@8732: RoadTypes GetPlayerRoadtypes(const PlayerID p);
rubidium@8732: 
smatz@8840: void UpdateLevelCrossing(TileIndex tile, bool sound = true);
smatz@8838: 
rubidium@8598: #endif /* ROAD_FUNC_H */