Class GridIterator.CenteredSquare

java.lang.Object
com.github.yellowstonegames.grid.GridIterator
com.github.yellowstonegames.grid.GridIterator.CenteredSquare
All Implemented Interfaces:
Iterator<Coord>
Enclosing class:
GridIterator
public static class GridIterator.CenteredSquare extends GridIterator
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.

  • Field Details

    • previous

      protected Coord previous

    • xStart

      protected int xStart

    • yStart

      protected int yStart

    • size

      protected 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()

    • next

      public Coord next()

    • remove

      public void remove()

    • findNext

      protected Coord findNext(boolean mutate)

    • findNextCandidate

      protected Coord findNextCandidate()

    • isInGrid

      protected boolean isInGrid(int x, int y)