road_func.h

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #ifndef ROAD_FUNC_H
00013 #define ROAD_FUNC_H
00014 
00015 #include "core/bitmath_func.hpp"
00016 #include "road_type.h"
00017 #include "direction_type.h"
00018 #include "company_type.h"
00019 #include "tile_type.h"
00020 #include "economy_func.h"
00021 
00031 #define FOR_EACH_SET_ROADTYPE(var, road_types) FOR_EACH_SET_BIT_EX(RoadType, var, RoadTypes, road_types)
00032 
00038 static inline bool IsValidRoadType(RoadType rt)
00039 {
00040   return rt == ROADTYPE_ROAD || rt == ROADTYPE_TRAM;
00041 }
00042 
00049 static inline RoadTypes RoadTypeToRoadTypes(RoadType rt)
00050 {
00051   return (RoadTypes)(1 << rt);
00052 }
00053 
00063 static inline RoadTypes ComplementRoadTypes(RoadTypes r)
00064 {
00065   return (RoadTypes)(ROADTYPES_ALL ^ r);
00066 }
00067 
00068 
00078 static inline RoadBits ComplementRoadBits(RoadBits r)
00079 {
00080   return (RoadBits)(ROAD_ALL ^ r);
00081 }
00082 
00091 static inline RoadBits MirrorRoadBits(RoadBits r)
00092 {
00093   return (RoadBits)(GB(r, 0, 2) << 2 | GB(r, 2, 2));
00094 }
00095 
00105 static inline RoadBits RotateRoadBits(RoadBits r, DiagDirDiff rot)
00106 {
00107   for (; rot > (DiagDirDiff)0; rot--) {
00108     r = (RoadBits)(GB(r, 0, 1) << 3 | GB(r, 1, 3));
00109   }
00110   return r;
00111 }
00112 
00119 static inline bool IsStraightRoad(RoadBits r)
00120 {
00121   return (r == ROAD_X || r == ROAD_Y);
00122 }
00123 
00133 static inline RoadBits DiagDirToRoadBits(DiagDirection d)
00134 {
00135   return (RoadBits)(ROAD_NW << (3 ^ d));
00136 }
00137 
00147 static inline RoadBits AxisToRoadBits(Axis a)
00148 {
00149   return a == AXIS_X ? ROAD_X : ROAD_Y;
00150 }
00151 
00152 
00159 static inline Money RoadMaintenanceCost(RoadType roadtype, uint32 num)
00160 {
00161   assert(roadtype < ROADTYPE_END);
00162   return (_price[PR_INFRASTRUCTURE_ROAD] * (roadtype == ROADTYPE_TRAM ? 3 : 2) * num * (1 + IntSqrt(num))) >> 9; // 2 bits fraction for the multiplier and 7 bits scaling.
00163 }
00164 
00165 bool HasRoadTypesAvail(const CompanyID company, const RoadTypes rts);
00166 bool ValParamRoadType(const RoadType rt);
00167 RoadTypes GetCompanyRoadtypes(const CompanyID company);
00168 
00169 void UpdateLevelCrossing(TileIndex tile, bool sound = true);
00170 
00171 #endif /* ROAD_FUNC_H */