Create a new sensor type for distance.

Create a new sensor type for distance. This sensor type supports new hardware sensors
that can measure physical distance from the device, in centimeters. The API is designed
to mimic the Android API for proximity (TYPE_PROXIMITY), so that if a given proximity
sensor only supports a binary measurement (near vs far), then instead of reporting distance
in cm, the QDistanceSensor will return the max range value to represent far, and a lesser
value to represent close. Using this definition should simplify implementation.

The main reason for not implementing this as a new property of QProximitySensor is that
clients of QProximitySensor have made the assumption that they will receive the readingReady
signal if and only if the reading has changed from near to far or vice versa. Adding a
distance property will break that assumption, as distance has a higher degree of precision.

Change-Id: Ia804948c78ff7391fc8b78df975cddcf861326dc
Reviewed-by: Fabian Bumberger <fbumberger@rim.com>
Reviewed-by: Bernd Weimer <bweimer@blackberry.com>
Reviewed-by: Lorn Potter <lorn.potter@jollamobile.com>

1 files changed, 77 insertions, 0 deletions

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