Class XRHandTrackingEvents

Component that subscribes to hand tracking events from the XRHandSubsystem for a particular Handedness and sends UnityEvents for tracking updates.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

XRHandTrackingEvents

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Hands

Assembly: Unity.XR.Hands.dll

Syntax

[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.hands@1.4/api/UnityEngine.XR.Hands.XRHandTrackingEvents.html")]
public class XRHandTrackingEvents : MonoBehaviour

Properties

bindableHandIsTracked

Whether the hand is currently being tracked, stored as a bindable variable that can be subscribed to for value changes.

Declaration

public IReadOnlyBindableVariable<bool> bindableHandIsTracked { get; }

Property Value

Type	Description
IReadOnlyBindableVariable<bool>

handIsTracked

Whether the hand is currently being tracked

Declaration

public bool handIsTracked { get; }

Property Value

Type	Description
bool

handedness

The hand to track and send events for.

Declaration

public Handedness handedness { get; set; }

Property Value

Type	Description
Handedness

jointsUpdated

Event that occurs when the joints of the hands have updated.

Declaration

public HandUpdatedEvent jointsUpdated { get; }

Property Value

Type	Description
HandUpdatedEvent

Remarks

The XRHandJointsUpdatedEventArgs passed to each listener is only valid while the event is invoked, do not hold a reference to it.

poseUpdated

Event that occurs when the pose of the hands has updated.

Declaration

public UnityEvent<Pose> poseUpdated { get; }

Property Value

Type	Description
UnityEvent<Pose>

rootPose

The root pose of the hand.

Declaration

public Pose rootPose { get; }

Property Value

Type	Description
Pose

trackingAcquired

Event that occurs when the hand tracking is acquired.

Declaration

public UnityEvent trackingAcquired { get; }

Property Value

Type	Description
UnityEvent

trackingChanged

Event that occurs when the hand tracking is acquired (true) or lost (false).

Declaration

public UnityEvent<bool> trackingChanged { get; }

Property Value

Type	Description
UnityEvent<bool>

trackingLost

Event that occurs when the hand tracking is lost.

Declaration

public UnityEvent trackingLost { get; }

Property Value

Type	Description
UnityEvent

updateType

Which update type to send events for when the pose and joints are updated. This can be one or multiple options from XRHandSubsystem.UpdateType.

Declaration

public XRHandTrackingEvents.UpdateTypes updateType { get; set; }

Property Value

Type	Description
XRHandTrackingEvents.UpdateTypes

See Also

XRHandTrackingEvents.UpdateTypes

Methods

OnDisable()

See MonoBehaviour.

Declaration

protected virtual void OnDisable()

Update()

See MonoBehaviour.

Declaration

protected virtual void Update()