QOrientationReading Class

The QOrientationReading class represents one reading from the orientation sensor. More...

Header: #include <QOrientationReading>
qmake: QT += sensors
Since: Qt 5.1
Inherits: QSensorReading

Public Types

enum Orientation { Undefined, TopUp, TopDown, LeftUp, ..., FaceDown }

Properties

Public Functions

QOrientationReading(QObject *parent = DECLARE_READING(QOrientationReading))
virtual ~QOrientationReading()
QOrientationReading::Orientation orientation() const
void setOrientation(QOrientationReading::Orientation orientation)

Reimplemented Public Functions

virtual void copyValuesFrom(QSensorReading *other) override

Additional Inherited Members

  • 1 public slot inherited from QObject
  • 2 signals inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QOrientationReading class represents one reading from the orientation sensor.

The orientation sensor reports the orientation of the device. As it operates below the UI level it does not report on or even know how the UI is rotated. Most importantly this means that this sensor cannot be used to detect if a device is in portrait or landscape mode.

This sensor is useful to detect that a particular side of the device is pointing up.

QOrientationReading Units

The orientation sensor returns the orientation of the device using the pre-defined values found in the QOrientationReading::Orientation enum.

Member Type Documentation

enum QOrientationReading::Orientation

This enum represents the orientation of the device.

To explain the meaning of each value it is helpful to refer to the following diagram.

The orientations are shown here in order: TopUp, TopDown, LeftUp, RightUp, FaceUp, FaceDown.

ConstantValueDescription
QOrientationReading::Undefined0The orientation is unknown.
QOrientationReading::TopUp1The Top edge of the device is pointing up.
QOrientationReading::TopDown2The Top edge of the device is pointing down.
QOrientationReading::LeftUp3The Left edge of the device is pointing up.
QOrientationReading::RightUp4The Right edge of the device is pointing up.
QOrientationReading::FaceUp5The Face of the device is pointing up.
QOrientationReading::FaceDown6The Face of the device is pointing down.

It should be noted that the orientation sensor reports the orientation of the device and not the UI. The orientation of the device will not change just because the UI is rotated. This means this sensor cannot be used to detect if a device is in portrait or landscape mode.

Property Documentation

orientation : const Orientation

This property holds the orientation of the device.

The unit is an enumeration describing the orientation of the device.

Access functions:

QOrientationReading::Orientation orientation() const

See also QOrientationReading Units.

Member Function Documentation

QOrientationReading::QOrientationReading(QObject *parent = DECLARE_READING(QOrientationReading))

Default constructs an instance of QOrientationReading.

[virtual] QOrientationReading::~QOrientationReading()

Destroys the instance of QOrientationReading. The destructor is virtual.

[override virtual] void QOrientationReading::copyValuesFrom(QSensorReading *other)

void QOrientationReading::setOrientation(QOrientationReading::Orientation orientation)

Sets the orientation for the reading.

See also orientation().

© 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.