InterfaceBaseHand

Describes the API for the BaseHand, which is part of the API accessible by external developers.

interface BaseHand {
    enabled: boolean;
    handType: "left" | "right";
    indexDistal: Keypoint;
    indexFinger: Keypoint[];
    indexIntermediate: Keypoint;
    indexKnuckle: Keypoint;
    indexMidJoint: Keypoint;
    indexPad: Keypoint;
    indexProximal: Keypoint;
    indexTip: Keypoint;
    indexToWrist: Keypoint;
    indexUpperJoint: Keypoint;
    isDominantHand: boolean;
    middleDistal: Keypoint;
    middleFinger: Keypoint[];
    middleIntermediate: Keypoint;
    middleKnuckle: Keypoint;
    middleMidJoint: Keypoint;
    middlePad: Keypoint;
    middleProximal: Keypoint;
    middleTip: Keypoint;
    middleToWrist: Keypoint;
    middleUpperJoint: Keypoint;
    objectTracking3D: ObjectTracking3D;
    onEnabledChanged: PublicApi<boolean>;
    onHandFound: PublicApi<void>;
    onHandLost: PublicApi<void>;
    onPinchCancel: PublicApi<void>;
    onPinchDown: PublicApi<void>;
    onPinchUp: PublicApi<void>;
    pinkyDistal: Keypoint;
    pinkyFinger: Keypoint[];
    pinkyIntermediate: Keypoint;
    pinkyKnuckle: Keypoint;
    pinkyMidJoint: Keypoint;
    pinkyPad: Keypoint;
    pinkyProximal: Keypoint;
    pinkyTip: Keypoint;
    pinkyToWrist: Keypoint;
    pinkyUpperJoint: Keypoint;
    points: Keypoint[];
    ringDistal: Keypoint;
    ringFinger: Keypoint[];
    ringIntermediate: Keypoint;
    ringKnuckle: Keypoint;
    ringMidJoint: Keypoint;
    ringPad: Keypoint;
    ringProximal: Keypoint;
    ringTip: Keypoint;
    ringToWrist: Keypoint;
    ringUpperJoint: Keypoint;
    targetingData: TargetingData;
    thumbBaseJoint: Keypoint;
    thumbDistal: Keypoint;
    thumbFinger: Keypoint[];
    thumbIntermediate: Keypoint;
    thumbKnuckle: Keypoint;
    thumbMidJoint: Keypoint;
    thumbPad: Keypoint;
    thumbProximal: Keypoint;
    thumbTip: Keypoint;
    thumbToWrist: Keypoint;
    wrist: Keypoint;
    attachHandVisuals(handVisuals: HandVisuals): void;
    detachHandVisuals(handVisuals: HandVisuals): void;
    getFacingCameraAngle(): number;
    getHandVisuals(): HandVisuals;
    getPalmCenter(): vec3;
    getPalmPitchAngle(): number;
    getPinchDirection(): quat;
    getPinchStrength(): number;
    getSceneObject(): SceneObject;
    isFacingCamera(): boolean;
    isInTargetingPose(): boolean;
    isPinching(): boolean;
    isTapping(): PalmTapDetectionEvent;
    isTracked(): boolean;
    setEnabled(isEnabled: boolean): void;
    setIsDominantHand(isDominantHand: boolean): void;
}

Implemented by

Properties

enabled handType indexDistal indexFinger indexIntermediate indexKnuckle indexMidJoint indexPad indexProximal indexTip indexToWrist indexUpperJoint isDominantHand middleDistal middleFinger middleIntermediate middleKnuckle middleMidJoint middlePad middleProximal middleTip middleToWrist middleUpperJoint objectTracking3D onEnabledChanged onHandFound onHandLost onPinchCancel onPinchDown onPinchUp pinkyDistal pinkyFinger pinkyIntermediate pinkyKnuckle pinkyMidJoint pinkyPad pinkyProximal pinkyTip pinkyToWrist pinkyUpperJoint points ringDistal ringFinger ringIntermediate ringKnuckle ringMidJoint ringPad ringProximal ringTip ringToWrist ringUpperJoint targetingData thumbBaseJoint thumbDistal thumbFinger thumbIntermediate thumbKnuckle thumbMidJoint thumbPad thumbProximal thumbTip thumbToWrist wrist

