| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** 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 The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/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 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #include "qgyroscope.h" |
| #include "qgyroscope_p.h" |
| |
| QT_BEGIN_NAMESPACE |
| |
| IMPLEMENT_READING(QGyroscopeReading) |
| |
| /*! |
| \class QGyroscopeReading |
| \ingroup sensors_reading |
| \inmodule QtSensors |
| \since 5.1 |
| |
| \brief The QGyroscopeReading class represents one reading from the |
| gyroscope sensor. |
| |
| \section2 QGyroscopeReading Units |
| |
| The reading contains 3 values, measured in degrees per second that define |
| the movement of the device around the x, y and z axes. Unlike QRotationReading, |
| the values represent the current angular velocity rather than a fixed rotation. |
| The measurements are in degrees per second. |
| |
| \image sensors-coordinates3.jpg |
| */ |
| |
| /*! |
| \property QGyroscopeReading::x |
| \brief the angular velocity around the x axis. |
| |
| Measured as degrees per second. |
| \sa {QGyroscopeReading Units} |
| */ |
| |
| qreal QGyroscopeReading::x() const |
| { |
| return d->x; |
| } |
| |
| /*! |
| Sets the angular velocity around the x axis to \a x. |
| */ |
| void QGyroscopeReading::setX(qreal x) |
| { |
| d->x = x; |
| } |
| |
| /*! |
| \property QGyroscopeReading::y |
| \brief the angular velocity around the y axis. |
| |
| Measured as degrees per second. |
| \sa {QGyroscopeReading Units} |
| */ |
| |
| qreal QGyroscopeReading::y() const |
| { |
| return d->y; |
| } |
| |
| /*! |
| Sets the angular velocity around the y axis to \a y. |
| */ |
| void QGyroscopeReading::setY(qreal y) |
| { |
| d->y = y; |
| } |
| |
| /*! |
| \property QGyroscopeReading::z |
| \brief the angular velocity around the z axis. |
| |
| Measured as degrees per second. |
| \sa {QGyroscopeReading Units} |
| */ |
| |
| qreal QGyroscopeReading::z() const |
| { |
| return d->z; |
| } |
| |
| /*! |
| Sets the angular velocity around the z axis to \a z. |
| */ |
| void QGyroscopeReading::setZ(qreal z) |
| { |
| d->z = z; |
| } |
| |
| // ===================================================================== |
| |
| /*! |
| \class QGyroscopeFilter |
| \ingroup sensors_filter |
| \inmodule QtSensors |
| \since 5.1 |
| |
| \brief The QGyroscopeFilter class is a convenience wrapper around QSensorFilter. |
| |
| The only difference is that the filter() method features a pointer to QGyroscopeReading |
| instead of QSensorReading. |
| */ |
| |
| /*! |
| \fn QGyroscopeFilter::filter(QGyroscopeReading *reading) |
| |
| Called when \a reading changes. Returns false to prevent the reading from propagating. |
| |
| \sa QSensorFilter::filter() |
| */ |
| |
| bool QGyroscopeFilter::filter(QSensorReading *reading) |
| { |
| return filter(static_cast<QGyroscopeReading*>(reading)); |
| } |
| |
| char const * const QGyroscope::type("QGyroscope"); |
| |
| /*! |
| \class QGyroscope |
| \ingroup sensors_type |
| \inmodule QtSensors |
| \since 5.1 |
| |
| \brief The QGyroscope class is a convenience wrapper around QSensor. |
| |
| The only behavioural difference is that this class sets the type properly. |
| |
| This class also features a reading() function that returns a QGyroscopeReading instead of a QSensorReading. |
| |
| For details about how the sensor works, see \l QGyroscopeReading. |
| |
| \sa QGyroscopeReading |
| */ |
| |
| /*! |
| Construct the sensor as a child of \a parent. |
| */ |
| QGyroscope::QGyroscope(QObject *parent) |
| : QSensor(QGyroscope::type, parent) |
| { |
| } |
| |
| /*! |
| Destroy the sensor. Stops the sensor if it has not already been stopped. |
| */ |
| QGyroscope::~QGyroscope() |
| { |
| } |
| |
| /*! |
| \fn QGyroscope::reading() const |
| |
| Returns the reading class for this sensor. |
| |
| \sa QSensor::reading() |
| */ |
| |
| QGyroscopeReading *QGyroscope::reading() const |
| { |
| return static_cast<QGyroscopeReading*>(QSensor::reading()); |
| } |
| |
| QT_END_NAMESPACE |
| |
| #include "moc_qgyroscope.cpp" |