Package com.github.stephengold.joltjni

Class BodyLockInterface

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.NonCopyable

com.github.stephengold.joltjni.BodyLockInterface

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<ConstJoltPhysicsObject>

Direct Known Subclasses:

BodyLockInterfaceLocking, BodyLockInterfaceNoLock

public abstract class BodyLockInterface
extends NonCopyable

An interface to a PhysicsSystem that is aware of body locking.

Method Summary

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

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

getSystem

public PhysicsSystem getSystem()

Access the underlying PhysicsSystem.

Returns:

the pre-existing instance

lockRead

public abstract SharedMutex lockRead(ConstBodyId bodyId)

Lock the specified body for reading.

Parameters:

bodyId - the body to read (not null, unaffected)

Returns:

a new mutex

lockWrite

public abstract SharedMutex lockWrite(ConstBodyId bodyId)

Lock the specified body for writing.

Parameters:

bodyId - the body to write (not null, unaffected)

Returns:

a new mutex

unlockRead

public abstract void unlockRead(SharedMutex mutex)

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

Parameters:

mutex - the mutex to unlock (not null)

unlockWrite

public abstract void unlockWrite(SharedMutex mutex)

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

Parameters:

mutex - the mutex to unlock (not null)