Methods

attachHandVisuals detachHandVisuals getFacingCameraAngle getHandVisuals getPalmCenter getPalmPitchAngle getPinchDirection getPinchStrength getSceneObject isFacingCamera isInTargetingPose isPinching isTapping isTracked setEnabled setIsDominantHand

Properties

Readonlyenabled

enabled: boolean

Returns the enabled state of the hand.

ReadonlyhandType

handType: "left" | "right"

Determines if the hand is the left or right hand

Readonly DeprecatedindexDistal

indexDistal: Keypoint

The Keypoint of the indexDistal joint, will soon be for indexMidJoint

ReadonlyindexFinger

indexFinger: Keypoint[]

The Keypoints of the Index finger

Readonly DeprecatedindexIntermediate

indexIntermediate: Keypoint

The Keypoint of the indexIntermediate joint, will be soon in favor of indexKnuckle.

ReadonlyindexKnuckle

indexKnuckle: Keypoint

The Keypoint of the indexKnuckle joint (Index Metacarpophalangeal (MCP) Joint)

ReadonlyindexMidJoint

indexMidJoint: Keypoint

The Keypoint of the indexMidJoint joint (Index Proximal Interphalangeal (PIP) Joint)

Readonly DeprecatedindexPad

indexPad: Keypoint

The Keypoint of the indexPad joint, will soon be for indexUpperJoint

Readonly DeprecatedindexProximal

indexProximal: Keypoint

The Keypoint of the indexProximal joint, will be soon in favor of indexToWrist.

ReadonlyindexTip

indexTip: Keypoint

The Keypoint of the indexTip joint (Index Tip Joint)

ReadonlyindexToWrist

indexToWrist: Keypoint

The Keypoint of the indexToWrist joint (Wrist Joint)

ReadonlyindexUpperJoint

indexUpperJoint: Keypoint

The Keypoint of the indexUpperJoint joint (Index Distal Interphalangeal (DIP) Joint)

ReadonlyisDominantHand

isDominantHand: boolean

Returns true if the hand is the dominant hand assigned by the system

Readonly DeprecatedmiddleDistal

middleDistal: Keypoint

The Keypoint of the middleDistal joint, will soon be for middleMidJoint

ReadonlymiddleFinger

middleFinger: Keypoint[]

The Keypoints of the Middle finger

Readonly DeprecatedmiddleIntermediate

middleIntermediate: Keypoint

The Keypoint of the middleIntermediate joint, will be soon in favor of middleKnuckle.

ReadonlymiddleKnuckle

middleKnuckle: Keypoint

The Keypoint of the middleKnuckle joint (Middle Metacarpophalangeal (MCP) Joint)

ReadonlymiddleMidJoint

middleMidJoint: Keypoint

The Keypoint of the middleMidJoint joint (Middle Proximal Interphalangeal (PIP) Joint)

Readonly DeprecatedmiddlePad

middlePad: Keypoint

The Keypoint of the middlePad joint, will soon be for middleUpperJoint

Readonly DeprecatedmiddleProximal

middleProximal: Keypoint

The Keypoint of the middleProximal joint, will be soon in favor of middleToWrist.

ReadonlymiddleTip

middleTip: Keypoint

The Keypoint of the middleTip joint (Middle Tip Joint)

ReadonlymiddleToWrist

middleToWrist: Keypoint

The Keypoint of the middleToWrist joint (Wrist Joint)

ReadonlymiddleUpperJoint

middleUpperJoint: Keypoint

The Keypoint of the middleUpperJoint joint (Middle Distal Interphalangeal (DIP) Joint)

ReadonlyobjectTracking3D

objectTracking3D: ObjectTracking3D

ObjectTracking3D associated with this base hand

ReadonlyonEnabledChanged

onEnabledChanged: PublicApi<boolean>

Event called when this hand gets enabled or disabled

ReadonlyonHandFound

onHandFound: PublicApi<void>

Event called when the hand is found by the system

ReadonlyonHandLost

