Class XRHandCaptureSequence

A sequence of captured frames, providing data for hand tracking over a period of time.

Inheritance

object

Object

ScriptableObject

XRHandCaptureSequence

Inherited Members

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

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

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

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, InstantiateParameters)

Object.InstantiateAsync<T>(T, int, InstantiateParameters)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

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

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.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.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.Capture

Assembly: Unity.XR.Hands.dll

Syntax

public class XRHandCaptureSequence : ScriptableObject

Properties

canSurfaceCommonPoseData

Reports what XRHandSubsystem.canSurfaceCommonPoseData returned during capture.

Declaration

public bool canSurfaceCommonPoseData { get; }

Property Value

Type	Description
bool	If canSurfaceCommonPoseData is false, no call to XRHandCaptureFrame.TryGetCommonGestures(Handedness, out XRCommonHandGesturesState). will ever succeed for frames retrieved from this asset's frames.

detectedHandMeshLayout

Reports what XRHandSubsystem.detectedHandMeshLayout returned during capture.

Declaration

public XRDetectedHandMeshLayout detectedHandMeshLayout { get; }

Property Value

Type	Description
XRDetectedHandMeshLayout

durationInSeconds

The duration of the entire captured sequence in seconds.

Declaration

public float durationInSeconds { get; }

Property Value

Type	Description
float	The duration in seconds.

frames

The captured frames in this sequence.

Declaration

public IReadOnlyList<XRHandCaptureFrame> frames { get; }

Property Value

Type	Description
IReadOnlyList<XRHandCaptureFrame>	A read-only list of XRHandCaptureFrame objects.

Methods

GetHandJointsInLayout(Allocator)

Gets the same joint layout that was retrieved during capture from XRHandSubsystem.jointsInLayout.

Declaration

public NativeArray<bool> GetHandJointsInLayout(Allocator allocator)

Parameters

Type	Name	Description
Allocator	allocator	This will be passed to the NativeArray_1 created and returned from GetHandJointsInLayout.

Returns

Type	Description
NativeArray<bool>	The same layout reported during capture for jointsInLayout. Each index will have a value of true if the capture can ever report valid XRHandJoints in captured XRHands if that XRHandJoint has an XRHandJointID that you can call XRHandJointID.ToIndex(XRHandJointID).

GetLastActiveFingerShapeConfigurationState(XRHandFingerID, out XRFingerShapeConfigurationState)

Gets the XRFingerShapeConfiguration data for the given XRHandFingerID that was active at the end of capture that resulted in this asset.

Declaration

public void GetLastActiveFingerShapeConfigurationState(XRHandFingerID fingerID, out XRFingerShapeConfigurationState state)

Parameters

Type	Name	Description
XRHandFingerID	fingerID	The finger to get captured finger shape configuration for.
XRFingerShapeConfigurationState	state	Will be filled out with state representing the active XRFingerShapeConfigurationState at the end of when the tracking data was captured.