qt-everywhere-src-5.14.1/qtsensors/examples/sensors/maze/doc/src/maze.qdoc

/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example maze
    \title Qt Sensors - Maze QML Example
    \ingroup qtsensors-examples
    \image maze.png

    \section2 Maze in QML
    \brief The Maze example demonstrates the TiltSensor QML type.


    To write a QML application that will use the TiltSensor QML sensors type you need to do the following steps:

    Import the QtSensors 5.x declarative plugin:

    \snippet maze/maze.qml 0

    Add the Sensor QML types into your qml file.

    In this example we use the TiltSensor with values based in degrees and an accuracy of 5 degree:

    \snippet maze/maze.qml 1

    Starting the sensor can be done by setting the 'enabled' property to true:

    \snippet maze/maze.qml 2

    The mouse should move by a factor of the tilt value:

    \snippet maze/maze.qml 3

    The walk direction of the mouse takes into account some collision detection:

    \snippet maze/maze.qml 4

    The rotation of the mouse image is determined according to the angle that the mouse is moving.

    \snippet maze/Mouse.qml 0

*/