SkeletonProfile

public int BoneSize { get; set; }

The amount of bones in retargeting section's BoneMap editor. For example, SkeletonProfileHumanoid has 56 bones. The size of elements in BoneMap updates when changing this property in its assigned SkeletonProfile.

public int GroupSize { get; set; }

The amount of groups of bones in retargeting section's BoneMap editor. For example, SkeletonProfileHumanoid has 4 groups. This property exists to separate the bone list into several sections in the editor.

public StringName RootBone { get; set; }

A bone name that will be used as the root bone in AnimationTree. This should be the bone of the parent of hips that exists at the world origin.

public StringName ScaleBaseBone { get; set; }

A bone name which will use model's height as the coefficient for normalization. For example, SkeletonProfileHumanoid defines it as Hips.

public int FindBone(StringName boneName);

Returns the bone index that matches bone_name as its name.

public StringName GetBoneName(int boneIdx);

Returns the name of the bone at bone_idx that will be the key name in the BoneMap. In the retargeting process, the returned bone name is the bone name of the target skeleton.

public StringName GetBoneParent(int boneIdx);

Returns the name of the bone which is the parent to the bone at bone_idx. The result is empty if the bone has no parent.

public StringName GetBoneTail(int boneIdx);

Returns the name of the bone which is the tail of the bone at bone_idx.

public StringName GetGroup(int boneIdx);

Returns the group of the bone at bone_idx.

public StringName GetGroupName(int groupIdx);

Returns the name of the group at group_idx that will be the drawing group in the BoneMap editor.

public Vector2 GetHandleOffset(int boneIdx);

Returns the offset of the bone at bone_idx that will be the button position in the BoneMap editor. This is the offset with origin at the top left corner of the square.

public Transform3D GetReferencePose(int boneIdx);

Returns the reference pose transform for bone bone_idx.

public SkeletonProfile.TailDirection GetTailDirection(int boneIdx);

Returns the tail direction of the bone at bone_idx.

public Texture2D GetTexture(int groupIdx);

Returns the texture of the group at group_idx that will be the drawing group background image in the BoneMap editor.

public bool IsRequired(int boneIdx);

Returns whether the bone at bone_idx is required for retargeting. This value is used by the bone map editor. If this method returns true, and no bone is assigned, the handle color will be red on the bone map editor.

public void SetBoneName(int boneIdx, StringName boneName);

Sets the name of the bone at bone_idx that will be the key name in the BoneMap. In the retargeting process, the setting bone name is the bone name of the target skeleton.

public void SetBoneParent(int boneIdx, StringName boneParent);

Sets the bone with name bone_parent as the parent of the bone at bone_idx. If an empty string is passed, then the bone has no parent.

public void SetBoneTail(int boneIdx, StringName boneTail);

Sets the bone with name bone_tail as the tail of the bone at bone_idx.

public void SetGroup(int boneIdx, StringName group);

Sets the group of the bone at bone_idx.

public void SetGroupName(int groupIdx, StringName groupName);

Sets the name of the group at group_idx that will be the drawing group in the BoneMap editor.

public void SetHandleOffset(int boneIdx, Vector2 handleOffset);

Sets the offset of the bone at bone_idx that will be the button position in the BoneMap editor. This is the offset with origin at the top left corner of the square.

public void SetReferencePose(int boneIdx, Transform3D boneName);

Sets the reference pose transform for bone bone_idx.

public void SetRequired(int boneIdx, bool required);

Sets the required status for bone bone_idx to required.

public void SetTailDirection(int boneIdx, SkeletonProfile.TailDirection tailDirection);

Sets the tail direction of the bone at bone_idx. Note: This only specifies the method of calculation. The actual coordinates required should be stored in an external skeleton, so the calculation itself needs to be done externally.

public void SetTexture(int groupIdx, Texture2D texture);

Sets the texture of the group at group_idx that will be the drawing group background image in the BoneMap editor.

public event Action ProfileUpdated;

This signal is emitted when change the value in profile. This is used to update key name in the BoneMap and to redraw the BoneMap editor. Note: This signal is not connected directly to editor to simplify the reference, instead it is passed on to editor through the BoneMap.