Skip to main content

Interface: SimulatorHands

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

Properties​

handPosePanelElement?​

optional handPosePanelElement: SimulatorHandPoseHTMLElement

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


input​

input: Input

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


leftController​

leftController: Object3D<Object3DEventMap>

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


leftHand?​

optional leftHand: Group<Object3DEventMap>

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


leftHandAtMaxRange​

leftHandAtMaxRange: boolean = false

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


leftHandBones​

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

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


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:118


leftHandPose?​

optional leftHandPose: SimulatorHandPose = SimulatorHandPose.RELAXED

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


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:124


lerpSpeed​

lerpSpeed: number = 0.1

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


loader​

loader: GLTFLoader

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


onHandednessChanged()?​

optional onHandednessChanged: (handedness) => void

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

Optional callback fired after the active hand changes.

Parameters​

handedness​

"left" | "right"

Returns​

void


rightController​

rightController: Object3D<Object3DEventMap>

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


rightHand?​

optional rightHand: Group<Object3DEventMap>

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


rightHandAtMaxRange​

rightHandAtMaxRange: boolean = false

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


rightHandBones​

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

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


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:121


rightHandPose?​

optional rightHandPose: SimulatorHandPose = SimulatorHandPose.RELAXED

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


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:127

Methods​

dispose()​

dispose(): void

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

Returns​

void


hideHands()​

hideHands(): void

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

Returns​

void


init()​

init(__namedParameters): Promise<void>

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

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:433

Returns​

void


lerpRightHandPose()​

lerpRightHandPose(): void

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

Returns​

void


loadMeshes()​

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

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

Returns​

Promise<[void, void]>


onHandPoseChangeRequest()​

onHandPoseChangeRequest(event): void

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

Parameters​

event​

Event

Returns​

void


setHandPosePanelElement()​

setHandPosePanelElement(element): void

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

Parameters​

element​

HTMLElement

Returns​

void


setLeftHandJoints()​

setLeftHandJoints(joints): void

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

Parameters​

joints​

readonly object[]

Returns​

void


setLeftHandLerpPose()​

setLeftHandLerpPose(pose): void

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

Parameters​

pose​

SimulatorHandPose

Returns​

void


setLeftHandPinching()​

setLeftHandPinching(pinching): void

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

Parameters​

pinching​

boolean = true

Returns​

void


setLeftHandRotations()​

setLeftHandRotations(rotations, applyConstraints): void

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

Applies semantic biomechanical rotations from SimulatorHandPoseRotations.

Parameters​

rotations​

SimulatorHandPoseRotations

applyConstraints​

boolean = false

Returns​

void


setRightHandJoints()​

setRightHandJoints(joints): void

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

Parameters​

joints​

readonly object[]

Returns​

void


setRightHandLerpPose()​

setRightHandLerpPose(pose): void

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

Parameters​

pose​

SimulatorHandPose

Returns​

void


setRightHandPinching()​

setRightHandPinching(pinching): void

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

Parameters​

pinching​

boolean = true

Returns​

void


setRightHandRotations()​

setRightHandRotations(rotations, applyConstraints): void

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

Applies semantic biomechanical rotations from SimulatorHandPoseRotations.

Parameters​

rotations​

SimulatorHandPoseRotations

applyConstraints​

boolean = false

Returns​

void


showHands()​

showHands(): void

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

Returns​

void


syncHandJoints()​

syncHandJoints(): void

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

Returns​

void


toggleHandedness()​

toggleHandedness(): void

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

Returns​

void


update()​

update(): void

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

Returns​

void


updateHandPosePanel()​

updateHandPosePanel(): void

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

Returns​

void