summaryrefslogtreecommitdiffstats
path: root/src/sensors
diff options
context:
space:
mode:
authorPaul Olav Tvete <paul.tvete@digia.com>2014-08-11 12:41:02 +0200
committerPaul Olav Tvete <paul.tvete@digia.com>2014-08-12 09:24:28 +0200
commit825ae95d8984a3daa49ad81a91e85483918799af (patch)
tree8d05520e172b155a977d072a1a875b4ec29707d3 /src/sensors
parent67dc29a96cf78ee4f4f2bfc42bfdde458138cd31 (diff)
Clarify the QCompass coordinate system
The compass behaves like the other sensors: it is measured relative to the top of the device. Change-Id: Iddc4ad6a16f8b09d26a9d300155324bb8d378b76 Reviewed-by: Alex Blasche <alexander.blasche@digia.com> Reviewed-by: Lorn Potter <lorn.potter@jollamobile.com>
Diffstat (limited to 'src/sensors')
-rw-r--r--src/sensors/qcompass.cpp5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/sensors/qcompass.cpp b/src/sensors/qcompass.cpp
index 8bfca073..6564d362 100644
--- a/src/sensors/qcompass.cpp
+++ b/src/sensors/qcompass.cpp
@@ -56,7 +56,8 @@ IMPLEMENT_READING(QCompassReading)
\section2 QCompassReading Units
The compass returns the azimuth of the device as degrees from
- magnetic north in a clockwise direction based on the top of the UI.
+ magnetic north in a clockwise direction based on the top of the device,
+ as defined by QPlatformScreen::nativeOrientation.
There is also a value to indicate the calibration status of the device.
If the device is not calibrated the azimuth may not be accurate.
@@ -75,7 +76,7 @@ IMPLEMENT_READING(QCompassReading)
\brief the azimuth of the device.
Measured in degrees from magnetic north in a clockwise direction based
- the top of the UI.
+ the top of the device, as defined by QPlatformScreen::nativeOrientation.
\sa {QCompassReading Units}
*/