Murl Engine Lua Addon API  Version 1.0 beta
Murl.Input.IHeadingDevice

The IHeadingDevice interface.

To receive data the device must be activated by IAppConfiguration::SetHeadingActive().


Table members

Inherited


Murl.Input.IDevice

Methods


GetMagneticFieldX()

Get the geomagnetic field for the x-axis in microteslas.

Number GetMagneticFieldX()

Returns
Number The geomagnetic field for the x-axis in microteslas.

GetMagneticFieldY()

Get the geomagnetic field for the y-axis in microteslas.

Number GetMagneticFieldY()

Returns
Number The geomagnetic field for the y-axis in microteslas.

GetMagneticFieldZ()

Get the geomagnetic field for the z-axis in microteslas.

Number GetMagneticFieldZ()

Returns
Number The geomagnetic field for the z-axis in microteslas.

GetMagneticField()

Get the geomagnetic field axes in microteslas.

Murl.Math.Vector GetMagneticField()

Returns
Murl.Math.Vector The geomagnetic field axes in microteslas.

GetMagneticAngle()

Get the angle relative to the magnetic north in degrees. The value 0 means the device is pointed toward magnetic north, 90 means it is pointed east, 180 means it is pointed south, and so on.

Number GetMagneticAngle()

Returns
Number The angle relative to the magnetic north in degrees.

GetTrueAngle()

Get the angle relative to the true north in degrees. The value 0 means the device is pointed toward true north, 90 means it is pointed east, 180 means it is pointed south, and so on.

Number GetTrueAngle()

Returns
Number The angle relative to the true north in degrees.

GetRawMagneticField()

Get the raw geomagnetic field axes in microteslas. This method is useful to evaluate the absolute device orientation. All other methods reports the values relative to the current screen axis orientation.

Murl.Math.Vector GetRawMagneticField()

Returns
Murl.Math.Vector The geomagnetic field axes in microteslas.

GetRawMagneticAngle()

Get the raw angle relative to the magnetic north in degrees. The value 0 means the device is pointed toward magnetic north, 90 means it is pointed east, 180 means it is pointed south, and so on.

This method is useful to evaluate the absolute device orientation. All other methods reports the values relative to the current screen axis orientation.

Number GetRawMagneticAngle()

Returns
Number The angle relative to the magnetic north in degrees.

GetRawTrueAngle()

Get the raw angle relative to the true north in degrees. The value 0 means the device is pointed toward true north, 90 means it is pointed east, 180 means it is pointed south, and so on.

This method is useful to evaluate the absolute device orientation. All other methods reports the values relative to the current screen axis orientation.

Number GetRawTrueAngle()

Returns
Number The angle relative to the true north in degrees.