road_func.h

Go to the documentation of this file.
00001 /* $Id: road_func.h 21846 2011-01-18 23:09:43Z rubidium $ */
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 
00030 #define FOR_EACH_SET_ROADTYPE(var, road_types) FOR_EACH_SET_BIT_EX(RoadType, var, RoadTypes, road_types)
00031 
00037 static inline bool IsValidRoadType(RoadType rt)
00038 {
00039   return rt == ROADTYPE_ROAD || rt == ROADTYPE_TRAM;
00040 }
00041 
00048 static inline RoadTypes RoadTypeToRoadTypes(RoadType rt)
00049 {
00050   return (RoadTypes)(1 << rt);
00051 }
00052 
00062 static inline RoadTypes ComplementRoadTypes(RoadTypes r)
00063 {
00064   return (RoadTypes)(ROADTYPES_ALL ^ r);
00065 }
00066 
00067 
00077 static inline RoadBits ComplementRoadBits(RoadBits r)
00078 {
00079   return (RoadBits)(ROAD_ALL ^ r);
00080 }
00081 
00090 static inline RoadBits MirrorRoadBits(RoadBits r)
00091 {
00092   return (RoadBits)(GB(r, 0, 2) << 2 | GB(r, 2, 2));
00093 }
00094 
00104 static inline RoadBits RotateRoadBits(RoadBits r, DiagDirDiff rot)
00105 {
00106   for (; rot > (DiagDirDiff)0; rot--) {
00107     r = (RoadBits)(GB(r, 0, 1) << 3 | GB(r, 1, 3));
00108   }
00109   return r;
00110 }
00111 
00118 static inline bool IsStraightRoad(RoadBits r)
00119 {
00120   return (r == ROAD_X || r == ROAD_Y);
00121 }
00122 
00132 static inline RoadBits DiagDirToRoadBits(DiagDirection d)
00133 {
00134   return (RoadBits)(ROAD_NW << (3 ^ d));
00135 }
00136 
00146 static inline RoadBits AxisToRoadBits(Axis a)
00147 {
00148   return a == AXIS_X ? ROAD_X : ROAD_Y;
00149 }
00150 
00151 bool HasRoadTypesAvail(const CompanyID company, const RoadTypes rts);
00152 bool ValParamRoadType(const RoadType rt);
00153 RoadTypes GetCompanyRoadtypes(const CompanyID company);
00154 
00155 void UpdateLevelCrossing(TileIndex tile, bool sound = true);
00156 
00157 #endif /* ROAD_FUNC_H */