Package squidpony.squidgrid.iterator

Class SquidIterators.CenteredSquare

java.lang.Object

squidpony.squidgrid.iterator.SquidIterators.CenteredSquare

All Implemented Interfaces:

Iterator<Coord>, SquidIterator

Enclosing class:

SquidIterators

public static class SquidIterators.CenteredSquare
extends Object
implements SquidIterator

An iterator that returns cells in a square around a location. Cells are iterated from bottom left to top right in this square. A square size of 0 creates an iterator that returns one location (the starting one); a square of size 1 is an iterator that returns at most 9 locations, (start.x-1,start.y+1), (start.x,start.y+1), ...; a square of size 2 returns at most ((2*2)+1)*((2*2)+1) = 25 locations, etc..

Instances of this iterator never return a coordinate outside the map.

Author:

smelC

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	done
protected int	height
protected Coord	previous
protected int	size
protected int	width
protected int	xstart
protected int	ystart

Constructor Summary

Constructors

Constructor	Description
CenteredSquare(int width, int height, int x, int y, int size)	An iterator to iterate in the square of size size around (x, y).
CenteredSquare(int width, int height, Coord start, int size)	An iterator to iterate in the square of size size around start.

Method Summary

Modifier and Type	Method	Description
protected Coord	findNext(boolean mute)
protected Coord	findNext0()
boolean	hasNext()
protected boolean	isInGrid(int x, int y)
Coord	next()
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Details

width

protected final int width

height

protected final int height

previous

protected Coord previous

xstart

protected final int xstart

ystart

protected final int ystart

size

protected final int size

done

protected boolean done

Constructor Details

CenteredSquare

public CenteredSquare(int width, int height, int x, int y, int size)

An iterator to iterate in the square of size size around (x, y).

Parameters:

width - The map's width

height - The map's height

x - The starting x coordinate.

y - The starting y coordinate.

size - The square's size. Can be 0 but not negative.

Throws:

IllegalStateException - If width <= 0 || height <= 0 || size < 0.

CenteredSquare

public CenteredSquare(int width, int height, Coord start, int size)

An iterator to iterate in the square of size size around start.

Parameters:

width - The grid's width

height - The grid's height

start - The starting coordinate.

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Coord>

next

public Coord next()

Specified by:

next in interface Iterator<Coord>

remove

public void remove()

Specified by:

remove in interface Iterator<Coord>

findNext

protected Coord findNext(boolean mute)

findNext0

protected Coord findNext0()

isInGrid

protected boolean isInGrid(int x, int y)