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

Interface ConstSkeleton

All Superinterfaces:
AutoCloseable, Comparable<JoltPhysicsObject>, ConstJoltPhysicsObject
All Known Implementing Classes:
Skeleton, SkeletonRef
public interface ConstSkeleton extends ConstJoltPhysicsObject
Read-only access to a Skeleton. (native type: const Skeleton)

  • Method Details

    • areJointsCorrectlyOrdered

      boolean areJointsCorrectlyOrdered()
      Test whether the joints are correctly ordered, parents before children.
      Returns:
      true if in order, otherwise false

    • getJoint

      ConstJoint getJoint(int jointIndex)
      Access the specified joint.
      Parameters:
      jointIndex - the index of the joint to access (≥0)
      Returns:
      a new JVM object with the pre-existing native object assigned

    • getJointCount

      int getJointCount()
      Count how many joints are in the skeleton.
      Returns:
      the count (≥0)

    • getJointIndex

      int getJointIndex(String name)
      Find the index of the named joint.
      Parameters:
      name - the name of the joint to find
      Returns:
      the joint's index

    • getJoints

      ConstJoint[] getJoints()
      Access all the joints.
      Returns:
      a new array of new JVM objects with the pre-existing native objects assigned

    • saveBinaryState

      void saveBinaryState(StreamOut stream)
      Save the skeleton to the specified binary stream.
      Parameters:
      stream - the stream to write to (not null)