VRDevice.resetPose()

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.

The resetPose() method of the VRDisplay interface resets the pose for the VRDisplay, treating its current VRPose.position and VRPose.orientation as the "origin/zero" values.

After resetPost() has been called, future poses returned from VRDisplay.getPose()/VRDisplay.getImmediatePose() will describe positions relative to the VRDisplay's position when resetPose() was last called and will treat the display’s yaw when resetPose() was last called as the forward orientation.

The VRDisplay's reported roll and pitch do not change when resetPose() is called as they are relative to gravity. Calling resetPose() may change the VRStageParameters.sittingToStandingTransform matrix.

Syntax

vrDisplayInstance.resetPose();

Parameters

None.

Return value

Void.

Examples

// Assuming vrDisplay already contains a VRDisplay object,
// and we have a <button> referenced inside btn
btn.addEventListener('click', function() {
  vrDisplay.resetPose();
  console.log('Current pose set as origin/center');
});

Specifications

Specification Status Comment
WebVR 1.1
The definition of 'resetPose()' in that specification.
Draft Initial definition

Browser compatibility

BCD tables only load in the browser

See also