Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class BodyLockInterfaceLocking

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.NonCopyable

com.github.stephengold.joltjni.BodyLockInterface

com.github.stephengold.joltjni.BodyLockInterfaceLocking

All Implemented Interfaces:

ConstBodyLockInterface, ConstBodyLockInterfaceLocking, ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public class BodyLockInterfaceLocking
extends BodyLockInterface
implements ConstBodyLockInterfaceLocking

A BodyLockInterface that actually locks bodies.

Method Summary

Modifier and Type	Method	Description
SharedMutex	lockRead(int bodyId)	Lock the specified body for reading.
SharedMutex	lockWrite(int bodyId)	Lock the specified body for writing.
void	unlockRead(SharedMutex mutex)	Unlock the specified mutex, which was created to read a body.
void	unlockWrite(SharedMutex mutex)	Unlock the specified mutex, which was created to write a body.

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

getSystem

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstBodyLockInterface

getSystem

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstJoltPhysicsObject

close, hasAssignedNativeObject, ownsNativeObject, targetVa

Method Details

lockRead

public SharedMutex lockRead(int bodyId)

Lock the specified body for reading.

Specified by:

lockRead in interface ConstBodyLockInterface

Specified by:

lockRead in class BodyLockInterface

Parameters:

bodyId - the ID of the body to read

Returns:

a new mutex

lockWrite

public SharedMutex lockWrite(int bodyId)

Lock the specified body for writing.

Specified by:

lockWrite in interface ConstBodyLockInterface

Specified by:

lockWrite in class BodyLockInterface

Parameters:

bodyId - the ID of the body to write

Returns:

a new mutex

unlockRead

public void unlockRead(SharedMutex mutex)

Unlock the specified mutex, which was created to read a body.

Specified by:

unlockRead in interface ConstBodyLockInterface

Specified by:

unlockRead in class BodyLockInterface

Parameters:

mutex - the mutex to unlock (not null)

unlockWrite

public void unlockWrite(SharedMutex mutex)

Unlock the specified mutex, which was created to write a body.

Specified by:

unlockWrite in interface ConstBodyLockInterface

Specified by:

unlockWrite in class BodyLockInterface

Parameters:

mutex - the mutex to unlock (not null)