UxrAvatarRig Class

Stores references to all elements in an avatar rig. These are the Transform components of the bones that drive the visual representation of a humanoid avatar. It also contains functionality to transform the hand using hand poses.

Inheritance Hierarchy

System.Object
UltimateXR.Avatar.Rig.UxrAvatarRig
Namespace: UltimateXR.Avatar.Rig
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

[SerializableAttribute]
public class UxrAvatarRig

The UxrAvatarRig type exposes the following members.

Constructors

	Name	Description
	UxrAvatarRig	Constructor.

Properties

	Name	Description
	Chest	Gets the chest transform or null if there isn’t any.
	Head	Gets the head.
	Hips	Gets the hips transform or null if there isn’t any.
	LeftArm	Gets the left arm.
	LeftLeg	Gets the left leg.
	RightArm	Gets the right arm.
	RightLeg	Gets the right leg.
	Spine	Gets the spine transform or null if there isn’t any.
	Transforms	Gets a sequence of all the non-null transforms in the avatar rig.
	UpperChest	Gets the upper chest transform or null if there isn’t any.

Methods

	Name	Description
	ClearRigElements	Sets all the rig element references to null.
	CurlFinger	Curls an avatar finger.
	GetArms	Gets the avatar arms.
	GetHandSide	Checks which side a transform is part of, based on which wrist it hangs from or if it hangs from an UxrHandIntegration.
	HasAnyUpperBodyIKReference	Gets whether the given rig has any of the references used in upper body IK (head, neck, upper chest, chest or spine).
	HasArmData	Gets whether the given rig has all arm references (upper arm, forearm and hand).
	HasFingerData()	Gets whether the given rig has all finger data.
	HasFingerData(UxrHandSide)	Gets whether the given rig has all finger data.
	HasFullHandData	Gets whether the given rig has all hand and finger bone references.
	PopHandTransforms	Restores all the transform information of the bones of a hand saved using PushHandTransforms(UxrAvatarHand).
	PushHandTransforms	Saves all the transform information of the bones of a hand so that it can later be restored using PopHandTransforms(UxrAvatarHand, Dictionary(Transform, UxrTransform)).
	SetupRigElementsFromAnimator	Tries to sets up all rig elements from the Animator of a humanoid model.
	TryToGetHandRenderer	Tries to get the SkinnedMeshRenderer that represents the given hand.
	TryToInferMissingRigElements	Tries to infer rig elements by doing some checks on names and bone hierarchy. This is useful when we have a rig that has no full humanoid avatar set up on its animator .
	TryToResolveArm	Tries to solve which bones from a SkinnedMeshRenderer are remaining parts of the arm that still have no references.
	TryToResolveHand	Tries to solve missing bone elements of a hand using a SkinnedMeshRenderer as source.
	UpdateHandUsingDescriptor(UxrAvatar, UxrHandSide, UxrHandDescriptor)	Updates an avatar’s hand transforms using a fixed hand descriptor.
	UpdateHandUsingDescriptor(UxrAvatarHand, UxrHandDescriptor, UxrUniversalLocalAxes, UxrUniversalLocalAxes)	Updates the hand transforms using a hand descriptor.
	UpdateHandUsingDescriptor(UxrAvatar, UxrHandSide, UxrHandDescriptor, UxrHandDescriptor, Single)	Updates an avatar’s hand transforms using two hand descriptors and a blend value.
	UpdateHandUsingDescriptor(UxrAvatarHand, UxrHandDescriptor, UxrHandDescriptor, Single, UxrUniversalLocalAxes, UxrUniversalLocalAxes)	Updates the hand transforms using two hand descriptors and an interpolation value.
	UpdateHandUsingRuntimeDescriptor(UxrAvatar, UxrHandSide, UxrRuntimeHandDescriptor)	Updates the hand transforms using a runtime hand descriptor.
	UpdateHandUsingRuntimeDescriptor(UxrAvatar, UxrHandSide, UxrRuntimeHandDescriptor, UxrRuntimeHandDescriptor, Single)	Updates the hand transforms blending between two runtime hand descriptors.

Fields

	Name	Description
	HandFingerCount	Number of fingers in a hand.

Extension Methods

	Name	Description
	ThrowIfNull	Throws an exception if the object is null. (Defined by ObjectExt.)