RelativeOrientationSensor

The RelativeOrientationSensor interface of the Sensor APIs describes the device's physical orientation without regard to the Earth's reference coordinate system.

To use this sensor, the user must grant permission to the 'accelerometer', and 'gyroscope' device sensors through the Permissions API.

If a feature policy blocks use of a feature it is because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. See Feature-Policy for implementation instructions.

Constructor

RelativeOrientationSensor.RelativeOrientationSensor()
Creates a new RelativeOrientationSensor object.

Properties

No specific properties; inherits methods from its ancestors OrientationSensor and Sensor.

Event handlers

No specific event handlers; inherits methods from its ancestor, Sensor.

Methods

No specific methods; inherits methods from its ancestors OrientationSensor and Sensor.

Examples

Basic Example

The following example, which is loosely based on Intel's Orientation Phone demo,  instantiates an RelativeOrientationSensor with a frequency of 60 times a second.

Note that the Intel demo this is based on uses the AbsoluteOreintationSensor. On each reading it uses OrientationSensor.quaternion to rotate a visual model of a phone.

const options = { frequency: 60, referenceFrame: 'device' };
const sensor = new RelativeOrientationSensor(options);

sensor.addEventListener('reading', () => {
  // model is a Three.js object instantiated elsewhere.
  model.quaternion.fromArray(sensor.quaternion).inverse();
});
sensor.addEventListener('error', error => {
  if (event.error.name == 'NotReadableError') {
    console.log("Sensor is not available.");
  }
});
sensor.start();

Permissions Example

Using orientation sensors requires requsting permissions for multiple device sensors. Becuase the Permissions uses promises, a good way to request permissions is to use Promise.all.

const sensor = new RelativeOrientationSensor();
Promise.all([navigator.permissions.query({ name: "accelerometer" }),
             navigator.permissions.query({ name: "gyroscope" })])
       .then(results => {
         if (results.every(result => result.state === "granted")) {
           sensor.start();
           ...
         } else {
           console.log("No permissions to use RelativeOrientationSensor.");
         }
   });

Specifications

Specification
Orientation Sensor
# relativeorientationsensor-interface

Browser compatibility

BCD tables only load in the browser