qtmobility/src/sensors/qaccelerometer.cpp
changeset 8 71781823f776
parent 4 90517678cc4f
child 11 06b8e2af4411
equal deleted inserted replaced
5:453da2cfceef 8:71781823f776
    48 
    48 
    49 /*!
    49 /*!
    50     \class QAccelerometerReading
    50     \class QAccelerometerReading
    51     \ingroup sensors_reading
    51     \ingroup sensors_reading
    52 
    52 
    53     \preliminary
       
    54     \brief The QAccelerometerReading class reports on linear acceleration
    53     \brief The QAccelerometerReading class reports on linear acceleration
    55            along the X, Y and Z axes.
    54            along the X, Y and Z axes.
    56 
    55 
    57     \section2 QAccelerometerReading Units
    56     \section2 QAccelerometerReading Units
    58     The scale of the values is meters per second squared.
    57     The scale of the values is meters per second squared.
    59     The axes are arranged as follows.
    58     The axes are arranged as follows.
    60 
    59 
    61 \code
    60     \image sensors-coordinates2.jpg
    62              +z
       
    63               |
       
    64               |      +y
       
    65               |     /
       
    66               |----/----
       
    67              /| NOKIA  /|
       
    68             //|--/--- / |
       
    69            // | /   //  /
       
    70           //  |/   //  /
       
    71          //   '--------------- +x
       
    72         //       //  /
       
    73        //       //  /
       
    74       /---------/  /
       
    75      /    O    /  /
       
    76     /         /  /
       
    77     ----------  /
       
    78     |_________!/
       
    79 \endcode
       
    80 
    61 
    81     A monoblock device sitting at rest, face up on a desk will experience
    62     A monoblock device sitting at rest, face up on a desk will experience
    82     a force of approximately 9.8 on the Z axis (ie. towards the roof).
    63     a force of approximately 9.8 on the Z axis (ie. towards the roof).
    83     This is the proper acceleration the device experiences relative to 
    64     This is the proper acceleration the device experiences relative to
    84     freefall.
    65     freefall.
    85 */
    66 */
    86 
    67 
    87 /*!
    68 /*!
    88     \property QAccelerometerReading::x
    69     \property QAccelerometerReading::x
   151 
   132 
   152 /*!
   133 /*!
   153     \class QAccelerometerFilter
   134     \class QAccelerometerFilter
   154     \ingroup sensors_filter
   135     \ingroup sensors_filter
   155 
   136 
   156     \preliminary
       
   157     \brief The QAccelerometerFilter class is a convenience wrapper around QSensorFilter.
   137     \brief The QAccelerometerFilter class is a convenience wrapper around QSensorFilter.
   158 
   138 
   159     The only difference is that the filter() method features a pointer to QAccelerometerReading
   139     The only difference is that the filter() method features a pointer to QAccelerometerReading
   160     instead of QSensorReading.
   140     instead of QSensorReading.
   161 */
   141 */
   172 
   152 
   173 /*!
   153 /*!
   174     \class QAccelerometer
   154     \class QAccelerometer
   175     \ingroup sensors_type
   155     \ingroup sensors_type
   176 
   156 
   177     \preliminary
       
   178     \brief The QAccelerometer class is a convenience wrapper around QSensor.
   157     \brief The QAccelerometer class is a convenience wrapper around QSensor.
   179 
   158 
   180     The only behavioural difference is that this class sets the type properly.
   159     The only behavioural difference is that this class sets the type properly.
   181 
   160 
   182     This class also features a reading() function that returns a QAccelerometerReading instead of a QSensorReading.
   161     This class also features a reading() function that returns a QAccelerometerReading instead of a QSensorReading.