Skip to content

spatial-monorepo


spatial-monorepo / core/src / SpatialState

Interface: SpatialState

Defined in: packages/core/src/store/types.ts:214

Extends

  • BuildingSliceState.FloorSliceState.CameraSliceState.DataLayerSliceState.SelectionSliceState.EditorSliceState.ThemeSliceState.WayfindingSliceState

Properties

accessibleMode

accessibleMode: boolean

Defined in: packages/core/src/store/types.ts:187

Inherited from

WayfindingSliceState.accessibleMode


activeBuilding

activeBuilding: string | null

Defined in: packages/core/src/store/types.ts:71

Inherited from

BuildingSliceState.activeBuilding


addDrawFeature

addDrawFeature: (feature) => void

Defined in: packages/core/src/store/types.ts:163

Parameters

feature

DrawFeature

Returns

void

Inherited from

EditorSliceState.addDrawFeature


avoidancePolicy

avoidancePolicy: VenueAvoidancePolicy

Defined in: packages/core/src/store/types.ts:210

Per-venue soft/hard block policy for occupied/reserved rooms (issue #473 — the "ready-for-human" policy knob; see DEFAULT_VENUE_AVOIDANCE_POLICY in @diginestai/wayfinding for the shipped default and the reasoning behind it). Defaults to {} (every field falls back to the package default) until a venue integration calls setAvoidancePolicy.

Inherited from

WayfindingSliceState.avoidancePolicy


buildings

buildings: BuildingFeature[]

Defined in: packages/core/src/store/types.ts:70

Inherited from

BuildingSliceState.buildings


camera

camera: CameraState

Defined in: packages/core/src/store/types.ts:112

Inherited from

CameraSliceState.camera


canRedo

canRedo: boolean

Defined in: packages/core/src/store/types.ts:173

True if there are steps to redo.

Inherited from

EditorSliceState.canRedo


canUndo

canUndo: boolean

Defined in: packages/core/src/store/types.ts:171

True if there are steps to undo.

Inherited from

EditorSliceState.canUndo


clearSelection

clearSelection: () => void

Defined in: packages/core/src/store/types.ts:147

Returns

void

Inherited from

SelectionSliceState.clearSelection


dataLayerConfigs

dataLayerConfigs: DataLayerConfig[]

Defined in: packages/core/src/store/types.ts:122

Inherited from

DataLayerSliceState.dataLayerConfigs


drawFeatures

drawFeatures: DrawFeature[]

Defined in: packages/core/src/store/types.ts:162

Features managed by the Terra Draw editor. Every mutation creates a undo step.

Inherited from

EditorSliceState.drawFeatures


editorMode

editorMode: EditorMode

Defined in: packages/core/src/store/types.ts:159

Inherited from

EditorSliceState.editorMode


explodedGapCm

explodedGapCm: number

Defined in: packages/core/src/store/types.ts:89

vertical gap between floors in exploded view, in centimetres (default 50)

Inherited from

FloorSliceState.explodedGapCm


explodedView

explodedView: boolean

Defined in: packages/core/src/store/types.ts:87

when true the 3-D deck.gl floors are spread apart vertically

Inherited from

FloorSliceState.explodedView


explodedWallHeightCm

explodedWallHeightCm: number

Defined in: packages/core/src/store/types.ts:97

Issue #454 — wall height used in the exploded-view base-offset formula, in centimetres (default 280). Tracked in the store (mirroring explodedGapCm) so a floor idle-unloaded by the FloorUnloader and later reloaded can be re-exploded with the same offset as still-loaded floors, instead of silently falling back to applyExplodedView's default.

Inherited from

FloorSliceState.explodedWallHeightCm


floorOrdinal

floorOrdinal: number

Defined in: packages/core/src/store/types.ts:83

Inherited from

FloorSliceState.floorOrdinal


floorPlans

floorPlans: BuildingFloorPlanRecord[]

Defined in: packages/core/src/store/types.ts:73

Persisted floor-plan records keyed by buildingId.

Inherited from

BuildingSliceState.floorPlans


levels

levels: LevelFeature[]

Defined in: packages/core/src/store/types.ts:81

Inherited from

FloorSliceState.levels


liveAvoidanceZones

liveAvoidanceZones: AvoidanceZone[]

Defined in: packages/core/src/store/types.ts:201

Live occupancy/reservation-derived avoid-zones (issue #473), kept in the store so any component (DirectionsPanel, room info cards, etc.) can read "is this room currently avoided?" without its own dataBus subscription. Written by useOccupancyAvoidance (wayfinding/useOccupancyAvoidance.ts) after its debounce window settles — never written synchronously on every raw sensor event. Spread into DirectionOptions.avoidanceZones when computing a route to make live occupancy state a routing constraint.

Inherited from

WayfindingSliceState.liveAvoidanceZones


mode

mode: ViewMode

Defined in: packages/core/src/store/types.ts:223


redo

redo: () => void

Defined in: packages/core/src/store/types.ts:169

Redo last undone editor operation (zundo). No-op if no future.

Returns

void

Inherited from

EditorSliceState.redo


removeDataLayerConfig

removeDataLayerConfig: (id) => void

Defined in: packages/core/src/store/types.ts:125

Parameters

id

string

Returns

void

Inherited from

DataLayerSliceState.removeDataLayerConfig


removeDrawFeature

removeDrawFeature: (id) => void

Defined in: packages/core/src/store/types.ts:165

Parameters

id

string

Returns

void

Inherited from

EditorSliceState.removeDrawFeature


resetEditor

resetEditor: () => void

Defined in: packages/core/src/store/types.ts:175

Reset editor state and clear all undo/redo history.

Returns

void

Inherited from

EditorSliceState.resetEditor


selectedFeatureIds

selectedFeatureIds: string[]

Defined in: packages/core/src/store/types.ts:145

Inherited from

SelectionSliceState.selectedFeatureIds


setAccessibleMode

setAccessibleMode: (enabled) => void

Defined in: packages/core/src/store/types.ts:191

Parameters

enabled

boolean

Returns

void

Inherited from

WayfindingSliceState.setAccessibleMode


setActiveBuilding

setActiveBuilding: (id) => void

Defined in: packages/core/src/store/types.ts:75

Parameters

id

string | null

Returns

void

Inherited from

BuildingSliceState.setActiveBuilding


setAvoidancePolicy

setAvoidancePolicy: (policy) => void

Defined in: packages/core/src/store/types.ts:211

Parameters

policy

VenueAvoidancePolicy

Returns

void

Inherited from

WayfindingSliceState.setAvoidancePolicy


setBuildings

setBuildings: (buildings) => void

Defined in: packages/core/src/store/types.ts:74

Parameters

buildings

BuildingFeature[]

Returns

void

Inherited from

BuildingSliceState.setBuildings


setCamera

setCamera: (camera) => void

Defined in: packages/core/src/store/types.ts:115

Parameters

camera

Partial`<CameraState>`

Returns

void

Inherited from

CameraSliceState.setCamera


setDataLayerConfigs

setDataLayerConfigs: (configs) => void

Defined in: packages/core/src/store/types.ts:123

Parameters

configs

DataLayerConfig[]

Returns

void

Inherited from

DataLayerSliceState.setDataLayerConfigs


setEditorMode

setEditorMode: (mode) => void

Defined in: packages/core/src/store/types.ts:160

Parameters

mode

EditorMode

Returns

void

Inherited from

EditorSliceState.setEditorMode


setExplodedGapCm

setExplodedGapCm: (n) => void

Defined in: packages/core/src/store/types.ts:104

Parameters

n

number

Returns

void

Inherited from

FloorSliceState.setExplodedGapCm


setExplodedView

setExplodedView: (v) => void

Defined in: packages/core/src/store/types.ts:102

Parameters

v

boolean

Returns

void

Inherited from

FloorSliceState.setExplodedView


setExplodedWallHeightCm

setExplodedWallHeightCm: (n) => void

Defined in: packages/core/src/store/types.ts:105

Parameters

n

number

Returns

void

Inherited from

FloorSliceState.setExplodedWallHeightCm


setFloorOrdinal

setFloorOrdinal: (ordinal) => void

Defined in: packages/core/src/store/types.ts:100

Parameters

ordinal

number

Returns

void

Inherited from

FloorSliceState.setFloorOrdinal


setFloorPlan

setFloorPlan: (record) => void

Defined in: packages/core/src/store/types.ts:77

Upsert a floor-plan record for a building.

Parameters

record

BuildingFloorPlanRecord

Returns

void

Inherited from

BuildingSliceState.setFloorPlan


setLevels

setLevels: (levels) => void

Defined in: packages/core/src/store/types.ts:98

Parameters

levels

LevelFeature[]

Returns

void

Inherited from

FloorSliceState.setLevels


setLiveAvoidanceZones

setLiveAvoidanceZones: (zones) => void

Defined in: packages/core/src/store/types.ts:202

Parameters

zones

AvoidanceZone[]

Returns

void

Inherited from

WayfindingSliceState.setLiveAvoidanceZones


setMode

setMode: (mode) => void

Defined in: packages/core/src/store/types.ts:224

Parameters

mode

ViewMode

Returns

void


setSelectedFeatureIds

setSelectedFeatureIds: (ids) => void

Defined in: packages/core/src/store/types.ts:146

Parameters

ids

string[]

Returns

void

Inherited from

SelectionSliceState.setSelectedFeatureIds


setThemeMode

setThemeMode: (mode) => void

Defined in: packages/core/src/store/types.ts:180

Parameters

mode

ThemeMode

Returns

void

Inherited from

ThemeSliceState.setThemeMode


setUnits

setUnits: (units) => void

Defined in: packages/core/src/store/types.ts:99

Parameters

units

UnitFeature[]

Returns

void

Inherited from

FloorSliceState.setUnits


setVenueBounds

setVenueBounds: (bounds) => void

Defined in: packages/core/src/store/types.ts:118

Parameters

bounds

VenueBounds | null

Returns

void

Inherited from

CameraSliceState.setVenueBounds


setVisibleUpToOrdinal

setVisibleUpToOrdinal: (n) => void

Defined in: packages/core/src/store/types.ts:101

Parameters

n

number | null

Returns

void

Inherited from

FloorSliceState.setVisibleUpToOrdinal


setWayfindingActive

setWayfindingActive: (active) => void

Defined in: packages/core/src/store/types.ts:188

Parameters

active

boolean

Returns

void

Inherited from

WayfindingSliceState.setWayfindingActive


setWayfindingDestination

setWayfindingDestination: (id) => void

Defined in: packages/core/src/store/types.ts:190

Parameters

id

string | null

Returns

void

Inherited from

WayfindingSliceState.setWayfindingDestination


setWayfindingOrigin

setWayfindingOrigin: (id) => void

Defined in: packages/core/src/store/types.ts:189

Parameters

id

string | null

Returns

void

Inherited from

WayfindingSliceState.setWayfindingOrigin


themeMode

themeMode: ThemeMode

Defined in: packages/core/src/store/types.ts:179

Inherited from

ThemeSliceState.themeMode


toggleExplodedView

toggleExplodedView: () => void

Defined in: packages/core/src/store/types.ts:103

Returns

void

Inherited from

FloorSliceState.toggleExplodedView


undo

undo: () => void

Defined in: packages/core/src/store/types.ts:167

Undo last editor operation (zundo). No-op if no history.

Returns

void

Inherited from

EditorSliceState.undo


units

units: UnitFeature[]

Defined in: packages/core/src/store/types.ts:82

Inherited from

FloorSliceState.units


updateDrawFeature

updateDrawFeature: (id, patch) => void

Defined in: packages/core/src/store/types.ts:164

Parameters

id

string

patch

Partial`<DrawFeature>`

Returns

void

Inherited from

EditorSliceState.updateDrawFeature


upsertDataLayerConfig

upsertDataLayerConfig: (config) => void

Defined in: packages/core/src/store/types.ts:124

Parameters

config

DataLayerConfig

Returns

void

Inherited from

DataLayerSliceState.upsertDataLayerConfig


venueBounds

venueBounds: VenueBounds | null

Defined in: packages/core/src/store/types.ts:117

Optional bounding box that constrains map panning. Null when unrestricted.

Inherited from

CameraSliceState.venueBounds


visibleUpToOrdinal

visibleUpToOrdinal: number | null

Defined in: packages/core/src/store/types.ts:85

null means "show all floors"

Inherited from

FloorSliceState.visibleUpToOrdinal


wayfindingActive

wayfindingActive: boolean

Defined in: packages/core/src/store/types.ts:184

Inherited from

WayfindingSliceState.wayfindingActive


wayfindingDestination

wayfindingDestination: string | null

Defined in: packages/core/src/store/types.ts:186

Inherited from

WayfindingSliceState.wayfindingDestination


wayfindingOrigin

wayfindingOrigin: string | null

Defined in: packages/core/src/store/types.ts:185

Inherited from

WayfindingSliceState.wayfindingOrigin


zoomMode

zoomMode: ZoomMode

Defined in: packages/core/src/store/types.ts:114

Issue #373 — derived from camera.zoom: "indoor" when zoom ≥ 18.

Inherited from

CameraSliceState.zoomMode

Released under commercial licensing.