import Orientation from '@mobilizing/library/js/Mobilizing/input/Orientation.js'

public class |source

Orientation

Extends:

Component → Orientation

Uses built-in compass and/or gyroscope to produce orientation Data. Some heplers functions are in there to generate quarternion that can be applied on a camera or a 3D object's transform. !WARNING! On iOS 13+ you must call on() in a user interaction (i.e "click" or equivalent). See examples!

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	available: * true if the magnetometer/compass is available on the device, false otherwise
public	compass: Object The compass/gyro current raw values.
public	rotationMatrix: *[]

Private Members
private	_baseHeading: number

Method Summary

Public Methods
public	getRotationMatrix(alpha: Number, beta: Number, gamma: Number): undefined[] ©https://www.w3.org/TR/orientation-event/
public	off()
public	on()
public	resetDirection() Reset the horizontal rotation to make a kind of realtime recalibration of the rotation
public	setup()

Private Methods
private	onCompassCalibration(event: Object) compass calibration event callback
private	onDeviceOrientation(event: Object) callback used to access compass event.

Inherited Summary

From class Component
public	active: boolean
public	context: *
public	events: *
public	id: *
public	name: *
private	_nexts: *[]
private	_setupDone: boolean
public	byPass()
public	chain(component: Component) Adds a component to this chained component array
public	getChainedComponents(): Array Returns the array of attached children components
public	off() Deactivate the component
public	on() Activate the component A call to this method calls the setup method if it has not been run yet
public	postUpdate() Run code after the update of all components is run This empty method is usually overriden to perform post-update actions for the component It is called periodically by an internal Mobilizing mechanism
public	preLoad() preLoad the component This empty method is usually overriden to perform preLoad actions for the component.
public	preUpdate() Run code before the update of all components is run This empty method is usually overriden to perform pre-update actions for the component It is called once per component by an internal Mobilizing mechanism
public	prepare() prepare the component This empty method is usually overriden to perform preparation actions for the component, from external process as a server.
public	setup() Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly
public	update() Update the component This empty method is usually overriden to perform update actions for the component It is called periodically by an internal Mobilizing mechanism

Public Constructors

public constructor() source

Override:

Component#constructor

Public Members

public available: * source

true if the magnetometer/compass is available on the device, false otherwise

public compass: Object source

The compass/gyro current raw values. This can also be get with the onDeviceOrientation event from the user script.

Properties:

Name	Type	Attribute	Description
alpha	*
gamma	*
beta	*
heading	*

public rotationMatrix: *[] source

Private Members

private _baseHeading: number source

Public Methods

public getRotationMatrix(alpha: Number, beta: Number, gamma: Number): undefined[] source

©https://www.w3.org/TR/orientation-event/

Params:

Name	Type	Attribute	Description
alpha	Number
beta	Number
gamma	Number

Return:

undefined[]

public off() source

Deactivate the component

Override:

Component#off

public on() source

Activate the component A call to this method calls the setup method if it has not been run yet

Override:

Component#on

public resetDirection() source

Reset the horizontal rotation to make a kind of realtime recalibration of the rotation

public setup() source

Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly

Override:

Component#setup

Private Methods

private onCompassCalibration(event: Object) source

compass calibration event callback

Params:

Name	Type	Attribute	Description
event	Object

private onDeviceOrientation(event: Object) source

callback used to access compass event.

Params:

Name	Type	Attribute	Description
event	Object