Add screentop tracking mode support. (#319)

JamesProvan-UL · web-flow · commit 131095b688b7 · 2025-02-24T13:22:36.000Z
* Add screentop tracking mode support.

* Fix swapping between HMD and screentop tracking modes. Adding example.
diff --git a/examples/optimizeHMDScreentop.html b/examples/optimizeHMDScreentop.html
@@ -0,0 +1,20 @@
+<html>
+  <head>
+    <title>HMD/Screentop Optimization - Leap</title>
+    <script src="../leap-1.1.1.js"></script>
+    <script>
+      var controller = new Leap.Controller({optimizeScreentop: true}).connect();
+    </script>
+  </head>
+  <body>
+  <button onclick="controller.setOptimizeHMD(true);">controller.setOptimizeHMD(true);</button>
+  <button onclick="controller.setOptimizeHMD(false);">controller.setOptimizeHMD(false);</button>
+  <br/>
+  <br/>
+  <button onclick="controller.setOptimizeScreentop(true);">controller.setOptimizeScreentop(true);</button>
+  <button onclick="controller.setOptimizeScreentop(false);">controller.setOptimizeScreentop(false);</button>
+  <pre>
+    <div id="out"></div>
+  </pre>
+  </body>
+</html>
diff --git a/leap-1.1.1.js b/leap-1.1.1.js
@@ -200,6 +200,7 @@ var BaseConnection = module.exports = function(opts) {
     port: this.getPort(),
     background: false,
     optimizeHMD: false,
+    optimizeScreentop: false,
     requestProtocolVersion: BaseConnection.defaultProtocolVersion
   }, opts || {});
   this.host = this.opts.host;
@@ -208,12 +209,16 @@ var BaseConnection = module.exports = function(opts) {
   this.protocolVersionVerified = false;
   this.background = null;
   this.optimizeHMD = null;
+  this.optimizeScreentop = null;
   this.on('ready', function() {
     this.setBackground(this.opts.background);
     this.setOptimizeHMD(this.opts.optimizeHMD);
+    this.setOptimizeScreentop(this.opts.optimizeScreentop);
 
     if (this.opts.optimizeHMD){
       console.log("Optimized for head mounted display usage.");
+    }else if (this.opts.optimizeScreentop){
+      console.log("Optimized for screentop usage.");
     }else {
       console.log("Optimized for desktop usage.");
     }
@@ -249,11 +254,21 @@ BaseConnection.prototype.setBackground = function(state) {
 BaseConnection.prototype.setOptimizeHMD = function(state) {
   this.opts.optimizeHMD = state;
   if (this.protocol && this.protocol.sendOptimizeHMD && this.optimizeHMD !== this.opts.optimizeHMD) {
+	if (state === true) this.optimizeScreentop = false;
     this.optimizeHMD = this.opts.optimizeHMD;
     this.protocol.sendOptimizeHMD(this, this.opts.optimizeHMD);
   }
 }
 
+BaseConnection.prototype.setOptimizeScreentop = function(state) {
+  this.opts.optimizeScreentop = state;
+  if (this.protocol && this.protocol.sendOptimizeScreentop && this.optimizeScreentop !== this.opts.optimizeScreentop) {
+	if (state === true) this.optimizeHMD = false;
+    this.optimizeScreentop = this.opts.optimizeScreentop;
+    this.protocol.sendOptimizeScreentop(this, this.opts.optimizeScreentop);
+  }
+}
+
 BaseConnection.prototype.handleOpen = function() {
   if (!this.connected) {
     this.connected = true;
@@ -298,6 +313,7 @@ BaseConnection.prototype.disconnect = function(allowReconnect) {
   delete this.protocol;
   delete this.background; // This is not persisted when reconnecting to the web socket server
   delete this.optimizeHMD;
+  delete this.optimizeScreentop;
   delete this.focusedState;
   if (this.connected) {
     this.connected = false;
@@ -590,6 +606,11 @@ Controller.prototype.setOptimizeHMD = function(state) {
   return this;
 }
 
+Controller.prototype.setOptimizeScreentop = function(state) {
+  this.connection.setOptimizeScreentop(state);
+  return this;
+}
+
 Controller.prototype.inBrowser = function() {
   return !this.inNode;
 }
@@ -2954,6 +2975,9 @@ exports.chooseProtocol = function(header) {
       protocol.sendOptimizeHMD = function(connection, state) {
         connection.send(protocol.encode({optimizeHMD: state}));
       }
+      protocol.sendOptimizeScreentop = function(connection, state) {
+        connection.send(protocol.encode({optimizeScreentop: state}));
+      }
       break;
     default:
       throw "unrecognized version";
diff --git a/leap-1.1.1.min.js b/leap-1.1.1.min.js
