PositionSensorVRDevice: resetSensor() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

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

Syntax

resetSensor()

Parameters

None.

Return value

None (undefined).

Examples

The following 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 = () => {
  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.

Browser compatibility

BCD tables only load in the browser

See also