com.bonzaiengine.model

Class Skeleton

java.lang.Object

com.bonzaiengine.model.Skeleton

All Implemented Interfaces:

java.lang.Cloneable

public final class Skeleton
extends java.lang.Object
implements java.lang.Cloneable

Constructor Summary

Constructors

Constructor and Description
Skeleton(JointMotion bindPose)

Method Summary

Modifier and Type	Method and Description
void	addMotion(JointMotion motion) Add a JointMotion to this Skeleton.
void	applySort(Model model, java.util.HashMap<java.lang.Integer,java.lang.Integer> sort)
Skeleton	duplicate()
void	filter(Model model, boolean[] keep) Internal use by Optimizer
JointMotion	getBindPose()
void	getBindPoseMatrixInv(int index, Mat4x4 dst)
JointMotion	getMotion(Animation animation)
JointMotion	getMotion(int index)
JointMotion	getMotion(java.lang.String motionName)
int	getNumMotions()
int	jointNameToID(java.lang.String jointName)
void	makeBindPoseMatrices() Compute JointKey.transformBindPose for all skeleton keys
Motion	merge(Model model, Motion motion) Add a compatible skeletal animation to the model
void	reconnectJoints(int oldIndex, int newIndex) Reconnect hierarchy replacing link to oldIndex by newIndex
boolean	removeMotion(JointMotion motion) Remove a JointMotion from this Skeleton.
void	renameJoint(int jointID, java.lang.String newName)
void	renameMotion(Model model, JointMotion motion, java.lang.String newName) Safely rename a JointMotion, ie update all references
void	replaceJointInfluence(Model model, java.lang.String oldJointName, java.lang.String newJointName)
Motion	retarget(Model model, Motion motion, JointMotion animBindPose, java.util.Map<java.lang.String,java.lang.String> modelToMotionName, java.util.Set<java.lang.String> keepInitialBindPose, boolean ignoreFirstFrame, boolean reorientLastJoint, boolean optimize, java.lang.String name) Re-target an animation to the skeleton
java.util.HashMap<java.lang.Integer,java.lang.Integer>	sort() Sort joint to the format expected by the engine.
void	transform(Mat4x4 matrix) Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Skeleton

public Skeleton(JointMotion bindPose)

Method Detail

duplicate

public final Skeleton duplicate()

getBindPose

public final JointMotion getBindPose()

Returns:

Bind-pose JointMotion: it defines the Joint hierarchy, naming and initial pose of this Skeleton

getNumMotions

public final int getNumMotions()

Returns:

the number of JointMotion, not including the bind pose

getMotion

public final JointMotion getMotion(Animation animation)

Returns:

the JointMotion used by the specified Animation, or bind pose

getMotion

public final JointMotion getMotion(int index)

Returns:

index index o the JointMotion to get

getMotion

public final JointMotion getMotion(java.lang.String motionName)

Returns:

the JointMotion , or null if not found

addMotion

public final void addMotion(JointMotion motion)

Add a JointMotion to this Skeleton.
This method does not create any Animation object that uses the JointMotion, for that use Model.addAnimation(Animation, JointMotion) instead.

Parameters:

motion - JointMotion to add

See Also:

Model.addAnimation(Animation, JointMotion)

removeMotion

public final boolean removeMotion(JointMotion motion)

Remove a JointMotion from this Skeleton.
This method does not remove any Animation that uses the specified JointMotion

Parameters:

motion - JointMotion to remove

makeBindPoseMatrices

public final void makeBindPoseMatrices()

Compute JointKey.transformBindPose for all skeleton keys

getBindPoseMatrixInv

public final void getBindPoseMatrixInv(int index,
                                       Mat4x4 dst)

transform

@Deprecated
public final void transform(Mat4x4 matrix)

Deprecated.

Internal use.

sort

public final java.util.HashMap<java.lang.Integer,java.lang.Integer> sort()

Sort joint to the format expected by the engine. Used by readers.

Returns:

the mapping between old and new joint indices. Must be used with applySort(Model, HashMap)

applySort

public final void applySort(Model model,
                            java.util.HashMap<java.lang.Integer,java.lang.Integer> sort)

Parameters:

model - Model to apply sorting

sort - mapping between old and new joint indices, which usually come from sort().

replaceJointInfluence

public final void replaceJointInfluence(Model model,
                                        java.lang.String oldJointName,
                                        java.lang.String newJointName)

Parameters:

model - Model to apply sorting

filter

public final void filter(Model model,
                         boolean[] keep)

Internal use by Optimizer

jointNameToID

public final int jointNameToID(java.lang.String jointName)

retarget

public final Motion retarget(Model model,
                             Motion motion,
                             JointMotion animBindPose,
                             java.util.Map<java.lang.String,java.lang.String> modelToMotionName,
                             java.util.Set<java.lang.String> keepInitialBindPose,
                             boolean ignoreFirstFrame,
                             boolean reorientLastJoint,
                             boolean optimize,
                             java.lang.String name)

Re-target an animation to the skeleton

Parameters:

model - Model

motion - animation to re-target

animBindPose - bind pose of the animation to be re-targeted

modelToMotionName - Joint name mapping between model joint (key) and motion joint (value)

keepInitialBindPose - Joint list of model joint name. The retarget algorithm use this for better anatomic binding between model and motion.

reorientLastJoint - reorient last joint, using true may sometimes result to artifact with the current algorithm

optimize - optimize memory usage. Recommended in general cases (except when the model is fully optimized), but consume noticeable amount of time

name - name of the retargetted motion, optional: null to use name from motion parameter

Returns:

the Motion retargetted

merge

public final Motion merge(Model model,
                          Motion motion)

Add a compatible skeletal animation to the model

Parameters:

model - model

motion - skeletal animation to merge in the model

Returns:

the Motion merged to this Skeleton

renameJoint

public final void renameJoint(int jointID,
                              java.lang.String newName)

Parameters:

jointID - index of the joint to rename

newName - new name

reconnectJoints

public final void reconnectJoints(int oldIndex,
                                  int newIndex)

Reconnect hierarchy replacing link to oldIndex by newIndex

Parameters:

oldIndex - old parent index

newIndex - new parent index

renameMotion

public final void renameMotion(Model model,
                               JointMotion motion,
                               java.lang.String newName)

Safely rename a JointMotion, ie update all references

Parameters:

motion -

newName -