spatial-monorepo

---

spatial-monorepo / wayfinding/src / GridRouteOptions

Interface: GridRouteOptions

Defined in: packages/wayfinding/src/grid-types.ts:149

Extends

• OccupancyGridOptions.JumpPointSearchOptions

Properties

blockedUnitIds?

optional blockedUnitIds?: string[] | ReadonlySet`<string>`

Defined in: packages/wayfinding/src/grid-types.ts:66

Unit IDs to fill solid regardless of their own geometry/openings — the dynamic "blocked room" layer (restricted units, avoidance zones, live occupancy) a relaxation rung decides to enforce. Applied last, after fixtures/discs, so it always wins.

Inherited from

OccupancyGridOptions.blockedUnitIds

---

cellsPerMetre?

optional cellsPerMetre?: number

Defined in: packages/wayfinding/src/grid-types.ts:21

Resolution in cells per metre. Default 5 — the Haltian Empathic Building reference constant.

Inherited from

OccupancyGridOptions.cellsPerMetre

---

diagonalMovement?

optional diagonalMovement?: DiagonalMovementMode

Defined in: packages/wayfinding/src/grid-types.ts:134

Default 'only-when-no-obstacles': diagonal steps are only allowed when neither orthogonal neighbour is blocked, so a path can never cut through a wall corner. Loosening this can shorten routes visually but risks corner-cutting through thin walls at low grid resolutions.

Inherited from

JumpPointSearchOptions.diagonalMovement

---

fixtures?

optional fixtures?: IMDFFeature`<ObstacleFootprintProps>`[]

Defined in: packages/wayfinding/src/grid-types.ts:40

Fixture/kiosk footprint features (already filtered to the level being rasterized) stamped as solid obstacles, upscaled about their own centroid by fixtureUpscale — cheap obstacle buffer per the Wayfinding v2 plan §3.3 ("desk/locker upscale 1.4-1.8x"). Geometry may be Polygon or MultiPolygon; see extractFootprintRings. Default: none.

Inherited from

OccupancyGridOptions.fixtures

---

fixtureUpscale?

optional fixtureUpscale?: number

Defined in: packages/wayfinding/src/grid-types.ts:42

Upscale factor applied to each fixture footprint about its own centroid. Default 1.6.

Inherited from

OccupancyGridOptions.fixtureUpscale

---

memoryBudgetCells?

optional memoryBudgetCells?: number

Defined in: packages/wayfinding/src/grid-types.ts:30

Memory budget in cells before the resolution auto-derates. Default ~4,000,000 (≈4 MB for a Uint8Array grid). See deriveGridResolution for the derate ladder.

Inherited from

OccupancyGridOptions.memoryBudgetCells

---

minDoorGapWidthM?

optional minDoorGapWidthM?: number

Defined in: packages/wayfinding/src/grid-types.ts:25

Minimum door-gap width in metres, applied even when the source Opening geometry is shorter. Default 0.9.

Inherited from

OccupancyGridOptions.minDoorGapWidthM

---

preserveUnitIds?

optional preserveUnitIds?: string[] | ReadonlySet`<string>`

Defined in: packages/wayfinding/src/grid-types.ts:72

Unit IDs exempted from blockedUnitIds — normally the unit containing the route's origin or destination, so a restricted/avoidance-zone room you are actually departing from or arriving at is never sealed shut (Wayfinding v2 plan §3.3).

Inherited from

OccupancyGridOptions.preserveUnitIds

---

wallStrokeWidthCells?

optional wallStrokeWidthCells?: number

Defined in: packages/wayfinding/src/grid-types.ts:23

Wall boundary stroke thickness in cells. Default 2.

Inherited from

OccupancyGridOptions.wallStrokeWidthCells

---

wallVertexClearanceM?

optional wallVertexClearanceM?: number

Defined in: packages/wayfinding/src/grid-types.ts:48

Clearance disc radius (metres) stamped at every unit-polygon boundary vertex that is NOT classified as an opening endpoint — the HEB column_size analogue (Wayfinding v2 plan §3.3). Default 0 (no discs — preserves pre-#477 rasterization exactly when unset).

Inherited from

OccupancyGridOptions.wallVertexClearanceM

---

wallVertexClearanceOpeningM?

optional wallVertexClearanceOpeningM?: number

Defined in: packages/wayfinding/src/grid-types.ts:54

Clearance disc radius (metres) at wall vertices classified as an opening endpoint (a doorway jamb) — smaller than wallVertexClearanceM so corner clearance doesn't reseal the door. The HEB column_opening_size analogue. Default 0.

Inherited from

OccupancyGridOptions.wallVertexClearanceOpeningM

---

wallVertexOpeningMatchToleranceM?

optional wallVertexOpeningMatchToleranceM?: number

Defined in: packages/wayfinding/src/grid-types.ts:60

How close (metres) a unit-ring vertex must be to a computed door-gap endpoint to be classified as an opening-endpoint vertex (smaller clearance) rather than a normal corner (larger clearance). Default 1.0.

Inherited from

OccupancyGridOptions.wallVertexOpeningMatchToleranceM