Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/json2d/hexacubic
A mathy Javacript utility library for working with hexacubic grids functionally
https://github.com/json2d/hexacubic
Last synced: about 1 month ago
JSON representation
A mathy Javacript utility library for working with hexacubic grids functionally
- Host: GitHub
- URL: https://github.com/json2d/hexacubic
- Owner: json2d
- License: mit
- Created: 2019-08-22T18:54:17.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-18T16:21:08.000Z (about 2 years ago)
- Last Synced: 2023-12-27T09:02:22.608Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.23 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hexacubic
[](https://www.npmjs.com/package/hexacubic)
## `⬢ → * → ⬡`
A mathy Javacript utility library for working with hexacubic grids functionally
# Getting started
Install via `yarn` or `npm`:
```
yarn add hexacubic
```
```
npm install hexacubic -S
```
### CJS
```javascript
const H = require('hexacubic')
```
### ES6
```javascript
import H from 'hexacubic'
```
# API
### `H.centerToNeighbors(hexacube)`
#### `Point → [Point]`
Takes a hexacube center point and returns an array of center points of its neighbor hexacubes.
##### Parameters
- `hexacube (Point)`: The center point of the hexacube.
##### Returns
- `([Point])`: Returns an array of center points of the neighbor hexacubes of the hexacube.
##### Examples
```js
const origin = [0, 0, 0];
H.centerToNeighbors(origin);
// =>
// [
// [1, 0, -1],
// [-1, 0, 1],
// [0, 1, -1],
// [0, -1, 1],
// [1, -1, 0],
// [-1, 1, 0]
//]
```
### `H.isNeighborOf(hexacubeA)(hexacubeB)`
#### `Point → Point → Boolean`
Creates a predicate function that evaluates if `hexacubeB` is a neighbor of `hexacubeA`.
##### Parameters
- `hexacubeA (Point)`: The center point of the source hexacube.
- `hexacubeB (Point)`: The center point of the target hexacube.
##### Returns
- `(Boolean)`: Returns `true` if source and target hexacubes are neighbors, else `false`.
##### Examples
```js
const homer = [0, 0, 0];
const flanders = [1, 0, -1];
H.isNeighborOf(homer)(flanders);
// => true
const patty = [10, -5, -5];
H.isNeighborOf(homer)(patty);
// => false
const selma = patty;
H.isNeighborOf(patty)(selma);
// => false
```
### `H.centerToCorners(hexacube)`
#### `Point → [Point]`
Takes a hexacube center point and returns its corner points.
##### Parameters
- `hexacube (Point)`: The center point of the hexacube.
##### Returns
- `([Point])`: Returns an array of corner points of the hexacube.
##### Examples
```js
const origin = [0, 0, 0];
H.centerToCorners(origin);
// =>
//[
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ],
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ],
// [ -0.6666666666666666, 0.3333333333333333, 0.3333333333333333 ],
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ],
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ],
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ]
// ]
```
### `H.centerToEdges(hexacube)` [aliases: `H.centerToBounds`]
#### `Point → [Edge]`
Takes a hexacube center point and returns its edges.
##### Parameters
- `hexacube (Point)`: The center point of the hexacube.
##### Returns
- `([Edge])`: Returns an array of corner point pairs representing the edges of the hexacube.
##### Examples
```js
const origin = [0, 0, 0];
H.centerToEdges(origin);
// =>
// [
// [
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ],
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ]
// ],
// [
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ],
// [ -0.6666666666666666, 0.3333333333333333, 0.3333333333333333 ]
// ],
// [
// [ -0.6666666666666666, 0.3333333333333333, 0.3333333333333333 ],
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ]
// ],
// [
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ],
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ]
// ],
// [
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ],
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ]
// ],
// [
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ],
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ]
// ]
// ]
```
### `H.centersToEdges(hexacubes)`
#### `[Point] → [Edge]`
Takes a set of hexacube center points returns all the edges. (deduped)
##### Parameters
- `hexacubes ([Point])`: The array of center points of the hexacubes.
##### Returns
- `([Edge])`: Returns an array of corner point pairs, or edges, of every hexacube.
##### Examples
```js
const origin = [0, 0, 0];
const originAndNeighbors = [
origin,
...H.centerToNeighbors(origin)
]
H.centersToEdges(originAndNeighbors);
// =>
// [
// [
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ],
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ]
// ],
// [
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ],
// [ -0.6666666666666666, 0.3333333333333333, 0.3333333333333333 ]
// ],
// [
// [ -0.6666666666666666, 0.3333333333333333, 0.3333333333333333 ],
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ]
// ],
// [
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ],
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ]
// ],
// [
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ],
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ]
// ],
// [
// [ -0.3333333333333333, 0.6666666666666666, -0.3333333333333333 ],
// [ 0.3333333333333333, 0.3333333333333333, -0.6666666666666666 ]
// ]
// ... 36 more edges (6 edges for each neighbor of origin)
// ]
```
If you want all the edges with duplicates instead, use `flatMap` with `.centerToEdges()`:
```js
import _ from "lodash/fp"
const edges = _.flatMap(H.centerToEdges)(originAndNeighbors)
```
### `H.centersToBounds(hexacubes)`
#### `[Point] → [Edge]`
Takes a set of hexacube center points and returns the edges of its boundary.
##### Parameters
- `hexacubes ([Point])`: The array of the center points of the hexacubes.
##### Returns
- `([Edge])`: Returns an array of the edges of the boundary around the cluster(s) of hexacubes.
##### Examples
```js
const origin = [0, 0, 0];
const originAndNeighbors = [
origin,
...H.centerToNeighbors(origin)
]
H.centersToBounds(originAndNeighbors);
// =>
// [
// ... 18 edges total (3 edges on boundary for each neighbor of origin)
// ]
```
### `H.accumlateBounds(accumulator, edge, edgeIndex, edges)`
Accumlates an edge if it is a boundary edge with respect to a set of edges
```js
const edges = H.centersToEdges(hexacubes);
const bounds = edges.reduce(H.accumlateBounds);
```
### `H.toProjection(point)`
#### `Point → XY`
Projects a hexacubic point isometrically to a plane of view, where x-axis is the horizontal axis and y-axis and z-axis are the diagonal axis
```js
H.toProjection(origin)
// => [0, 0]
H.centerToCorners(origin)
.map(_.compose(customTransform, H.toProjection))
.map(([x,y]) => )
// =>
const customProjectionOf = _.compose(customTransform, H.toProjection)
H.centerToEdges(origin)
.map(edge => edge.map(customProjectionOf))
.map(([[Ax,Ay],[Bx,By]]) => )
// =>
```
### `H.toProjectionWith(options)(point)`
#### `Point → * → XY`
options:
- `size (Number)` - The projection scalar.
- `offset ([Number])` - The projection translated.
### `H.toMidpoint(points)`
#### `[Point] → Point`
Takes an array of hexacubic points and returns the midpoint, or median point.
```js
const origin = [0, 0, 0];
const neighborOfOrigin = [0, 1, -1];
H.toMidpoint([origin, neighborOfOrigin])
// => [0, .5, -.5]
const neighborsOfOrigin = H.centerToNeighbors(origin);
H.toMidpoint(neighborsOfNeighbor);
// => [0, 0, 0]
```
### `H.distanceFrom(hexacubeA)(hexacubeB)`
#### `Point → Point → Number`
Creates a function that calculates the distance of `hexacubeB` from `hexacubeA`.
```js
const origin = [0, 0, 0];
const neighborOfOrigin = [0, 1, -1];
H.distanceFrom(origin)(neighborOfOrigin)
// => 1
const distanceFromOrigin = H.distanceFrom(origin)
const elsewhere = [5, -5, 0]
distanceFromOrigin(elsewhere)
// => 5
```
### `H.centersToPolygons(hexacubes)`
#### `[Point] → [Polygon]`
Takes a set of hexacube center points and returns a set of one or more polygons (one for each bound cluster).
##### Parameters
- `hexacubes ([Point])`: The array of the center points of the hexacubes.
##### Returns
- `([Polygon])`: Returns an array of the polygon(s) of the bound cluster(s) of hexacubes.
##### Examples
```js
const origin = [0, 0, 0];
H.centersToPolygons([origin]);
// =>
// [
// ... 1 polygon with 6 points
// ]
const originAndNeighbors = [
origin,
...H.centerToNeighbors(origin)
]
H.centersToPolygons(originAndNeighbors);
// =>
// [
// ... 1 polygon with 18 points
// ]
```