API Docs for: 0.7.1
Show:

SAPBroadphase Class

Extends Broadphase
Defined in: src/collision/SAPBroadphase.js:6

Sweep and prune broadphase along one axis.

Constructor

SAPBroadphase

()

Defined in src/collision/SAPBroadphase.js:6

Methods

aabbQuery

(
  • world
  • aabb
  • result
)
Array

Defined in src/collision/SAPBroadphase.js:146

Returns all the bodies within an AABB.

Parameters:

  • world World
  • aabb AABB
  • result Array

    An array to store resulting bodies in.

Returns:

Array:

boundingRadiusCheck

(
  • bodyA
  • bodyB
)
Boolean

Inherited from Broadphase but overwritten in src/collision/Broadphase.js:70

Check whether the bounding radius of two bodies overlap.

Parameters:

Returns:

Boolean:

canCollide

(
  • bodyA
  • bodyB
)
Boolean

Inherited from Broadphase: src/collision/Broadphase.js:118

Check whether two bodies are allowed to collide at all.

Parameters:

Returns:

Boolean:

getCollisionPairs

(
  • world
)
Array

Inherited from Broadphase but overwritten in src/collision/SAPBroadphase.js:99

Get the colliding pairs

Parameters:

Returns:

Array:

setWorld

(
  • world
)

Inherited from Broadphase but overwritten in src/collision/SAPBroadphase.js:46

Change the world

Parameters:

sortAxisList

(
  • a
  • axisIndex
)
Array

Defined in src/collision/SAPBroadphase.js:69

Sorts bodies along an axis.

Parameters:

  • a Array
  • axisIndex Number

Returns:

Array:

Properties

axisIndex

Number

Defined in src/collision/SAPBroadphase.js:23

The axis to sort along. 0 means x-axis and 1 y-axis. If your bodies are more spread out over the X axis, set axisIndex to 0, and you will gain some performance.

axisList

Array

Defined in src/collision/SAPBroadphase.js:16

List of bodies currently in the broadphase.

boundingVolumeType

Number

Inherited from Broadphase: src/collision/Broadphase.js:30

The bounding volume type to use in the broadphase algorithms. Should be set to Broadphase.AABB or Broadphase.BOUNDING_CIRCLE.

result

Array

Inherited from Broadphase: src/collision/Broadphase.js:15

The resulting overlapping pairs. Will be filled with results during .getCollisionPairs().

world

World

Inherited from Broadphase: src/collision/Broadphase.js:22

The world to search for collision pairs in. To change it, use .setWorld()