Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class CharacterContactKey

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.CharacterContactKey

All Implemented Interfaces:

ConstCharacterContactKey, ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

Direct Known Subclasses:

CharacterContact

public class CharacterContactKey
extends JoltPhysicsObject
implements ConstCharacterContactKey

Identify a contact between a virtual character and a body or another virtual character. (native type: CharacterContactKey)

Constructor Summary

Constructors

Constructor	Description
CharacterContactKey()	Instantiate a default key.
CharacterContactKey(char idType, int bodyOrCharacterId, int subShapeId)	Instantiate a key with the specified parameters.
CharacterContactKey(CharacterContactKey original)	Instantiate a copy of the specified key.

Method Summary

Modifier and Type	Method	Description
int	getBodyB()	Return the ID of the colliding body.
int	getCharacterIdB()	Return the ID of the colliding character.
int	getSubShapeIdB()	Return the sub-shape ID of the colliding body.
boolean	isEqual(ConstCharacterContactKey other)	Test for content equivalence with another key.
boolean	isNotEqual(ConstCharacterContactKey other)	Test for content equivalence with another key.
void	restoreState(StateRecorder recorder)	Restore the key from the specified recorder.
void	saveState(StateRecorder recorder)	Save the key to the specified recorder.
String	toString()	Return a string representation of the properties object, which is unaffected.

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

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, isCleanerStarted, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, 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.ConstJoltPhysicsObject

close, hasAssignedNativeObject, ownsNativeObject, targetVa

Constructor Details

CharacterContactKey

public CharacterContactKey()

Instantiate a default key.

CharacterContactKey

public CharacterContactKey(char idType,
 int bodyOrCharacterId,
 int subShapeId)

Instantiate a key with the specified parameters.

Parameters:

idType - "b" for body or "c" for character

bodyOrCharacterId - the BodyID or CharacterID of the other colliding object

subShapeId - the SubShapeID of the shape that is in contact

CharacterContactKey

public CharacterContactKey(CharacterContactKey original)

Instantiate a copy of the specified key.

Parameters:

original - the settings to copy (not null, unaffected)

Method Details

restoreState

public void restoreState(StateRecorder recorder)

Restore the key from the specified recorder.

Parameters:

recorder - the recorder to restore from (not null)

getBodyB

public int getBodyB()

Return the ID of the colliding body. The key is unaffected. (native attribute: mBodyB)

Specified by:

getBodyB in interface ConstCharacterContactKey

Returns:

the BodyID value

getCharacterIdB

public int getCharacterIdB()

Return the ID of the colliding character. The key is unaffected. (native attribute: mCharacterIDB)

Specified by:

getCharacterIdB in interface ConstCharacterContactKey

Returns:

the CharacterID value

getSubShapeIdB

public int getSubShapeIdB()

Return the sub-shape ID of the colliding body. The contact is unaffected. (native attribute: mSubShapeIDB)

Specified by:

getSubShapeIdB in interface ConstCharacterContactKey

Returns:

a SubShapeID value (typically negative)

isEqual

public boolean isEqual(ConstCharacterContactKey other)

Test for content equivalence with another key. The key is unaffected. (native operator: binary ==)

Specified by:

isEqual in interface ConstCharacterContactKey

Parameters:

other - the key to compare with (not null, unaffected)

Returns:

true if equivalent, otherwise false

isNotEqual

public boolean isNotEqual(ConstCharacterContactKey other)

Test for content equivalence with another key. The key is unaffected.(native operator: binary !=)

Specified by:

isNotEqual in interface ConstCharacterContactKey

Parameters:

other - the key to compare with (not null, unaffected)

Returns:

false if equivalent, otherwise true

saveState

public void saveState(StateRecorder recorder)

Save the key to the specified recorder. The key is unaffected.

Specified by:

saveState in interface ConstCharacterContactKey

Parameters:

recorder - the recorder to save to (not null)

toString

public String toString()

Return a string representation of the properties object, which is unaffected.

Overrides:

toString in class JoltPhysicsObject

Returns:

the string representation (not null, not empty)