Package com.github.stephengold.joltjni

Class BroadPhase

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.NonCopyable

com.github.stephengold.joltjni.BroadPhaseQuery

com.github.stephengold.joltjni.BroadPhase

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<ConstJoltPhysicsObject>

Direct Known Subclasses:

BroadPhaseBruteForce, BroadPhaseQuadTree

public abstract class BroadPhase
extends BroadPhaseQuery

Coarse collision-detection phase to quickly eliminate body pairs that cannot collide.

Method Summary

Modifier and Type	Method	Description
void	addBodiesAbort(BodyId[] bodyIds, int numBodies, long addState)	Abort adding bodies to the phase.
void	addBodiesAbort(BodyId[] bodyIds, long addState)	Abort adding bodies to the phase.
void	addBodiesFinalize(BodyId[] bodyIds, int numBodies, long addState)	Finish adding bodies to the phase.
void	addBodiesFinalize(BodyId[] bodyIds, long addState)	Finish adding bodies to the phase.
long	addBodiesPrepare(BodyId... bodyIds)	Prepare to add a batch of bodies to the phase.
long	addBodiesPrepare(BodyId[] bodyIds, int numBodies)	Prepare for adding multiple bodies to the phase.
void	init(BodyManager manager, ConstBroadPhaseLayerInterface map)	Initialize the phase.
void	notifyBodiesAabbChanged(BodyId... bodyIds)	Invoke whenever the bounding boxes of some bodies change.
void	notifyBodiesAabbChanged(BodyId[] bodyIds, int numBodies)	Invoke whenever the bounding boxes of some bodies change.
void	notifyBodiesAabbChanged(BodyId[] bodyIds, int numBodies, boolean takeLock)	Invoke whenever the bounding boxes of some bodies change.
void	optimize()	Optimize the phase after adding objects.
void	removeBodies(BodyId... bodyIds)	Remove multiple bodies from the phase.
void	removeBodies(BodyId[] bodyIds, int numBodies)	Remove multiple bodies from the phase.

Methods inherited from class com.github.stephengold.joltjni.BroadPhaseQuery

castRay, castRay, castRay, collideAaBox, collideAaBox, collideAaBox, collidePoint, collideSphere, getSystem

Methods inherited from class com.github.stephengold.joltjni.JoltPhysicsObject

close, compareTo, equals, hasAssignedNativeObject, hashCode, ownsNativeObject, setVirtualAddress, startCleaner, toString, va

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

addBodiesAbort

public void addBodiesAbort(BodyId[] bodyIds,
 long addState)

Abort adding bodies to the phase.

Parameters:

bodyIds - the IDs of the bodies to be added (not null, unmodified since the handle was created)

addState - the handle returned by addBodiesPrepare()

addBodiesAbort

public void addBodiesAbort(BodyId[] bodyIds,
 int numBodies,
 long addState)

Abort adding bodies to the phase.

Parameters:

bodyIds - the IDs of the bodies to be added (not null, unmodified since the handle was created)

numBodies - the number of bodies to be added (≥0)

addState - the handle returned by addBodiesPrepare()

addBodiesFinalize

public void addBodiesFinalize(BodyId[] bodyIds,
 long addState)

Finish adding bodies to the phase.

Parameters:

bodyIds - the IDs of the bodies to be added (not null, unmodified since the handle was created)

addState - the handle returned by addBodiesPrepare()

addBodiesFinalize

public void addBodiesFinalize(BodyId[] bodyIds,
 int numBodies,
 long addState)

Finish adding bodies to the phase.

Parameters:

bodyIds - the IDs of the bodies to be added (not null, unmodified since the handle was created)

numBodies - the number of bodies to be added (≥0)

addState - the handle returned by addBodiesPrepare()

addBodiesPrepare

public long addBodiesPrepare(BodyId... bodyIds)

Prepare to add a batch of bodies to the phase.

Parameters:

bodyIds - the IDs of the bodies to be added (not null)

Returns:

a handle to be passed to addBodiesFinalize() or addBodiesFinalize()

addBodiesPrepare

public long addBodiesPrepare(BodyId[] bodyIds,
 int numBodies)

Prepare for adding multiple bodies to the phase.

Parameters:

bodyIds - the IDs of the bodies to be added (not null, possibly shuffled)

numBodies - the number of bodies to be added (≥0)

Returns:

a handle to be passed to addBodiesFinalize() or addBodiesFinalize()

init

public void init(BodyManager manager,
 ConstBroadPhaseLayerInterface map)

Initialize the phase.

Parameters:

manager - the manager to use (not null)

map - the desired map from object layers to broad-phase layers (not null, alias created)

optimize

public void optimize()

Optimize the phase after adding objects.

notifyBodiesAabbChanged

public void notifyBodiesAabbChanged(BodyId... bodyIds)

Invoke whenever the bounding boxes of some bodies change.

Parameters:

bodyIds - the IDs of the bodies to be notified (not null)

notifyBodiesAabbChanged

public void notifyBodiesAabbChanged(BodyId[] bodyIds,
 int numBodies)

Invoke whenever the bounding boxes of some bodies change.

Parameters:

bodyIds - the IDs of the bodies to be notified (not null)

numBodies - the number of bodies to be notified (≥0)

notifyBodiesAabbChanged

public void notifyBodiesAabbChanged(BodyId[] bodyIds,
 int numBodies,
 boolean takeLock)

Invoke whenever the bounding boxes of some bodies change.

Parameters:

bodyIds - the IDs of the bodies to be notified (not null)

numBodies - the number of bodies to be notified (≥0)

takeLock - true to acquire a lock, otherwise false

removeBodies

public void removeBodies(BodyId... bodyIds)

Remove multiple bodies from the phase.

Parameters:

bodyIds - the IDs of the bodies to be removed (not null)

removeBodies

public void removeBodies(BodyId[] bodyIds,
 int numBodies)

Remove multiple bodies from the phase.

Parameters:

bodyIds - the IDs of the bodies to be removed (not null, possibly shuffled)

numBodies - the number of bodies to be removed (≥0)