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 "qlightsensor.h"
41#include "qlightsensor_p.h"
42
43QT_BEGIN_NAMESPACE
44
45IMPLEMENT_READING(QLightReading)
46
47/*!
48 \class QLightReading
49 \ingroup sensors_reading
50 \inmodule QtSensors
51 \since 5.1
52
53 \brief The QLightReading class represents one reading from the
54 light sensor.
55
56 \section2 QLightReading Units
57 The light sensor returns the intensity of the light in lux.
58*/
59
60/*!
61 \property QLightReading::lux
62 \brief the light level.
63
64 Measured as lux.
65 \sa {QLightReading Units}
66*/
67
68qreal QLightReading::lux() const
69{
70 return d->lux;
71}
72
73/*!
74 Sets the light level to \a lux.
75*/
76void QLightReading::setLux(qreal lux)
77{
78 d->lux = lux;
79}
80
81// =====================================================================
82
83/*!
84 \class QLightFilter
85 \ingroup sensors_filter
86 \inmodule QtSensors
87 \since 5.1
88
89 \brief The QLightFilter class is a convenience wrapper around QSensorFilter.
90
91 The only difference is that the filter() method features a pointer to QLightReading
92 instead of QSensorReading.
93*/
94
95/*!
96 \fn QLightFilter::filter(QLightReading *reading)
97
98 Called when \a reading changes. Returns false to prevent the reading from propagating.
99
100 \sa QSensorFilter::filter()
101*/
102
103bool QLightFilter::filter(QSensorReading *reading)
104{
105 return filter(reading: static_cast<QLightReading*>(reading));
106}
107
108char const * const QLightSensor::type("QLightSensor");
109
110/*!
111 \class QLightSensor
112 \ingroup sensors_type
113 \inmodule QtSensors
114 \since 5.1
115
116 \brief The QLightSensor class is a convenience wrapper around QSensor.
117
118 The only behavioural difference is that this class sets the type properly.
119
120 This class also features a reading() function that returns a QLightReading instead of a QSensorReading.
121
122 For details about how the sensor works, see \l QLightReading.
123
124 \sa QLightReading
125*/
126
127/*!
128 Construct the sensor as a child of \a parent.
129*/
130QLightSensor::QLightSensor(QObject *parent)
131 : QSensor(QLightSensor::type, *new QLightSensorPrivate, parent)
132{
133}
134
135/*!
136 Destroy the sensor. Stops the sensor if it has not already been stopped.
137*/
138QLightSensor::~QLightSensor()
139{
140}
141
142/*!
143 \fn QLightSensor::reading() const
144
145 Returns the reading class for this sensor.
146
147 \sa QSensor::reading()
148*/
149
150QLightReading *QLightSensor::reading() const
151{
152 return static_cast<QLightReading*>(QSensor::reading());
153}
154
155/*!
156 \property QLightSensor::fieldOfView
157 \brief a value indicating the field of view.
158
159 This is an angle that represents the field of view of the sensor.
160
161 Not all light sensor support retrieving their field of view. For sensors
162 that don't support this property, the value will be 0. Whether the field of
163 view is supported can be checked with QSensor::isFeatureSupported() and the
164 QSensor::FieldOfView flag.
165*/
166
167qreal QLightSensor::fieldOfView() const
168{
169 Q_D(const QLightSensor);
170 return d->fieldOfView;
171}
172
173/*!
174 \since 5.1
175
176 Sets the field of view to \a fieldOfView. This is to be called from the
177 backend.
178*/
179void QLightSensor::setFieldOfView(qreal fieldOfView)
180{
181 Q_D(QLightSensor);
182 if (d->fieldOfView != fieldOfView) {
183 d->fieldOfView = fieldOfView;
184 emit fieldOfViewChanged(fieldOfView);
185 }
186}
187
188QT_END_NAMESPACE
189
190#include "moc_qlightsensor.cpp"
191

source code of qtsensors/src/sensors/qlightsensor.cpp