API reference

BodySkeletonMapping Class

Maps a skeleton with joint id TSourceJointId to BodyJointId, and exposes parent/child relationships within the skeleton.

Constructors

BodySkeletonMapping ( root , jointMapping )

Signature

BodySkeletonMapping(TSourceJointId root, IReadOnlyDictionary< BodyJointId, JointInfo > jointMapping)

Parameters

root: TSourceJointId

jointMapping: IReadOnlyDictionary< BodyJointId, JointInfo >

Joints : IEnumerableHashSet< BodyJointId >

[Get]

The set of BodyJointIds supported by this skeleton.

Signature

IEnumerableHashSet<BodyJointId> Joints

GetBodyJointFromSourceJoint ( sourceJointId )	Signature BodyJointId GetBodyJointFromSourceJoint(TSourceJointId sourceJointId) Parameters `sourceJointId: TSourceJointId` Returns `BodyJointId`
GetSourceJointFromBodyJoint ( jointId )	Signature TSourceJointId GetSourceJointFromBodyJoint(BodyJointId jointId) Parameters `jointId: BodyJointId` Returns `TSourceJointId`

TryGetBodyJointId ( jointId , bodyJointId )	Signature bool TryGetBodyJointId(TSourceJointId jointId, out BodyJointId bodyJointId) Parameters `jointId: TSourceJointId` `bodyJointId: out BodyJointId` Returns `bool`
TryGetParentJointId ( jointId , parent )	Get the parent joint for a given body joint. Signature bool TryGetParentJointId(BodyJointId jointId, out BodyJointId parentJointId) Parameters `jointId: BodyJointId` The joint to fetch the parent for `parent: out BodyJointId` The parent joint Returns `bool` True if parent could be retrieved
TryGetSourceJointId ( jointId , sourceJointId )	Signature bool TryGetSourceJointId(BodyJointId jointId, out TSourceJointId sourceJointId) Parameters `jointId: BodyJointId` `sourceJointId: out TSourceJointId` Returns `bool`

JointInfo ( sourceJointId , parentJointId )

Signature

JointInfo(TSourceJointId sourceJointId, TSourceJointId parentJointId)

Parameters

sourceJointId: TSourceJointId

parentJointId: TSourceJointId

ParentJointId : readonly TSourceJointId	Signature readonly TSourceJointId ParentJointId
SourceJointId : readonly TSourceJointId	Signature readonly TSourceJointId SourceJointId