This project is part of the @thi.ng/umbrella monorepo.

• About
  • Columns
  • Diagonal
  • Hilbert curve
  • Interleave columns
  • Interleave rows
  • Random
  • Rows
  • Outward spiral
  • Z-curve
  • Zigzag columns
  • Zigzag diagonal
  • Zigzag rows
  • Miscellaneous
  • Status
  • Related packages
• Installation
• Dependencies
• Usage examples
• API
• Authors
• License

2D grid iterators w/ multiple orderings.

Provides the 15 following orderings to generate grid coordinates and additional iterators for shape rasterization:

Source

Also see the filtered version columnEnds2d(), which only includes the end points of each column.

Source

Also see the filtered version diagonalEnds2d(), which only includes the end points of the diagonals.

Source

Source

Supports custom strides... example uses step = 4

Source

Supports custom strides... example uses step = 4

Source

Supports custom PRNG implementations via IRandom interface defined in @thi.ng/random

Source

Also see the filtered version rowEnds2d(), which only includes the end points of each row.

Source

Source

Source

Source

Source

Some functions have been ported from Christopher Kulla's Java-based Sunflow renderer.

For more basic 2D/3D grid iteration, also see range2d() & range3d() in @thi.ng/transducers.

Additionally, the following shape iterators are available:

• circle (Bresenham)
• hline
• vline
• line (Bresenham)

STABLE - used in production

Search or submit any issues for this package

• @thi.ng/morton - Z-order curve / Morton encoding, decoding & range extraction for arbitrary dimensions
• @thi.ng/transducers - Lightweight transducer implementations for ES6 / TypeScript

yarn add @thi.ng/grid-iterators

// ES module
<script type="module" src="https://unpkg.com/@thi.ng/grid-iterators?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/grid-iterators/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 1.47 KB / CJS: 1.59 KB / UMD: 1.63 KB

• @thi.ng/arrays
• @thi.ng/binary
• @thi.ng/morton
• @thi.ng/random
• @thi.ng/transducers

Several demos in this repo's /examples directory are using this package.

A selection:

Screenshot	Description	Live demo	Source
	Visualization of different grid iterator strategies	Demo	Source

Generated API docs

import * as gi from "@thi.ng/grid-iterators";

[...gi.zigzagRows2d(4, 4)]

// [
//   [ 0, 0 ], [ 1, 0 ], [ 2, 0 ], [ 3, 0 ],
//   [ 3, 1 ], [ 2, 1 ], [ 1, 1 ], [ 0, 1 ],
//   [ 0, 2 ], [ 1, 2 ], [ 2, 2 ], [ 3, 2 ],
//   [ 3, 3 ], [ 2, 3 ], [ 1, 3 ], [ 0, 3 ]
// ]

Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-grid-iterators,
  title = "@thi.ng/grid-iterators",
  author = "Karsten Schmidt",
  note = "https://thi.ng/grid-iterators",
  year = 2019
}

© 2019 - 2021 Karsten Schmidt // Apache Software License 2.0