Iterator to iterate over a tile area (rectangle) of the map. More...

Inheritance diagram for OrthogonalTileIterator:

Public Member Functions
	OrthogonalTileIterator (const OrthogonalTileArea &ta)
	Construct the iterator. More...

	OrthogonalTileIterator (TileIndex corner1, TileIndex corner2)
	Construct the iterator. More...

TileIterator &	operator++ () override
	Move ourselves to the next tile in the rectangle on the map.

std::unique_ptr< TileIterator >	Clone () const override
	Allocate a new iterator that is a copy of this one.

Public Member Functions inherited from TileIterator
virtual	~TileIterator ()
	Some compilers really like this.

	operator TileIndex () const
	Get the tile we are currently at. More...

TileIndex	operator* () const
	Get the tile we are currently at. More...

bool	operator== (const TileIterator &rhs) const
	Equality comparison.

bool	operator!= (const TileIterator &rhs) const
	Inequality comparison.

bool	operator== (const TileIndex &rhs) const
	Equality comparison.

bool	operator!= (const TileIndex &rhs) const
	Inequality comparison.

Private Attributes
int	w
	The width of the iterated area.

int	x
	The current 'x' position in the rectangle.

int	y
	The current 'y' position in the rectangle.

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

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

Protected Attributes inherited from TileIterator
TileIndex	tile
	The current tile we are at.

Detailed Description

Iterator to iterate over a tile area (rectangle) of the map.

Definition at line 185 of file tilearea_type.h.

Constructor & Destructor Documentation

OrthogonalTileIterator::OrthogonalTileIterator ( const OrthogonalTileArea & ta )

inline

Construct the iterator.

Parameters

ta	Area, i.e. begin point and width/height of to-be-iterated area.

Definition at line 196 of file tilearea_type.h.

OrthogonalTileIterator::OrthogonalTileIterator	(	TileIndex	corner1,
		TileIndex	corner2
	)

inline

Construct the iterator.

Parameters

corner1	Tile from where to begin iterating.
corner2	Tile where to end the iterating.

Definition at line 205 of file tilearea_type.h.

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