From 9d4d08421acb628e0115b140e54656fc779d13db Mon Sep 17 00:00:00 2001 From: Geir Vattekar Date: Thu, 4 Oct 2012 13:48:23 +0200 Subject: Doc: Modularized the Qt Sensor Docs Change-Id: Ie8636ec443f43b1f238342e0f6f7d321e13dce09 Reviewed-by: Jerome Pasion --- examples/sensors/cubehouse/doc/src/cubehouse.qdoc | 60 +++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 examples/sensors/cubehouse/doc/src/cubehouse.qdoc (limited to 'examples/sensors/cubehouse') diff --git a/examples/sensors/cubehouse/doc/src/cubehouse.qdoc b/examples/sensors/cubehouse/doc/src/cubehouse.qdoc new file mode 100644 index 00000000..e286e32e --- /dev/null +++ b/examples/sensors/cubehouse/doc/src/cubehouse.qdoc @@ -0,0 +1,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 + +*/ + -- cgit v1.2.3