Package com.github.stephengold.joltjni

Class BodyLockWrite

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.NonCopyable
com.github.stephengold.joltjni.BodyLockWrite
All Implemented Interfaces:
ConstJoltPhysicsObject, AutoCloseable, Comparable<ConstJoltPhysicsObject>
public class BodyLockWrite extends NonCopyable
Lock a body for read-write access.

  • Constructor Details

    • BodyLockWrite

      public BodyLockWrite(BodyLockInterface bli, ConstBodyId id)
      Acquire a lock using the specified interface and ID.
      Parameters:
      bli - the interface to use (not null, unaffected)
      id - the ID of the body (not null, unaffected)

  • Method Details

    • getBody

      public Body getBody()
      Access the body.
      Returns:
      a new JVM object with the pre-existing native object assigned

    • releaseLock

      public void releaseLock()
      Explicitly release the lock. Normally this is done in the destructor.

    • succeeded

      public boolean succeeded()
      Test whether the lock was successfully acquired.
      Returns:
      true if acquired, otherwise false

    • succeededAndIsInBroadPhase

      public boolean succeededAndIsInBroadPhase()
      Test whether the lock was acquired and the body is still in broadphase.
      Returns:
      true if both conditions are met, otherwise false