The AbsoluteOrientationSensor
interface of the Sensor APIs describes the device's physical orientation in relation to the Earth's reference coordinate system.
To use this sensor, the user must grant permission to the 'accelerometer'
, 'gyroscope'
, and 'magnetometer'
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
AbsoluteOrientationSensor.AbsoluteOrientationSensor()
- Creates a new
AbsoluteOrientationSensor
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 AbsoluteOrientationSensor
with a frequency of 60 times a second. On each reading it uses OrientationSensor.quaternion
to rotate a visual model of a phone.
const options = { frequency: 60, referenceFrame: 'device' }; const sensor = new AbsoluteOrientationSensor(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 requesting permissions for multiple device sensors. Because the Permissions
uses promises, a good way to request permissions is to use Promise.all
.
const sensor = new AbsoluteOrientationSensor(); Promise.all([navigator.permissions.query({ name: "accelerometer" }), navigator.permissions.query({ name: "magnetometer" }), navigator.permissions.query({ name: "gyroscope" })]) .then(results => { if (results.every(result => result.state === "granted")) { sensor.start(); ... } else { console.log("No permissions to use AbsoluteOrientationSensor."); } });
Specifications
Specification | Status | Comment |
---|---|---|
Generic Sensor API | Candidate Recommendation | Defines sensors in general. |
Orientation Sensor The definition of 'AbsoluteOrientationSensor' in that specification. |
Candidate Recommendation |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
AbsoluteOrientationSensor | Chrome Full support 69 | Edge Full support ≤79 | Firefox No support No | IE No support No | Opera Full support 56 | Safari No support No | WebView Android Full support 69 | Chrome Android Full support 69 | Firefox Android ? | Opera Android Full support 48 | Safari iOS ? | Samsung Internet Android Full support 10.0 |
AbsoluteOrientationSensor() constructor | Chrome Full support 69 | Edge Full support ≤79 | Firefox No support No | IE No support No | Opera Full support 56 | Safari No support No | WebView Android Full support 69 | Chrome Android Full support 69 | Firefox Android ? | Opera Android Full support 48 | Safari iOS ? | Samsung Internet Android Full support 10.0 |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown