Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class SkeletonPose

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.SkeletonPose

All Implemented Interfaces:

ConstJoltPhysicsObject, ConstSkeletonPose, AutoCloseable, Comparable<JoltPhysicsObject>

public class SkeletonPose
extends JoltPhysicsObject
implements ConstSkeletonPose

A skeleton with joint transforms specifying a pose.

Constructor Summary

Constructors

Constructor	Description
SkeletonPose()	Instantiate a default pose.
SkeletonPose(ConstSkeletonPose original)	Instantiate a clone of the specified pose.

Method Summary

Modifier and Type	Method	Description
void	calculateJointMatrices()	Convert the joint transforms to matrices.
void	calculateJointStates()	Convert the joint matrices to joint states.
void	calculateLocalSpaceJointMatrices(Mat44Array storeMatrices)	Calculate the joint matrices in local space.
void	draw(SkeletonPoseDrawSettings settings, DebugRenderer renderer)	Draw the current pose using the specified settings and renderer.
void	draw(SkeletonPoseDrawSettings settings, DebugRenderer renderer, RMat44Arg transform)	Draw the current pose using the specified settings and renderer.
JointState	getJoint(int jointIndex)	Access the transforms of the specified joint.
int	getJointCount()	Count how many joints are in the pose.
Mat44Array	getJointMatrices()	Access the joint matrices.
Mat44	getJointMatrix(int jointIndex)	Access the transform matrix for the specified joint.
RVec3	getRootOffset()	Copy the root offset.
ConstSkeleton	getSkeleton()	Access the skeleton that underlies this pose.
void	setRootOffset(RVec3Arg offset)	Alter the root offset.
void	setSkeleton(ConstSkeleton skeleton)	Replace the skeleton.

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstJoltPhysicsObject

close, hasAssignedNativeObject, ownsNativeObject, targetVa

Constructor Details

SkeletonPose

public SkeletonPose()

Instantiate a default pose.

SkeletonPose

public SkeletonPose(ConstSkeletonPose original)

Instantiate a clone of the specified pose.

Parameters:

original - the pose to clone (not null, unaffected)

Method Details

calculateJointMatrices

public void calculateJointMatrices()

Convert the joint transforms to matrices.

calculateJointStates

public void calculateJointStates()

Convert the joint matrices to joint states.

getJointMatrices

public Mat44Array getJointMatrices()

Access the joint matrices.

Returns:

a new JVM object with the pre-existing native object assigned

setRootOffset

public void setRootOffset(RVec3Arg offset)

Alter the root offset.

Parameters:

offset - the desired offset (not null, unaffected)

setSkeleton

public void setSkeleton(ConstSkeleton skeleton)

Replace the skeleton.

Parameters:

skeleton - the desired skeleton (not null)

calculateLocalSpaceJointMatrices

public void calculateLocalSpaceJointMatrices(Mat44Array storeMatrices)

Calculate the joint matrices in local space. The pose is unaffected.

Specified by:

calculateLocalSpaceJointMatrices in interface ConstSkeletonPose

Parameters:

storeMatrices - storage for the matrices (not null, modified)

draw

public void draw(SkeletonPoseDrawSettings settings,
 DebugRenderer renderer)

Draw the current pose using the specified settings and renderer. The pose is unaffected.

Specified by:

draw in interface ConstSkeletonPose

Parameters:

settings - the desired settings (not null, unaffected)

renderer - the renderer to use (not null)

draw

public void draw(SkeletonPoseDrawSettings settings,
 DebugRenderer renderer,
 RMat44Arg transform)

Draw the current pose using the specified settings and renderer. The pose is unaffected.

Specified by:

draw in interface ConstSkeletonPose

Parameters:

settings - the desired settings (not null, unaffected)

renderer - the renderer to use (not null)

transform - the transform to apply (not null, unaffected, default=Identity)

getJoint

public JointState getJoint(int jointIndex)

Access the transforms of the specified joint. The pose is unaffected.

Specified by:

getJoint in interface ConstSkeletonPose

Parameters:

jointIndex - the index of the joint to access

Returns:

a new JVM object with the pre-existing native object assigned

getJointCount

public int getJointCount()

Count how many joints are in the pose. The pose is unaffected.

Specified by:

getJointCount in interface ConstSkeletonPose

Returns:

the count (≥0)

getJointMatrix

public Mat44 getJointMatrix(int jointIndex)

Access the transform matrix for the specified joint. The pose is unaffected.

Specified by:

getJointMatrix in interface ConstSkeletonPose

Parameters:

jointIndex - which joint (≥0)

Returns:

a new JVM object with the pre-existing native object assigned

getRootOffset

public RVec3 getRootOffset()

Copy the root offset. The pose is unaffected.

Specified by:

getRootOffset in interface ConstSkeletonPose

Returns:

a new vector

getSkeleton

public ConstSkeleton getSkeleton()

Access the skeleton that underlies this pose. The pose is unaffected.

Specified by:

getSkeleton in interface ConstSkeletonPose

Returns:

a new JVM object with the pre-existing native object assigned