2021-05-11 18:30:36 -07:00

9.6 KiB
Raw Permalink Blame History

Planck.js API Doc › Globals › BroadPhase

Class: BroadPhase

The broad-phase wraps and extends a dynamic-tree to keep track of moved objects and query them on update.

Hierarchy

  • BroadPhase

Index

Properties

Methods

Properties

m_callback

• m_callback: function

Defined in src/collision/BroadPhase.ts:45

Type declaration:

▸ (userDataA: any, userDataB: any): void

Parameters:

Name Type
userDataA any
userDataB any

m_moveBuffer

• m_moveBuffer: any[] = []

Defined in src/collision/BroadPhase.ts:43


m_proxyCount

• m_proxyCount: number = 0

Defined in src/collision/BroadPhase.ts:42


m_queryProxyId

• m_queryProxyId: number

Defined in src/collision/BroadPhase.ts:46


m_tree

• m_tree: DynamicTree‹FixtureProxy‹›› = new DynamicTree()

Defined in src/collision/BroadPhase.ts:41

Methods

bufferMove

▸ bufferMove(proxyId: number): void

Defined in src/collision/BroadPhase.ts:172

Parameters:

Name Type
proxyId number

Returns: void


createProxy

▸ createProxy(aabb: AABB, userData: FixtureProxy): number

Defined in src/collision/BroadPhase.ts:135

Create a proxy with an initial AABB. Pairs are not reported until UpdatePairs is called.

Parameters:

Name Type
aabb AABB
userData FixtureProxy

Returns: number


destroyProxy

▸ destroyProxy(proxyId: number): void

Defined in src/collision/BroadPhase.ts:146

Destroy a proxy. It is up to the client to remove any pairs.

Parameters:

Name Type
proxyId number

Returns: void


getFatAABB

▸ getFatAABB(proxyId: number): AABB

Defined in src/collision/BroadPhase.ts:67

Get the fat AABB for a proxy.

Parameters:

Name Type
proxyId number

Returns: AABB


getProxyCount

▸ getProxyCount(): number

Defined in src/collision/BroadPhase.ts:74

Get the number of proxies.

Returns: number


getTreeBalance

▸ getTreeBalance(): number

Defined in src/collision/BroadPhase.ts:88

Get the balance (integer) of the embedded tree.

Returns: number


getTreeHeight

▸ getTreeHeight(): number

Defined in src/collision/BroadPhase.ts:81

Get the height of the embedded tree.

Returns: number


getTreeQuality

▸ getTreeQuality(): number

Defined in src/collision/BroadPhase.ts:95

Get the quality metric of the embedded tree.

Returns: number


getUserData

▸ getUserData(proxyId: number): FixtureProxy

Defined in src/collision/BroadPhase.ts:51

Get user data from a proxy. Returns null if the id is invalid.

Parameters:

Name Type
proxyId number

Returns: FixtureProxy


moveProxy

▸ moveProxy(proxyId: number, aabb: AABB, displacement: Vec2): void

Defined in src/collision/BroadPhase.ts:156

Call moveProxy as many times as you like, then when you are done call UpdatePairs to finalized the proxy pairs (for your time step).

Parameters:

Name Type
proxyId number
aabb AABB
displacement Vec2

Returns: void


query

▸ query(aabb: any, queryCallback: any): void

Defined in src/collision/BroadPhase.ts:103

Query an AABB for overlapping proxies. The callback class is called for each proxy that overlaps the supplied AABB.

Parameters:

Name Type
aabb any
queryCallback any

Returns: void


queryCallback

▸ queryCallback(proxyId: number): boolean

Defined in src/collision/BroadPhase.ts:210

Parameters:

Name Type
proxyId number

Returns: boolean


rayCast

▸ rayCast(input: RayCastInput, rayCastCallback: RayCastCallback): void

Defined in src/collision/BroadPhase.ts:117

Ray-cast against the proxies in the tree. This relies on the callback to perform a exact ray-cast in the case were the proxy contains a shape. The callback also performs the any collision filtering. This has performance roughly equal to k * log(n), where k is the number of collisions and n is the number of proxies in the tree.

Parameters:

Name Type Description
input RayCastInput The ray-cast input data. The ray extends from p1 to p1 + maxFraction * (p2 - p1).
rayCastCallback RayCastCallback A function that is called for each proxy that is hit by the ray.

Returns: void


shiftOrigin

▸ shiftOrigin(newOrigin: Vec2): void

Defined in src/collision/BroadPhase.ts:127

Shift the world origin. Useful for large worlds. The shift formula is: position -= newOrigin

Parameters:

Name Type Description
newOrigin Vec2 The new origin with respect to the old origin

Returns: void


testOverlap

▸ testOverlap(proxyIdA: number, proxyIdB: number): boolean

Defined in src/collision/BroadPhase.ts:58

Test overlap of fat AABBs.

Parameters:

Name Type
proxyIdA number
proxyIdB number

Returns: boolean


touchProxy

▸ touchProxy(proxyId: number): void

Defined in src/collision/BroadPhase.ts:168

Call to trigger a re-processing of it's pairs on the next call to UpdatePairs.

Parameters:

Name Type
proxyId number

Returns: void


unbufferMove

▸ unbufferMove(proxyId: number): void

Defined in src/collision/BroadPhase.ts:176

Parameters:

Name Type
proxyId number

Returns: void


updatePairs

▸ updatePairs(addPairCallback: function): void

Defined in src/collision/BroadPhase.ts:187

Update the pairs. This results in pair callbacks. This can only add pairs.

Parameters:

▪ addPairCallback: function

▸ (userDataA: FixtureProxy, userDataB: FixtureProxy): void

Parameters:

Name Type
userDataA FixtureProxy
userDataB FixtureProxy

Returns: void