OpenTTD Source: src/pathfinder/water_regions.cpp Source File

OpenTTD Source 14.0-RC3

water_regions.cpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #include "stdafx.h"
11 #include "map_func.h"
12 #include "water_regions.h"
13 #include "map_func.h"
14 #include "tilearea_type.h"
15 #include "track_func.h"
16 #include "transport_type.h"
17 #include "landscape.h"
18 #include "tunnelbridge_map.h"
19 #include "follow_track.hpp"
20 #include "ship.h"
21 #include "debug.h"
22
23 using TWaterRegionTraversabilityBits = uint16_t;
24 constexpr TWaterRegionPatchLabel FIRST_REGION_LABEL = 1;
25
26 static_assert(sizeof(TWaterRegionTraversabilityBits) * 8 == WATER_REGION_EDGE_LENGTH);
27 static_assert(sizeof(TWaterRegionPatchLabel) == sizeof(byte)); // Important for the hash calculation.
28
29 static inline TrackBits GetWaterTracks(TileIndex tile) { return TrackStatusToTrackBits(GetTileTrackStatus(tile, TRANSPORT_WATER, 0)); }
30 static inline bool IsAqueductTile(TileIndex tile) { return IsBridgeTile(tile) && GetTunnelBridgeTransportType(tile) == TRANSPORT_WATER; }
31
32 static inline int GetWaterRegionX(TileIndex tile) { return TileX(tile) / WATER_REGION_EDGE_LENGTH; }
33 static inline int GetWaterRegionY(TileIndex tile) { return TileY(tile) / WATER_REGION_EDGE_LENGTH; }
34
35 static inline int GetWaterRegionMapSizeX() { return Map::SizeX() / WATER_REGION_EDGE_LENGTH; }
36 static inline int GetWaterRegionMapSizeY() { return Map::SizeY() / WATER_REGION_EDGE_LENGTH; }
37
38 static inline TWaterRegionIndex GetWaterRegionIndex(int region_x, int region_y) { return GetWaterRegionMapSizeX() * region_y + region_x; }
39 static inline TWaterRegionIndex GetWaterRegionIndex(TileIndex tile) { return GetWaterRegionIndex(GetWaterRegionX(tile), GetWaterRegionY(tile)); }
40
41 using TWaterRegionPatchLabelArray = std::array<TWaterRegionPatchLabel, WATER_REGION_NUMBER_OF_TILES>;
42
49 class WaterRegion
50 {
51 private:
52 std::array<TWaterRegionTraversabilityBits, DIAGDIR_END> edge_traversability_bits{};
53 bool has_cross_region_aqueducts = false;
54 bool initialized = false;
55 TWaterRegionPatchLabel number_of_patches = 0; // 0 = no water, 1 = one single patch of water, etc...
56 const OrthogonalTileArea tile_area;
57 std::unique_ptr<TWaterRegionPatchLabelArray> tile_patch_labels;
58
65 inline int GetLocalIndex(TileIndex tile) const
66 {
67 assert(this->tile_area.Contains(tile));
68 return (TileX(tile) - TileX(this->tile_area.tile)) + WATER_REGION_EDGE_LENGTH * (TileY(tile) - TileY(this->tile_area.tile));
69 }
70
71 public:
72 WaterRegion(int region_x, int region_y)
73 : tile_area(TileXY(region_x * WATER_REGION_EDGE_LENGTH, region_y * WATER_REGION_EDGE_LENGTH), WATER_REGION_EDGE_LENGTH, WATER_REGION_EDGE_LENGTH)
74 {}
75
76 OrthogonalTileIterator begin() const { return this->tile_area.begin(); }
77 OrthogonalTileIterator end() const { return this->tile_area.end(); }
78
79 bool IsInitialized() const { return this->initialized; }
80
81 void Invalidate()
82 {
83 if (!IsInitialized()) Debug(map, 3, "Invalidated water region ({},{})", GetWaterRegionX(this->tile_area.tile), GetWaterRegionY(this->tile_area.tile));
84 this->initialized = false;
85 }
86
94 TWaterRegionTraversabilityBits GetEdgeTraversabilityBits(DiagDirection side) const { return edge_traversability_bits[side]; }
95
100 int NumberOfPatches() const { return this->number_of_patches; }
101
105 bool HasCrossRegionAqueducts() const { return this->has_cross_region_aqueducts; }
106
112 TWaterRegionPatchLabel GetLabel(TileIndex tile) const
113 {
114 assert(this->tile_area.Contains(tile));
115 if (this->tile_patch_labels == nullptr) {
116 return this->NumberOfPatches() == 0 ? INVALID_WATER_REGION_PATCH : 1;
117 }
118 return (*this->tile_patch_labels)[GetLocalIndex(tile)];
119 }
120
125 void ForceUpdate()
126 {
127 Debug(map, 3, "Updating water region ({},{})", GetWaterRegionX(this->tile_area.tile), GetWaterRegionY(this->tile_area.tile));
128 this->has_cross_region_aqueducts = false;
129
130 /* Acquire a tile patch label array if this region does not already have one */
131 if (this->tile_patch_labels == nullptr) {
132 this->tile_patch_labels = std::make_unique<TWaterRegionPatchLabelArray>();
133 }
134
135 this->tile_patch_labels->fill(INVALID_WATER_REGION_PATCH);
136 this->edge_traversability_bits.fill(0);
137
138 TWaterRegionPatchLabel current_label = 1;
139 TWaterRegionPatchLabel highest_assigned_label = 0;
140
141 /* Perform connected component labeling. This uses a flooding algorithm that expands until no
142 * additional tiles can be added. Only tiles inside the water region are considered. */
143 for (const TileIndex start_tile : tile_area) {
144 static std::vector<TileIndex> tiles_to_check;
145 tiles_to_check.clear();
146 tiles_to_check.push_back(start_tile);
147
148 bool increase_label = false;
149 while (!tiles_to_check.empty()) {
150 const TileIndex tile = tiles_to_check.back();
151 tiles_to_check.pop_back();
152
153 const TrackdirBits valid_dirs = TrackBitsToTrackdirBits(GetWaterTracks(tile));
154 if (valid_dirs == TRACKDIR_BIT_NONE) continue;
155
156 TWaterRegionPatchLabel &tile_patch = (*this->tile_patch_labels)[GetLocalIndex(tile)];
157 if (tile_patch != INVALID_WATER_REGION_PATCH) continue;
158
159 tile_patch = current_label;
160 highest_assigned_label = current_label;
161 increase_label = true;
162
163 for (const Trackdir dir : SetTrackdirBitIterator(valid_dirs)) {
164 /* By using a TrackFollower we "play by the same rules" as the actual ship pathfinder */
165 CFollowTrackWater ft;
166 if (ft.Follow(tile, dir)) {
167 if (this->tile_area.Contains(ft.m_new_tile)) {
168 tiles_to_check.push_back(ft.m_new_tile);
169 } else if (!ft.m_is_bridge) {
170 assert(DistanceManhattan(ft.m_new_tile, tile) == 1);
171 const auto side = DiagdirBetweenTiles(tile, ft.m_new_tile);
172 const int local_x_or_y = DiagDirToAxis(side) == AXIS_X ? TileY(tile) - TileY(this->tile_area.tile) : TileX(tile) - TileX(this->tile_area.tile);
173 SetBit(this->edge_traversability_bits[side], local_x_or_y);
174 } else {
175 this->has_cross_region_aqueducts = true;
176 }
177 }
178 }
179 }
180
181 if (increase_label) current_label++;
182 }
183
184 this->number_of_patches = highest_assigned_label;
185 this->initialized = true;
186
187 if (this->number_of_patches == 0 || (this->number_of_patches == 1 &&
188 std::all_of(this->tile_patch_labels->begin(), this->tile_patch_labels->end(), [](TWaterRegionPatchLabel label) { return label == 1; }))) {
189 /* No need for patch storage: trivial cases */
190 this->tile_patch_labels.reset();
191 }
192 }
193
197 inline void UpdateIfNotInitialized()
198 {
199 if (!this->initialized) ForceUpdate();
200 }
201
202 void PrintDebugInfo()
203 {
204 Debug(map, 9, "Water region {},{} labels and edge traversability = ...", GetWaterRegionX(tile_area.tile), GetWaterRegionY(tile_area.tile));
205
206 const size_t max_element_width = std::to_string(this->number_of_patches).size();
207
208 std::array<int, 16> traversability_NW{0};
209 for (auto bitIndex : SetBitIterator(edge_traversability_bits[DIAGDIR_NW])) *(traversability_NW.rbegin() + bitIndex) = 1;
210 Debug(map, 9, " {:{}}", fmt::join(traversability_NW, " "), max_element_width);
211 Debug(map, 9, " +{:->{}}+", "", WATER_REGION_EDGE_LENGTH * (max_element_width + 1) + 1);
212
213 for (int y = 0; y < WATER_REGION_EDGE_LENGTH; ++y) {
214 std::string line{};
215 for (int x = 0; x < WATER_REGION_EDGE_LENGTH; ++x) {
216 const auto label = this->GetLabel(TILE_ADDXY(tile_area.tile, x, y));
217 const std::string label_str = label == INVALID_WATER_REGION_PATCH ? "." : std::to_string(label);
218 line = fmt::format("{:{}}", label_str, max_element_width) + " " + line;
219 }
220 Debug(map, 9, "{} | {}| {}", GB(this->edge_traversability_bits[DIAGDIR_SW], y, 1), line, GB(this->edge_traversability_bits[DIAGDIR_NE], y, 1));
221 }
222
223 Debug(map, 9, " +{:->{}}+", "", WATER_REGION_EDGE_LENGTH * (max_element_width + 1) + 1);
224 std::array<int, 16> traversability_SE{0};
225 for (auto bitIndex : SetBitIterator(edge_traversability_bits[DIAGDIR_SE])) *(traversability_SE.rbegin() + bitIndex) = 1;
226 Debug(map, 9, " {:{}}", fmt::join(traversability_SE, " "), max_element_width);
227 }
228 };
229
230 std::vector<WaterRegion> _water_regions;
231
232 TileIndex GetTileIndexFromLocalCoordinate(int region_x, int region_y, int local_x, int local_y)
233 {
234 assert(local_x >= 0 && local_x < WATER_REGION_EDGE_LENGTH);
235 assert(local_y >= 0 && local_y < WATER_REGION_EDGE_LENGTH);
236 return TileXY(WATER_REGION_EDGE_LENGTH * region_x + local_x, WATER_REGION_EDGE_LENGTH * region_y + local_y);
237 }
238
239 TileIndex GetEdgeTileCoordinate(int region_x, int region_y, DiagDirection side, int x_or_y)
240 {
241 assert(x_or_y >= 0 && x_or_y < WATER_REGION_EDGE_LENGTH);
242 switch (side) {
243 case DIAGDIR_NE: return GetTileIndexFromLocalCoordinate(region_x, region_y, 0, x_or_y);
244 case DIAGDIR_SW: return GetTileIndexFromLocalCoordinate(region_x, region_y, WATER_REGION_EDGE_LENGTH - 1, x_or_y);
245 case DIAGDIR_NW: return GetTileIndexFromLocalCoordinate(region_x, region_y, x_or_y, 0);
246 case DIAGDIR_SE: return GetTileIndexFromLocalCoordinate(region_x, region_y, x_or_y, WATER_REGION_EDGE_LENGTH - 1);
247 default: NOT_REACHED();
248 }
249 }
250
251 WaterRegion &GetUpdatedWaterRegion(uint16_t region_x, uint16_t region_y)
252 {
253 WaterRegion &result = _water_regions[GetWaterRegionIndex(region_x, region_y)];
254 result.UpdateIfNotInitialized();
255 return result;
256 }
257
258 WaterRegion &GetUpdatedWaterRegion(TileIndex tile)
259 {
260 WaterRegion &result = _water_regions[GetWaterRegionIndex(tile)];
261 result.UpdateIfNotInitialized();
262 return result;
263 }
264
269 TWaterRegionIndex GetWaterRegionIndex(const WaterRegionDesc &water_region)
270 {
271 return GetWaterRegionIndex(water_region.x, water_region.y);
272 }
273
278 int CalculateWaterRegionPatchHash(const WaterRegionPatchDesc &water_region_patch)
279 {
280 return water_region_patch.label | GetWaterRegionIndex(water_region_patch) << 8;
281 }
282
288 TileIndex GetWaterRegionCenterTile(const WaterRegionDesc &water_region)
289 {
290 return TileXY(water_region.x * WATER_REGION_EDGE_LENGTH + (WATER_REGION_EDGE_LENGTH / 2), water_region.y * WATER_REGION_EDGE_LENGTH + (WATER_REGION_EDGE_LENGTH / 2));
291 }
292
297 WaterRegionDesc GetWaterRegionInfo(TileIndex tile)
298 {
299 return WaterRegionDesc{ GetWaterRegionX(tile), GetWaterRegionY(tile) };
300 }
301
306 WaterRegionPatchDesc GetWaterRegionPatchInfo(TileIndex tile)
307 {
308 WaterRegion &region = GetUpdatedWaterRegion(tile);
309 return WaterRegionPatchDesc{ GetWaterRegionX(tile), GetWaterRegionY(tile), region.GetLabel(tile)};
310 }
311
316 void InvalidateWaterRegion(TileIndex tile)
317 {
318 if (!IsValidTile(tile)) return;
319 const int water_region_index = GetWaterRegionIndex(tile);
320 _water_regions[water_region_index].Invalidate();
321
322 /* When updating the water region we look into the first tile of adjacent water regions to determine edge
323 * traversability. This means that if we invalidate any region edge tiles we might also change the traversability
324 * of the adjacent region. This code ensures the adjacent regions also get invalidated in such a case. */
325 for (DiagDirection side = DIAGDIR_BEGIN; side < DIAGDIR_END; side++) {
326 const int adjacent_region_index = GetWaterRegionIndex(TileAddByDiagDir(tile, side));
327 if (adjacent_region_index != water_region_index) _water_regions[adjacent_region_index].Invalidate();
328 }
329 }
330
338 static inline void VisitAdjacentWaterRegionPatchNeighbors(const WaterRegionPatchDesc &water_region_patch, DiagDirection side, TVisitWaterRegionPatchCallBack &func)
339 {
340 if (water_region_patch.label == INVALID_WATER_REGION_PATCH) return;
341
342 const WaterRegion &current_region = GetUpdatedWaterRegion(water_region_patch.x, water_region_patch.y);
343
344 const TileIndexDiffC offset = TileIndexDiffCByDiagDir(side);
345 const int nx = water_region_patch.x + offset.x;
346 const int ny = water_region_patch.y + offset.y;
347
348 if (nx < 0 || ny < 0 || nx >= GetWaterRegionMapSizeX() || ny >= GetWaterRegionMapSizeY()) return;
349
350 const WaterRegion &neighboring_region = GetUpdatedWaterRegion(nx, ny);
351 const DiagDirection opposite_side = ReverseDiagDir(side);
352
353 /* Indicates via which local x or y coordinates (depends on the "side" parameter) we can cross over into the adjacent region. */
354 const TWaterRegionTraversabilityBits traversability_bits = current_region.GetEdgeTraversabilityBits(side)
355 & neighboring_region.GetEdgeTraversabilityBits(opposite_side);
356 if (traversability_bits == 0) return;
357
358 if (current_region.NumberOfPatches() == 1 && neighboring_region.NumberOfPatches() == 1) {
359 func(WaterRegionPatchDesc{ nx, ny, FIRST_REGION_LABEL }); // No further checks needed because we know there is just one patch for both adjacent regions
360 return;
361 }
362
363 /* Multiple water patches can be reached from the current patch. Check each edge tile individually. */
364 static std::vector<TWaterRegionPatchLabel> unique_labels; // static and vector-instead-of-map for performance reasons
365 unique_labels.clear();
366 for (int x_or_y = 0; x_or_y < WATER_REGION_EDGE_LENGTH; ++x_or_y) {
367 if (!HasBit(traversability_bits, x_or_y)) continue;
368
369 const TileIndex current_edge_tile = GetEdgeTileCoordinate(water_region_patch.x, water_region_patch.y, side, x_or_y);
370 const TWaterRegionPatchLabel current_label = current_region.GetLabel(current_edge_tile);
371 if (current_label != water_region_patch.label) continue;
372
373 const TileIndex neighbor_edge_tile = GetEdgeTileCoordinate(nx, ny, opposite_side, x_or_y);
374 const TWaterRegionPatchLabel neighbor_label = neighboring_region.GetLabel(neighbor_edge_tile);
375 assert(neighbor_label != INVALID_WATER_REGION_PATCH);
376 if (std::find(unique_labels.begin(), unique_labels.end(), neighbor_label) == unique_labels.end()) unique_labels.push_back(neighbor_label);
377 }
378 for (TWaterRegionPatchLabel unique_label : unique_labels) func(WaterRegionPatchDesc{ nx, ny, unique_label });
379 }
380
387 void VisitWaterRegionPatchNeighbors(const WaterRegionPatchDesc &water_region_patch, TVisitWaterRegionPatchCallBack &callback)
388 {
389 if (water_region_patch.label == INVALID_WATER_REGION_PATCH) return;
390
391 const WaterRegion &current_region = GetUpdatedWaterRegion(water_region_patch.x, water_region_patch.y);
392
393 /* Visit adjacent water region patches in each cardinal direction */
394 for (DiagDirection side = DIAGDIR_BEGIN; side < DIAGDIR_END; side++) VisitAdjacentWaterRegionPatchNeighbors(water_region_patch, side, callback);
395
396 /* Visit neigboring water patches accessible via cross-region aqueducts */
397 if (current_region.HasCrossRegionAqueducts()) {
398 for (const TileIndex tile : current_region) {
399 if (GetWaterRegionPatchInfo(tile) == water_region_patch && IsAqueductTile(tile)) {
400 const TileIndex other_end_tile = GetOtherBridgeEnd(tile);
401 if (GetWaterRegionIndex(tile) != GetWaterRegionIndex(other_end_tile)) callback(GetWaterRegionPatchInfo(other_end_tile));
402 }
403 }
404 }
405 }
406
410 void AllocateWaterRegions()
411 {
412 _water_regions.clear();
413 _water_regions.reserve(static_cast<size_t>(GetWaterRegionMapSizeX()) * GetWaterRegionMapSizeY());
414
415 Debug(map, 2, "Allocating {} x {} water regions", GetWaterRegionMapSizeX(), GetWaterRegionMapSizeY());
416
417 for (int region_y = 0; region_y < GetWaterRegionMapSizeY(); region_y++) {
418 for (int region_x = 0; region_x < GetWaterRegionMapSizeX(); region_x++) {
419 _water_regions.emplace_back(region_x, region_y);
420 }
421 }
422 }
423
424 void PrintWaterRegionDebugInfo(TileIndex tile)
425 {
426 GetUpdatedWaterRegion(tile).PrintDebugInfo();
427 }
TileY
static debug_inline uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:437
TileIndexDiffCByDiagDir
TileIndexDiffC TileIndexDiffCByDiagDir(DiagDirection dir)
Returns the TileIndexDiffC offset from a DiagDirection.
Definition: map_func.h:490
DIAGDIR_SE
@ DIAGDIR_SE
Southeast.
Definition: direction_type.h:76
transport_type.h
SetBit
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
GetOtherBridgeEnd
TileIndex GetOtherBridgeEnd(TileIndex tile)
Starting at one bridge end finds the other bridge end.
Definition: bridge_map.cpp:59
WaterRegion::ForceUpdate
void ForceUpdate()
Performs the connected component labeling and other data gathering.
Definition: water_regions.cpp:125
WaterRegionPatchDesc
Describes a single interconnected patch of water within a particular water region.
Definition: water_regions.h:26
tunnelbridge_map.h
GB
constexpr static debug_inline uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
WaterRegion::UpdateIfNotInitialized
void UpdateIfNotInitialized()
Updates the patch labels and other data, but only if the region is not yet initialized.
Definition: water_regions.cpp:197
DIAGDIR_END
@ DIAGDIR_END
Used for iterations.
Definition: direction_type.h:79
map_func.h
DiagDirToAxis
Axis DiagDirToAxis(DiagDirection d)
Convert a DiagDirection to the axis.
Definition: direction_func.h:214
ship.h
WaterRegionPatchDesc::y
int y
The Y coordinate of the water region, i.e. Y=2 is the 3rd water region along the Y-axis.
Definition: water_regions.h:29
GetWaterRegionCenterTile
TileIndex GetWaterRegionCenterTile(const WaterRegionDesc &water_region)
Returns the center tile of a particular water region.
Definition: water_regions.cpp:288
TRANSPORT_WATER
@ TRANSPORT_WATER
Transport over water.
Definition: transport_type.h:29
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
DIAGDIR_NW
@ DIAGDIR_NW
Northwest.
Definition: direction_type.h:78
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
CFollowTrackT::m_is_bridge
bool m_is_bridge
last turn passed bridge ramp
Definition: follow_track.hpp:47
GetTileTrackStatus
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
Definition: landscape.cpp:556
OrthogonalTileIterator
Iterator to iterate over a tile area (rectangle) of the map.
Definition: tilearea_type.h:185
DistanceManhattan
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:159
DIAGDIR_SW
@ DIAGDIR_SW
Southwest.
Definition: direction_type.h:77
GetWaterRegionPatchInfo
WaterRegionPatchDesc GetWaterRegionPatchInfo(TileIndex tile)
Returns basic water region patch information for the provided tile.
Definition: water_regions.cpp:306
GetWaterRegionInfo
WaterRegionDesc GetWaterRegionInfo(TileIndex tile)
Returns basic water region information for the provided tile.
Definition: water_regions.cpp:297
TrackBitsToTrackdirBits
TrackdirBits TrackBitsToTrackdirBits(TrackBits bits)
Converts TrackBits to TrackdirBits while allowing both directions.
Definition: track_func.h:319
SetBitIterator
Iterable ensemble of each set bit in a value.
Definition: bitmath_func.hpp:282
WaterRegion
Represents a square section of the map of a fixed size.
Definition: water_regions.cpp:49
WaterRegion::GetLocalIndex
int GetLocalIndex(TileIndex tile) const
Returns the local index of the tile within the region.
Definition: water_regions.cpp:65
TRACKDIR_BIT_NONE
@ TRACKDIR_BIT_NONE
No track build.
Definition: track_type.h:99
OrthogonalTileArea::begin
OrthogonalTileIterator begin() const
Returns an iterator to the beginning of the tile area.
Definition: tilearea.cpp:153
ReverseDiagDir
DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
Definition: direction_func.h:118
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:18
water_regions.h
IsBridgeTile
bool IsBridgeTile(Tile t)
checks if there is a bridge on this tile
Definition: bridge_map.h:35
follow_track.hpp
VisitWaterRegionPatchNeighbors
void VisitWaterRegionPatchNeighbors(const WaterRegionPatchDesc &water_region_patch, TVisitWaterRegionPatchCallBack &callback)
Calls the provided callback function on all accessible water region patches in each cardinal directio...
Definition: water_regions.cpp:387
OrthogonalTileArea::end
OrthogonalTileIterator end() const
Returns an iterator to the end of the tile area.
Definition: tilearea.cpp:162
WaterRegion::GetEdgeTraversabilityBits
TWaterRegionTraversabilityBits GetEdgeTraversabilityBits(DiagDirection side) const
Returns a set of bits indicating whether an edge tile on a particular side is traversable or not.
Definition: water_regions.cpp:94
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition: direction_type.h:73
TrackStatusToTrackBits
TrackBits TrackStatusToTrackBits(TrackStatus ts)
Returns the present-track-information of a TrackStatus.
Definition: track_func.h:363
stdafx.h
WaterRegionDesc
Describes a single square water region.
Definition: water_regions.h:40
landscape.h
CalculateWaterRegionPatchHash
int CalculateWaterRegionPatchHash(const WaterRegionPatchDesc &water_region_patch)
Calculates a number that uniquely identifies the provided water region patch.
Definition: water_regions.cpp:278
WaterRegionDesc::y
int y
The Y coordinate of the water region, i.e. Y=2 is the 3rd water region along the Y-axis.
Definition: water_regions.h:43
GetWaterRegionIndex
TWaterRegionIndex GetWaterRegionIndex(const WaterRegionDesc &water_region)
Returns the index of the water region.
Definition: water_regions.cpp:269
IsValidTile
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition: tile_map.h:161
TileIndexDiffC
A pair-construct of a TileIndexDiff.
Definition: map_type.h:31
Map::SizeX
static debug_inline uint SizeX()
Get the size of the map along the X.
Definition: map_func.h:270
tilearea_type.h
DiagdirBetweenTiles
DiagDirection DiagdirBetweenTiles(TileIndex tile_from, TileIndex tile_to)
Determines the DiagDirection to get from one tile to another.
Definition: map_func.h:616
OrthogonalTileArea::tile
TileIndex tile
The base tile of the area.
Definition: tilearea_type.h:19
GetTunnelBridgeTransportType
TransportType GetTunnelBridgeTransportType(Tile t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
Definition: tunnelbridge_map.h:39
InvalidateWaterRegion
void InvalidateWaterRegion(TileIndex tile)
Marks the water region that tile is part of as invalid.
Definition: water_regions.cpp:316
DIAGDIR_BEGIN
@ DIAGDIR_BEGIN
Used for iterations.
Definition: direction_type.h:74
track_func.h
AllocateWaterRegions
void AllocateWaterRegions()
Allocates the appropriate amount of water regions for the current map size.
Definition: water_regions.cpp:410
CFollowTrackT::m_new_tile
TileIndex m_new_tile
the new tile (the vehicle has entered)
Definition: follow_track.hpp:43
AXIS_X
@ AXIS_X
The X axis.
Definition: direction_type.h:117
TILE_ADDXY
#define TILE_ADDXY(tile, x, y)
Adds a given offset to a tile.
Definition: map_func.h:480
TileIndexDiffC::y
int16_t y
The y value of the coordinate.
Definition: map_type.h:33
TrackBits
TrackBits
Allow incrementing of Track variables.
Definition: track_type.h:35
WaterRegion::tile_patch_labels
std::unique_ptr< TWaterRegionPatchLabelArray > tile_patch_labels
Tile patch labels, this may be nullptr in the following trivial cases: region is invalid,...
Definition: water_regions.cpp:57
WaterRegionPatchDesc::label
TWaterRegionPatchLabel label
Unique label identifying the patch within the region.
Definition: water_regions.h:30
CFollowTrackT::Follow
bool Follow(TileIndex old_tile, Trackdir old_td)
main follower routine.
Definition: follow_track.hpp:119
TileXY
static debug_inline TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition: map_func.h:385
WaterRegion::GetLabel
TWaterRegionPatchLabel GetLabel(TileIndex tile) const
Returns the patch label that was assigned to the tile.
Definition: water_regions.cpp:112
WaterRegionDesc::x
int x
The X coordinate of the water region, i.e. X=2 is the 3rd water region along the X-axis.
Definition: water_regions.h:42
Trackdir
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:67
TrackdirBits
TrackdirBits
Allow incrementing of Trackdir variables.
Definition: track_type.h:98
TileX
static debug_inline uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:427
VisitAdjacentWaterRegionPatchNeighbors
static void VisitAdjacentWaterRegionPatchNeighbors(const WaterRegionPatchDesc &water_region_patch, DiagDirection side, TVisitWaterRegionPatchCallBack &func)
Calls the provided callback function for all water region patches accessible from one particular side...
Definition: water_regions.cpp:338
DIAGDIR_NE
@ DIAGDIR_NE
Northeast, upper right on your monitor.
Definition: direction_type.h:75
WaterRegion::HasCrossRegionAqueducts
bool HasCrossRegionAqueducts() const
Definition: water_regions.cpp:105
TileAddByDiagDir
TileIndex TileAddByDiagDir(TileIndex tile, DiagDirection dir)
Adds a DiagDir to a tile.
Definition: map_func.h:604
TileIndexDiffC::x
int16_t x
The x value of the coordinate.
Definition: map_type.h:32
WaterRegion::NumberOfPatches
int NumberOfPatches() const
Definition: water_regions.cpp:100
CFollowTrackT
Track follower helper template class (can serve pathfinders and vehicle controllers).
Definition: follow_track.hpp:28
Map::SizeY
static uint SizeY()
Get the size of the map along the Y.
Definition: map_func.h:279
OrthogonalTileArea::Contains
bool Contains(TileIndex tile) const
Does this tile area contain a tile?
Definition: tilearea.cpp:104
debug.h
WaterRegionPatchDesc::x
int x
The X coordinate of the water region, i.e. X=2 is the 3rd water region along the X-axis.
Definition: water_regions.h:28
HasBit
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103