cuboidFaceMovefunction
A face turned, depth layers in from it (1 is the face itself), on this cuboid: the move, or why not.
Import it
import { cuboidFaceMove } from "@johnmorrisdotca/kyuubu/cuboid";
Definition
function cuboidFaceMove(face: Letter, depth: number, amount: "cw" | "half" | "ccw", dims: CuboidDims): CuboidReading
Parameters
| Name | Type | Description |
|---|---|---|
face | Letter | The face letter: U, R, F, D, L or B. |
depth | number | The layer depth counted from the named face, starting at 1. |
amount | "cw" | "half" | "ccw" | The turn direction: cw, half or ccw. |
dims | CuboidDims | The cuboid’s x, y and z dimensions, in that order. |
Returns
CuboidReading
A face turned, depth layers in from it (1 is the face itself), on this cuboid: the move, or why not.
Examples
import { cuboidFaceMove } from "@johnmorrisdotca/kyuubu/cuboid";
const dims = [2, 3, 3] as const;
console.log(cuboidFaceMove("R", 1, "cw", dims));{ move: { axis: 0, layer: 1, turns: 3 } }What it prints (run when this page was built)