PositionSensorVRDevice
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 thecompatibility 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 not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
ThePositionSensorVRDevice interface of theWebVR API represents VR hardware's position sensor. You can access information such as the current position and orientation of the sensor in relation to the head mounted display through thePositionSensorVRDevice.getState() method.
Instance methods
PositionSensorVRDevice.getState()DeprecatedNon-standardReturns the current state of the position sensor for the current frame (e.g., within the current
window.requestAnimationFramecallback) or for the previous frame, contained with aVRPoseobject. This is the method you'd normally want to use, versusgetImmediateState().PositionSensorVRDevice.getImmediateState()DeprecatedNon-standardReturns the current instantaneous position sensor state. This is intended to only be used rarely, for certain special uses, for example sampling the immediate position of a hand orientation sensor — or at least it will be, in the future.
PositionSensorVRDevice.resetSensor()DeprecatedNon-standardCan be used to reset the sensor if desired, returning the position and orientation values to zero.
Instance properties
This interface doesn't define any properties of its own, but it does inherit the properties of its parent interface,VRDisplay.
VRDisplay.displayIdRead onlyReturns the ID for this specific
VRDevice. The ID shouldn't change across browser restarts, allowing configuration data to be saved based on it.VRDisplay.displayNameRead onlyA human-readable name to identify the
VRDevice.
Examples
The following example uses the WebVR API to update the view of a simple2D canvas scene on each frame of arequestAnimationFrame loop.
function setView() { const posState = gPositionSensor.getState(); if (posState.hasPosition) { posPara.textContent = `Position: x${roundToTwo( posState.position.x, )} y${roundToTwo(posState.position.y)} z${roundToTwo(posState.position.z)}`; xPos = -posState.position.x * WIDTH * 2; yPos = posState.position.y * HEIGHT * 2; zPos = -posState.position.z > 0.01 ? -posState.position.z : 0.01; } if (posState.hasOrientation) { orientPara.textContent = `Orientation: x${roundToTwo( posState.orientation.x, )} y${roundToTwo(posState.orientation.y)} z${roundToTwo( posState.orientation.z, )}`; xOrient = posState.orientation.x * WIDTH; yOrient = -posState.orientation.y * HEIGHT * 2; zOrient = posState.orientation.z * 180; }}Here we are grabbing aVRPose object usingPositionSensorVRDevice.getState() and storing it inposState. We then check to make sure that position and orientation info is present in the current frame usingVRPose.position andVRPose.orientation (these returnnull if, for example the head mounted display is turned off or not pointing at the position sensor, which would cause an error.)
We then output the x, y and z position and orientation values for informational purposes, and use those values to update thexPos,yPos,zPos,xOrient,yOrient, andzOrient variables, which are used to update the scene rendering on each frame.
Browser compatibility
Loading…