Skip to main content

Interface: SimulatorHands

Defined in: src/simulator/SimulatorHands.ts:103

Properties

handPosePanelElement?

optional handPosePanelElement: SimulatorHandPoseHTMLElement

Defined in: src/simulator/SimulatorHands.ts:127


input

input: Input

Defined in: src/simulator/SimulatorHands.ts:128


leftController

leftController: Object3D<Object3DEventMap>

Defined in: src/simulator/SimulatorHands.ts:104


leftHand?

optional leftHand: Group<Object3DEventMap>

Defined in: src/simulator/SimulatorHands.ts:106


leftHandAtMaxRange

leftHandAtMaxRange: boolean = false

Defined in: src/simulator/SimulatorHands.ts:112


leftHandBones

leftHandBones: (Object3D<Object3DEventMap> | undefined)[] = []

Defined in: src/simulator/SimulatorHands.ts:108


leftHandCurrentRotations

leftHandCurrentRotations: Partial<Record<"wrist" | "thumb-metacarpal" | "thumb-phalanx-proximal" | "thumb-phalanx-distal" | "thumb-tip" | "index-finger-metacarpal" | "index-finger-phalanx-proximal" | "index-finger-phalanx-intermediate" | "index-finger-phalanx-distal" | "index-finger-tip" | "middle-finger-metacarpal" | "middle-finger-phalanx-proximal" | "middle-finger-phalanx-intermediate" | "middle-finger-phalanx-distal" | "middle-finger-tip" | "ring-finger-metacarpal" | "ring-finger-phalanx-proximal" | "ring-finger-phalanx-intermediate" | "ring-finger-phalanx-distal" | "ring-finger-tip" | "pinky-finger-metacarpal" | "pinky-finger-phalanx-proximal" | "pinky-finger-phalanx-intermediate" | "pinky-finger-phalanx-distal" | "pinky-finger-tip", SimulatorHandJointRotationArray>>

Defined in: src/simulator/SimulatorHands.ts:114


leftHandPose?

optional leftHandPose: SimulatorHandPose = SimulatorHandPose.RELAXED

Defined in: src/simulator/SimulatorHands.ts:110


leftHandTargetRotations

leftHandTargetRotations: Partial<Record<"wrist" | "thumb-metacarpal" | "thumb-phalanx-proximal" | "thumb-phalanx-distal" | "thumb-tip" | "index-finger-metacarpal" | "index-finger-phalanx-proximal" | "index-finger-phalanx-intermediate" | "index-finger-phalanx-distal" | "index-finger-tip" | "middle-finger-metacarpal" | "middle-finger-phalanx-proximal" | "middle-finger-phalanx-intermediate" | "middle-finger-phalanx-distal" | "middle-finger-tip" | "ring-finger-metacarpal" | "ring-finger-phalanx-proximal" | "ring-finger-phalanx-intermediate" | "ring-finger-phalanx-distal" | "ring-finger-tip" | "pinky-finger-metacarpal" | "pinky-finger-phalanx-proximal" | "pinky-finger-phalanx-intermediate" | "pinky-finger-phalanx-distal" | "pinky-finger-tip", SimulatorHandJointRotationArray>>

Defined in: src/simulator/SimulatorHands.ts:120


lerpSpeed

lerpSpeed: number = 0.1

Defined in: src/simulator/SimulatorHands.ts:126


loader

loader: GLTFLoader

Defined in: src/simulator/SimulatorHands.ts:129


onHandednessChanged()?

optional onHandednessChanged: (handedness) => void

Defined in: src/simulator/SimulatorHands.ts:617

Optional callback fired after the active hand changes.

Parameters

handedness

"left" | "right"

Returns

void


rightController

rightController: Object3D<Object3DEventMap>

Defined in: src/simulator/SimulatorHands.ts:105


rightHand?

optional rightHand: Group<Object3DEventMap>

Defined in: src/simulator/SimulatorHands.ts:107


rightHandAtMaxRange

rightHandAtMaxRange: boolean = false

Defined in: src/simulator/SimulatorHands.ts:113


rightHandBones

rightHandBones: (Object3D<Object3DEventMap> | undefined)[] = []

Defined in: src/simulator/SimulatorHands.ts:109


rightHandCurrentRotations

rightHandCurrentRotations: Partial<Record<"wrist" | "thumb-metacarpal" | "thumb-phalanx-proximal" | "thumb-phalanx-distal" | "thumb-tip" | "index-finger-metacarpal" | "index-finger-phalanx-proximal" | "index-finger-phalanx-intermediate" | "index-finger-phalanx-distal" | "index-finger-tip" | "middle-finger-metacarpal" | "middle-finger-phalanx-proximal" | "middle-finger-phalanx-intermediate" | "middle-finger-phalanx-distal" | "middle-finger-tip" | "ring-finger-metacarpal" | "ring-finger-phalanx-proximal" | "ring-finger-phalanx-intermediate" | "ring-finger-phalanx-distal" | "ring-finger-tip" | "pinky-finger-metacarpal" | "pinky-finger-phalanx-proximal" | "pinky-finger-phalanx-intermediate" | "pinky-finger-phalanx-distal" | "pinky-finger-tip", SimulatorHandJointRotationArray>>

