author | truebrain |
Fri, 13 Jun 2008 13:07:31 +0000 | |
branch | noai |
changeset 10952 | d16212cc2394 |
parent 9826 | 9707ad4c9b60 |
permissions | -rw-r--r-- |
9723 | 1 |
/* $Id$ */ |
2 |
||
3 |
/** @file road_func.h Functions related to roads. */ |
|
4 |
||
5 |
#ifndef ROAD_FUNC_H |
|
6 |
#define ROAD_FUNC_H |
|
7 |
||
8 |
#include "core/bitmath_func.hpp" |
|
9 |
#include "road_type.h" |
|
10 |
#include "direction_func.h" |
|
9724
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
11 |
#include "player_type.h" |
9723 | 12 |
|
13 |
/** |
|
14 |
* Whether the given roadtype is valid. |
|
15 |
* @param rt the roadtype to check for validness |
|
16 |
* @return true if and only if valid |
|
17 |
*/ |
|
18 |
static inline bool IsValidRoadType(RoadType rt) |
|
19 |
{ |
|
20 |
return rt == ROADTYPE_ROAD || rt == ROADTYPE_TRAM; |
|
21 |
} |
|
22 |
||
23 |
/** |
|
24 |
* Are the given bits pointing to valid roadtypes? |
|
25 |
* @param rts the roadtypes to check for validness |
|
26 |
* @return true if and only if valid |
|
27 |
*/ |
|
28 |
static inline bool AreValidRoadTypes(RoadTypes rts) |
|
29 |
{ |
|
30 |
return HasBit(rts, ROADTYPE_ROAD) || HasBit(rts, ROADTYPE_TRAM); |
|
31 |
} |
|
32 |
||
33 |
/** |
|
34 |
* Maps a RoadType to the corresponding RoadTypes value |
|
35 |
* |
|
36 |
* @param rt the roadtype to get the roadtypes from |
|
37 |
* @return the roadtypes with the given roadtype |
|
38 |
*/ |
|
39 |
static inline RoadTypes RoadTypeToRoadTypes(RoadType rt) |
|
40 |
{ |
|
41 |
return (RoadTypes)(1 << rt); |
|
42 |
} |
|
43 |
||
44 |
/** |
|
45 |
* Returns the RoadTypes which are not present in the given RoadTypes |
|
46 |
* |
|
47 |
* This function returns the complement of a given RoadTypes. |
|
48 |
* |
|
49 |
* @param r The given RoadTypes |
|
50 |
* @return The complement of the given RoadTypes |
|
51 |
* @note The unused value ROADTYPES_HWAY will be used, too. |
|
52 |
*/ |
|
53 |
static inline RoadTypes ComplementRoadTypes(RoadTypes r) |
|
54 |
{ |
|
55 |
return (RoadTypes)(ROADTYPES_ALL ^ r); |
|
56 |
} |
|
57 |
||
58 |
||
59 |
/** |
|
60 |
* Calculate the complement of a RoadBits value |
|
61 |
* |
|
62 |
* Simply flips all bits in the RoadBits value to get the complement |
|
63 |
* of the RoadBits. |
|
64 |
* |
|
65 |
* @param r The given RoadBits value |
|
66 |
* @return the complement |
|
67 |
*/ |
|
68 |
static inline RoadBits ComplementRoadBits(RoadBits r) |
|
69 |
{ |
|
70 |
return (RoadBits)(ROAD_ALL ^ r); |
|
71 |
} |
|
72 |
||
73 |
/** |
|
74 |
* Calculate the mirrored RoadBits |
|
75 |
* |
|
76 |
* Simply move the bits to their new position. |
|
77 |
* |
|
78 |
* @param r The given RoadBits value |
|
79 |
* @return the mirrored |
|
80 |
*/ |
|
81 |
static inline RoadBits MirrorRoadBits(RoadBits r) |
|
82 |
{ |
|
83 |
return (RoadBits)(GB(r, 0, 2) << 2 | GB(r, 2, 2)); |
|
84 |
} |
|
85 |
||
86 |
/** |
|
87 |
* Calculate rotated RoadBits |
|
88 |
* |
|
89 |
* Move the Roadbits clockwise til they are in their final position. |
|
90 |
* |
|
91 |
* @param r The given RoadBits value |
|
92 |
* @param rot The given Rotation angle |
|
93 |
* @return the rotated |
|
94 |
*/ |
|
95 |
static inline RoadBits RotateRoadBits(RoadBits r, DiagDirDiff rot) |
|
96 |
{ |
|
97 |
for (; rot > (DiagDirDiff)0; rot--){ |
|
98 |
r = (RoadBits)(GB(r, 0, 1) << 3 | GB(r, 1, 3)); |
|
99 |
} |
|
100 |
return r; |
|
101 |
} |
|
102 |
||
103 |
/** |
|
9826
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
104 |
* Check if we've got a straight road |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
105 |
* |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
106 |
* @param r The given RoadBits |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
107 |
* @return true if we've got a straight road |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
108 |
*/ |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
109 |
static inline bool IsStraightRoad(RoadBits r) |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
110 |
{ |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
111 |
return (r == ROAD_X || r == ROAD_Y); |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
112 |
} |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
113 |
|
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
114 |
/** |
9723 | 115 |
* Create the road-part which belongs to the given DiagDirection |
116 |
* |
|
117 |
* This function returns a RoadBits value which belongs to |
|
118 |
* the given DiagDirection. |
|
119 |
* |
|
120 |
* @param d The DiagDirection |
|
121 |
* @return The result RoadBits which the selected road-part set |
|
122 |
*/ |
|
123 |
static inline RoadBits DiagDirToRoadBits(DiagDirection d) |
|
124 |
{ |
|
125 |
return (RoadBits)(ROAD_NW << (3 ^ d)); |
|
126 |
} |
|
127 |
||
9724
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
128 |
/** |
9826
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
129 |
* Create the road-part which belongs to the given Axis |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
130 |
* |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
131 |
* This function returns a RoadBits value which belongs to |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
132 |
* the given Axis. |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
133 |
* |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
134 |
* @param a The Axis |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
135 |
* @return The result RoadBits which the selected road-part set |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
136 |
*/ |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
137 |
static inline RoadBits AxisToRoadBits(Axis a) |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
138 |
{ |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
139 |
return a == AXIS_X ? ROAD_X : ROAD_Y; |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
140 |
} |
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
141 |
|
9707ad4c9b60
(svn r12462) [NoAI] -Sync: with trunk r12304:12461.
rubidium
parents:
9724
diff
changeset
|
142 |
/** |
9724
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
143 |
* Finds out, whether given player has all given RoadTypes available |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
144 |
* @param PlayerID ID of player |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
145 |
* @param rts RoadTypes to test |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
146 |
* @return true if player has all requested RoadTypes available |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
147 |
*/ |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
148 |
bool HasRoadTypesAvail(const PlayerID p, const RoadTypes rts); |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
149 |
|
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
150 |
/** |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
151 |
* Validate functions for rail building. |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
152 |
* @param rt road type to check. |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
153 |
* @return true if the current player may build the road. |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
154 |
*/ |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
155 |
bool ValParamRoadType(const RoadType rt); |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
156 |
|
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
157 |
/** |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
158 |
* Get the road types the given player can build. |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
159 |
* @param p the player to get the roadtypes for. |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
160 |
* @return the road types. |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
161 |
*/ |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
162 |
RoadTypes GetPlayerRoadtypes(const PlayerID p); |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
163 |
|
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
164 |
void UpdateLevelCrossing(TileIndex tile, bool sound = true); |
b39bc69bb2f2
(svn r12051) [NoAI] -Sync: with trunk (r11795:12050).
rubidium
parents:
9723
diff
changeset
|
165 |
|
9723 | 166 |
#endif /* ROAD_FUNC_H */ |