water_regions.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef WATER_REGIONS_H
#define WATER_REGIONS_H
 
#include "tile_type.h"
#include "map_func.h"
 
using TWaterRegionPatchLabel = uint8_t;
using TWaterRegionIndex = uint;
 
constexpr int WATER_REGION_EDGE_LENGTH = 16;
constexpr int WATER_REGION_NUMBER_OF_TILES = WATER_REGION_EDGE_LENGTH * WATER_REGION_EDGE_LENGTH;
constexpr TWaterRegionPatchLabel INVALID_WATER_REGION_PATCH = 0;
 
struct WaterRegionPatchDesc
{
  int x; 
  int y; 
  TWaterRegionPatchLabel label; 
 
  bool operator==(const WaterRegionPatchDesc &other) const { return x == other.x && y == other.y && label == other.label; }
  bool operator!=(const WaterRegionPatchDesc &other) const { return !(*this == other); }
};
 
 
struct WaterRegionDesc
{
  int x; 
  int y; 
 
  WaterRegionDesc(const int x, const int y) : x(x), y(y) {}
  WaterRegionDesc(const WaterRegionPatchDesc &water_region_patch) : x(water_region_patch.x), y(water_region_patch.y) {}
 
  bool operator==(const WaterRegionDesc &other) const { return x == other.x && y == other.y; }
  bool operator!=(const WaterRegionDesc &other) const { return !(*this == other); }
};
 
TWaterRegionIndex GetWaterRegionIndex(const WaterRegionDesc &water_region);
 
int CalculateWaterRegionPatchHash(const WaterRegionPatchDesc &water_region_patch);
 
TileIndex GetWaterRegionCenterTile(const WaterRegionDesc &water_region);
 
WaterRegionDesc GetWaterRegionInfo(TileIndex tile);
WaterRegionPatchDesc GetWaterRegionPatchInfo(TileIndex tile);
 
void InvalidateWaterRegion(TileIndex tile);
 
using TVisitWaterRegionPatchCallBack = std::function<void(const WaterRegionPatchDesc &)>;
void VisitWaterRegionPatchNeighbors(const WaterRegionPatchDesc &water_region_patch, TVisitWaterRegionPatchCallBack &callback);
 
void AllocateWaterRegions();
 
void PrintWaterRegionDebugInfo(TileIndex tile);
 
#endif /* WATER_REGIONS_H */