Defined in: src/simulator/SimulatorHands.ts:117


rightHandPose?

optional rightHandPose: SimulatorHandPose = SimulatorHandPose.RELAXED

Defined in: src/simulator/SimulatorHands.ts:111


rightHandTargetRotations

rightHandTargetRotations: Partial<Record<"wrist" | "thumb-metacarpal" | "thumb-phalanx-proximal" | "thumb-phalanx-distal" | "thumb-tip" | "index-finger-metacarpal" | "index-finger-phalanx-proximal" | "index-finger-phalanx-intermediate" | "index-finger-phalanx-distal" | "index-finger-tip" | "middle-finger-metacarpal" | "middle-finger-phalanx-proximal" | "middle-finger-phalanx-intermediate" | "middle-finger-phalanx-distal" | "middle-finger-tip" | "ring-finger-metacarpal" | "ring-finger-phalanx-proximal" | "ring-finger-phalanx-intermediate" | "ring-finger-phalanx-distal" | "ring-finger-tip" | "pinky-finger-metacarpal" | "pinky-finger-phalanx-proximal" | "pinky-finger-phalanx-intermediate" | "pinky-finger-phalanx-distal" | "pinky-finger-tip", SimulatorHandJointRotationArray>>

Defined in: src/simulator/SimulatorHands.ts:123

Methods

dispose()

dispose(): void

Defined in: src/simulator/SimulatorHands.ts:575

Returns

void


hideHands()

hideHands(): void

Defined in: src/simulator/SimulatorHands.ts:540

Returns

void


init()

init(__namedParameters): Promise<void>

Defined in: src/simulator/SimulatorHands.ts:147

Initialize Simulator Hands.

Parameters

__namedParameters
camera?

Camera

input

Input

physics?

SimulatorPhysics

simulatorOptions?

SimulatorOptions

Returns

Promise<void>


lerpLeftHandPose()

lerpLeftHandPose(): void

Defined in: src/simulator/SimulatorHands.ts:429

Returns

void


lerpRightHandPose()

lerpRightHandPose(): void

Defined in: src/simulator/SimulatorHands.ts:453

Returns

void


loadMeshes()

loadMeshes(): Promise<[void, void]>

Defined in: src/simulator/SimulatorHands.ts:167

Returns

Promise<[void, void]>


onHandPoseChangeRequest()

onHandPoseChangeRequest(event): void

Defined in: src/simulator/SimulatorHands.ts:595

Parameters

event

Event

Returns

void


setHandPosePanelElement()

setHandPosePanelElement(element): void

Defined in: src/simulator/SimulatorHands.ts:560

Parameters

element

HTMLElement

Returns

void


setLeftHandJoints()

setLeftHandJoints(joints): void

Defined in: src/simulator/SimulatorHands.ts:343

Parameters

joints

readonly object[]

Returns

void


setLeftHandLerpPose()

setLeftHandLerpPose(pose): void

Defined in: src/simulator/SimulatorHands.ts:229

Parameters

pose

SimulatorHandPose

Returns

void


setLeftHandPinching()

setLeftHandPinching(pinching): void

Defined in: src/simulator/SimulatorHands.ts:519

Parameters

pinching

boolean = true

Returns

void


setLeftHandRotations()

setLeftHandRotations(rotations, applyConstraints): void

Defined in: src/simulator/SimulatorHands.ts:296

Applies semantic biomechanical rotations from SimulatorHandPoseRotations.

Parameters

rotations

SimulatorHandPoseRotations

applyConstraints

boolean = false

Returns

void


setRightHandJoints()

setRightHandJoints(joints): void

Defined in: src/simulator/SimulatorHands.ts:359

Parameters

joints

readonly object[]

Returns

void


setRightHandLerpPose()

setRightHandLerpPose(pose): void

Defined in: src/simulator/SimulatorHands.ts:262

Parameters

pose

SimulatorHandPose

Returns

void


setRightHandPinching()

setRightHandPinching(pinching): void

Defined in: src/simulator/SimulatorHands.ts:525

Parameters

pinching

boolean = true

Returns

void


setRightHandRotations()

setRightHandRotations(rotations, applyConstraints): void

Defined in: src/simulator/SimulatorHands.ts:320

Applies semantic biomechanical rotations from SimulatorHandPoseRotations.

Parameters

rotations

SimulatorHandPoseRotations

applyConstraints

boolean = false

Returns

void


showHands()

showHands(): void

Defined in: src/simulator/SimulatorHands.ts:531

Returns

void


syncHandJoints()

syncHandJoints(): void

Defined in: src/simulator/SimulatorHands.ts:477

Returns

void


toggleHandedness()

toggleHandedness(): void

Defined in: src/simulator/SimulatorHands.ts:605

Returns

void


update()

update(): void

Defined in: src/simulator/SimulatorHands.ts:375

Returns

void


updateHandPosePanel()

updateHandPosePanel(): void

Defined in: src/simulator/SimulatorHands.ts:549

Returns

void