Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class BodyLockMultiRead

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.NonCopyable

com.github.stephengold.joltjni.BodyLockMultiBase

com.github.stephengold.joltjni.BodyLockMultiRead

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public class BodyLockMultiRead
extends BodyLockMultiBase

Lock multiple bodies for read-only access.

Field Summary

Fields inherited from class com.github.stephengold.joltjni.BodyLockMultiBase

bli, idArray

Constructor Summary

Constructors

Constructor	Description
BodyLockMultiRead(ConstBodyLockInterface bli, int... bodyIds)	Acquire body locks using the specified interface and body IDs.
BodyLockMultiRead(ConstBodyLockInterface bli, ConstBodyIdArray bodyIds)	Acquire body locks using the specified interface and body IDs.

Method Summary

Modifier and Type	Method	Description
ConstBody[]	getBodies()	Access all the bodies.
ConstBody	getBody(int index)	Access a specific body.
int	getNumBodies()	Count the bodies that were locked.
void	releaseLocks()	Release all the locks.

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

getBodyIdArray

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

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, isCleanerStarted, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, toString, va

Methods inherited from class java.lang.Object

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

Constructor Details

BodyLockMultiRead

public BodyLockMultiRead(ConstBodyLockInterface bli,
 ConstBodyIdArray bodyIds)

Acquire body locks using the specified interface and body IDs.

Parameters:

bli - the lock interface to use (not null, alias created)

bodyIds - the IDs of the bodies to lock (not null, alias created)

BodyLockMultiRead

public BodyLockMultiRead(ConstBodyLockInterface bli,
 int... bodyIds)

Acquire body locks using the specified interface and body IDs.

Parameters:

bli - the lock interface to use (not null, alias created)

bodyIds - the IDs of the bodies to lock (not empty)

Method Details

getBodies

public ConstBody[] getBodies()

Access all the bodies.

Specified by:

getBodies in class BodyLockMultiBase

Returns:

a new array

getBody

public ConstBody getBody(int index)

Access a specific body.

Specified by:

getBody in class BodyLockMultiBase

Parameters:

index - into the array of body IDs (≥0)

Returns:

a new JVM object with the pre-existing native object assigned, or null if not available

getNumBodies

public int getNumBodies()

Count the bodies that were locked.

Specified by:

getNumBodies in class BodyLockMultiBase

Returns:

the number of bodies (≥0)

releaseLocks

public void releaseLocks()

Release all the locks.

Specified by:

releaseLocks in class BodyLockMultiBase