blob: d2147a6fe1840233169ab427a84538d5e8c3b12b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtSensors module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qorientationsensor.h"
#include "qorientationsensor_p.h"
QT_BEGIN_NAMESPACE
IMPLEMENT_READING(QOrientationReading)
/*!
\class QOrientationReading
\ingroup sensors_reading
\inmodule QtSensors
\since 5.1
\brief 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.
\section2 QOrientationReading Units
The orientation sensor returns the orientation of the device using
the pre-defined values found in the QOrientationReading::Orientation
enum.
*/
/*!
\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.
\image sensors-sides.jpg
The orientations are shown here in order: TopUp, TopDown, LeftUp, RightUp, FaceUp, FaceDown.
\image sensors-orientation.jpg
\value Undefined The orientation is unknown.
\value TopUp The Top edge of the device is pointing up.
\value TopDown The Top edge of the device is pointing down.
\value LeftUp The Left edge of the device is pointing up.
\value RightUp The Right edge of the device is pointing up.
\value FaceUp The Face of the device is pointing up.
\value 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.
*/
/*!
\property QOrientationReading::orientation
\brief the orientation of the device.
The unit is an enumeration describing the orientation of the device.
\sa {QOrientationReading Units}
*/
QOrientationReading::Orientation QOrientationReading::orientation() const
{
return static_cast<QOrientationReading::Orientation>(d->orientation);
}
/*!
Sets the \a orientation for the reading.
*/
void QOrientationReading::setOrientation(QOrientationReading::Orientation orientation)
{
switch (orientation) {
case TopUp:
case TopDown:
case LeftUp:
case RightUp:
case FaceUp:
case FaceDown:
d->orientation = orientation;
break;
default:
d->orientation = Undefined;
break;
}
}
// =====================================================================
/*!
\class QOrientationFilter
\ingroup sensors_filter
\inmodule QtSensors
\since 5.1
\brief The QOrientationFilter class is a convenience wrapper around QSensorFilter.
The only difference is that the filter() method features a pointer to QOrientationReading
instead of QSensorReading.
*/
/*!
\fn QOrientationFilter::filter(QOrientationReading *reading)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
*/
bool QOrientationFilter::filter(QSensorReading *reading)
{
return filter(static_cast<QOrientationReading*>(reading));
}
char const * const QOrientationSensor::type("QOrientationSensor");
/*!
\class QOrientationSensor
\ingroup sensors_type
\inmodule QtSensors
\since 5.1
\brief The QOrientationSensor class is a convenience wrapper around QSensor.
The only behavioural difference is that this class sets the type properly.
This class also features a reading() function that returns a QOrientationReading instead of a QSensorReading.
For details about how the sensor works, see \l QOrientationReading.
\sa QOrientationReading
*/
/*!
Construct the sensor as a child of \a parent.
*/
QOrientationSensor::QOrientationSensor(QObject *parent)
: QSensor(QOrientationSensor::type, parent)
{
}
/*!
Destroy the sensor. Stops the sensor if it has not already been stopped.
*/
QOrientationSensor::~QOrientationSensor()
{
}
/*!
\fn QOrientationSensor::reading() const
Returns the reading class for this sensor.
\sa QSensor::reading()
*/
QOrientationReading *QOrientationSensor::reading() const
{
return static_cast<QOrientationReading*>(QSensor::reading());
}
#include "moc_qorientationsensor.cpp"
QT_END_NAMESPACE
|
