diff options
Diffstat (limited to 'examples/3dstudioruntime2/layersinquick/doc/src/layersinquick.qdoc')
-rw-r--r-- | examples/3dstudioruntime2/layersinquick/doc/src/layersinquick.qdoc | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/examples/3dstudioruntime2/layersinquick/doc/src/layersinquick.qdoc b/examples/3dstudioruntime2/layersinquick/doc/src/layersinquick.qdoc new file mode 100644 index 0000000..46ed0f7 --- /dev/null +++ b/examples/3dstudioruntime2/layersinquick/doc/src/layersinquick.qdoc @@ -0,0 +1,65 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt 3D Studio. +** +** $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 layersinquick + \title Qt 3D Studio Runtime: Layers in Qt Quick Example + \ingroup qt3dstudioruntime2-examples-qml + \brief Demonstrates using the View3D element in a Qt Quick application + + \image layersinquick.png + + \e {This example demonstrates basic usage of the View3D element in Qt Quick applications} + + \include examples-run.qdocinc + + \section1 Description + + This example consists of a simple C++ main() function that sets up a + QQuickView and a QML scene demonstrating the usage of the \l Studio3D and + \l View3D QML types. This combination is important because once a \l View3D + element is added to the Qt Quick scene, the behavior of \l Studio3D changes + significantly: instead of displaying the composited image of all layers + from the Qt 3D Studio presentation loaded from the \c{.uip} file(s), it + rather delegates the rendering of the individual layers to the \l View3D + items. + + This offers a lightweight and efficient way to create user interfaces that + have 3D content present in a number of different areas in the window. In + contrast, the traditional approach treats the 3D view as a "box", a + rectangular area defined by the bounds of the \l Studio3D element. With \l + View3D this limitation can be lifted since each layer from the 3D scene can + be managed (positioned, transformed, blended) individually via a \l View3D + instance dedicated to that layer. + + In the example the source \c{.uip} file has two layers. Both have + transparent backgrounds, one contains a single cube, while the other a + sphere and some text nodes. When it comes to the \l Studio3D item, the QML + code is no different from other examples. What makes it special is the + inclusion of two \l View3D items, each referencing a layer from the + \c{.uip} presentation by name. + */ |