aframe
Version:
A web framework for building virtual reality experiences.
63 lines (49 loc) • 3.1 kB
Markdown
---
title: hand-controls
type: components
layout: docs
parent_section: components
source_code: src/components/hand-controls.js
examples: []
---
[tracked]: ./tracked-controls.md
[vive]: ./vive-controls.md
[metatouch]: ./meta-touch-controls.md
[daydream]: ./daydream-controls.md
The hand-controls component provides tracked hands (using a prescribed model)
with animated gestures. hand-controls wraps the [vive-controls][vive] and
[meta-touch-controls][metatouch] which in turn wrap the [tracked-controls
component][tracked]. By specifying just `hand-controls`, we have something that
works well with both Vive and Rift. The component gives extra events and
handles hand animations and poses.
## Example
```html
<a-entity id="leftHand" hand-controls="hand: left; handModelStyle: lowPoly; color: #ffcccc"></a-entity>
<a-entity id="rightHand" hand-controls="hand: right; handModelStyle: lowPoly; color: #ffcccc"></a-entity>
```
## Properties
| Property | Description | Default Value |
|----------------|----------------------------------------------------------------------------------------|---------------|
| color | Color of hand material. | white |
| hand | Associated controller. Can be `left` or `right`. | left |
| handModelStyle | Style of the hand 3D model loaded. Can be `lowPoly`, `highPoly` or `toon`. | lowPoly |
## Events
| Event Name | Description |
| ---------- | ----------- |
| gripdown | The hand is closed into a fist without thumb raised. |
| gripup | The hand is no longer closed into a fist without thumb raised. |
| pointup | The hand is touching or pressing the trigger only. |
| pointdown | The hand is no longer touching or pressing the trigger only. |
| thumbup | The hand is closed into a fist with thumb raised. |
| thumbdown | The hand is no longer closed into a fist with thumb raised. |
| pointingstart | The hand is pointing with index finger without thumb raised. |
| pointingend | The hand is no longer pointing without thumb raised. |
| pistolstart | The hand is pointing with index finger and thumb raised. |
| pistolend | The hand is no longer pointing with thumb raised. |
## Assets
- [Left hand low poly model](https://cdn.aframe.io/controllers/hands/leftHandLow.glb)
- [Right hand low poly model](https://cdn.aframe.io/controllers/hands/rightHandLow.glb)
- [Left hand high poly model](https://cdn.aframe.io/controllers/hands/leftHandHigh.glb)
- [Right hand high poly model](https://cdn.aframe.io/controllers/hands/rightHandHigh.glb)
- [Left hand toon model](https://cdn.aframe.io/controllers/hands/leftHand.glb)
- [Right hand toon model](https://cdn.aframe.io/controllers/hands/rightHand.glb)