summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Olav Tvete <paul.tvete@digia.com>2013-08-06 14:40:40 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-09-03 10:30:15 +0200
commitd9776fc6aa8e90926fa024bb64c4e31406d1d091 (patch)
treed358729b4651e351f98b508c89ac766de135d7c8
parent4e0ed94eb1281bfeafd377ebc39e84562fbd1f23 (diff)
downloadqtsensors-d9776fc6aa8e90926fa024bb64c4e31406d1d091.tar.gz
qtsensors-d9776fc6aa8e90926fa024bb64c4e31406d1d091.tar.bz2
qtsensors-d9776fc6aa8e90926fa024bb64c4e31406d1d091.zip
Define the sensor coordinate system unambiguously
All illustrations in the documentation show devices with phone form factors, i.e. portrait orientation. Some tablets have a native landscape orientation. It is not clear from the documentation if the sensor coordinate system should be relative to the portrait orientation or the native orientation. This change defines the native orientation as the canonical orientation. Task-number: QTBUG-32144 Change-Id: I870cb3c9b5aec04f2ed8394a4407b53b888e82c3 Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>
-rw-r--r--src/sensors/doc/src/qtsensors-cpp.qdoc4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/sensors/doc/src/qtsensors-cpp.qdoc b/src/sensors/doc/src/qtsensors-cpp.qdoc
index 2f60592..5157dda 100644
--- a/src/sensors/doc/src/qtsensors-cpp.qdoc
+++ b/src/sensors/doc/src/qtsensors-cpp.qdoc
@@ -56,7 +56,9 @@ Where rotation around an axis is used, the rotation shall be expressed as a Righ
\image sensors-coordinates3.jpg
-In general, sensor data is oriented to the top of the device. If values are to be displayed on
+In general, sensor data is oriented relative to \l QPlatformScreen::nativeOrientation, i.e
+to the top of the device when the device is held in its natural orientation (normally
+when the device logo appears the right side up). If values are to be displayed on
the screen the values may need to be transformed so that they match the user interface orientation. A sensor
may define its data as being oriented to the UI. This will be noted in the documentation for the
sensor.