VRFieldOfView.VRFieldOfView()

Obsolete
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

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 VRFieldOfView() constructor creates a new VRFieldOFView object.

Syntax

There are two forms of this constructor, which take their information in slightly different ways. The first one accepts four separate arguments — the VRFieldOfViewReadOnly.upDegrees, VRFieldOfViewReadOnly.rightDegrees, VRFieldOfViewReadOnly.downDegrees, and VRFieldOfViewReadOnly.leftDegrees values you want the field of view to have

var myFOV = new VRFieldOfView(upDegrees, rightDegrees, downDegrees, leftDegrees);

The second one takes a VRFieldOfViewInit object as a single argument, which is just a dictionary containing the four degree values mentioned above:

var init = {upDegrees:up,rightDegrees:right,downDegrees:down,leftDegrees:left}
var myFOV = new VRFieldOfView(init);

Parameters

  • Four argument version:

    upDegrees
    The number of degrees upwards that the field of view will extend in.
    rightDegrees
    The number of degrees to the right that the field of view will extend in.
    downDegrees
    The number of degrees downwards that the field of view will extend in.
    leftDegrees
    The number of degrees to the left that the field of view will extend in.
  • One argument version:

    init
    A dictionary object containing the four degree values specified above.

Examples

The following simple example shows a function that can be used to set a custom field of view with four specified degree values for up, right, down and left. The VRFieldOfView() constructor is used to create a VRFieldOfView object from the supplied values, which is then fed into the HMDVRDevice.setFieldOfView method.

function setCustomFOV(up,right,down,left) {
  var testFOV = new VRFieldOfView(up,right,down,left);

  gHMD.setFieldOfView(testFOV,testFOV,0.01,10000.0);

  var lEye = gHMD.getEyeParameters('left');
  var rEye = gHMD.getEyeParameters('right');
  console.log(lEye.currentFieldOfView);
  console.log(rEye.currentFieldOfView);
}

Note: When testing, setting a weird/tiny field of view can really mess up your view. It is a good idea to grab the current field of view first (using VREyeParameters.currentFieldOfView) before making any drastic changes, so you can reset it afterwards if needed.

Specifications

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

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes)[1] 46 (46) 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 46.0 (46) 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.

See also

Document Tags and Contributors

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