class QOrientationReading

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

Inheritance diagram of PySide6.QtSensors.QOrientationReading

Synopsis

Properties

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

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 Orientation enum.

class 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.

../../_images/sensors-sides.jpg

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

../../_images/sensors-orientation.jpg

Constant

Description

QOrientationReading.Undefined

The orientation is unknown.

QOrientationReading.TopUp

The Top edge of the device is pointing up.

QOrientationReading.TopDown

The Top edge of the device is pointing down.

QOrientationReading.LeftUp

The Left edge of the device is pointing up.

QOrientationReading.RightUp

The Right edge of the device is pointing up.

QOrientationReading.FaceUp

The Face of the device is pointing up.

QOrientationReading.FaceDown

The 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.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property orientationᅟ: QOrientationReading.Orientation

This property holds the orientation of the device..

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

See also

QOrientationReading Units

Access functions:
__init__(parent)
Parameters:

parentQObject

orientation()
Return type:

Orientation

See also

setOrientation()

Getter of property orientationᅟ .

setOrientation(orientation)
Parameters:

orientationOrientation

Sets the orientation for the reading.

See also

orientation()