PositionSensorVRDevice.resetSensor()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The resetSensor() method of the VRDevice interface can be used to reset the sensor if desired, returning the position and orientation values to zero.

Syntax

PositionSensorVRDevice.resetSensor();

Parameters

None.

Returns

Void.

Examples

Our positionsensorvrdevice demo uses the WebVR API to update the view of a simple 2D canvas scene on each frame of a requestAnimationFrame loop. It features, among other things, a "Reset Sensor" button in the UI, which when pressed runs the resetSensor() function on the position sensor. The JavaScript looks like this:

document.querySelector('button').onclick = function() {
  gPositionSensor.resetSensor();
}

When the button is pressed, the current position, orientation, etc. of the sensor/head mounted display is set to be 0 — this makes the method useful for calibration when an app is first loaded.

Specifications

Specification Status Comment
WebVR
The definition of 'PositionSensorVRDevice' in that specification.
Editor's Draft Initial definition

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes)[1] 39 (39)[2] No support No support No support
Feature Android Firefox Mobile (Gecko) Firefox OS (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support No support 39.0 (39)[2]
44.0 (44)[3]
No support No support No support No support No support
  • [1] The support in Chrome is currently experimental. To find information on Chrome's WebVR implementation status including supporting builds, check out Bringing VR to Chrome by Brandon Jones.
  • [2] The support for this feature is currently disabled by default in Firefox. To enable WebVR support in Firefox Nightly/Developer Edition, you can go to about:config and enable the dom.vr* prefs. A better option however is to install the WebVR Enabler Add-on, which does this for you and sets up other necessary parts of the environment.
  • [3] The dom.vr* prefs are enabled by default at this point, in Nightly/Aurora editions.

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, Sebastianz
 Last updated by: chrisdavidmills,