Module com.github.stephengold.joltjni
Package com.github.stephengold.joltjni.readonly

Interface ConstContactKey

All Superinterfaces:
AutoCloseable, Comparable<JoltPhysicsObject>, ConstJoltPhysicsObject
All Known Subinterfaces:
ConstContact
All Known Implementing Classes:
Contact, ContactKey
public interface ConstContactKey extends ConstJoltPhysicsObject
Read-only access to a ContactKey. (native type: const CharacterVirtual::ContactKey)

  • Method Details

    • getBodyB

      int getBodyB()
      Return the ID of the colliding body. The key is unaffected.
      Returns:
      the BodyID value

    • getCharacterIdB

      int getCharacterIdB()
      Return the ID of the colliding character. The key is unaffected.
      Returns:
      the CharacterID value

    • getSubShapeIdB

      int getSubShapeIdB()
      Return the sub-shape ID of the colliding body. The key is unaffected.
      Returns:
      a SubShapeID value (typically negative)

    • isEqual

      boolean isEqual(ConstContactKey other)
      Test for equivalence with another key. Both keys are unaffected.
      Parameters:
      other - the key to compare with (not null)
      Returns:
      true if equivalent, otherwise false

    • isNotEqual

      boolean isNotEqual(ConstContactKey other)
      Test for equivalence with another key. Both keys are unaffected.
      Parameters:
      other - the key to compare with (not null)
      Returns:
      false if equivalent, otherwise true

    • saveState

      void saveState(StateRecorder recorder)
      Save the key to the specified recorder. The key is unaffected.
      Parameters:
      recorder - the recorder to save to (not null)