title: vive-controls type: components layout: docs parent_section: components source_code: src/components/vive-controls.js
The vive-controls component interfaces with the HTC Vive controllers/wands. It wraps the tracked-controls component while adding button mappings, events, and a Vive controller model that highlights the pressed buttons (trigger, grip, menu, system) and trackpad.
<a-entity vive-controls="hand: left"></a-entity> <a-entity vive-controls="hand: right"></a-entity>
Property | Description | Default Value |
---|---|---|
buttonColor | Button colors when not pressed. | #FAFAFA (off-white) |
buttonHighlightColor | Button colors when pressed and active. | #22D1EE (light blue) |
hand | The hand that will be tracked (i.e., right, left). | left |
model | Whether the Vive controller model is loaded. | true |
orientationOffset | Offset to apply to model orientation. | x: 0, y: 0, z: 0 |
Event Name | Description |
---|---|
gripdown | Grip button pressed. |
gripup | Grip button released. |
gripchanged | Grip button changed. |
menudown | Menu button pressed. |
menuup | Menu button released. |
menuchanged | Menu button changed. |
systemdown | System button pressed. |
systemup | System button released. |
systemchanged | System button changed. |
trackpaddown | Trackpad pressed. |
trackpadup | Trackpad released. |
trackpadchanged | Trackpad button changed. |
triggerdown | Trigger pressed. |
triggerup | Trigger released. |
triggerchanged | Trigger changed. |