summaryrefslogtreecommitdiff
path: root/examples/sensors/cubehouse/doc/src/cubehouse.qdoc
blob: e286e32e1357bae394559b448fc27b112eb5539f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.  Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example cubehouse
    \title Qt Sensors - Cube House QML Accelerometer example
    \ingroup qtsensors-examples
    \brief The Cube House example demonstrates the use of the accelerometer to drive a camera to create a pseudo-3D effect.
    \image cubehouse.png

\section1 Overview
    To write a QML application that will use the QML Accelerometer type from the QtSensors import you need to to the following steps:

    Import the QtSensors declarative plugin:

\snippet cubehouse/cubehouse.qml 0

    Add the Accelerometer QML types into your qml file.

\snippet cubehouse/cubehouse.qml 1

    In additional two properties are added to save the calculated pitch and roll values:

\snippet cubehouse/cubehouse.qml 2

    Reading out the Accelerometer data can be done by implementing the 'onReadingChanged' slot and
    accessing the 'reading' property from the Accelerometer type:

\snippet cubehouse/cubehouse.qml 3

    By using a timer the view can be rotated using the pitch and roll properties from the Accelerometer type:

\snippet cubehouse/cubehouse.qml 4

*/