SAPBroadphase | cannon-es

Sweep and prune broadphase along one axis.

Hierarchy

Broadphase
- SAPBroadphase

Constructors

constructor

new SAPBroadphase(world: World): SAPBroadphase

Overrides Broadphase.constructor
- Defined in collision/SAPBroadphase.ts:111
Parameters
- world: World
Returns SAPBroadphase

Properties

axisIndex

axisIndex: 0 | 1 | 2

Axis to sort the bodies along. Set to 0 for x axis, and 1 for y axis. For best performance, pick the axis where bodies are most distributed.

axisList

axisList: Body[]

List of bodies currently in the broadphase.

dirty

dirty: boolean

Set to true if the objects in the world moved.

useBoundingBoxes

useBoundingBoxes: boolean

If set to true, the broadphase uses bounding boxes for intersection tests, else it uses bounding spheres.

world

world: null | World

The world to search in.

Methods

aabbQuery

aabbQuery(world: World, aabb: AABB, result?: Body[]): Body[]

Overrides Broadphase.aabbQuery
- Defined in collision/SAPBroadphase.ts:270
Returns all the bodies within an AABB.

Parameters
- world: World
- aabb: AABB
- result: Body[] = []
  
  An array to store resulting bodies in.
Returns Body[]

autoDetectAxis

autoDetectAxis(): void

- Defined in collision/SAPBroadphase.ts:222
Computes the variance of the body positions and estimates the best axis to use. Will automatically set property axisIndex.

Returns void

collisionPairs

collisionPairs(world: World, p1: Body[], p2: Body[]): void

Overrides Broadphase.collisionPairs
- Defined in collision/SAPBroadphase.ts:163
Collect all collision pairs

Parameters
- world: World
- p1: Body[]
- p2: Body[]
Returns void

doBoundingBoxBroadphase

doBoundingBoxBroadphase(bodyA: Body, bodyB: Body, pairs1: Body[], pairs2: Body[]): void

Inherited from Broadphase.doBoundingBoxBroadphase
- Defined in collision/Broadphase.ts:95
Check if the bounding boxes of two bodies are intersecting.

Parameters
- bodyA: Body
- bodyB: Body
- pairs1: Body[]
- pairs2: Body[]
Returns void

doBoundingSphereBroadphase

doBoundingSphereBroadphase(bodyA: Body, bodyB: Body, pairs1: Body[], pairs2: Body[]): void

Inherited from Broadphase.doBoundingSphereBroadphase
- Defined in collision/Broadphase.ts:81
Check if the bounding spheres of two bodies are intersecting.

Parameters
- bodyA: Body
- bodyB: Body
- pairs1: Body[]
  
  bodyA is appended to this array if intersection
- pairs2: Body[]
  
  bodyB is appended to this array if intersection
Returns void

intersectionTest

intersectionTest(bodyA: Body, bodyB: Body, pairs1: Body[], pairs2: Body[]): void

Inherited from Broadphase.intersectionTest
- Defined in collision/Broadphase.ts:68
Check if the bounding volumes of two bodies intersect.

Parameters
- bodyA: Body
- bodyB: Body
- pairs1: Body[]
- pairs2: Body[]
Returns void

makePairsUnique

makePairsUnique(pairs1: Body[], pairs2: Body[]): void

Inherited from Broadphase.makePairsUnique
- Defined in collision/Broadphase.ts:113
Removes duplicate pairs from the pair arrays.

Parameters
- pairs1: Body[]
- pairs2: Body[]
Returns void

needBroadphaseCollision

needBroadphaseCollision(bodyA: Body, bodyB: Body): boolean

Inherited from Broadphase.needBroadphaseCollision
- Defined in collision/Broadphase.ts:44
Check if a body pair needs to be intersection tested at all.

Parameters
- bodyA: Body
- bodyB: Body
Returns boolean

setWorld

setWorld(world: World): void

Overrides Broadphase.setWorld
- Defined in collision/SAPBroadphase.ts:139
Change the world

Parameters
- world: World
Returns void

Static boundingSphereCheck

boundingSphereCheck(bodyA: Body, bodyB: Body): boolean

Inherited from Broadphase.boundingSphereCheck
- Defined in collision/Broadphase.ts:152
Check if the bounding spheres of two bodies overlap.

Parameters
- bodyA: Body
- bodyB: Body
Returns boolean

Static checkBounds

checkBounds(bi: Body, bj: Body, axisIndex: 0 | 1 | 2): boolean

- Defined in collision/SAPBroadphase.ts:33
Check if the bounds of two bodies overlap, along the given SAP axis.

Parameters
- bi: Body
- bj: Body
- axisIndex: 0 | 1 | 2
Returns boolean

Static insertionSortX

insertionSortX(a: Body[]): Body[]

- Defined in collision/SAPBroadphase.ts:60
insertionSortX

Parameters
- a: Body[]
Returns Body[]

Static insertionSortY

insertionSortY(a: Body[]): Body[]

- Defined in collision/SAPBroadphase.ts:78
insertionSortY

Parameters
- a: Body[]
Returns Body[]

Static insertionSortZ

insertionSortZ(a: Body[]): Body[]

- Defined in collision/SAPBroadphase.ts:96
insertionSortZ

Parameters
- a: Body[]
Returns Body[]

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

world: World

Returns SAPBroadphase

Properties

axisIndex

axisList

dirty

useBoundingBoxes

world

Methods

aabbQuery

Parameters

world: World

aabb: AABB

result: Body[] = []

Returns Body[]

autoDetectAxis

Returns void

collisionPairs

Parameters

world: World

p1: Body[]

p2: Body[]

Returns void

doBoundingBoxBroadphase

Parameters

bodyA: Body

bodyB: Body

pairs1: Body[]

pairs2: Body[]

Returns void

doBoundingSphereBroadphase

Parameters

bodyA: Body

bodyB: Body

pairs1: Body[]

pairs2: Body[]

Returns void

intersectionTest

Parameters

bodyA: Body

bodyB: Body

pairs1: Body[]

pairs2: Body[]

Returns void

makePairsUnique

Parameters

pairs1: Body[]

pairs2: Body[]

Returns void

needBroadphaseCollision

Parameters

bodyA: Body

bodyB: Body

Returns boolean

setWorld

Parameters

world: World

Returns void

Static boundingSphereCheck

Parameters

bodyA: Body

bodyB: Body

Returns boolean

Static checkBounds

Parameters

bi: Body

bj: Body

axisIndex: 0 | 1 | 2

Returns boolean

Static insertionSortX

Parameters

a: Body[]