summaryrefslogtreecommitdiffstats
path: root/examples/qt3d/scene3d/doc/src/scene3d.qdoc
blob: fd324e6a44b413703e57ad954f68c438eb24f8c9 (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
/****************************************************************************
**
** Copyright (C) 2016 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 scene3d
    \title Qt 3D: Scene3D QML Example
    \ingroup qt3d-examples-qml
    \brief A QML application that demonstrates visualizing a 3D scene.

    \image scene3d.png

    \e {Scene3D} demonstrates visualizing a 3D scene from a Qt Quick
    application. The 3D scene contains a single active camera and a single
    active light source. Visualized data is assumed to be at a fixed location.

    \include examples-run.qdocinc

    \section1 Visualizing 3D Scenes

    We set up the 3D scene and specify the entity to animate in \e main.qml:

    \quotefromfile scene3d/main.qml
    \skipto Scene3D {
    \printuntil }
    \printuntil }

    We specify the active camera in \e scene3d/AnimatedEntity.qml:

    \quotefromfile scene3d/AnimatedEntity.qml
    \skipto Camera
    \printuntil }
*/