Public Member Functions | Protected Member Functions | Protected Attributes

TileIterator Class Reference

Base class for tile iterators. More...

#include <tilearea_type.h>

Inheritance diagram for TileIterator:
DiagonalTileIterator OrthogonalTileIterator

Public Member Functions

virtual ~TileIterator ()
 Some compilers really like this.
FORCEINLINE operator TileIndex () const
 Get the tile we are currently at.
virtual TileIteratoroperator++ ()=0
 Move ourselves to the next tile in the rectange on the map.

Protected Member Functions

 TileIterator (TileIndex 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 64 of file tilearea_type.h.


Constructor & Destructor Documentation

TileIterator::TileIterator ( TileIndex  tile  )  [inline, protected]

Initialise the iterator starting at this tile.

Parameters:
tile The tile we start iterating from.

Definition at line 72 of file tilearea_type.h.

virtual TileIterator::~TileIterator (  )  [inline, virtual]

Some compilers really like this.

Definition at line 78 of file tilearea_type.h.


Member Function Documentation

FORCEINLINE 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 86 of file tilearea_type.h.

References tile.


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