Interface CurrentSpaceTracker

Readonlysettings

configure

• configure(settings: Partial<CurrentSpaceTrackerSettings>): Promise<void>

  Changes settings; a new getClause re-runs the feature prefetch.

  Parameters

  • settings: Partial<CurrentSpaceTrackerSettings>

  Returns Promise<void>

dispose

• dispose(): void

  Returns void

getCurrent

• getCurrent(): CurrentSpaceResult

  Returns CurrentSpaceResult

getSpaces

• getSpaces(): { centre: vec3; inside: vec3; qid: string }[]

  The spaces of the loaded index, no query: a point inside each footprint and the footprint's centre, both at the floor (render frame)

  Returns { centre: vec3; inside: vec3; qid: string }[]

off

• off(
      event: "current_space_changed" | "current_zone_changed",
      fn: (payload: any) => void,
  ): this

  Parameters

  • event: "current_space_changed" | "current_zone_changed"
  • fn: (payload: any) => void

  Returns this

on

• on(
      event: "current_space_changed",
      fn: (current: CurrentSpaceResult) => void,
  ): this

  Parameters

  • event: "current_space_changed"
  • fn: (current: CurrentSpaceResult) => void

  Returns this

• on(
      event: "current_zone_changed",
      fn: (payload: { stale: boolean; zones: CurrentZone[] }) => void,
  ): this

  Parameters

  • event: "current_zone_changed"
  • fn: (payload: { stale: boolean; zones: CurrentZone[] }) => void

  Returns this

prefetch

• prefetch(): Promise<void>

  Re-runs the bulk BQL prefetch of every space's features.

  Returns Promise<void>

spacesInZone

• spacesInZone(zoneQid: string): string[]

  The qids ("vid-oid") of every prefetched space that belongs to the zone: no query.

  Parameters

  • zoneQid: string

  Returns string[]