onHandLost: PublicApi<void>

Event called when the hand is lost by the system

ReadonlyonPinchCancel

onPinchCancel: PublicApi<void>

Event called when the user's pinch is canceled by the system.

ReadonlyonPinchDown

onPinchDown: PublicApi<void>

Event called when the user has successfully pinched down.

ReadonlyonPinchUp

onPinchUp: PublicApi<void>

Event called when the user has released pinching after they have successfully pinched down.

Readonly DeprecatedpinkyDistal

pinkyDistal: Keypoint

The Keypoint of the pinkyDistal joint, will soon be for pinkyMidJoint

ReadonlypinkyFinger

pinkyFinger: Keypoint[]

The Keypoints of the Pinky finger

Readonly DeprecatedpinkyIntermediate

pinkyIntermediate: Keypoint

The Keypoint of the pinkyIntermediate joint, will be soon in favor of pinkyKnuckle.

ReadonlypinkyKnuckle

pinkyKnuckle: Keypoint

The Keypoint of the pinkyKnuckle joint (Pinky Metacarpophalangeal (MCP) Joint)

ReadonlypinkyMidJoint

pinkyMidJoint: Keypoint

The Keypoint of the pinkyMidJoint joint (Pinky Proximal Interphalangeal (PIP) Joint)

Readonly DeprecatedpinkyPad

pinkyPad: Keypoint

The Keypoint of the pinkyPad joint, will soon be for pinkyUpperJoint

Readonly DeprecatedpinkyProximal

pinkyProximal: Keypoint

The Keypoint of the pinkyProximal joint, will be soon in favor of pinkyToWrist.

ReadonlypinkyTip

pinkyTip: Keypoint

The Keypoint of the pinkyTip joint (Pinky Tip Joint)

ReadonlypinkyToWrist

pinkyToWrist: Keypoint

The Keypoint of the pinkyToWrist joint (Wrist Joint)

ReadonlypinkyUpperJoint

pinkyUpperJoint: Keypoint

The Keypoint of the pinkyUpperJoint joint (Pinky Distal Interphalangeal (DIP) Joint)

Readonlypoints

points: Keypoint[]

The Keypoints of the entire Hand

Readonly DeprecatedringDistal

ringDistal: Keypoint

The Keypoint of the ringDistal joint, will soon be for ringMidJoint

ReadonlyringFinger

ringFinger: Keypoint[]

The Keypoints of the Ring finger

Readonly DeprecatedringIntermediate

ringIntermediate: Keypoint

The Keypoint of the ringIntermediate joint, will be soon in favor of ringKnuckle.

ReadonlyringKnuckle

ringKnuckle: Keypoint

The Keypoint of the ringKnuckle joint (Ring Metacarpophalangeal (MCP) Joint)

ReadonlyringMidJoint

ringMidJoint: Keypoint

The Keypoint of the ringMidJoint joint (Ring Proximal Interphalangeal (PIP) Joint)

Readonly DeprecatedringPad

ringPad: Keypoint

The Keypoint of the ringPad joint, will soon be for ringUpperJoint

Readonly DeprecatedringProximal

ringProximal: Keypoint

The Keypoint of the ringProximal joint, will be soon in favor of ringToWrist.

ReadonlyringTip

ringTip: Keypoint

The Keypoint of the ringTip joint (Ring Tip Joint)

ReadonlyringToWrist

ringToWrist: Keypoint

The Keypoint of the ringToWrist joint (Wrist Joint)

ReadonlyringUpperJoint

ringUpperJoint: Keypoint

The Keypoint of the ringUpperJoint joint (Ring Distal Interphalangeal (DIP) Joint)

ReadonlytargetingData

targetingData: TargetingData

Returns the normalized direction and origin point of the targeting ray in world coordinate system It can return null if the data has not been received from LensCore's GestureModule API.

ReadonlythumbBaseJoint

thumbBaseJoint: Keypoint

The Keypoint of the thumbBaseJoint joint (Thumb Carpometacarpal (CMC) Joint)

Readonly DeprecatedthumbDistal

thumbDistal: Keypoint

The Keypoint of the thumbDistal joint, will soon be for thumbKnuckle

