Classdefault

constructor

• new default(config): default

• Parameters

  • config: BaseHandConfig

  Returns default

ReadonlyonEnabledChanged

ReadonlyonHandFound

ReadonlyonHandLost

ReadonlyonPinchCancel

ReadonlyonPinchDown

ReadonlyonPinchUp

ProtectedsceneObjectManager

enabled

• get enabled(): boolean

• Returns the enabled state of the hand.

  Returns boolean

handType

• get handType(): "left" | "right"

• Determines if the hand is the left or right hand

  Returns "left" | "right"

DeprecatedindexDistal

• get indexDistal(): Keypoint
• Deprecated

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

  Returns Keypoint

indexFinger

• get indexFinger(): Keypoint[]

• The Keypoints of the Index finger

  Returns Keypoint[]

DeprecatedindexIntermediate

• get indexIntermediate(): Keypoint
• Deprecated

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

  Returns Keypoint

indexKnuckle

• get indexKnuckle(): Keypoint

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

  Returns Keypoint

indexMidJoint

• get indexMidJoint(): Keypoint

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

  Returns Keypoint

DeprecatedindexPad

• get indexPad(): Keypoint
• Deprecated

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

  Returns Keypoint

DeprecatedindexProximal

• get indexProximal(): Keypoint
• Deprecated

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

  Returns Keypoint

indexTip

• get indexTip(): Keypoint

• The Keypoint of the indexTip joint (Index Tip Joint)

  Returns Keypoint

indexToWrist

• get indexToWrist(): Keypoint

• The Keypoint of the indexToWrist joint (Wrist Joint)

  Returns Keypoint

indexUpperJoint

• get indexUpperJoint(): Keypoint

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

  Returns Keypoint

isDominantHand

• get isDominantHand(): boolean

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

  Returns boolean

DeprecatedmiddleDistal

• get middleDistal(): Keypoint
• Deprecated

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

  Returns Keypoint

middleFinger

• get middleFinger(): Keypoint[]

• The Keypoints of the Middle finger

  Returns Keypoint[]

DeprecatedmiddleIntermediate

• get middleIntermediate(): Keypoint
• Deprecated

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

  Returns Keypoint

middleKnuckle

• get middleKnuckle(): Keypoint

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

  Returns Keypoint

middleMidJoint

• get middleMidJoint(): Keypoint

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

  Returns Keypoint

DeprecatedmiddlePad

• get middlePad(): Keypoint
• Deprecated

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

  Returns Keypoint

DeprecatedmiddleProximal

• get middleProximal(): Keypoint
• Deprecated

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

  Returns Keypoint

middleTip

• get middleTip(): Keypoint

• The Keypoint of the middleTip joint (Middle Tip Joint)

  Returns Keypoint

middleToWrist

• get middleToWrist(): Keypoint

• The Keypoint of the middleToWrist joint (Wrist Joint)

  Returns Keypoint

middleUpperJoint

• get middleUpperJoint(): Keypoint

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

  Returns Keypoint

objectTracking3D

• get objectTracking3D(): ObjectTracking3D

• ObjectTracking3D associated with this base hand

  Returns ObjectTracking3D

DeprecatedpinkyDistal

• get pinkyDistal(): Keypoint
• Deprecated

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

  Returns Keypoint

pinkyFinger

• get pinkyFinger(): Keypoint[]

• The Keypoints of the Pinky finger

  Returns Keypoint[]

DeprecatedpinkyIntermediate

• get pinkyIntermediate(): Keypoint
• Deprecated

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

  Returns Keypoint

pinkyKnuckle

• get pinkyKnuckle(): Keypoint

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

  Returns Keypoint

pinkyMidJoint

• get pinkyMidJoint(): Keypoint

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

  Returns Keypoint

DeprecatedpinkyPad

• get pinkyPad(): Keypoint
• Deprecated

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

  Returns Keypoint

DeprecatedpinkyProximal

• get pinkyProximal(): Keypoint
• Deprecated

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

  Returns Keypoint

pinkyTip

