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