1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtSensors module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #include "qmlorientationsensor.h"
41 #include <QtSensors/QOrientationSensor>
42 
43 /*!
44     \qmltype OrientationSensor
45     \instantiates QmlOrientationSensor
46     \ingroup qml-sensors_type
47     \inqmlmodule QtSensors
48     \since QtSensors 5.0
49     \inherits Sensor
50     \brief The OrientationSensor element reports device orientation.
51 
52     The OrientationSensor element reports device orientation.
53 
54     This element wraps the QOrientationSensor class. Please see the documentation for
55     QOrientationSensor for details.
56 
57     \sa OrientationReading
58 */
59 
QmlOrientationSensor(QObject * parent)60 QmlOrientationSensor::QmlOrientationSensor(QObject *parent)
61     : QmlSensor(parent)
62     , m_sensor(new QOrientationSensor(this))
63 {
64 }
65 
~QmlOrientationSensor()66 QmlOrientationSensor::~QmlOrientationSensor()
67 {
68 }
69 
createReading() const70 QmlSensorReading *QmlOrientationSensor::createReading() const
71 {
72     return new QmlOrientationSensorReading(m_sensor);
73 }
74 
sensor() const75 QSensor *QmlOrientationSensor::sensor() const
76 {
77     return m_sensor;
78 }
79 
80 /*!
81     \qmltype OrientationReading
82     \instantiates QmlOrientationSensorReading
83     \ingroup qml-sensors_reading
84     \inqmlmodule QtSensors
85     \since QtSensors 5.0
86     \inherits SensorReading
87     \brief The OrientationReading element holds the most recent OrientationSensor reading.
88 
89     The OrientationReading element holds the most recent OrientationSensor reading.
90 
91     This element wraps the QOrientationReading class. Please see the documentation for
92     QOrientationReading for details.
93 
94     This element cannot be directly created.
95 */
96 
QmlOrientationSensorReading(QOrientationSensor * sensor)97 QmlOrientationSensorReading::QmlOrientationSensorReading(QOrientationSensor *sensor)
98     : QmlSensorReading(sensor)
99     , m_sensor(sensor)
100 {
101 }
102 
~QmlOrientationSensorReading()103 QmlOrientationSensorReading::~QmlOrientationSensorReading()
104 {
105 }
106 
107 /*!
108     \qmlproperty Orientation OrientationReading::orientation
109     This property holds the orientation of the device.
110 
111     Please see QOrientationReading::orientation for information about this property.
112 
113     Note that Orientation constants are exposed through the OrientationReading class.
114     \code
115         OrientationSensor {
116             onReadingChanged: {
117                 if (reading.orientation == OrientationReading.TopUp)
118                     // do something
119             }
120         }
121     \endcode
122 */
123 
orientation() const124 QOrientationReading::Orientation QmlOrientationSensorReading::orientation() const
125 {
126     return m_orientation;
127 }
128 
reading() const129 QSensorReading *QmlOrientationSensorReading::reading() const
130 {
131     return m_sensor->reading();
132 }
133 
readingUpdate()134 void QmlOrientationSensorReading::readingUpdate()
135 {
136     QOrientationReading::Orientation o = m_sensor->reading()->orientation();
137     if (m_orientation != o) {
138         m_orientation = o;
139         Q_EMIT orientationChanged();
140     }
141 }
142