Class SpatialHashGrid

SpatialHashGrid for fast particle lookup

Index

Constructors

Accessors

Methods

clear insert query queryCircle queryRectangle

Constructors

constructor

new SpatialHashGrid(cellSize: number): SpatialHashGrid
Parameters
- cellSize: number
Returns SpatialHashGrid
- Defined in Core/Utils/SpatialHashGrid.ts:25

Accessors

cellSize

get cellSize(): number
Returns number
- Defined in Core/Utils/SpatialHashGrid.ts:32
set cellSize(value: number): void
Sets the cell size (applied on next clear)
Parameters
- value: number
  the new cell size
Returns void
- Defined in Core/Utils/SpatialHashGrid.ts:40

Methods

clear

clear(): void
Clears the grid for the next frame

Returns void
- Defined in Core/Utils/SpatialHashGrid.ts:47

insert

insert(particle: Particle): void
Adds a particle to the appropriate cell
Parameters
- particle: Particle
  the particle to insert
Returns void
- Defined in Core/Utils/SpatialHashGrid.ts:63

query

query(
    range: BaseRange,
    check?: (particle: Particle) => boolean,
    out?: Particle[],
): Particle[]
Queries particles within a range (Circle or Rectangle)
Parameters
- range: BaseRange
  the range to query particles in
- Optionalcheck: (particle: Particle) => boolean
  optional callback to check particles against, if not provided all particles will be returned
- out: Particle[] = []
  optional output array to fill with results
Returns Particle[]
the array of particles within the range
- Defined in Core/Utils/SpatialHashGrid.ts:81

queryCircle

queryCircle(
    position: ICoordinates,
    radius: number,
    check?: (particle: Particle) => boolean,
    out?: Particle[],
): Particle[]
Queries particles within a circular range
Parameters
- position: ICoordinates
  the center position of the circle
- radius: number
  the circle radius
- Optionalcheck: (particle: Particle) => boolean
  optional callback to filter particles
- out: Particle[] = []
  optional output array to fill with results
Returns Particle[]
the array of particles within the circle
- Defined in Core/Utils/SpatialHashGrid.ts:110

queryRectangle

queryRectangle(
    position: ICoordinates,
    size: IDimension,
    check?: (particle: Particle) => boolean,
    out?: Particle[],
): Particle[]
Queries particles within a rectangular range
Parameters
- position: ICoordinates
  the top-left position of the rectangle
- size: IDimension
  the rectangle size
- Optionalcheck: (particle: Particle) => boolean
  optional callback to filter particles
- out: Particle[] = []
  optional output array to fill with results
Returns Particle[]
the array of particles within the rectangle
- Defined in Core/Utils/SpatialHashGrid.ts:133