SparseHashGridCollisionProcessor

This collision processor uses a sparsely populated grid of uniform cells to bucket potential colliders together for the purpose of detecting collision pairs and collisions.

Implements

• CollisionProcessor

Index

Constructors

• constructor

Properties

• _pairPool
• gridSize
• hashGrid

Methods

• broadphase
• debug
• getColliders
• narrowphase
• query
• rayCast
• track
• untrack
• update

Constructors

constructor

• new SparseHashGridCollisionProcessor(options: { size: number }): SparseHashGridCollisionProcessor

• Parameters

  • options: { size: number }

  • size: number

  Returns SparseHashGridCollisionProcessor

Properties

public_pairPool

_pairPool: Pool<Pair> = ...

readonlygridSize

gridSize: number

readonlyhashGrid

hashGrid: SparseHashGrid<Collider, HashColliderProxy>

Methods

broadphase

• broadphase(targets: Collider[], elapsedMs: number): Pair[]

• Implementation of CollisionProcessor.broadphase

  Runs the broadphase sweep over tracked colliders and returns possible collision pairs

  ---

  Parameters

  • targets: Collider[]

  • elapsedMs: number

  Returns Pair[]

debug

• debug(ex: ExcaliburGraphicsContext, elapsedMs: number): void

• Implementation of CollisionProcessor.debug

  Draws the internal data structure

  ---

  Parameters

  • ex: ExcaliburGraphicsContext

  • elapsedMs: number

  Returns void

getColliders

• getColliders(): readonly Collider[]

• Implementation of CollisionProcessor.getColliders

  Get all tracked colliders

  ---

  Returns readonly Collider[]

narrowphase

• narrowphase(pairs: Pair[], stats?: FrameStats): CollisionContact[]

• Implementation of CollisionProcessor.narrowphase

  Runs a fine grain pass on collision pairs and does geometry intersection tests producing any contacts

  ---

  Parameters

  • pairs: Pair[]

  • optionalstats: FrameStats

  Returns CollisionContact[]

query

• query(point: Vector): Collider[]
• query(bound: BoundingBox): Collider[]

• Implementation of CollisionProcessor.query

  Query the collision processor for colliders that contain the point

  ---

  Parameters

  • point: Vector

  Returns Collider[]

rayCast

• rayCast(ray: Ray, options?: RayCastOptions): RayCastHit[]

• Implementation of CollisionProcessor.rayCast

  Parameters

  • ray: Ray

  • optionaloptions: RayCastOptions

  Returns RayCastHit[]

track

• track(target: Collider): void

• Implementation of CollisionProcessor.track

  Adds the collider to the internal data structure for collision tracking

  ---

  Parameters

  • target: Collider

  Returns void

untrack

• untrack(target: Collider): void

• Implementation of CollisionProcessor.untrack

  Removes a collider from the internal data structure for tracking collisions

  ---

  Parameters

  • target: Collider

  Returns void

update

• update(targets: Collider[], elapsedMs: number): number

• Implementation of CollisionProcessor.update

  Perform data structure maintenance, returns number of colliders updated

  ---

  Parameters

  • targets: Collider[]

  • elapsedMs: number

  Returns number