OpenTTD Source  20241108-master-g80f628063a
tilearea_type.h
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 #ifndef TILEAREA_TYPE_H
11 #define TILEAREA_TYPE_H
12 
13 #include "map_func.h"
14 
16 
20  uint16_t w;
21  uint16_t h;
22 
29  OrthogonalTileArea(TileIndex tile = INVALID_TILE, uint16_t w = 0, uint16_t h = 0) : tile(tile), w(w), h(h)
30  {
31  }
32 
34 
35  void Add(TileIndex to_add);
36 
40  void Clear()
41  {
42  this->tile = INVALID_TILE;
43  this->w = 0;
44  this->h = 0;
45  }
46 
47  bool Intersects(const OrthogonalTileArea &ta) const;
48 
49  bool Contains(TileIndex tile) const;
50 
51  OrthogonalTileArea &Expand(int rad);
52 
53  void ClampToMap();
54 
60  {
61  return TileAddXY(this->tile, this->w / 2, this->h / 2);
62  }
63 
65 
67 };
68 
71 
73  int16_t a;
74  int16_t b;
75 
82  DiagonalTileArea(TileIndex tile = INVALID_TILE, int16_t a = 0, int16_t b = 0) : tile(tile), a(a), b(b)
83  {
84  }
85 
87 
91  void Clear()
92  {
93  this->tile = INVALID_TILE;
94  this->a = 0;
95  this->b = 0;
96  }
97 
98  bool Contains(TileIndex tile) const;
99 };
100 
103 
106 protected:
108 
114  {
115  }
116 
117 public:
119  virtual ~TileIterator()
120  {
121  }
122 
127  inline operator TileIndex () const
128  {
129  return this->tile;
130  }
131 
136  inline TileIndex operator *() const
137  {
138  return this->tile;
139  }
140 
144  virtual TileIterator& operator ++() = 0;
145 
149  virtual std::unique_ptr<TileIterator> Clone() const = 0;
150 
154  bool operator ==(const TileIterator &rhs) const
155  {
156  return this->tile == rhs.tile;
157  }
161  bool operator !=(const TileIterator &rhs) const
162  {
163  return this->tile != rhs.tile;
164  }
165 
169  bool operator ==(const TileIndex &rhs) const
170  {
171  return this->tile == rhs;
172  }
176  bool operator !=(const TileIndex &rhs) const
177  {
178  return this->tile != rhs;
179  }
180 
181  static std::unique_ptr<TileIterator> Create(TileIndex corner1, TileIndex corner2, bool diagonal);
182 };
183 
186 private:
187  int w;
188  int x;
189  int y;
190 
191 public:
196  OrthogonalTileIterator(const OrthogonalTileArea &ta) : TileIterator(ta.w == 0 || ta.h == 0 ? INVALID_TILE : ta.tile), w(ta.w), x(ta.w), y(ta.h)
197  {
198  }
199 
206  {
207  *this = OrthogonalTileIterator(OrthogonalTileArea(corner1, corner2));
208  }
209 
213  inline TileIterator& operator ++() override
214  {
215  assert(this->tile != INVALID_TILE);
216 
217  if (--this->x > 0) {
218  this->tile++;
219  } else if (--this->y > 0) {
220  this->x = this->w;
221  this->tile += TileDiffXY(1 - this->w, 1);
222  } else {
223  this->tile = INVALID_TILE;
224  }
225  return *this;
226  }
227 
228  std::unique_ptr<TileIterator> Clone() const override
229  {
230  return std::make_unique<OrthogonalTileIterator>(*this);
231  }
232 };
233 
236 private:
237  uint base_x;
238  uint base_y;
239  int a_cur;
240  int b_cur;
241  int a_max;
242  int b_max;
243 
244 public:
245 
251  TileIterator(ta.tile), base_x(TileX(ta.tile)), base_y(TileY(ta.tile)), a_cur(0), b_cur(0), a_max(ta.a), b_max(ta.b)
252  {
253  }
254 
261  {
262  *this = DiagonalTileIterator(DiagonalTileArea(corner1, corner2));
263  }
264 
265  TileIterator& operator ++() override;
266 
267  std::unique_ptr<TileIterator> Clone() const override
268  {
269  return std::make_unique<DiagonalTileIterator>(*this);
270  }
271 };
272 
273 #endif /* TILEAREA_TYPE_H */
Iterator to iterate over a diagonal area of the map.
TileIterator & operator++() override
Move ourselves to the next tile in the rectangle on the map.
Definition: tilearea.cpp:234
DiagonalTileIterator(const DiagonalTileArea &ta)
Construct the iterator.
uint base_x
The base tile x coordinate from where the iterating happens.
int a_max
The (rotated) x coordinate of the end of the iteration.
DiagonalTileIterator(TileIndex corner1, TileIndex corner2)
Construct the iterator.
int b_max
The (rotated) y coordinate of the end of the iteration.
std::unique_ptr< TileIterator > Clone() const override
Allocate a new iterator that is a copy of this one.
int b_cur
The current (rotated) y coordinate of the iteration.
int a_cur
The current (rotated) x coordinate of the iteration.
uint base_y
The base tile y coordinate from where the iterating happens.
Iterator to iterate over a tile area (rectangle) of the map.
OrthogonalTileIterator(TileIndex corner1, TileIndex corner2)
Construct the iterator.
OrthogonalTileIterator(const OrthogonalTileArea &ta)
Construct the iterator.
int y
The current 'y' position in the rectangle.
int w
The width of the iterated area.
std::unique_ptr< TileIterator > Clone() const override
Allocate a new iterator that is a copy of this one.
TileIterator & operator++() override
Move ourselves to the next tile in the rectangle on the map.
int x
The current 'x' position in the rectangle.
Base class for tile iterators.
TileIndex operator*() const
Get the tile we are currently at.
TileIterator(TileIndex tile=INVALID_TILE)
Initialise the iterator starting at this tile.
virtual std::unique_ptr< TileIterator > Clone() const =0
Allocate a new iterator that is a copy of this one.
virtual ~TileIterator()
Some compilers really like this.
TileIndex tile
The current tile we are at.
virtual TileIterator & operator++()=0
Move ourselves to the next tile in the rectangle on the map.
bool operator==(const TileIterator &rhs) const
Equality comparison.
bool operator!=(const TileIterator &rhs) const
Inequality comparison.
static std::unique_ptr< TileIterator > Create(TileIndex corner1, TileIndex corner2, bool diagonal)
Create either an OrthogonalTileIterator or DiagonalTileIterator given the diagonal parameter.
Definition: tilearea.cpp:291
Functions related to maps.
TileIndex TileAddXY(TileIndex tile, int x, int y)
Adds a given offset to a tile.
Definition: map_func.h:467
TileIndexDiff TileDiffXY(int x, int y)
Calculates an offset for the given coordinate(-offset).
Definition: map_func.h:389
static debug_inline uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:425
static debug_inline uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:415
Represents a diagonal tile area.
Definition: tilearea_type.h:70
void Clear()
Clears the TileArea by making the tile invalid and setting a and b to 0.
Definition: tilearea_type.h:91
int16_t b
Extent in diagonal "y" direction (may be negative to signify the area stretches upwards)
Definition: tilearea_type.h:74
bool Contains(TileIndex tile) const
Does this tile area contain a tile?
Definition: tilearea.cpp:205
int16_t a
Extent in diagonal "x" direction (may be negative to signify the area stretches to the left)
Definition: tilearea_type.h:73
TileIndex tile
Base tile of the area.
Definition: tilearea_type.h:72
DiagonalTileArea(TileIndex tile=INVALID_TILE, int16_t a=0, int16_t b=0)
Construct this tile area with some set values.
Definition: tilearea_type.h:82
Represents the covered area of e.g.
Definition: tilearea_type.h:18
OrthogonalTileIterator end() const
Returns an iterator to the end of the tile area.
Definition: tilearea.cpp:162
void ClampToMap()
Clamp the tile area to map borders.
Definition: tilearea.cpp:142
bool Contains(TileIndex tile) const
Does this tile area contain a tile?
Definition: tilearea.cpp:104
uint16_t w
The width of the area.
Definition: tilearea_type.h:20
void Add(TileIndex to_add)
Add a single tile to a tile area; enlarge if needed.
Definition: tilearea.cpp:43
bool Intersects(const OrthogonalTileArea &ta) const
Does this tile area intersect with another?
Definition: tilearea.cpp:75
TileIndex GetCenterTile() const
Get the center tile.
Definition: tilearea_type.h:59
void Clear()
Clears the 'tile area', i.e.
Definition: tilearea_type.h:40
TileIndex tile
The base tile of the area.
Definition: tilearea_type.h:19
uint16_t h
The height of the area.
Definition: tilearea_type.h:21
OrthogonalTileIterator begin() const
Returns an iterator to the beginning of the tile area.
Definition: tilearea.cpp:153
OrthogonalTileArea(TileIndex tile=INVALID_TILE, uint16_t w=0, uint16_t h=0)
Construct this tile area with some set values.
Definition: tilearea_type.h:29
OrthogonalTileArea & Expand(int rad)
Expand a tile area by rad tiles in each direction, keeping within map bounds.
Definition: tilearea.cpp:123
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:95
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition: tile_type.h:87
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.