summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/src/examples/sensors.qdoc8
-rw-r--r--doc/src/maze.qdoc56
-rw-r--r--examples/sensors/maze/Maze.qml11
3 files changed, 67 insertions, 8 deletions
diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc
index 98bf0e0e..e20eb35b 100644
--- a/doc/src/examples/sensors.qdoc
+++ b/doc/src/examples/sensors.qdoc
@@ -47,12 +47,4 @@
It was designed as a debugging aid.
*/
-/*!
- \example sensors/maze
- \title Maze
- \brief The Maze example demonstrates the TiltSensor QML element
- \ingroup qtsensors-examples
-
- The Maze example demonstrates the use of the TiltSensor QML element.
-*/
diff --git a/doc/src/maze.qdoc b/doc/src/maze.qdoc
new file mode 100644
index 00000000..51520caa
--- /dev/null
+++ b/doc/src/maze.qdoc
@@ -0,0 +1,56 @@
+/****************************************************************************
+**
+** 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/maze
+ \title Maze
+ \brief The Maze example demonstrates the TiltSensor QML element
+ \ingroup qtsensors-examples
+
+\section1 Overview
+ To write a QML application that will use the TiltSensor QML sensors element you need to do the following steps:
+
+ Import the QtSensors 5.x declarative plugin:
+
+\snippet ../examples/sensors/maze/Maze.qml 0
+
+ Add the Sensor QML elements into your qml file.
+
+ In this example we use the TiltSensor with values based in degrees and an accuracy of 5 degree:
+
+\snippet ../examples/sensors/maze/Maze.qml 1
+
+ Starting the sensor can be done by setting the 'enabled' property to true:
+
+\snippet ../examples/sensors/maze/Maze.qml 2
+
+ To determine the walk direction of the mouse we use the following if -else statements:
+
+\snippet ../examples/sensors/maze/Maze.qml 3
+
+*/
+
diff --git a/examples/sensors/maze/Maze.qml b/examples/sensors/maze/Maze.qml
index a0a998ab..189f5239 100644
--- a/examples/sensors/maze/Maze.qml
+++ b/examples/sensors/maze/Maze.qml
@@ -40,7 +40,10 @@
//Import the declarative plugins
import QtQuick 2.0
+
+//! [0]
import QtSensors 5.0
+//! [0]
//Import the javascript functions for this game
import "lib.js" as Lib
@@ -159,20 +162,25 @@ Rectangle {
}
}
+//! [1]
TiltSensor{
id: tiltSensor
unit: TiltSensor.Degrees
enabled: true
accuracy: 5.0
}
+//! [1]
//Timer to read out the x and y rotation of the TiltSensor
Timer {
id: tiltTimer
interval: 50; running: false; repeat: true
+
+//! [2]
onTriggered: {
if (!tiltSensor.enabled)
tiltSensor.enabled = true;
+//! [2]
if (mouseCtrl === null)
return;
@@ -185,6 +193,8 @@ Rectangle {
//check if we can move the mouse
var xval = -1;
var yval = -1;
+
+//! [3]
var xstep = 0;
if (tiltSensor.yRotation > 0)
xstep = 1;
@@ -195,6 +205,7 @@ Rectangle {
ystep = 1;
else if (tiltSensor.xRotation < 0)
ystep = -1;
+//! [3]
if (xstep < 0){
if (mouseCtrl.x > 0){