Skip to main content

Class: HandsOptions

Defined in: src/input/HandsOptions.ts:4

Constructors​

Constructor​

new HandsOptions(options?): HandsOptions

Defined in: src/input/HandsOptions.ts:16

Parameters​

options?​
debugging?​

boolean = false

enabled?​

boolean = false

Whether hand tracking is enabled.

enableHands?​

() => HandsOptions

enableHandsVisualization?​

() => HandsOptions

visualization?​

boolean = false

Whether to show any hand visualization.

visualizeJoints?​

boolean = false

Whether to show the tracked hand joints.

visualizeMeshes?​

boolean = false

Whether to show the virtual hand meshes.

Returns​

HandsOptions

Properties​

debugging​

debugging: boolean = false

Defined in: src/input/HandsOptions.ts:14

enabled​

enabled: boolean = false

Defined in: src/input/HandsOptions.ts:6

Whether hand tracking is enabled.

visualization​

visualization: boolean = false

Defined in: src/input/HandsOptions.ts:8

Whether to show any hand visualization.

visualizeJoints​

visualizeJoints: boolean = false

Defined in: src/input/HandsOptions.ts:10

Whether to show the tracked hand joints.

visualizeMeshes​

visualizeMeshes: boolean = false

Defined in: src/input/HandsOptions.ts:12

Whether to show the virtual hand meshes.

Methods​

enableHands()​

enableHands(): HandsOptions

Defined in: src/input/HandsOptions.ts:24

Enables hands tracking.

Returns​

HandsOptions

The instance for chaining.

enableHandsVisualization()​

enableHandsVisualization(): HandsOptions

Defined in: src/input/HandsOptions.ts:29

Returns​

HandsOptions