cuboidFacesfunction
The six faces of a cuboid, in the order the state is written, with their size and where each begins.
Import it
import { cuboidFaces } from "@johnmorrisdotca/kyuubu/cuboid";
Definition
function cuboidFaces(dims: CuboidDims): readonly CuboidFace[]
Parameters
| Name | Type | Description |
|---|---|---|
dims | CuboidDims | The cuboid’s x, y and z dimensions, in that order. |
Returns
readonly CuboidFace[]
The six faces of a cuboid, in the order the state is written, with their size and where each begins.
Examples
import { cuboidFaces } from "@johnmorrisdotca/kyuubu/cuboid";
const dims = [2, 3, 3] as const;
console.log(cuboidFaces(dims));[
{ face: 'U', cols: 2, rows: 3, start: 0 },
{ face: 'R', cols: 3, rows: 3, start: 6 },
{ face: 'F', cols: 2, rows: 3, start: 15 },
{ face: 'D', cols: 2, rows: 3, start: 21 },
{ face: 'L', cols: 3, rows: 3, start: 27 },
{ face: 'B', cols: 2, rows: 3, start: 36 }
]What it prints (run when this page was built)