UxrControllerHand Class

Component that represents a hand holding a VR controller. It allows to graphically render a hand that mimics the interaction that the user performs on a VR controller.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Core.Components.UxrComponent(UxrControllerHand)
              UltimateXR.Core.Components.Composite.UxrAvatarComponent(UxrControllerHand)
                UltimateXR.Devices.Visualization.UxrControllerHand
Namespace: UltimateXR.Devices.Visualization
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

[DisallowMultipleComponent]
public class UxrControllerHand : UxrAvatarComponent<UxrControllerHand>

The UxrControllerHand type exposes the following members.

Constructors

	Name	Description
	UxrControllerHand

Properties

	Name	Description
	Hand	Gets the hand references.
	Variations	Gets the hand variations, if there are any. Variations allow to provide different visual representations of the hand. It can be different objects and each object may have different materials.

Methods

	Name	Description
	Awake	Generates the internal list of fingers. (Overrides UxrAvatarComponent<T>.Awake().)
	InitializeFromCurrentHandPose	Initializes the component when the controller hand is dynamic, such as when used through an UxrAvatar that changes poses.
	OnDisable	Disables the finger IK solvers. (Overrides UxrComponent<T>.OnDisable().)
	OnEnable	Enables the finger IK solvers. (Overrides UxrComponent<T>.OnEnable().)
	Reset	Make sure the hand rig is allocated when the component is reset. (Overrides UxrComponent.Reset().)
	Start	Initializes the fingers. (Overrides UxrComponent.Start().)
	UpdateFinger	Updates a given finger.
	UpdateIKManually	Allows to manually update the Inverse Kinematics of all fingers.

Extension Methods

	Name	Description
	CheckSetEnabled	Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
	GetOrAddComponent<T>	Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
	GetPathUnderScene	Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
	GetSceneUid	Gets an unique identifier string for the given component. (Defined by ComponentExt.)
	GetUniqueScenePath	Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.)
	LoopCoroutine	Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
	SafeGetComponentInParent<T>	Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.)
	ShowInInspector(Boolean)	Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
	ShowInInspector(Boolean, Boolean)	Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
	ThrowIfNull	Throws an exception if the object is null. (Defined by ObjectExt.)