summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/src/cubehouse.qdoc60
-rw-r--r--doc/src/examples/sensors.qdoc11
-rw-r--r--examples/sensors/cubehouse/Cubehouse.qml14
3 files changed, 74 insertions, 11 deletions
diff --git a/doc/src/cubehouse.qdoc b/doc/src/cubehouse.qdoc
new file mode 100644
index 00000000..3a2b9410
--- /dev/null
+++ b/doc/src/cubehouse.qdoc
@@ -0,0 +1,60 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** 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.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \example sensors/cubehouse
+ \title 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 element from the QtMobility.sensors import you need to to the following steps:
+
+ Import the QtMobility.sensors declarative plugin:
+
+\snippet ../examples/sensors/cubehouse/Cubehouse.qml 0
+
+ Add the Accelerometer QML elements into your qml file.
+
+\snippet ../examples/sensors/cubehouse/Cubehouse.qml 1
+
+ In additional two properties are added to save the calculated pitch and roll values:
+
+\snippet ../examples/sensors/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 element:
+
+\snippet ../examples/sensors/cubehouse/Cubehouse.qml 3
+
+ By using a timer the view can be rotated using the pitch and roll properties from the Accelerometer element:
+
+\snippet ../examples/sensors/cubehouse/Cubehouse.qml 4
+
+*/
+
diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc
index 91d4735a..98bf0e0e 100644
--- a/doc/src/examples/sensors.qdoc
+++ b/doc/src/examples/sensors.qdoc
@@ -37,17 +37,6 @@
*/
/*!
- \example sensors/cubehouse
- \title Cube House QML Accelerometer example
- \ingroup qtsensors-examples
-
- \image cubehouse.png
-
- The Cube House example demonstrates the use of the accelerometer to drive a camera
- to create a pseudo-3D effect.
-*/
-
-/*!
\example sensors/sensor_explorer
\title Sensor Explorer
\ingroup qtsensors-examples
diff --git a/examples/sensors/cubehouse/Cubehouse.qml b/examples/sensors/cubehouse/Cubehouse.qml
index 8ea06de0..2aa1480f 100644
--- a/examples/sensors/cubehouse/Cubehouse.qml
+++ b/examples/sensors/cubehouse/Cubehouse.qml
@@ -41,7 +41,11 @@
import QtQuick 2.0
import Qt3D 1.0
import Qt3D.Shapes 1.0
+
+//! [0]
import QtMobility.sensors 1.3
+//! [0]
+
import "."
Item {
@@ -75,19 +79,28 @@ Item {
}
}
+//! [1]
Accelerometer {
id: accel
active: true
+//! [1]
+
+//! [2]
property double pitch: 0.0
property double roll: 0.0
+//! [2]
+//! [3]
onReadingChanged: {
pitch = -(Math.atan2(reading.x, Math.sqrt(reading.y * reading.y + reading.z * reading.z)) * 180) / Math.PI;
roll = (Math.atan2(reading.y, Math.sqrt(reading.x * reading.x + reading.z * reading.z)) * 180) / Math.PI;
}
}
+//! [3]
+
//Timer to read out the x and y rotation of the TiltSensor
+//! [4]
Timer {
interval: 150; running: true; repeat: true
@@ -96,4 +109,5 @@ Item {
view.rotateX(accel.roll);
}
}
+//! [4]
}