CollisionProcessor

Definition for collision processor

Collision processors are responsible for tracking colliders and identifying contacts between them

Implemented by

• DynamicTreeCollisionProcessor
• SparseHashGridCollisionProcessor

Index

Methods

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

Methods

broadphase

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

• Detect potential collision pairs given a list of colliders

  ---

  Parameters

  • targets: Collider[]

  • elapsedMs: number

  • optionalstats: FrameStats

  Returns Pair[]

debug

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

• Draw any debug information

  ---

  Parameters

  • ex: ExcaliburGraphicsContext

  • elapsedMs: number

  Returns void

getColliders

• getColliders(): readonly Collider[]

• Get all tracked colliders

  ---

  Returns readonly Collider[]

narrowphase

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

• Identify actual collisions from those pairs, and calculate collision impulse

  ---

  Parameters

  • pairs: Pair[]

  • optionalstats: FrameStats

  Returns CollisionContact[]

query

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

• Query the collision processor for colliders that contain the point

  ---

  Parameters

  • point: Vector

  Returns Collider[]

rayCast

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

• Parameters

  • ray: Ray

  • optionaloptions: RayCastOptions

  Returns RayCastHit[]

track

• track(target: Collider): void

• Track collider in collision processor

  ---

  Parameters

  • target: Collider

  Returns void

untrack

• untrack(target: Collider): void

• Untrack collider in collision processor

  ---

  Parameters

  • target: Collider

  Returns void

update

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

• Update the internal structures to track colliders

  ---

  Parameters

  • targets: Collider[]

  • elapsedMs: number

  Returns number