DynamicTreeCollisionProcessor

Responsible for performing the collision broadphase (locating potential collisions) and the narrowphase (actual collision contacts)

Implements

• CollisionProcessor

Index

Constructors

• constructor

Methods

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

Constructors

constructor

• new DynamicTreeCollisionProcessor(_config: Required<{ arcade?: Required<{ contactSolveBias?: ContactSolveBias }>; bodies?: Required<{ canSleepByDefault?: boolean; defaultMass?: number; sleepBias?: number; sleepEpsilon?: number; wakeThreshold?: number }>; colliders?: Required<{ compositeStrategy?: separate | together }>; continuous?: Required<{ checkForFastBodies?: boolean; disableMinimumSpeedForFastBody?: boolean; surfaceEpsilon?: number }>; dynamicTree?: Required<{ boundsPadding?: number; velocityMultiplier?: number }>; enabled?: boolean; gravity?: Vector; realistic?: Required<{ positionIterations?: number; slop?: number; steeringFactor?: number; velocityIterations?: number; warmStart?: boolean }>; solver?: SolverStrategy; sparseHashGrid?: SparseHashGridConfig; spatialPartition?: SpatialPartitionStrategy; substep?: number }>): DynamicTreeCollisionProcessor

• Parameters

  • _config: Required<{ arcade?: Required<{ contactSolveBias?: ContactSolveBias }>; bodies?: Required<{ canSleepByDefault?: boolean; defaultMass?: number; sleepBias?: number; sleepEpsilon?: number; wakeThreshold?: number }>; colliders?: Required<{ compositeStrategy?: separate | together }>; continuous?: Required<{ checkForFastBodies?: boolean; disableMinimumSpeedForFastBody?: boolean; surfaceEpsilon?: number }>; dynamicTree?: Required<{ boundsPadding?: number; velocityMultiplier?: number }>; enabled?: boolean; gravity?: Vector; realistic?: Required<{ positionIterations?: number; slop?: number; steeringFactor?: number; velocityIterations?: number; warmStart?: boolean }>; solver?: SolverStrategy; sparseHashGrid?: SparseHashGridConfig; spatialPartition?: SpatialPartitionStrategy; substep?: number }>

  Returns DynamicTreeCollisionProcessor

Methods

publicbroadphase

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

• Implementation of CollisionProcessor.broadphase

  Detects potential collision pairs in a broadphase approach with the dynamic AABB tree strategy

  ---

  Parameters

  • targets: Collider[]

  • elapsed: number

  • optionalstats: FrameStats

  Returns Pair[]

publicdebug

• debug(ex: ExcaliburGraphicsContext): void

• Implementation of CollisionProcessor.debug

  Draw any debug information

  ---

  Parameters

  • ex: ExcaliburGraphicsContext

  Returns void

publicgetColliders

• getColliders(): readonly Collider[]

• Implementation of CollisionProcessor.getColliders

  Get all tracked colliders

  ---

  Returns readonly Collider[]

publicnarrowphase

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

• Implementation of CollisionProcessor.narrowphase

  Applies narrow phase on collision pairs to find actual area intersections Adds actual colliding pairs to stats' Frame data

  ---

  Parameters

  • pairs: Pair[]

  • optionalstats: FrameStats

  Returns CollisionContact[]

publicquery

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

• Implementation of CollisionProcessor.query

  Query the collision processor for colliders that contain the point

  ---

  Parameters

  • point: Vector

  Returns Collider[]

publicrayCast

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

• Implementation of CollisionProcessor.rayCast

  Parameters

  • ray: Ray

  • optionaloptions: RayCastOptions

  Returns RayCastHit[]

publictrack

• track(target: Collider): void

• Implementation of CollisionProcessor.track

  Tracks a physics body for collisions

  ---

  Parameters

  • target: Collider

  Returns void

publicuntrack

• untrack(target: Collider): void

• Implementation of CollisionProcessor.untrack

  Untracks a physics body

  ---

  Parameters

  • target: Collider

  Returns void

publicupdate

• update(targets: Collider[]): number

• Implementation of CollisionProcessor.update

  Update the dynamic tree positions

  ---

  Parameters

  • targets: Collider[]

  Returns number