class Hand

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

Summary

Nested types

The handedness of the user's hand.

The representation of the current state of Hand.

Public companion functions
Hand.HandSide

Returns the handedness of the user's primary hand.
Hand?
left(session: Session)

Returns the Hand object that corresponds to the user's left hand when available.
Hand?
right(session: Session)

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

Public functions
open operator Boolean
equals(other: Any?)
open Int

Public properties
StateFlow<Hand.State>

The current State of this hand.

Extension properties
Flowable<Hand.State>

The current State of this hand.

Public companion functions

getPrimaryHandSide

Added in 1.0.0-alpha05
fun getPrimaryHandSide(resolver: ContentResolver): Hand.HandSide

Returns the handedness of the user's primary hand.

Parameters
resolver: ContentResolver

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

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

left

Added in 1.0.0-alpha05
fun left(session: Session): Hand?

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

Parameters
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
fun right(session: Session): Hand?

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

Parameters
session: Session

the currently active Session.
Throws
kotlin.IllegalStateException

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

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

state

Added in 1.0.0-alpha05
val state: StateFlow<Hand.State>

The current State of this hand.

Extension properties

stateAsFlowable

val Hand.stateAsFlowable: Flowable<Hand.State>

The current State of this hand.