Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions examples/jsm/utils/SkeletonUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,13 @@ function getBoneName( bone, options ) {
}

/**
* Retargets the skeleton from the given source 3D object to the
* target 3D object.
* Retargets the skeleton from the given source to the target.
*
* @param {Object3D} target - The target 3D object.
* @param {Object3D} source - The source 3D object.
* Both `target` and `source` can be a 3D object with a skeleton property (e.g. a skinned mesh)
* or a {@link Skeleton} directly.
*
* @param {Object3D|Skeleton} target - The target object.
* @param {Object3D|Skeleton} source - The source object.
* @param {module:SkeletonUtils~RetargetOptions} options - The options.
*/
function retarget( target, source, options = {} ) {
Expand Down Expand Up @@ -210,11 +212,13 @@ function retarget( target, source, options = {} ) {
}

/**
* Retargets the animation clip of the source object to the
* target 3D object.
* Retargets the animation clip of the source to the target 3D object.
*
* The `source` can be a 3D object with a skeleton property (e.g. a skinned mesh)
* or a {@link Skeleton} directly.
*
* @param {Object3D} target - The target 3D object.
* @param {Object3D} source - The source 3D object.
* @param {Object3D} target - The target 3D object. Must have a `skeleton` property.
* @param {Object3D|Skeleton} source - The source object.
* @param {AnimationClip} clip - The animation clip.
* @param {module:SkeletonUtils~RetargetOptions} options - The options.
* @return {AnimationClip} The retargeted animation clip.
Expand Down Expand Up @@ -481,6 +485,8 @@ function parallelTraverse( a, b, callback ) {
* @property {string} [hip='hip'] - The name of the source's hip bone.
* @property {Vector3} [hipInfluence=(1,1,1)] - The hip influence.
* @property {number} [scale=1] - The scale.
* @property {Object<string,Matrix4>} [localOffsets] - Per-bone local offset matrices, keyed by bone name.
* @property {Vector3} [hipPosition] - An additional position offset applied to the hip bone.
**/

export {
Expand Down
Loading