Update polyfill to use WebVR v1 API #33

toji · 2016-02-24T18:54:50Z

Now includes distortion and querying of device parameters from DPDB. Old API
is still accessible when setting WebVRConfig.ENABLE_DEPRECATED_API to true.

toji · 2016-02-24T18:56:53Z

Apologies for the large pull request. Happy to discuss any part of it you have questions about. Would like to try and get this merged before the release of the WebVR v1 spec/builds so that I can point developers to the official polyfill repo from day one instead of my fork.

cvan · 2016-02-24T22:22:05Z

src/base.js

+        self.isPresenting = fullscreenElement == layer.source;
+        self.fireVRDisplayPresentChange_();
+        if (self.isPresenting) {
+          if (screen.orientation && screen.orientation.lock)


jshint will complain; I would put /* global screen */ up top

toji · 2016-02-25T05:20:06Z

Addressed @cvan's comments and fixed a bug or two.

cvan · 2016-02-26T05:21:46Z

src/webvr-polyfill.js


-  if (!this.isWebVRAvailable()) {
+  if (!this.nativeWebVRAvailable) {


IMO, we should bail return early if this.nativeWebVRAvailable (would also prevent having to check WebVRConfig.ENABLE_DEPRECATED_API below if you wanted to).

cvan · 2016-02-26T06:52:37Z

I had to make these changes for this to work in Firefox and your older Chromium builds:

diff --git a/src/webvr-polyfill.js b/src/webvr-polyfill.js
index 0e8c237..a02952b 100644
--- a/src/webvr-polyfill.js
+++ b/src/webvr-polyfill.js
@@ -28,12 +28,15 @@ function WebVRPolyfill() {
   this.devices = []; // For deprecated objects
   this.devicesPopulated = false;
   this.nativeWebVRAvailable = this.isWebVRAvailable();
+  this.nativeLegacyWebVRAvailable = this.isDeprecatedWebVRAvailable();

-  if (!this.nativeWebVRAvailable) {
-    this.enablePolyfill();
-  }
-  if (WebVRConfig.ENABLE_DEPRECATED_API && !this.isDeprecatedWebVRAvailable()) {
-    this.enableDeprecatedPolyfill();
+  if (!this.nativeLegacyWebVRAvailable) {
+    if (!this.nativeWebVRAvailable) {
+      this.enablePolyfill();
+    }
+    if (WebVRConfig.ENABLE_DEPRECATED_API) {
+      this.enableDeprecatedPolyfill();
+    }
   }
 }

@@ -113,15 +116,30 @@ WebVRPolyfill.prototype.getVRDevices = function() {
   var self = this;
   return new Promise(function(resolve, reject) {
     try {
-      if (!self.devicesPopulated && self.nativeWebVRAvailable) {
-        navigator.getVRDisplays(function(displays) {
-          for (var i = 0; i < displays.length; ++i) {
-            self.devices.push(new VRDisplayHMDDevice(displays[i]));
-            self.devices.push(new VRDisplayPositionSensorDevice(displays[i]));
-          }
-          self.devicesPopulated = true;
-          resolve(self.devices);
-        }, reject);
+      if (!self.devicesPopulated) {
+        if (self.nativeWebVRAvailable) {
+          navigator.getVRDisplays(function(displays) {
+            for (var i = 0; i < displays.length; ++i) {
+              self.devices.push(new VRDisplayHMDDevice(displays[i]));
+              self.devices.push(new VRDisplayPositionSensorDevice(displays[i]));
+            }
+            self.devicesPopulated = true;
+            resolve(self.devices);
+          }, reject);
+        } else if (self.nativeLegacyWebVRAvailable) {
+          (navigator.getVRDDevices || navigator.mozGetVRDevices)(function(devices) {
+            for (var i = 0; i < devices.length; ++i) {
+              if (devices[i] instanceof HMDVRDevice) {
+                self.devices.push(displays[i]);
+              }
+              if (devices[i] instanceof PositionSensorVRDevice) {
+                self.devices.push(devices[i]);
+              }
+            }
+            self.devicesPopulated = true;
+            resolve(self.devices);
+          }, reject);
+        }
       } else {
         self.populateDevices();
         resolve(self.devices);

cvan · 2016-02-28T23:56:38Z

.gitignore

@@ -0,0 +1,2 @@
+


I'd recommend

*.log *.pid *.seed *~ .DS_Store .node_repl_history .npm logs node_modules npm-debug.log* pids

I opened #34; this is fine for now

cvan · 2016-03-01T00:39:58Z

latest patch to fix Firefox/older Chromium experimental builds:

diff --git a/src/webvr-polyfill.js b/src/webvr-polyfill.js
index 0e8c237..20eac0d 100644
--- a/src/webvr-polyfill.js
+++ b/src/webvr-polyfill.js
@@ -28,12 +28,15 @@ function WebVRPolyfill() {
   this.devices = []; // For deprecated objects
   this.devicesPopulated = false;
   this.nativeWebVRAvailable = this.isWebVRAvailable();
+  this.nativeLegacyWebVRAvailable = this.isDeprecatedWebVRAvailable();

-  if (!this.nativeWebVRAvailable) {
-    this.enablePolyfill();
-  }
-  if (WebVRConfig.ENABLE_DEPRECATED_API && !this.isDeprecatedWebVRAvailable()) {
-    this.enableDeprecatedPolyfill();
+  if (!this.nativeLegacyWebVRAvailable) {
+    if (!this.nativeWebVRAvailable) {
+      this.enablePolyfill();
+    }
+    if (WebVRConfig.ENABLE_DEPRECATED_API) {
+      this.enableDeprecatedPolyfill();
+    }
   }
 }

@@ -113,19 +116,36 @@ WebVRPolyfill.prototype.getVRDevices = function() {
   var self = this;
   return new Promise(function(resolve, reject) {
     try {
-      if (!self.devicesPopulated && self.nativeWebVRAvailable) {
-        navigator.getVRDisplays(function(displays) {
-          for (var i = 0; i < displays.length; ++i) {
-            self.devices.push(new VRDisplayHMDDevice(displays[i]));
-            self.devices.push(new VRDisplayPositionSensorDevice(displays[i]));
-          }
-          self.devicesPopulated = true;
-          resolve(self.devices);
-        }, reject);
-      } else {
-        self.populateDevices();
-        resolve(self.devices);
+      if (!self.devicesPopulated) {
+        if (self.nativeWebVRAvailable) {
+          return navigator.getVRDisplays(function(displays) {
+            for (var i = 0; i < displays.length; ++i) {
+              self.devices.push(new VRDisplayHMDDevice(displays[i]));
+              self.devices.push(new VRDisplayPositionSensorDevice(displays[i]));
+            }
+            self.devicesPopulated = true;
+            resolve(self.devices);
+          }, reject);
+        }
+
+        if (self.nativeLegacyWebVRAvailable) {
+          return (navigator.getVRDDevices || navigator.mozGetVRDevices)(function(devices) {
+            for (var i = 0; i < devices.length; ++i) {
+              if (devices[i] instanceof HMDVRDevice) {
+                self.devices.push(displays[i]);
+              }
+              if (devices[i] instanceof PositionSensorVRDevice) {
+                self.devices.push(devices[i]);
+              }
+            }
+            self.devicesPopulated = true;
+            resolve(self.devices);
+          }, reject);
+        }
       }
+
+      self.populateDevices();
+      resolve(self.devices);
     } catch (e) {
       reject(e);
     }

cvan · 2016-03-01T00:50:04Z

src/webvr-polyfill.js

  // Initialize our virtual VR devices.
  if (this.isCardboardCompatible()) {
-    this.devices.push(new CardboardHMDVRDevice());
+    var vrDisplay = new CardboardVRDisplay();


variable already defined above. drop the var.

toji · 2016-03-01T18:59:11Z

Implemented the patch @cvan pasted inline above as well as a couple of other fixes mentioned in this conversation. Also refactored the mouse and keyboard implementation as a VRDisplay and started exposing it on non-mobile. As always, you can see the latest version in action on http://toji.github.io/webvr-samples/03a-webvr-polyfill.html

toji · 2016-03-02T00:44:35Z

Latest update fixes resetPose on CardboardVRDisplay and corrects non-black distortion background with backbuffers that have an alpha channel. (which is forced on iOS)

ashconnell · 2016-03-02T01:39:42Z

src/base.js

+};
+
+VRDisplay.prototype.fireVRDisplayPresentChange_ = function() {
+  var event = new CustomEvent('vrdisplaypresentchange', { 'vrdisplay': this });


@toji listeners to this event don't receive the vrdisplay value, it needs to be added to the event detail:

var event = new CustomEvent('vrdisplaypresentchange', { detail: { vrdisplay: this } });

which makes it available at e.details.vrdisplay

I was going to reply here, but I instead adding a comment to the issue filed in the spec repo. Feel free to drop a line there: MozillaReality/webvr-spec#15.

toji · 2016-03-02T02:39:18Z

Added flag to defer initialization of the polyfill (now used with all the samples at https://toji.github.io/webvr-samples) and fixed the issue @ashconnell brought up.

cvan · 2016-03-02T07:47:48Z

README.md

+      //MOUSE_KEYBOARD_CONTROLS_DISABLED: true, // Default: false
+      // Prevent the polyfill from initializing immediately. Requiures the app
+      // to call InitializeWebVRPolyfill() before it can be used.
+      //DEFER_INITIALIZATION: true, // default: false


would also mention this in the commit message

cvan · 2016-03-02T07:55:32Z

build/webvr-polyfill.js needs to be rebuilt. or I guess you could undo those changes and wait until the PR is ready to be merged and @borismus could do it.

Now includes distortion and querying of device parameters from DPDB. Old API is still accessible when setting WebVRConfig.ENABLE_DEPRECATED_API to true.

toji · 2016-03-02T18:30:41Z

Latests patch now includes basic Cardboard UI with the alignment line and options button. Hooks are in for a button click listener but at the moment it only writes a "not implemented" error to the console.

Also made sure I rebuilt the build/ version this time. :)

As for the deferred load thing, I talked to @borismus about it offline yesterday and he seemed OK with the current form, but if he'd like me to refactor it I'm happy to.

Update polyfill to use WebVR v1 API

borismus · 2016-03-02T19:04:07Z

Thanks Brandon, this is huge. I've started a parallel webvr-boilerplate branch. Once everything is working (hopefully with compat), can branch both branches to masters.

cvan · 2016-03-02T20:26:24Z

woo! thanks, @borismus and @toji! 👍

cvan reviewed Feb 24, 2016
View reviewed changes

cvan reviewed Feb 26, 2016
View reviewed changes

cvan reviewed Feb 28, 2016
View reviewed changes

cvan reviewed Mar 1, 2016
View reviewed changes

cvan mentioned this pull request Mar 1, 2016

bump libs for WebVR API v1.0 ngokevin/aframe-core#796

Closed

ashconnell reviewed Mar 2, 2016
View reviewed changes

cvan mentioned this pull request Mar 2, 2016

Document events on window MozillaReality/webvr-spec#15

Closed

cvan reviewed Mar 2, 2016
View reviewed changes

Update polyfill to use WebVR v1 API

cdef6bd

Now includes distortion and querying of device parameters from DPDB. Old API is still accessible when setting WebVRConfig.ENABLE_DEPRECATED_API to true.

borismus added a commit that referenced this pull request Mar 2, 2016

Merge pull request #33 from toji/webvr_1

4e10331

Update polyfill to use WebVR v1 API

borismus merged commit 4e10331 into immersive-web:master Mar 2, 2016

borismus mentioned this pull request Mar 2, 2016

Revert "Update polyfill to use WebVR v1 API" #36

Merged

toji deleted the webvr_1 branch April 3, 2016 22:02

cvan mentioned this pull request Jun 1, 2016

Document events on window immersive-web/webxr#23

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update polyfill to use WebVR v1 API #33

Update polyfill to use WebVR v1 API #33

toji commented Feb 24, 2016

toji commented Feb 24, 2016

cvan Feb 24, 2016

toji commented Feb 25, 2016

cvan Feb 26, 2016

cvan commented Feb 26, 2016

cvan Feb 28, 2016

cvan Feb 29, 2016

cvan commented Mar 1, 2016

cvan Mar 1, 2016

toji commented Mar 1, 2016

toji commented Mar 2, 2016

ashconnell Mar 2, 2016

cvan Mar 2, 2016

toji commented Mar 2, 2016

cvan Mar 2, 2016

cvan commented Mar 2, 2016

toji commented Mar 2, 2016

borismus commented Mar 2, 2016

cvan commented Mar 2, 2016


		if (!this.isWebVRAvailable()) {
		if (!this.nativeWebVRAvailable) {

Update polyfill to use WebVR v1 API #33

Update polyfill to use WebVR v1 API #33

Conversation

toji commented Feb 24, 2016

toji commented Feb 24, 2016

Choose a reason for hiding this comment

toji commented Feb 25, 2016

Choose a reason for hiding this comment

cvan commented Feb 26, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cvan commented Mar 1, 2016

Choose a reason for hiding this comment

toji commented Mar 1, 2016

toji commented Mar 2, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toji commented Mar 2, 2016

Choose a reason for hiding this comment

cvan commented Mar 2, 2016

toji commented Mar 2, 2016

borismus commented Mar 2, 2016

cvan commented Mar 2, 2016