Iterator to iterate over all tiles belonging to a bitmaptilearea. More...

#include <bitmap_type.h>

Inheritance diagram for BitmapTileIterator:

Public Member Functions
	BitmapTileIterator (const BitmapTileArea &bitmap)
	Construct the iterator.
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 OrthogonalTileIterator
	OrthogonalTileIterator (const OrthogonalTileArea &ta)
	Construct the iterator.
	OrthogonalTileIterator (TileIndex corner1, TileIndex corner2)
	Construct the iterator.
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
	operator TileIndex () const
	Get the tile we are currently at.
TileIndex	operator* () const
	Get the tile we are currently at.
bool	operator== (const TileIterator &rhs) const
	Equality comparison.
bool	operator== (const TileIndex &rhs) const
	Equality comparison.

Protected Attributes
const BitmapTileArea *	bitmap
Protected Attributes inherited from TileIterator
TileIndex	tile
	The current tile we are at.

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.
Protected Member Functions inherited from TileIterator
	TileIterator (TileIndex tile=INVALID_TILE)
	Initialise the iterator starting at this tile.

Detailed Description

Iterator to iterate over all tiles belonging to a bitmaptilearea.

Definition at line 106 of file bitmap_type.h.

Constructor & Destructor Documentation

◆ BitmapTileIterator()

BitmapTileIterator::BitmapTileIterator ( const BitmapTileArea & bitmap )

inline

Construct the iterator.

Parameters

bitmap BitmapTileArea to iterate.

Definition at line 114 of file bitmap_type.h.

References BitmapTileArea::HasTile(), and OrthogonalTileIterator::OrthogonalTileIterator().

Member Function Documentation

◆ Clone()

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

inlineoverridevirtual

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

Implements TileIterator.

Definition at line 128 of file bitmap_type.h.

◆ operator++()

TileIterator & BitmapTileIterator::operator++ ( )

inlineoverridevirtual

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

Implements TileIterator.

Definition at line 119 of file bitmap_type.h.

References BitmapTileArea::HasTile(), INVALID_TILE, OrthogonalTileIterator::operator++(), and TileIterator::TileIterator().

Field Documentation

◆ bitmap

const BitmapTileArea* BitmapTileIterator::bitmap

protected

Definition at line 108 of file bitmap_type.h.

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

src/bitmap_type.h

Public Member Functions

Protected Attributes

Additional Inherited Members