StereoDevice (Generic/OVR): Add knowledge about LocationSensorParameter and allow reset origin of location-sensor

6 files changed, 133 insertions, 13 deletions

diff --git a/src/jogl/classes/com/jogamp/opengl/util/stereo/LocationSensorParameter.java b/src/jogl/classes/com/jogamp/opengl/util/stereo/LocationSensorParameter.java
new file mode 100644
index 000000000..b795927cd
--- /dev/null
+++ b/src/jogl/classes/com/jogamp/opengl/util/stereo/LocationSensorParameter.java
@@ -0,0 +1,51 @@
+/**
+ * Copyright 2015 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+package com.jogamp.opengl.util.stereo;
+
+import com.jogamp.opengl.math.geom.Frustum;
+
+/**
+ * Constant parameter of the positioning sensor to locate the {@link ViewerPose}.
+ */
+public final class LocationSensorParameter {
+    /** The {@link Frustum} of the location sensor. */
+    public final Frustum frustum;
+    /** The {@link Frustum}'s {@link Frustum.FovDesc} description of the location sensor. */
+    public final Frustum.FovDesc frustumDesc;
+    /** The {@link Frustum}'s float[16] projection matrix of the location sensor. */
+    public final float[] frustumProjMat;
+
+    public LocationSensorParameter(final Frustum.FovDesc fovDesc) {
+        this.frustumDesc = fovDesc;
+        this.frustum = new Frustum();
+        this.frustumProjMat = frustum.updateByFovDesc(new float[16], 0, true, fovDesc);
+    }
+    public final String toString() {
+        return "LocationSensor["+frustumDesc+"]";
+    }
+}
\ No newline at end of file
diff --git a/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDevice.java b/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDevice.java
index 68d0f4b39..b6112650a 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDevice.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDevice.java
@@ -117,6 +117,23 @@ public interface StereoDevice {
     public FovHVHalves[] getDefaultFOV();
 
     /**
+     * Returns the {@link LocationSensorParameter} of the device
+     * if {@link #SENSOR_POSITION} is {@link #getSupportedSensorBits() supported},
+     * otherwise returns {@code null}.
+     */
+    public LocationSensorParameter getLocationSensorParams();
+
+
+    /**
+     * Sets the location sensor's origin of this device to the current position.
+     * <p>
+     * In case {@link #SENSOR_POSITION} is not {@link #getSupportedSensorBits() supported},
+     * this method is a no-op.
+     * </p>
+     */
+    public void resetLocationSensorOrigin();
+
+    /**
      * Start desired and required sensors. Returns true if action was successful, otherwise false.
      * <p>
      * Method fails if required sensors are not {@link #getSupportedSensorBits() supported}.
diff --git a/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDevice.java b/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDevice.java
index 88be3b26b..bfe93b59c 100644
--- a/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDevice.java
+++ b/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDevice.java
@@ -36,6 +36,7 @@ import com.jogamp.nativewindow.util.RectangleImmutable;
 import com.jogamp.opengl.math.FovHVHalves;
 import com.jogamp.opengl.util.stereo.StereoDeviceConfig;
 import com.jogamp.opengl.util.stereo.EyeParameter;
+import com.jogamp.opengl.util.stereo.LocationSensorParameter;
 import com.jogamp.opengl.util.stereo.StereoDevice;
 import com.jogamp.opengl.util.stereo.StereoDeviceFactory;
 import com.jogamp.opengl.util.stereo.StereoDeviceRenderer;
@@ -179,6 +180,11 @@ public class GenericStereoDevice implements StereoDevice {
     @Override
     public final FovHVHalves[] getDefaultFOV() { return defaultEyeFov; }
 
+    @Override
+    public final LocationSensorParameter getLocationSensorParams() { return null; }
+
+    @Override
+    public final void resetLocationSensorOrigin() { }
 
     @Override
     public final boolean startSensors(final int desiredSensorBits, final int requiredSensorBits) {
diff --git a/src/oculusvr/classes/com/jogamp/oculusvr/OVRVersion.java b/src/oculusvr/classes/com/jogamp/oculusvr/OVRVersion.java
index 1b85e8450..6269ce4e9 100644
--- a/src/oculusvr/classes/com/jogamp/oculusvr/OVRVersion.java
+++ b/src/oculusvr/classes/com/jogamp/oculusvr/OVRVersion.java
@@ -107,20 +107,23 @@ public class OVRVersion extends JogampVersion {
         if(null==sb) {
             sb = new StringBuilder();
         }
-        sb.append("\thmd."+ovrHmdIndex+".productName:\t"+hmdDesc.getProductNameAsString()).append(Platform.getNewline());
-        sb.append("\thmd."+ovrHmdIndex+".vendorName:\t"+hmdDesc.getManufacturerAsString()).append(Platform.getNewline());
-        sb.append("\thmd."+ovrHmdIndex+".deviceName:\t"+hmdDesc.getDisplayDeviceNameAsString()).append(Platform.getNewline());
-        sb.append("\thmd."+ovrHmdIndex+".productId:\t0x"+Integer.toHexString(hmdDesc.getProductId())).append(Platform.getNewline());
-        sb.append("\thmd."+ovrHmdIndex+".vendorId:\t0x"+Integer.toHexString(hmdDesc.getVendorId())).append(Platform.getNewline());
-        sb.append("\thmd."+ovrHmdIndex+".serial:\t"+hmdDesc.getSerialNumberAsString()).append(Platform.getNewline());
-        sb.append("\thmd."+ovrHmdIndex+".type:\t"+hmdDesc.getType()).append(Platform.getNewline());
-        sb.append("\thmd."+ovrHmdIndex+".hmdCaps:\t"+toHexString(hmdDesc.getHmdCaps())).append(Platform.getNewline());
-        sb.append("\thmd."+ovrHmdIndex+".distorCaps:\t"+toHexString(hmdDesc.getDistortionCaps())).append(Platform.getNewline());
-        sb.append("\thmd."+ovrHmdIndex+".sensorCaps:\t"+toHexString(hmdDesc.getTrackingCaps())).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".productName: "+hmdDesc.getProductNameAsString()).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".vendorName: "+hmdDesc.getManufacturerAsString()).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".deviceName: "+hmdDesc.getDisplayDeviceNameAsString()).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".productId: 0x"+Integer.toHexString(hmdDesc.getProductId())).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".vendorId: 0x"+Integer.toHexString(hmdDesc.getVendorId())).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".serial: "+hmdDesc.getSerialNumberAsString()).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".firmware: "+hmdDesc.getFirmwareMajor()+"."+hmdDesc.getFirmwareMinor()).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".type: "+hmdDesc.getType()).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".hmdCaps: "+toHexString(hmdDesc.getHmdCaps())).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".distorCaps: "+toHexString(hmdDesc.getDistortionCaps())).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".sensorCaps: "+toHexString(hmdDesc.getTrackingCaps())).append(Platform.getNewline());
         final ovrSizei resolution = hmdDesc.getResolution();
-        sb.append("\thmd."+ovrHmdIndex+".resolution:\t"+resolution.getW()+"x"+resolution.getH()).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".resolution: "+resolution.getW()+"x"+resolution.getH()).append(Platform.getNewline());
         final ovrVector2i winPos = hmdDesc.getWindowsPos();
-        sb.append("\thmd."+ovrHmdIndex+".winPos:\t"+winPos.getX()+" / "+winPos.getY()).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".winPos: "+winPos.getX()+" / "+winPos.getY()).append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".cameraFrustum.Z: "+hmdDesc.getCameraFrustumNearZInMeters()+" - "+hmdDesc.getCameraFrustumFarZInMeters()+" meter").append(Platform.getNewline());
+        sb.append("\thmd."+ovrHmdIndex+".cameraFrustum.Fov: H "+hmdDesc.getCameraFrustumHFovInRadians()+" rad, V "+hmdDesc.getCameraFrustumVFovInRadians()+" rad").append(Platform.getNewline());
         return sb;
     }
     private static String toHexString(final int v) { return "0x"+Integer.toHexString(v); }
diff --git a/src/oculusvr/classes/jogamp/opengl/oculusvr/OVRStereoDevice.java b/src/oculusvr/classes/jogamp/opengl/oculusvr/OVRStereoDevice.java
index b22aecab8..44bf13cd3 100644
--- a/src/oculusvr/classes/jogamp/opengl/oculusvr/OVRStereoDevice.java
+++ b/src/oculusvr/classes/jogamp/opengl/oculusvr/OVRStereoDevice.java
@@ -40,6 +40,8 @@ import com.jogamp.oculusvr.ovrHmdDesc;
 import com.jogamp.oculusvr.ovrSizei;
 import com.jogamp.oculusvr.ovrTrackingState;
 import com.jogamp.opengl.math.FovHVHalves;
+import com.jogamp.opengl.math.geom.Frustum;
+import com.jogamp.opengl.util.stereo.LocationSensorParameter;
 import com.jogamp.opengl.util.stereo.StereoDevice;
 import com.jogamp.opengl.util.stereo.StereoDeviceFactory;
 import com.jogamp.opengl.util.stereo.StereoDeviceRenderer;
@@ -69,6 +71,8 @@ public class OVRStereoDevice implements StereoDevice {
     private final PointImmutable position;
     private final int dkVersion;
 
+    private final LocationSensorParameter locationSensorParams;
+
     public OVRStereoDevice(final StereoDeviceFactory factory, final ovrHmdDesc hmdDesc, final int deviceIndex) {
         if( null == hmdDesc ) {
             throw new IllegalArgumentException("Passed null hmdDesc");
@@ -81,6 +85,15 @@ public class OVRStereoDevice implements StereoDevice {
         this.handle = nativeContext;
         this.deviceIndex = deviceIndex;
         this.hmdDesc = hmdDesc;
+
+        {
+            final FovHVHalves posFov = FovHVHalves.byRadians(hmdDesc.getCameraFrustumHFovInRadians(),
+                                                             hmdDesc.getCameraFrustumVFovInRadians());
+            final float posZNear = hmdDesc.getCameraFrustumNearZInMeters();
+            final float posZFar = hmdDesc.getCameraFrustumFarZInMeters();
+            locationSensorParams = new LocationSensorParameter(new Frustum.FovDesc(posFov, posZNear, posZFar));
+        }
+
         final ovrFovPort[] defaultOVREyeFov = hmdDesc.getDefaultEyeFov(0, new ovrFovPort[ovrHmdDesc.getEyeRenderOrderArrayLength()]);
         defaultEyeFov = new FovHVHalves[defaultOVREyeFov.length];
         for(int i=0; i<defaultEyeFov.length; i++) {
@@ -132,7 +145,8 @@ public class OVRStereoDevice implements StereoDevice {
                       "], recommended ["+StereoUtil.distortionBitsToString(getRecommendedDistortionBits())+
                       "], minimum ["+StereoUtil.distortionBitsToString(getMinimumDistortionBits())+"]]");
         sb.append(", sensorBits[supported ["+StereoUtil.sensorBitsToString(getSupportedSensorBits())+
-                      "], enabled ["+StereoUtil.sensorBitsToString(getEnabledSensorBits())+"]]]");
+                      "], enabled ["+StereoUtil.sensorBitsToString(getEnabledSensorBits())+"]]");
+        sb.append(", "+locationSensorParams+"]");
         return sb.toString();
     }
 
@@ -164,6 +178,15 @@ public class OVRStereoDevice implements StereoDevice {
 
     @Override
     public final FovHVHalves[] getDefaultFOV() { return defaultEyeFov; }
+
+    @Override
+    public final LocationSensorParameter getLocationSensorParams() { return locationSensorParams; }
+
+    @Override
+    public final void resetLocationSensorOrigin() {
+        if( isValid() && sensorsStarted && StereoUtil.usesPositionSensor(supportedSensorBits)) {
+            OVR.ovrHmd_RecenterPose(hmdDesc);
+        }
     }
 
     /* pp */ void updateUsedSensorBits(final ovrTrackingState trackingState) {
diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/stereo/StereoDemo01.java b/src/test/com/jogamp/opengl/test/junit/jogl/stereo/StereoDemo01.java
index c2e808770..df8e2bef6 100644
--- a/src/test/com/jogamp/opengl/test/junit/jogl/stereo/StereoDemo01.java
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/stereo/StereoDemo01.java
@@ -34,8 +34,10 @@ import java.util.Arrays;
 import com.jogamp.nativewindow.util.DimensionImmutable;
 import com.jogamp.nativewindow.util.PointImmutable;
 import com.jogamp.opengl.GL;
+import com.jogamp.opengl.GLAutoDrawable;
 import com.jogamp.opengl.GLCapabilities;
 import com.jogamp.opengl.GLProfile;
+import com.jogamp.opengl.GLRunnable;
 
 import jogamp.opengl.util.stereo.GenericStereoDevice;
 
@@ -334,6 +336,24 @@ public class StereoDemo01 {
                     return;
                 }
                 switch(e.getKeySymbol()) {
+                    case KeyEvent.VK_O: {
+                        window.invoke(false, new GLRunnable() {
+                            @Override
+                            public boolean run(final GLAutoDrawable drawable) {
+                                stereoDevice.resetLocationSensorOrigin();
+                                return true;
+                            } });
+                        break;
+                    }
+                    case KeyEvent.VK_P: {
+                        window.invoke(false, new GLRunnable() {
+                            @Override
+                            public boolean run(final GLAutoDrawable drawable) {
+                                System.err.println(stereoDeviceRenderer.getLastViewerPose());
+                                return true;
+                            } });
+                        break;
+                    }
                     case KeyEvent.VK_R: {
                         if( stereoDevice.getSensorsStarted() ) {
                             stereoDevice.stopSensors();