Murl::Input::IHeadingDevice Interface Reference

The IHeadingDevice interface. More...

#include "murl_input_i_heading_device.h"

Inheritance diagram for Murl::Input::IHeadingDevice:

Public Member Functions
virtual Double	GetMagneticFieldX () const =0
	Get the geomagnetic field for the x-axis in microteslas. More...
virtual Double	GetMagneticFieldY () const =0
	Get the geomagnetic field for the y-axis in microteslas. More...
virtual Double	GetMagneticFieldZ () const =0
	Get the geomagnetic field for the z-axis in microteslas. More...
virtual MagneticFieldVector	GetMagneticField () const =0
	Get the geomagnetic field axes in microteslas. More...
virtual Double	GetMagneticAngle () const =0
	Get the angle relative to the magnetic north in degrees. More...
virtual Double	GetTrueAngle () const =0
	Get the angle relative to the true north in degrees. More...
virtual MagneticFieldVector	GetRawMagneticField () const =0
	Get the raw geomagnetic field axes in microteslas. More...
virtual Double	GetRawMagneticAngle () const =0
	Get the raw angle relative to the magnetic north in degrees. More...
virtual Double	GetRawTrueAngle () const =0
	Get the raw angle relative to the true north in degrees. More...
Public Member Functions inherited from Murl::Input::IDevice
virtual const String &	GetName () const =0
	Get the device name. More...
virtual UInt32	GetId () const =0
	Get the unique device identifier. More...
virtual Bool	HasUpdate () const =0
	Check if the device has received new data since the last Update(). More...
virtual void	LogicUpdate ()=0
	Is executed in the logic thread context each logic tick.
virtual void	ConfigChanged (const IAppConfiguration *appConfig)=0
	Notification of changed configuration. More...

Detailed Description

The IHeadingDevice interface.

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

Member Function Documentation

GetMagneticFieldX()

virtual Double Murl::Input::IHeadingDevice::GetMagneticFieldX ( ) const

pure virtual

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

Returns

The geomagnetic field for the x-axis in microteslas.

GetMagneticFieldY()

virtual Double Murl::Input::IHeadingDevice::GetMagneticFieldY ( ) const

pure virtual

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

Returns

The geomagnetic field for the y-axis in microteslas.

GetMagneticFieldZ()

virtual Double Murl::Input::IHeadingDevice::GetMagneticFieldZ ( ) const

pure virtual

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

Returns

The geomagnetic field for the z-axis in microteslas.

GetMagneticField()

virtual MagneticFieldVector Murl::Input::IHeadingDevice::GetMagneticField ( ) const

pure virtual

Get the geomagnetic field axes in microteslas.

Returns

The geomagnetic field axes in microteslas.

GetMagneticAngle()

virtual Double Murl::Input::IHeadingDevice::GetMagneticAngle ( ) const

pure virtual

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.

Returns

The angle relative to the magnetic north in degrees.

GetTrueAngle()

virtual Double Murl::Input::IHeadingDevice::GetTrueAngle ( ) const

pure virtual

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.

Returns

The angle relative to the true north in degrees.

GetRawMagneticField()

virtual MagneticFieldVector Murl::Input::IHeadingDevice::GetRawMagneticField ( ) const

pure virtual

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.

Returns

The geomagnetic field axes in microteslas.

GetRawMagneticAngle()

virtual Double Murl::Input::IHeadingDevice::GetRawMagneticAngle ( ) const

pure virtual

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.

Returns

The angle relative to the magnetic north in degrees.

GetRawTrueAngle()

virtual Double Murl::Input::IHeadingDevice::GetRawTrueAngle ( ) const

pure virtual

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.

Returns

The angle relative to the true north in degrees.

---

The documentation for this interface was generated from the following file:

• murl_input_i_heading_device.h