Class SpatialHash<T>

constructor

• new SpatialHash<T>(options: SpatialHashOptions): SpatialHash<T>

  Type Parameters

  • T

  Parameters

  • options: SpatialHashOptions

  Returns SpatialHash<T>

ReadonlycellSize

size

• get size(): number

  Number of entries currently stored.

  Returns number

clear

• clear(): void

  Remove every entry and bucket while retaining allocated bucket arrays.

  Returns void

get

• get(key: number): SpatialHashEntry<T> | undefined

  Lookup by key, or undefined when absent.

  Parameters

  • key: number

  Returns SpatialHashEntry<T> | undefined

has

• has(key: number): boolean

  Whether key is currently stored.

  Parameters

  • key: number

  Returns boolean

insert

• insert(key: number, x: number, y: number, z: number, data: T): void

  Insert or replace an entry.

  A fresh key receives the next insertion-order ticket. Replacing an existing key keeps the original ticket so steering order stays stable when positions are updated in place via SpatialHash.update.

  Parameters

  • key: number
  • x: number
  • y: number
  • z: number
  • data: T

  Returns void

query

• query(
      cx: number,
      cy: number,
      cz: number,
      radius: number,
      out: T[],
      excludeKey?: number,
  ): readonly T[]

  Collect payloads of every entry within radius of (cx, cy, cz).

  out is cleared, then filled in insertion order. Pass excludeKey to omit self-neighbours (typical when the query centre is an agent's own position). Returns out for chaining.

  Parameters

  • cx: number
  • cy: number
  • cz: number
  • radius: number
  • out: T[]
  • OptionalexcludeKey: number

  Returns readonly T[]

queryKeys

• queryKeys(
      cx: number,
      cy: number,
      cz: number,
      radius: number,
      out: number[],
      excludeKey?: number,
  ): readonly number[]

  Collect keys of every entry within radius of (cx, cy, cz).

  Same ordering rules as SpatialHash.query. Useful when payloads are looked up elsewhere (for example a parallel SoA particle pool).

  Parameters

  • cx: number
  • cy: number
  • cz: number
  • radius: number
  • out: number[]
  • OptionalexcludeKey: number

  Returns readonly number[]

remove

• remove(key: number): boolean

  Remove an entry. Returns false when the key was not present.

  Parameters

  • key: number

  Returns boolean

update

• update(key: number, x: number, y: number, z: number): void

  Move an existing entry to a new position. Throws if the key is absent.

  Parameters

  • key: number
  • x: number
  • y: number
  • z: number

  Returns void