public final class Hand

Contains the tracking information of one of the user's hands.

Summary

Nested types
public enum Hand.HandSide extends Enum

The handedness of the user's hand.
public final class Hand.State

The representation of the current state of Hand.

Public methods
boolean
equals(Object other)
static final @NonNull Hand.HandSide

Returns the handedness of the user's primary hand.
final @NonNull StateFlow<@NonNull Hand.State>

The current State of this hand.
int
static final Hand
left(@NonNull Session session)

Returns the Hand object that corresponds to the user's left hand when available.
static final Hand
right(@NonNull Session session)

Returns the Hand object that corresponds to the user's right hand when available.

Extension functions
final @NonNull Flowable<@NonNull Hand.State>

The current State of this hand.

Public methods

equals

public boolean equals(Object other)

getPrimaryHandSide

Added in 1.0.0-alpha05
public static final @NonNull Hand.HandSide getPrimaryHandSide(@NonNull ContentResolver resolver)

Returns the handedness of the user's primary hand.

Parameters
@NonNull ContentResolver resolver

the ContentResolver to use to retrieve the setting.
Returns
@NonNull Hand.HandSide

the HandSide of the user's primary hand. If the setting is not configured, returns HandSide.UNKNOWN.

getState

Added in 1.0.0-alpha05
public final @NonNull StateFlow<@NonNull Hand.State> getState()

The current State of this hand.

hashCode

public int hashCode()

left

Added in 1.0.0-alpha05
public static final Hand left(@NonNull Session session)

Returns the Hand object that corresponds to the user's left hand when available.

Parameters
@NonNull Session session

the currently active Session.
Throws
kotlin.IllegalStateException

if Session.config is set to Config.HandTrackingMode.DISABLED.

right

Added in 1.0.0-alpha05
public static final Hand right(@NonNull Session session)

Returns the Hand object that corresponds to the user's right hand when available.

Parameters
@NonNull Session session

the currently active Session.
Throws
kotlin.IllegalStateException

if Session.config is set to Config.HandTrackingMode.DISABLED.

Extension functions

RxJava3HandKt.getStateAsFlowable

public final @NonNull Flowable<@NonNull Hand.State> RxJava3HandKt.getStateAsFlowable(@NonNull Hand receiver)

The current State of this hand.