SensorManager.GetRotationMatrix Method

Reference

Definition

Namespace:: Android.Hardware

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Computes the inclination matrix I as well as the rotation matrix R transforming a vector from the device coordinate system to the world's coordinate system which is defined as a direct orthonormal basis, where:

[Android.Runtime.Register("getRotationMatrix", "([F[F[F[F)Z", "")]
public static bool GetRotationMatrix (float[]? R, float[]? I, float[]? gravity, float[]? geomagnetic);

[<Android.Runtime.Register("getRotationMatrix", "([F[F[F[F)Z", "")>]
static member GetRotationMatrix : single[] * single[] * single[] * single[] -> bool

Parameters

R: Single[]

is an array of 9 floats holding the rotation matrix R when this function returns. R can be null.

I: Single[]

is an array of 9 floats holding the rotation matrix I when this function returns. I can be null.

gravity: Single[]

is an array of 3 floats containing the gravity vector expressed in the device's coordinate. You can simply use the android.hardware.SensorEvent#values values returned by a android.hardware.SensorEvent SensorEvent of a android.hardware.Sensor Sensor of type android.hardware.Sensor#TYPE_ACCELEROMETER TYPE_ACCELEROMETER.

geomagnetic: Single[]

is an array of 3 floats containing the geomagnetic vector expressed in the device's coordinate. You can simply use the android.hardware.SensorEvent#values values returned by a android.hardware.SensorEvent SensorEvent of a android.hardware.Sensor Sensor of type android.hardware.Sensor#TYPE_MAGNETIC_FIELD TYPE_MAGNETIC_FIELD.

Returns

Boolean

true on success, false on failure (for instance, if the device is in free fall). Free fall is defined as condition when the magnitude of the gravity is less than 1/10 of the nominal value. On failure the output matrices are not modified.

Attributes: RegisterAttribute

Remarks

<ul> <li>X is defined as the vector product Y.Z (It is tangential to the ground at the device's current location and roughly points East).</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 sky and is perpendicular to the ground.</li> </ul>

<hr>

By definition:

[0 0 g] = R * gravity (g = magnitude of gravity)

[0 m 0] = I * R * geomagnetic (m = magnitude of geomagnetic field)

R is the identity matrix when the device is aligned with the world's coordinate system, that is, when the device's X axis points toward East, the Y axis points to the North Pole and the device is facing the sky.

I is a rotation matrix transforming the geomagnetic vector into the same coordinate space as gravity (the world's coordinate space). I is a simple rotation around the X axis. The inclination angle in radians can be computed with #getInclination. <hr>

Each matrix is returned either as a 3x3 or 4x4 row-major matrix depending on the length of the passed array:

If the array length is 16:

/  M[ 0]   M[ 1]   M[ 2]   M[ 3]  \
              |  M[ 4]   M[ 5]   M[ 6]   M[ 7]  |
              |  M[ 8]   M[ 9]   M[10]   M[11]  |
              \  M[12]   M[13]   M[14]   M[15]  /

This matrix is ready to be used by OpenGL ES's javax.microedition.khronos.opengles.GL10#glLoadMatrixf(float[], int) glLoadMatrixf(float[], int).

Note that because OpenGL matrices are column-major matrices you must transpose the matrix before using it. However, since the matrix is a rotation matrix, its transpose is also its inverse, conveniently, it is often the inverse of the rotation that is needed for rendering; it can therefore be used with OpenGL ES directly.

Also note that the returned matrices always have this form:

/  M[ 0]   M[ 1]   M[ 2]   0  \
              |  M[ 4]   M[ 5]   M[ 6]   0  |
              |  M[ 8]   M[ 9]   M[10]   0  |
              \      0       0       0   1  /

If the array length is 9:

/  M[ 0]   M[ 1]   M[ 2]  \
              |  M[ 3]   M[ 4]   M[ 5]  |
              \  M[ 6]   M[ 7]   M[ 8]  /

<hr>

The inverse of each matrix can be computed easily by taking its transpose.

The matrices returned by this function are meaningful only when the device is not free-falling and it is not close to the magnetic north. If the device is accelerating, or placed into a strong magnetic field, the returned matrices may be inaccurate.

Java documentation for android.hardware.SensorManager.getRotationMatrix(float[], float[], float[], float[]).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to