Murl::IHeading Interface Referenceabstract

The heading device interface. More...

#include "murl_i_heading.h"

Inherited by Murl::Input::HeadingDevice.

Public Member Functions

virtual void PostEvent (Double fieldX, Double fieldY, Double fieldZ, Double magneticAngle, Double trueAngle)=0
 Post the current geomagnetic data. More...
 

Detailed Description

The heading device interface.

Used by the platform to post events to the device.

Member Function Documentation

◆ PostEvent()

virtual void Murl::IHeading::PostEvent ( Double  fieldX,
Double  fieldY,
Double  fieldZ,
Double  magneticAngle,
Double  trueAngle 
)
pure virtual

Post the current geomagnetic data.

Parameters
fieldXThe geomagnetic data for the x-axis in microteslas.
fieldYThe geomagnetic data for the y-axis in microteslas.
fieldZThe geomagnetic data for the z-axis in microteslas.
magneticAngleThe 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 south, and 270 west.
trueAngleThe 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 south, and 270 west.

The documentation for this interface was generated from the following file:
  • murl_i_heading.h


Copyright © 2011-2024 Spraylight GmbH.