summaryrefslogtreecommitdiffstats
path: root/core/java/android/hardware/SensorManager.java
diff options
context:
space:
mode:
authorMathias Agopian <mathias@google.com>2010-11-19 16:25:11 -0800
committerMathias Agopian <mathias@google.com>2010-11-19 16:25:11 -0800
commitf71384cd6141c50f589178d309db3ceeb848fb30 (patch)
treecb69bacd157c7749636c8948c51f9ba3d7c65da1 /core/java/android/hardware/SensorManager.java
parent0e29064d1caad7b82aa76876e7e2f4c86ded06d2 (diff)
downloadframeworks_base-f71384cd6141c50f589178d309db3ceeb848fb30.zip
frameworks_base-f71384cd6141c50f589178d309db3ceeb848fb30.tar.gz
frameworks_base-f71384cd6141c50f589178d309db3ceeb848fb30.tar.bz2
Fix SensorManager.getOrientation() documentation.
This function doesn't use the same reference coordinate system used for the rotation matrix, unlike what the documentation previously stated. Change-Id: I38abeb74540d33b67f72993b54d7a00a73588dde
Diffstat (limited to 'core/java/android/hardware/SensorManager.java')
-rw-r--r--core/java/android/hardware/SensorManager.java16
1 files changed, 13 insertions, 3 deletions
diff --git a/core/java/android/hardware/SensorManager.java b/core/java/android/hardware/SensorManager.java
index 3f6e4ce..c178aee 100644
--- a/core/java/android/hardware/SensorManager.java
+++ b/core/java/android/hardware/SensorManager.java
@@ -1158,7 +1158,7 @@ public class SensorManager
*
* <p>
* <center><img src="../../../images/axis_globe.png"
- * alt="Sensors coordinate-system diagram." border="0" /></center>
+ * alt="World coordinate-system diagram." border="0" /></center>
* </p>
*
* <p>
@@ -1521,9 +1521,19 @@ public class SensorManager
* <li>values[1]: <i>pitch</i>, rotation around the X axis.</li>
* <li>values[2]: <i>roll</i>, rotation around the Y axis.</li>
* </ul>
+ * <p>The reference coordinate-system used is different from the world
+ * coordinate-system defined for the rotation matrix:</p>
+ * <ul>
+ * <li>X is defined as the vector product <b>Y.Z</b> (It is tangential to
+ * the ground at the device's current location and roughly points West).</li>
+ * <li>Y is tangential to the ground at the device's current location and
+ * points towards the magnetic North Pole.</li>
+ * <li>Z points towards the center of the Earth and is perpendicular to the ground.</li>
+ * </ul>
+ *
* <p>
- * <center><img src="../../../images/axis_device.png"
- * alt="Sensors coordinate-system diagram." border="0" /></center>
+ * <center><img src="../../../images/axis_device_inverted.png"
+ * alt="Inverted world coordinate-system diagram." border="0" /></center>
* </p>
* <p>
* All three angles above are in <b>radians</b> and <b>positive</b> in the