Update copyright headers
[qt:qt.git] / doc / src / demos / qml-qtbubblelevel.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file.  Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29     \page qtbubblelevel_example.html
30     \title Qt Bubble Level Demo
31     \example demos/mobile/qtbubblelevel
32
33 \brief Qt Bubble Level is a simple application that uses
34 Qt Mobility's accelerometer APIs and hardware
35 sensor information to calculate the inclination of the device and presents this
36 as atraditional bubble level.
37
38 The application provides a calibration feature to
39 handle any possible errors in accelerometer readings. The example is hosted in
40 Projects Forum Nokia: https://projects.forum.nokia.com/qtbubblelevel
41
42 \note This demonstration requires QtMobility libraries.
43
44     \image qml-qtbubblelevel-demo.png
45
46     \section1 Initialising the application
47
48     All of the initialisations are done in the main function.
49
50     First, QDeclarativeView is created to intepret the QML files. The QML file given is found in the Qt resource. The root QML element is set to resize to the view whenever the view is resized.
51
52     \snippet demos/mobile/qtbubblelevel/main.cpp 0
53
54     The Settings object will handle the loading or storing of the calibration value. Next, we create instances from QAccelerometer and AccelerometerFilter and attach the filter to the sensor.
55
56     \snippet demos/mobile/qtbubblelevel/main.cpp 1
57
58     The Qt code is then connected to QML code by using Qt Signals and Slots connections. First, the root object is retrieved from QDeclarativeView. The root object now represents the Qt object of the QML root element.
59
60     The saveCorrectionAngle signal of the QML root element is connected to the Qt slot saveCorrectionAngle. The rotationChanged and correctionAngle Qt signals are connected to the handleRotation and setCorrectionAngle slot of the QML root element. Finally, the quit signal of QDeclarativeEngine is connected to QApplication's quit slot.
61
62     \snippet demos/mobile/qtbubblelevel/main.cpp 2
63
64     On the Maemo target, the application needs a minimise button, so we connect one additional QML signal to the Qt slot. The minimise button is made visible by setting the value of the QML root element's taskSwitcherVisible property to true.
65
66     \snippet demos/mobile/qtbubblelevel/main.cpp 3
67
68     The correction factor of the accelerometer is retrieved from persistent storage by using QSettings. The correction factor is signalled to the QML side by using the function setCorrectionAngle. The accelerometer sensor is started and it will eventually begin to signal the changes in accelerometer readings.
69
70     \snippet demos/mobile/qtbubblelevel/main.cpp 4
71
72     Finally, in the end of the function the view is shown in full screen on mobile devices. On other targets, the application is shown as 800 x 480 resolution in the 100, 100 position from the top-left corner of the desktop.
73
74     \snippet demos/mobile/qtbubblelevel/main.cpp 5
75
76     \section1 Accessing the accelerometer information
77
78     The inclination of the device is resolved by using the QAccelerometer sensor of QtMobility. We already created the sensor in the main function and attached our self-derived AccelerometerFilter object to it. Here is the definition of the AccelerometerFilter class:
79
80     \snippet demos/mobile/qtbubblelevel/accelerometerfilter.h 0
81
82     The class is multiderived from QObject and QAccelerometerFilter classes. The QAccelerometerFilter class is derived from QObject because we want to use Qt Signals and Slots to signal changes in accelerometer readings.
83
84     The members x, y, and z store the previous values of the sensor reading in order to implement a low pass filter to the values.
85
86     In the implementation of the AccelerometerFilter class, we first read the value of each axis from the QAccelerometerReading object. The values are then converted from radians to degrees and applied the low pass filter to reduce noise in the sensor readings. Different low pass factors are used depending on the platform (these were determined to be good via experimenting). Finally, the calculated value is emitted.
87
88     Note that the accelerometer sensors are oriented differently in Symbian and Maemo devices, and we must account for this by using platform-specific code.
89
90     \snippet demos/mobile/qtbubblelevel/accelerometerfilter.cpp 0
91
92     \section1 The Qt Quick UI
93
94     BubbleLevel.qml is the main QML element. It represents the wooden board of the bubble level, and it also acts as a connection point between the QML and the Qt side. In the beginning of the element, there are two signals, two functions, and one property. All of these define the interface between Qt and QML.
95
96     On the Maemo platform, when the application is to be minimised, minimizeApplication is signalled. When a new calibration factor is to be stored in the device's memory, saveCorrectionAngle is signalled.
97
98     The handleRotation function acts as a Qt slot to which the AccelerometerFilters signal rotationChanged is connected. Similarly, the setCorrectionAngle function also acts as a Qt slot to which the Settings object's signal, correctionAngle, is connected.
99
100     The property alias taskSwitcherVisible is provided to allow the Qt model to show or hide the task switcher button which minimises the application. This is only meaningful on Maemo platforms, where every application normally has a task switcher button.
101
102     \snippet demos/mobile/qtbubblelevel/qml/BubbleLevel.qml 0
103
104     The Tube element represents the the glass tube of the bubble level. It is anchored to the centre of the wooden board. The width and height are calculated with specific factors to make the glass tube scale to different resolutions.
105
106     \snippet demos/mobile/qtbubblelevel/qml/BubbleLevel.qml 1
107
108     In the implementation of Tube.qml, the property deg represents the current inclination. The x-position of the bubble is bound to the JavaScript function calX which is called every time the property deg, center, or bubblCenter is changed. The function places the bubble in the corresponding place on its parent.
109
110     \snippet demos/mobile/qtbubblelevel/qml/Tube.qml 0
111 */