Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class BodyIdArray

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.BodyIdArray

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public class BodyIdArray
extends JoltPhysicsObject

A fixed-length array of body IDs. (native type: BodyID[])

Constructor Summary

Constructors

Constructor	Description
BodyIdArray(int length)	Instantiate an uninitialized array with the specified length.
BodyIdArray(int... idArray)	Instantiate an array initialized from a Java array.
BodyIdArray(IntBuffer idBuffer)	Instantiate an array initialized from a direct buffer.
BodyIdArray(List<Integer> idList)	Instantiate an array initialized from a Java list.

Method Summary

Modifier and Type	Method	Description
int	get(int elementIndex)	Return the ID at the specified index.
int	length()	Return the length of the array.
void	set(int elementIndex, int bodyId)	Store the specified ID at the specified index.

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

Constructor Details

BodyIdArray

public BodyIdArray(int length)

Instantiate an uninitialized array with the specified length.

Parameters:

length - the desired number of IDs (>0)

BodyIdArray

public BodyIdArray(int... idArray)

Instantiate an array initialized from a Java array.

Parameters:

idArray - the ID values (not null, not empty, unaffected)

BodyIdArray

public BodyIdArray(IntBuffer idBuffer)

Instantiate an array initialized from a direct buffer.

Parameters:

idBuffer - the ID values (not null, direct, positive capacity, unaffected)

BodyIdArray

public BodyIdArray(List<Integer> idList)

Instantiate an array initialized from a Java list.

Parameters:

idList - the ID values (not null, not empty, unaffected)

Method Details

get

public int get(int elementIndex)

Return the ID at the specified index.

Parameters:

elementIndex - the index from which to copy the ID (≥0)

Returns:

the BodyID value

length

public int length()

Return the length of the array.

Returns:

the length (in IDs)

set

public void set(int elementIndex,
 int bodyId)

Store the specified ID at the specified index.

Parameters:

elementIndex - the index at which to store the ID (≥0)

bodyId - the ID to store