• get pinkyTip(): Keypoint

• The Keypoint of the pinkyTip joint (Pinky Tip Joint)

  Returns Keypoint

pinkyToWrist

• get pinkyToWrist(): Keypoint

• The Keypoint of the pinkyToWrist joint (Wrist Joint)

  Returns Keypoint

pinkyUpperJoint

• get pinkyUpperJoint(): Keypoint

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

  Returns Keypoint

points

• get points(): Keypoint[]

• The Keypoints of the entire Hand

  Returns Keypoint[]

DeprecatedringDistal

• get ringDistal(): Keypoint
• Deprecated

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

  Returns Keypoint

ringFinger

• get ringFinger(): Keypoint[]

• The Keypoints of the Ring finger

  Returns Keypoint[]

DeprecatedringIntermediate

• get ringIntermediate(): Keypoint
• Deprecated

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

  Returns Keypoint

ringKnuckle

• get ringKnuckle(): Keypoint

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

  Returns Keypoint

ringMidJoint

• get ringMidJoint(): Keypoint

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

  Returns Keypoint

DeprecatedringPad

• get ringPad(): Keypoint
• Deprecated

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

  Returns Keypoint

DeprecatedringProximal

• get ringProximal(): Keypoint
• Deprecated

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

  Returns Keypoint

ringTip

• get ringTip(): Keypoint

• The Keypoint of the ringTip joint (Ring Tip Joint)

  Returns Keypoint

ringToWrist

• get ringToWrist(): Keypoint

• The Keypoint of the ringToWrist joint (Wrist Joint)

  Returns Keypoint

ringUpperJoint

• get ringUpperJoint(): Keypoint

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

  Returns Keypoint

targetingData

• get 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.

  Returns TargetingData

thumbBaseJoint

• get thumbBaseJoint(): Keypoint

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

  Returns Keypoint

DeprecatedthumbDistal

• get thumbDistal(): Keypoint
• Deprecated

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

  Returns Keypoint

thumbFinger

• get thumbFinger(): Keypoint[]

• The Keypoints of the Thumb finger

  Returns Keypoint[]

DeprecatedthumbIntermediate

• get thumbIntermediate(): Keypoint
• Deprecated

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

  Returns Keypoint

thumbKnuckle

• get thumbKnuckle(): Keypoint

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

  Returns Keypoint

thumbMidJoint

• get thumbMidJoint(): Keypoint

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

  Returns Keypoint

DeprecatedthumbPad

• get thumbPad(): Keypoint
• Deprecated

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

  Returns Keypoint

DeprecatedthumbProximal

• get thumbProximal(): Keypoint
• Deprecated

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

  Returns Keypoint

thumbTip

• get thumbTip(): Keypoint

• The Keypoint of the thumbTip joint (Thumb Tip Joint)

  Returns Keypoint

thumbToWrist

• get thumbToWrist(): Keypoint

• The Keypoint of the thumbToWrist joint (Wrist Joint)

  Returns Keypoint

wrist

• get wrist(): Keypoint

• The Keypoint of the wrist joint

  Returns Keypoint

attachHandVisuals

• attachHandVisuals(handVisuals): void

• Attaches HandVisuals to the tracked hand

  Parameters

  • handVisuals: HandVisuals

  Returns void

destroy

• destroy(): void

• Destroys the hand and associated keypoints

  Returns void

detachHandVisuals

• detachHandVisuals(handVisuals): void

• Detaches HandVisuals to the tracked hand

  Parameters

  • handVisuals: HandVisuals

  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

• getHandVisuals(): HandVisuals

• Returns HandVisuals

  attached HandVisuals or null if none is attached.

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

• getSceneObject(): SceneObject

• Returns owner scene object associated with the hand

  Returns SceneObject

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

• isTapping(): PalmTapDetectionEvent

• Returns PalmTapDetectionEvent

  whether the user is tapping their hand

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

setTrackingMode

• setTrackingMode(trackingMode): void

• Parameters

  • trackingMode: TrackingMode

  Returns void

  Inherit Doc