framedfunction
The rectangle to look at to see the whole of a shape with a margin of pad cells.
Import it
import { framed } from "@johnmorrisdotca/meikyuu/draw";
Definition
function framed(grid: Grid, pad: number): { x: number; y: number; w: number; h: number; }
Parameters
| Name | Type | Description |
|---|---|---|
grid | Grid | The valid native flat or surface cell graph. |
pad | number | The native SVG or viewport padding in drawing units/pixels specified by the signature. |
Returns
{ x: number; y: number; w: number; h: number; }
The rectangle to look at to see the whole of a shape with a margin of pad cells.
Examples
import type { MazeRecipe } from "@johnmorrisdotca/meikyuu";
import { buildMaze } from "@johnmorrisdotca/meikyuu";
import { framed } from "@johnmorrisdotca/meikyuu/draw";
const recipe: MazeRecipe = {shape:"square",w:5,h:5,algorithm:"backtracker",mode:"to-goal",seed:42};
const maze = buildMaze(recipe);
const grid = maze.grid;
console.log(framed(grid,2));{ x: -2, y: -2, w: 9, h: 9 }What it prints (run when this page was built)