OpenTTD Source 20261112-master-gbcbec5e63f
TileAreaWrapper< Titer, Tarea > Class Template Reference

Tile area wrapper. More...

#include <tilearea_wrapper.h>

Data Structures

struct  begin_visitor
 Visitor to call the underlying tile area's begin method. More...
struct  contains_visitor
 Visitor to call the underlying tile area's contains method. More...

Public Types

using iterator = Titer
 The iterator type.

Public Member Functions

template<typename T>
 TileAreaWrapper (const T &area)
 Construct a new tile area wrapper.
template<typename T>
 TileAreaWrapper (T &&area)
 Construct a new tile area wrapper.
iterator begin () const
 Returns an iterator to the start of the tile area.
std::default_sentinel_t end () const
 Returns an iterator to the end of the tile area.
bool Contains (TileIndex tile) const
 Test if a tile is part of the tile area.

Private Attributes

std::variant< Tarea... > area
 The underlying tile area.

Detailed Description

template<TileIterator Titer, typename... Tarea>
class TileAreaWrapper< Titer, Tarea >

Tile area wrapper.

Template Parameters
TiterTile iterator types this wrapper supports.
TareaTile area types this wrapper supports.

Definition at line 122 of file tilearea_wrapper.h.

Member Typedef Documentation

◆ iterator

template<TileIterator Titer, typename... Tarea>
using TileAreaWrapper< Titer, Tarea >::iterator = Titer

The iterator type.

Definition at line 124 of file tilearea_wrapper.h.

Constructor & Destructor Documentation

◆ TileAreaWrapper() [1/2]

template<TileIterator Titer, typename... Tarea>
template<typename T>
TileAreaWrapper< Titer, Tarea >::TileAreaWrapper ( const T & area)
inline

Construct a new tile area wrapper.

Parameters
areaThe underlying tile area.

Definition at line 131 of file tilearea_wrapper.h.

◆ TileAreaWrapper() [2/2]

template<TileIterator Titer, typename... Tarea>
template<typename T>
TileAreaWrapper< Titer, Tarea >::TileAreaWrapper ( T && area)
inline

Construct a new tile area wrapper.

Parameters
areaThe underlying tile area.

Definition at line 140 of file tilearea_wrapper.h.

Member Function Documentation

◆ begin()

template<TileIterator Titer, typename... Tarea>
iterator TileAreaWrapper< Titer, Tarea >::begin ( ) const
inline

Returns an iterator to the start of the tile area.

Returns
The TileAreaWrapper::iterator.

Definition at line 148 of file tilearea_wrapper.h.

◆ Contains()

template<TileIterator Titer, typename... Tarea>
bool TileAreaWrapper< Titer, Tarea >::Contains ( TileIndex tile) const
inline

Test if a tile is part of the tile area.

Parameters
tileTile to check.
Returns
true iff the tile is in this area.

Definition at line 167 of file tilearea_wrapper.h.

◆ end()

template<TileIterator Titer, typename... Tarea>
std::default_sentinel_t TileAreaWrapper< Titer, Tarea >::end ( ) const
inline

Returns an iterator to the end of the tile area.

Returns
The iterator.

Definition at line 157 of file tilearea_wrapper.h.

Field Documentation

◆ area

template<TileIterator Titer, typename... Tarea>
std::variant<Tarea...> TileAreaWrapper< Titer, Tarea >::area
private

The documentation for this class was generated from the following file: