Package squidpony.squidgrid.iterator

Class SquidIterators.AroundCounterClockWise

java.lang.Object

squidpony.squidgrid.iterator.SquidIterators.AroundCounterClockWise

All Implemented Interfaces:

Iterator<Coord>, SquidIterator

Enclosing class:

SquidIterators

public static class SquidIterators.AroundCounterClockWise
extends Object
implements SquidIterator

An iterator that iterates around a starting position (counter clockwise). It can return at most 9 elements. Instances of this iterator only return coordinates that are valid w.r.t. to the widths and heights given at creation time (i.e. they do not go off the map).

Author:

smelC

Field Summary

Fields

Modifier and Type	Field	Description
protected int	height
protected Direction	prev
protected int	width
protected int	xstart
protected int	ystart

Constructor Summary

Constructors

Constructor	Description
AroundCounterClockWise(int width, int height, int xstart, int ystart)	A fresh iterator, to iterate counter clock wise around (xstart, ystart) starting on start's right.
AroundCounterClockWise(int width, int height, Coord start)	A fresh iterator, to iterate counter clock wise around start starting on start's right.

Method Summary

Modifier and Type	Method	Description
protected Coord	findNext(boolean mute)
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

xstart

protected final int xstart

ystart

protected final int ystart

prev

protected Direction prev

Constructor Details

AroundCounterClockWise

public AroundCounterClockWise(int width, int height, Coord start)

A fresh iterator, to iterate counter clock wise around start starting on start's right.

Parameters:

width - The grid's width.

height - The grid's height.

start -

AroundCounterClockWise

public AroundCounterClockWise(int width, int height, int xstart, int ystart)

A fresh iterator, to iterate counter clock wise around (xstart, ystart) starting on start's right.

Parameters:

width - The grid's width.

height - The grid's height.

xstart - The starting x-coordinate.

ystart - The starting y-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)

isInGrid

protected boolean isInGrid(int x, int y)