Haxe Code Cookbook
Haxe programming cookbookData structuresGrid iterator

Grid iterator

Reading time: 0.5 minute

Often, in games or UI, you might want to create a grid.

A custom iterators can provide such functionality.

class GridIterator {
  var gridWidth:Int = 0;
  var gridHeight:Int = 0;
  var i:Int = 0;

  public inline function new(gridWidth:Int, gridHeight:Int) {
    this.gridWidth = gridWidth;
    this.gridHeight = gridHeight;

  public inline function hasNext() {
    return i < gridWidth * gridHeight;

  public inline function next() {
    return new GridIteratorObject(i++, gridWidth);

class GridIteratorObject {
  public var index(default, null):Int;
  public var x(default, null):Int;
  public var y(default, null):Int;

  public inline function new(index:Int, gridWidth:Int) {
    this.index = index;
    this.x = index % gridWidth;
    this.y = Std.int(index / gridWidth);


The following example uses the GridIterator and displays a grid of 6x5 using dark colored divs. Because of the used js package/features, it only compiles in the JavaScript target.

Learn more about iterators here: https://haxe.org/manual/lf-iterators.html

Last modified:
Category:  Data structures