Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 210fc914 authored by Mathias Agopian's avatar Mathias Agopian
Browse files

[2472946] Sensor.TYPE_ORIENTATION returns inverted roll values 

Fix the documentation to reflect reality and encourage developpers to use
SensorManager.getRotation() instead of using Sensor.TYPE_ORIENTATION
parent ccea7662

core/java/android/hardware/Sensor.java

+3 −0
Original line number Diff line number Diff line
@@ -52,10 +52,13 @@ public class Sensor { 
     * for more details.

     */

    public static final int TYPE_LIGHT          = 5;



    /** A constant describing a pressure sensor type */

    public static final int TYPE_PRESSURE       = 6;



    /** A constant describing a temperature sensor type */

    public static final int TYPE_TEMPERATURE    = 7;



    /**

     * A constant describing an proximity sensor type.

     * See {@link android.hardware.SensorEvent SensorEvent}

core/java/android/hardware/SensorEvent.java

+10 −7
Original line number Diff line number Diff line
@@ -75,20 +75,23 @@ public class SensorEvent { 
     * with positive values when the z-axis moves <b>toward</b> the y-axis.

     *

     * <p>values[2]: Roll, rotation around Y axis (-90 to 90), with 

     * positive values  when the x-axis moves <b>away</b> from the z-axis.

     * positive values  when the x-axis moves <b>toward</b> the z-axis.

     * 

     * <p><b>Important note:</b> For historical reasons the roll angle is

     * positive in the clockwise direction (mathematically speaking, it

     * should be positive in the counter-clockwise direction).

     *

     * <p><b>Note:</b> This definition is different from <b>yaw, pitch and 

     * roll</b> used in aviation where the X axis is along the long side of

     * the plane (tail to nose).

     *

     * <p><b>Note:</b> It is preferable to use 

     * <p><b>Note:</b> This sensor type exists for legacy reasons, please use

     * {@link android.hardware.SensorManager#getRotationMatrix 

     *      getRotationMatrix()} in conjunction with

     * {@link android.hardware.SensorManager#remapCoordinateSystem 

     *      remapCoordinateSystem()} and

     * {@link android.hardware.SensorManager#getOrientation getOrientation()}

     * to compute these values; while it may be more expensive, it is usually 

     * more accurate.

     * to compute these values instead.

     *

     * <p>{@link android.hardware.Sensor#TYPE_ACCELEROMETER Sensor.TYPE_ACCELEROMETER}:<p>

     *  All values are in SI units (m/s^2) and measure the acceleration applied

core/java/android/hardware/SensorManager.java

+2 −0
Original line number Diff line number Diff line
@@ -1306,6 +1306,8 @@ 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>

     * <p>

     * All three angles above are in <b>radians</b> and <b>positive</b> in the

     * <b>counter-clockwise</b> direction.

     *

     * @param R rotation matrix see {@link #getRotationMatrix}.

     * @param values an array of 3 floats to hold the result.