Interface XRHand

    The XRHand interface is pair iterator (an ordered map) with the key being the hand joints (XRHandJoint) and the value being an XRJointSpace.

    See

    https://immersive-web.github.io/webxr-hand-input/#xrhand-interface

    interface XRHand {
        "[toStringTag]": string;
        INDEX_METACARPAL: number;
        INDEX_PHALANX_DISTAL: number;
        INDEX_PHALANX_INTERMEDIATE: number;
        INDEX_PHALANX_PROXIMAL: number;
        INDEX_PHALANX_TIP: number;
        LITTLE_METACARPAL: number;
        LITTLE_PHALANX_DISTAL: number;
        LITTLE_PHALANX_INTERMEDIATE: number;
        LITTLE_PHALANX_PROXIMAL: number;
        LITTLE_PHALANX_TIP: number;
        MIDDLE_METACARPAL: number;
        MIDDLE_PHALANX_DISTAL: number;
        MIDDLE_PHALANX_INTERMEDIATE: number;
        MIDDLE_PHALANX_PROXIMAL: number;
        MIDDLE_PHALANX_TIP: number;
        RING_METACARPAL: number;
        RING_PHALANX_DISTAL: number;
        RING_PHALANX_INTERMEDIATE: number;
        RING_PHALANX_PROXIMAL: number;
        RING_PHALANX_TIP: number;
        size: number;
        THUMB_METACARPAL: number;
        THUMB_PHALANX_DISTAL: number;
        THUMB_PHALANX_PROXIMAL: number;
        THUMB_PHALANX_TIP: number;
        WRIST: number;
        "[iterator]"(): MapIterator<[XRHandJoint, XRJointSpace]>;
        clear(): void;
        delete(key: XRHandJoint): boolean;
        entries(): MapIterator<[XRHandJoint, XRJointSpace]>;
        forEach(
            callbackfn: (
                value: XRJointSpace,
                key: XRHandJoint,
                map: Map<XRHandJoint, XRJointSpace>,
            ) => void,
            thisArg?: any,
        ): void;
        get(key: XRHandJoint): XRJointSpace;
        has(key: XRHandJoint): boolean;
        keys(): MapIterator<XRHandJoint>;
        set(key: XRHandJoint, value: XRJointSpace): this;
        values(): MapIterator<XRJointSpace>;
    }
    Hierarchy

    Properties

    [toStringTag] INDEX_METACARPAL INDEX_PHALANX_DISTAL INDEX_PHALANX_INTERMEDIATE INDEX_PHALANX_PROXIMAL INDEX_PHALANX_TIP LITTLE_METACARPAL LITTLE_PHALANX_DISTAL LITTLE_PHALANX_INTERMEDIATE LITTLE_PHALANX_PROXIMAL LITTLE_PHALANX_TIP MIDDLE_METACARPAL MIDDLE_PHALANX_DISTAL MIDDLE_PHALANX_INTERMEDIATE MIDDLE_PHALANX_PROXIMAL MIDDLE_PHALANX_TIP RING_METACARPAL RING_PHALANX_DISTAL RING_PHALANX_INTERMEDIATE RING_PHALANX_PROXIMAL RING_PHALANX_TIP size THUMB_METACARPAL THUMB_PHALANX_DISTAL THUMB_PHALANX_PROXIMAL THUMB_PHALANX_TIP WRIST

    Methods

    [iterator] clear delete entries forEach get has keys set values

    Properties

    Readonly[toStringTag]

    "[toStringTag]": string

    ReadonlyINDEX_METACARPAL

    INDEX_METACARPAL: number

    ReadonlyINDEX_PHALANX_DISTAL

    INDEX_PHALANX_DISTAL: number

    ReadonlyINDEX_PHALANX_INTERMEDIATE

    INDEX_PHALANX_INTERMEDIATE: number

    ReadonlyINDEX_PHALANX_PROXIMAL

    INDEX_PHALANX_PROXIMAL: number

    ReadonlyINDEX_PHALANX_TIP

    INDEX_PHALANX_TIP: number

    ReadonlyLITTLE_METACARPAL

    LITTLE_METACARPAL: number

    ReadonlyLITTLE_PHALANX_DISTAL

    LITTLE_PHALANX_DISTAL: number

    ReadonlyLITTLE_PHALANX_INTERMEDIATE

    LITTLE_PHALANX_INTERMEDIATE: number

    ReadonlyLITTLE_PHALANX_PROXIMAL

    LITTLE_PHALANX_PROXIMAL: number

    ReadonlyLITTLE_PHALANX_TIP

    LITTLE_PHALANX_TIP: number

    ReadonlyMIDDLE_METACARPAL

    MIDDLE_METACARPAL: number

    ReadonlyMIDDLE_PHALANX_DISTAL

    MIDDLE_PHALANX_DISTAL: number

    ReadonlyMIDDLE_PHALANX_INTERMEDIATE

    MIDDLE_PHALANX_INTERMEDIATE: number

    ReadonlyMIDDLE_PHALANX_PROXIMAL

    MIDDLE_PHALANX_PROXIMAL: number

    ReadonlyMIDDLE_PHALANX_TIP

    MIDDLE_PHALANX_TIP: number

    ReadonlyRING_METACARPAL

    RING_METACARPAL: number

    ReadonlyRING_PHALANX_DISTAL

    RING_PHALANX_DISTAL: number

    ReadonlyRING_PHALANX_INTERMEDIATE

    RING_PHALANX_INTERMEDIATE: number

    ReadonlyRING_PHALANX_PROXIMAL

    RING_PHALANX_PROXIMAL: number

    ReadonlyRING_PHALANX_TIP

    RING_PHALANX_TIP: number

    Readonlysize

    size: number

    Returns

    the number of elements in the Map.

    ReadonlyTHUMB_METACARPAL

    THUMB_METACARPAL: number

    ReadonlyTHUMB_PHALANX_DISTAL

    THUMB_PHALANX_DISTAL: number

    ReadonlyTHUMB_PHALANX_PROXIMAL

    THUMB_PHALANX_PROXIMAL: number

    ReadonlyTHUMB_PHALANX_TIP

    THUMB_PHALANX_TIP: number

    ReadonlyWRIST

    WRIST: number

    Methods

    [iterator]

    clear

    • clear(): void

    • Returns void

    delete

    • delete(key: XRHandJoint): boolean

    • Parameters

      Returns boolean

      true if an element in the Map existed and has been removed, or false if the element does not exist.

    entries

    forEach

    get

    • get(key: XRHandJoint): XRJointSpace

    • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

      Parameters

      Returns XRJointSpace

      Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

    has

    • has(key: XRHandJoint): boolean

    • Parameters

      Returns boolean

      boolean indicating whether an element with the specified key exists or not.

    keys

    set

    • set(key: XRHandJoint, value: XRJointSpace): this

    • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

      Parameters

      Returns this

    values

    Settings

    Member Visibility

    On This Page

    Properties
    Methods