Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SpatialHash

Hierarchy

  • SpatialHash

Index

Constructors

constructor

  • creates a spatial-hash cull Note, options.dirtyTest defaults to false. To greatly improve performance set to true and set displayObject.dirty=true when the displayObject changes)

    Parameters

    Returns SpatialHash

Properties

dirtyTest

dirtyTest: boolean = true

dirtyTest toggle

simpleTest

simpleTest: boolean = true

simpleTest toggle

Methods

add

addContainer

cull

getAverageSize

  • getAverageSize(): number
  • helper function to evaluate hash table

    Returns number

    • the average number of entries in each bucket

getBuckets

  • getBuckets(minimum?: number): string[]
  • returns an array of buckets with >= minimum of objects in each bucket

    Parameters

    • minimum: number = 1

    Returns string[]

    array of buckets

getLargest

  • getLargest(): number
  • helper function to evaluate the hash table

    Returns number

    • the largest sized bucket

getNumberOfBuckets

  • getNumberOfBuckets(): number
  • helper function to evaluate hash table

    Returns number

    • the number of buckets in the hash table

getSparseness

  • getSparseness(AABB?: AABB): number
  • helper function to evaluate the hash table

    Parameters

    • Optional AABB: AABB

    Returns number

    • sparseness percentage (i.e., buckets with at least 1 element divided by total possible buckets)

getWorldBounds

  • getWorldBounds(): SpatialHashBounds

insert

invisible

  • invisible(): void

neighbors

query

queryCallback

queryCallbackAll

remove

removeContainer

removeFromHash

stats

updateObject

updateObjects

  • updateObjects(): void
  • update the hashes for all objects automatically called from update() when skipUpdate=false

    Returns void

Generated using TypeDoc