ReadonlythumbFinger

thumbFinger: Keypoint[]

The Keypoints of the Thumb finger

Readonly DeprecatedthumbIntermediate

thumbIntermediate: Keypoint

The Keypoint of the thumbIntermediate joint, will be soon in favor of thumbBaseJoint.

ReadonlythumbKnuckle

thumbKnuckle: Keypoint

The Keypoint of the thumbKnuckle joint (Thumb Metacarpophalangeal (MCP) Joint)

ReadonlythumbMidJoint

thumbMidJoint: Keypoint

The Keypoint of the thumbMidJoint joint (Thumb Interphalangeal (IP) Joint)

Readonly DeprecatedthumbPad

thumbPad: Keypoint

The Keypoint of the thumbPad joint, will soon be for thumbMidJoint

Readonly DeprecatedthumbProximal

thumbProximal: Keypoint

The Keypoint of the thumbProximal joint, will be soon in favor of thumbToWrist.

ReadonlythumbTip

thumbTip: Keypoint

The Keypoint of the thumbTip joint (Thumb Tip Joint)

ReadonlythumbToWrist

thumbToWrist: Keypoint

The Keypoint of the thumbToWrist joint (Wrist Joint)

Readonlywrist

wrist: Keypoint

The Keypoint of the wrist joint

Methods

attachHandVisuals

  • attachHandVisuals(handVisuals): void

  • Attaches HandVisuals to the tracked hand

    Parameters

    Returns void

detachHandVisuals

  • detachHandVisuals(handVisuals): void

  • Detaches HandVisuals to the tracked hand

    Parameters

    Returns void

getFacingCameraAngle

  • getFacingCameraAngle(): number

  • Returns the roll rotation of the hand in degrees. This is the result of the dot product from a right vector, created by the index and middle knuckle, and the camera's right vector to determine if the palm if facing the user.

    A value less than 30 is facing towards the user. A value greater than 30 is facing away from the user.

    Returns null if the hand is not being tracked.

    Returns number

getHandVisuals

getPalmCenter

  • getPalmCenter(): vec3

  • Approximates the center of the palm, as we currently do not have a center palm landmark. Used to determine whether hands are overlapping

    Returns vec3

    the calculated center or null if any of the landmarks don't exist

getPalmPitchAngle

  • getPalmPitchAngle(): number

  • Returns the pitch rotation of the hand in degrees. This is the result of the dot product from a forward vector, created by the middle knuckle and wrist, and the camera's forward vector.

    A value greater than 0 is pointing up. A value less than 0 is pointing down.

    Returns null if the hand is not being tracked.

    Returns number

getPinchDirection

  • getPinchDirection(): quat

  • Returns a direction quaternion based on a plane derived from a forward direction (between your thumb knuckle to thumb tip) and a right direction (between your thumb knuckle to index knuckle)

    Returns quat

getPinchStrength

  • getPinchStrength(): number

  • Returns a normalized value from 0-1, where 0 is the distance from a finger tip to the thumb tip in resting/neutral hand pose. 1 is when a finger tip to thumb tip are touching/pinching. Returns null if the hand is not tracked

    Returns number

getSceneObject

isFacingCamera

  • isFacingCamera(): boolean

  • Determines if the hand's palm is facing the user

    Returns boolean

isInTargetingPose

  • isInTargetingPose(): boolean

  • Determines if the hand is aiming towards objects in the scene

    Returns boolean

isPinching

  • isPinching(): boolean

  • Determines if the user is pinching

    Returns boolean

isTapping

isTracked

  • isTracked(): boolean

  • Determines if the system is able to track the BaseHand

    Returns boolean

setEnabled

  • setEnabled(isEnabled): void

  • Sets the enabled state of the hand. Events will not be called if isEnabled is set to false.

    Parameters

    • isEnabled: boolean

    Returns void

setIsDominantHand

  • setIsDominantHand(isDominantHand): void

  • Sets isDominantHand. This is used from HandInputData based on Lens Tweak value, and shouldn't be accessible by external developers.

    Parameters

    • isDominantHand: boolean

      describes if this hand is the dominant one or not

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods