summaryrefslogtreecommitdiffstats
path: root/src/sensors
diff options
context:
space:
mode:
Diffstat (limited to 'src/sensors')
-rw-r--r--src/sensors/doc/src/compatmap.qdoc11
-rw-r--r--src/sensors/qdistancesensor.cpp164
-rw-r--r--src/sensors/qdistancesensor.h84
-rw-r--r--src/sensors/qdistancesensor_p.h77
-rw-r--r--src/sensors/sensors.pro5
5 files changed, 339 insertions, 2 deletions
diff --git a/src/sensors/doc/src/compatmap.qdoc b/src/sensors/doc/src/compatmap.qdoc
index 622069bb..db9d66ca 100644
--- a/src/sensors/doc/src/compatmap.qdoc
+++ b/src/sensors/doc/src/compatmap.qdoc
@@ -118,6 +118,17 @@
<td bgcolor="green"></td>
</tr>
<tr>
+ <td nowrap="nowrap">Distance</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
<td nowrap="nowrap">Gyroscope</td>
<td bgcolor="green"></td>
<td bgcolor="green"></td>
diff --git a/src/sensors/qdistancesensor.cpp b/src/sensors/qdistancesensor.cpp
new file mode 100644
index 00000000..3cec9ca9
--- /dev/null
+++ b/src/sensors/qdistancesensor.cpp
@@ -0,0 +1,164 @@
+ /****************************************************************************
+ **
+ ** Copyright (C) 2014 BlackBerry Limited. All rights reserved.
+ ** Contact: http://www.qt-project.org/legal
+ **
+ ** 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 Digia. For licensing terms and
+ ** conditions see http://qt.digia.com/licensing. For further information
+ ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
+ ** Foundation and appearing in the file LICENSE.LGPL included in the
+ ** packaging of this file. Please review the following information to
+ ** ensure the GNU Lesser General Public License version 2.1 requirements
+ ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+ **
+ ** In addition, as a special exception, Digia gives you certain additional
+ ** rights. These rights are described in the Digia Qt LGPL Exception
+ ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+ **
+ ** GNU General Public License Usage
+ ** Alternatively, this file may be used under the terms of the GNU
+ ** General Public License version 3.0 as published by the Free Software
+ ** Foundation and appearing in the file LICENSE.GPL included in the
+ ** packaging of this file. Please review the following information to
+ ** ensure the GNU General Public License version 3.0 requirements will be
+ ** met: http://www.gnu.org/copyleft/gpl.html.
+ **
+ **
+ ** $QT_END_LICENSE$
+ **
+ ****************************************************************************/
+
+#include <qdistancesensor.h>
+#include "qdistancesensor_p.h"
+
+QT_BEGIN_NAMESPACE
+
+IMPLEMENT_READING(QDistanceReading)
+
+/*!
+ \class QDistanceReading
+ \ingroup sensors_reading
+ \inmodule QtSensors
+ \since 5.4
+
+ \brief The QDistanceReading class holds distance reading in cm from the proximity sensor.
+
+ The QDistanceReading class holds distance reading in cm from the proximity sensor.
+ Note: Some proximity sensor only support two values for distance, a near and far value.
+ In this case, the sensor should report its maximum range value to represent the far state,
+ and a lesser value to represent the near state.
+
+ \section2 QDistanceReading Units
+ The distance is measured in cm
+
+ The distance sensor is typically located in the front face of a device, and thus will
+ measure the distance of an object from the device's front face.
+*/
+
+/*!
+ \property QDistanceReading::distance
+ \brief distance of object from front face of device
+
+ \sa {QDistanceReading Units}
+*/
+
+qreal QDistanceReading::distance() const
+{
+ return d->distance;
+}
+
+/*!
+ Sets distance to \a distance.
+*/
+void QDistanceReading::setDistance(qreal distance)
+{
+ d->distance = distance;
+}
+
+// =====================================================================
+
+/*!
+ \class QDistanceFilter
+ \ingroup sensors_filter
+ \inmodule QtSensors
+ \since 5.4
+
+ \brief The QDistanceFilter class is a convenience wrapper around QSensorFilter.
+
+ The only difference is that the filter() method features a pointer to QDistanceReading
+ instead of QSensorReading.
+*/
+
+/*!
+ \fn QDistanceFilter::filter(QDistanceReading *reading)
+
+ Called when \a reading changes. Returns false to prevent the reading from propagating.
+
+ \sa QSensorFilter::filter()
+*/
+
+bool QDistanceFilter::filter(QSensorReading *reading)
+{
+ return filter(static_cast<QDistanceReading*>(reading));
+}
+
+char const * const QDistanceSensor::type("QDistanceSensor");
+
+/*!
+ \class QDistanceSensor
+ \ingroup sensors_type
+ \inmodule QtSensors
+ \since 5.4
+
+ \brief The QDistanceSensor class is a convenience wrapper around QSensor.
+
+ The only behavioral difference is that this class sets the type properly.
+
+ This class also features a reading() function that returns a QDistanceReading instead of a QSensorReading.
+
+ For details about how the sensor works, see \l QDistanceReading.
+
+ \sa QDistanceReading
+*/
+
+/*!
+ Construct the sensor as a child of \a parent.
+*/
+QDistanceSensor::QDistanceSensor(QObject *parent)
+ : QSensor(QDistanceSensor::type, parent)
+{
+}
+
+/*!
+ Destroy the sensor. Stops the sensor if it has not already been stopped.
+*/
+QDistanceSensor::~QDistanceSensor()
+{
+}
+
+/*!
+ \fn QDistanceSensor::reading() const
+
+ Returns the reading class for this sensor.
+
+ \sa QSensor::reading()
+*/
+
+QDistanceReading *QDistanceSensor::reading() const
+{
+ return static_cast<QDistanceReading*>(QSensor::reading());
+}
+
+#include "moc_qdistancesensor.cpp"
+QT_END_NAMESPACE
diff --git a/src/sensors/qdistancesensor.h b/src/sensors/qdistancesensor.h
new file mode 100644
index 00000000..0014d6fb
--- /dev/null
+++ b/src/sensors/qdistancesensor.h
@@ -0,0 +1,84 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 BlackBerry Limited. All rights reserved.
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QDISTANCESENSOR_H
+#define QDISTANCESENSOR_H
+
+#include <QtSensors/qsensor.h>
+
+QT_BEGIN_NAMESPACE
+
+class QDistanceReadingPrivate;
+
+class Q_SENSORS_EXPORT QDistanceReading : public QSensorReading
+{
+ Q_OBJECT
+ Q_PROPERTY(qreal distance READ distance)
+ DECLARE_READING(QDistanceReading)
+public:
+ qreal distance() const;
+ void setDistance(qreal distance);
+};
+
+class Q_SENSORS_EXPORT QDistanceFilter : public QSensorFilter
+{
+public:
+ virtual bool filter(QDistanceReading *reading) = 0;
+private:
+ bool filter(QSensorReading *reading) Q_DECL_OVERRIDE;
+};
+
+class Q_SENSORS_EXPORT QDistanceSensor : public QSensor
+{
+ Q_OBJECT
+public:
+ explicit QDistanceSensor(QObject *parent = 0);
+ ~QDistanceSensor();
+ QDistanceReading *reading() const;
+ static char const * const type;
+
+private:
+ Q_DISABLE_COPY(QDistanceSensor)
+};
+
+QT_END_NAMESPACE
+
+#endif
diff --git a/src/sensors/qdistancesensor_p.h b/src/sensors/qdistancesensor_p.h
new file mode 100644
index 00000000..2bbb8955
--- /dev/null
+++ b/src/sensors/qdistancesensor_p.h
@@ -0,0 +1,77 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 BlackBerry Limited. All rights reserved.
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QDISTANCESENSOR_P_H
+#define QDISTANCESENSOR_P_H
+
+//
+// W A R N I N G
+// -------------
+//
+// This file is not part of the Qt API. It exists purely as an
+// implementation detail. This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+QT_BEGIN_NAMESPACE
+
+class QDistanceReadingPrivate
+{
+public:
+ QDistanceReadingPrivate()
+ : distance(0.0)
+ {
+ }
+
+ /*
+ * Note that this class is copied so you may need to implement
+ * a copy constructor if you have complex types or pointers
+ * as values.
+ */
+
+ qreal distance;
+};
+
+QT_END_NAMESPACE
+
+#endif
diff --git a/src/sensors/sensors.pro b/src/sensors/sensors.pro
index e7ad05f5..5ca3325a 100644
--- a/src/sensors/sensors.pro
+++ b/src/sensors/sensors.pro
@@ -35,7 +35,7 @@ PRIVATE_HEADERS += \
SOURCES += qsensorbackend.cpp\
qsensormanager.cpp\
- qsensorplugin.cpp\
+ qsensorplugin.cpp
SOURCES += \
gestures/qsensorgesture.cpp \
@@ -65,6 +65,7 @@ SENSORS=\
qambientlightsensor\
qambienttemperaturesensor\
qcompass\
+ qdistancesensor\
qholstersensor\
qlightsensor\
qmagnetometer\
@@ -75,7 +76,7 @@ SENSORS=\
qtapsensor\
qtiltsensor\
qgyroscope\
- qpressuresensor\
+ qpressuresensor
for(s,SENSORS) {
# Client API