TileIterator Class Reference

Base class for tile iterators. More...

#include <tilearea_type.h>

Inheritance diagram for TileIterator:

Public Member Functions
virtual	~TileIterator ()=default
	Ensure the destructor of the sub classes are called as well.
	operator TileIndex () const
	Get the tile we are currently at.
TileIndex	operator* () const
	Get the tile we are currently at.
virtual TileIterator &	operator++ ()=0
	Move ourselves to the next tile in the rectangle on the map.
virtual std::unique_ptr< TileIterator >	Clone () const =0
	Allocate a new iterator that is a copy of this one.
bool	operator== (const TileIterator &rhs) const
	Equality comparison.
bool	operator== (const TileIndex &rhs) const
	Equality comparison.

Static Public Member Functions
static std::unique_ptr< TileIterator >	Create (TileIndex corner1, TileIndex corner2, bool diagonal)
	Create either an OrthogonalTileIterator or DiagonalTileIterator given the diagonal parameter.

Protected Member Functions
	TileIterator (TileIndex tile=INVALID_TILE)
	Initialise the iterator starting at this tile.

Protected Attributes
TileIndex	tile
	The current tile we are at.

Detailed Description

Base class for tile iterators.

Definition at line 105 of file tilearea_type.h.

Constructor & Destructor Documentation

TileIterator()

TileIterator::TileIterator ( TileIndex tile = INVALID_TILE )

inlineprotected

Initialise the iterator starting at this tile.

Parameters

tile	The tile we start iterating from.

Definition at line 113 of file tilearea_type.h.

References INVALID_TILE, and tile.

Referenced by AirportTileTableIterator::AirportTileTableIterator(), DiagonalTileIterator::DiagonalTileIterator(), AirportTileIterator::operator++(), AirportTileTableIterator::operator++(), BitmapTileIterator::operator++(), DiagonalTileIterator::operator++(), OrthogonalTileIterator::operator++(), operator++(), operator==(), and OrthogonalTileIterator::OrthogonalTileIterator().

Member Function Documentation

Clone()

virtual std::unique_ptr< TileIterator > TileIterator::Clone ( ) const

pure virtual

Allocate a new iterator that is a copy of this one.

Returns

A clone of this iterator.

Implemented in AirportTileIterator, AirportTileTableIterator, BitmapTileIterator, DiagonalTileIterator, and OrthogonalTileIterator.

Create()

std::unique_ptr< TileIterator > TileIterator::Create ( TileIndex corner1, TileIndex corner2, bool diagonal )

static

Create either an OrthogonalTileIterator or DiagonalTileIterator given the diagonal parameter.

Parameters

corner1	Tile from where to begin iterating.
corner2	Tile where to end the iterating.
diagonal	Whether to create a DiagonalTileIterator or OrthogonalTileIterator.

Returns

unique_ptr to the allocated TileIterator.

Definition at line 292 of file tilearea.cpp.

Referenced by CmdBuildCanal(), CmdBuildObjectArea(), CmdClearArea(), CmdConvertRail(), CmdConvertRoad(), CmdLevelLand(), CmdPlaceHouseArea(), and CmdPlantTree().

operator TileIndex()

TileIterator::operator TileIndex ( ) const

inline

Get the tile we are currently at.

Returns

The tile we are at, or INVALID_TILE when we're done.

Definition at line 125 of file tilearea_type.h.

operator*()

TileIndex TileIterator::operator* ( ) const

inline

Get the tile we are currently at.

Returns

The tile we are at, or INVALID_TILE when we're done.

Definition at line 134 of file tilearea_type.h.

operator++()

virtual TileIterator & TileIterator::operator++ ( )

pure virtual

Move ourselves to the next tile in the rectangle on the map.

Returns

Reference to this iterator.

Implemented in AirportTileIterator, AirportTileTableIterator, BitmapTileIterator, DiagonalTileIterator, and OrthogonalTileIterator.

References TileIterator().

operator==() [1/2]

bool TileIterator::operator== ( const TileIndex & rhs ) const

inline

Equality comparison.

Parameters

rhs	The other iterator to compare to.

Returns

true iff the tile of both iterators is the same.

Definition at line 166 of file tilearea_type.h.

operator==() [2/2]

bool TileIterator::operator== ( const TileIterator & rhs ) const

inline

Equality comparison.

Parameters

rhs	The other iterator to compare to.

Returns

true iff the tile of both iterators is the same.

Definition at line 156 of file tilearea_type.h.

References tile, and TileIterator().

Field Documentation

tile

TileIndex TileIterator::tile

protected

The current tile we are at.

Definition at line 107 of file tilearea_type.h.

Referenced by DiagonalTileIterator::DiagonalTileIterator(), AirportTileIterator::operator++(), AirportTileTableIterator::operator++(), DiagonalTileIterator::operator++(), OrthogonalTileIterator::operator++(), operator==(), OrthogonalTileIterator::OrthogonalTileIterator(), and TileIterator().

---

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

• src/tilearea_type.h
• src/tilearea.cpp