diff options
Diffstat (limited to 'src/sensors/qtiltsensor.cpp')
-rw-r--r-- | src/sensors/qtiltsensor.cpp | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/src/sensors/qtiltsensor.cpp b/src/sensors/qtiltsensor.cpp new file mode 100644 index 00000000..b78746bc --- /dev/null +++ b/src/sensors/qtiltsensor.cpp @@ -0,0 +1,175 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** 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 "qtiltsensor.h" +#include "qtiltsensor_p.h" + +#include "qsensorbackend.h" + +#include <QtCore/QMetaObject> + +QT_BEGIN_NAMESPACE + +IMPLEMENT_READING(QTiltReading) + +/*! + \class QTiltReading + \ingroup sensors_reading + \inmodule QtSensors + + \brief The QTiltReading class holds readings from the tilt sensor. + + The tilt sensor reports the angle of tilt in degrees of the device along the X and Y plane. + +*/ + + +/*! + \property QTiltReading::yRotation + \brief This property holds the amount of tilt on the Y axis. +*/ +qreal QTiltReading::yRotation() const +{ + return d->yRotation; +} + +/*! + Sets yRotation to \a y. +*/ +void QTiltReading::setYRotation(qreal y) +{ + d->yRotation = y; +} + +/*! + \property QTiltReading::xRotation + \brief This property holds the amount of tilt on the X axis. + +*/ +qreal QTiltReading::xRotation() const +{ + return d->xRotation; +} + +/*! + Sets xRotation to \a x. +*/ +void QTiltReading::setXRotation(qreal x) +{ + d->xRotation = x; +} + +// ===================================================================== + +/*! + \class QTiltFilter + \ingroup sensors_filter + \inmodule QtSensors + + \brief The QTiltFilter class is a convenience wrapper around QSensorFilter. + + The only difference is that the filter() method features a pointer to QTiltReading + instead of QSensorReading. +*/ + +/*! + \fn QTiltFilter::filter(QTiltReading *reading) + + Called when \a reading changes. Returns false to prevent the reading from propagating. + + \sa QSensorFilter::filter() +*/ + +char const * const QTiltSensor::type("QTiltSensor"); + +/*! + \class QTiltSensor + \ingroup sensors_type + \inmodule QtSensors + + \brief The QTiltSensor class is a convenience wrapper around QSensor. + + The only behavioural difference is that this class sets the type properly.QMetaObject::invokeMethod(backend(), "calibrate"); + + This class also features a reading() function that returns a QTiltReading instead of a QSensorReading. + + For details about how the sensor works, see \l QTiltReading. + + \sa QTiltReading +*/ + +/*! + \fn QTiltSensor::QTiltSensor(QObject *parent) + + Construct the sensor as a child of \a parent. +*/ +QTiltSensor::QTiltSensor(QObject *parent) + : QSensor(QTiltSensor::type, parent) +{ +} + +/*! + \fn QTiltSensor::~QTiltSensor() + + Destroy the sensor. Stops the sensor if it has not already been stopped. +*/ +QTiltSensor::~QTiltSensor() +{ +} +/*! + \fn QTiltSensor::reading() const + + Returns the reading class for this sensor. + + \sa QSensor::reading() +*/ + + +/*! + Calibrates the tilt sensor. Uses the current tilt angles as 0. + */ +void QTiltSensor::calibrate() +{ + QMetaObject::invokeMethod(backend(), "calibrate", Qt::DirectConnection); +} + +#include "moc_qtiltsensor.cpp" +QT_END_NAMESPACE |