Add docs for qmldynamickeyframes and qmlstreamer examples

Task-number: QT3DS-521
Change-Id: Id3d54f1c7a2bf955d73e95548ead5fef675f7a81
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>

4 files changed, 118 insertions, 0 deletions

diff --git a/examples/studio3d/qmldynamickeyframes/doc/images/qml-dynamic-keyframes.jpg b/examples/studio3d/qmldynamickeyframes/doc/images/qml-dynamic-keyframes.jpg
new file mode 100644
index 00000000..b67e497a
--- /dev/null
+++ b/examples/studio3d/qmldynamickeyframes/doc/images/qml-dynamic-keyframes.jpg
diff --git a/examples/studio3d/qmldynamickeyframes/doc/src/qmldynamickeyframes.qdoc b/examples/studio3d/qmldynamickeyframes/doc/src/qmldynamickeyframes.qdoc
new file mode 100644
index 00000000..f769de0f
--- /dev/null
+++ b/examples/studio3d/qmldynamickeyframes/doc/src/qmldynamickeyframes.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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 qmldynamickeyframes
+    \title Qt 3D Studio: Dynamic Keyframes Example
+    \ingroup qtstudio3d-examples-qml
+    \brief Demonstrates using dynamic keyframes in QML
+
+    \image qml-dynamic-keyframes.jpg
+
+    \e {This example demonstrates using dynamic keyframes with QML in Studio}
+
+    \include examples-run.qdocinc
+
+    \section1 Description
+
+    The presentation displayed in this example consists of three simple slides with ping-pong
+    animations:
+
+    \list
+        \li Slide 1: Move ball to the right side of the screen
+        \li Slide 2: Move ball to center of the screen and scale it up
+        \li Slide 3: Move ball back to the initial position on the left side of the screen
+    \endlist
+
+    Because the animations in the presentation are defined dynamic, the current position
+    and scale of the ball are used as the initial keyframes for animations whenever
+    a slide is changed.
+
+    \section1 Usage
+
+    \section2 Change Slide
+
+    Changes the current slide to next slide in sequence
+
+    \section2 Reset Time
+
+    Resets the animation time to the beginning
+
+    \section2 Change Color
+
+    Changes the current color to the next one in an array of predefined colors
+*/
diff --git a/examples/studio3d/qmlstreamer/doc/images/qml-streamer.jpg b/examples/studio3d/qmlstreamer/doc/images/qml-streamer.jpg
new file mode 100644
index 00000000..b296e64c
--- /dev/null
+++ b/examples/studio3d/qmlstreamer/doc/images/qml-streamer.jpg
diff --git a/examples/studio3d/qmlstreamer/doc/src/qmlstreamer.qdoc b/examples/studio3d/qmlstreamer/doc/src/qmlstreamer.qdoc
new file mode 100644
index 00000000..584d764e
--- /dev/null
+++ b/examples/studio3d/qmlstreamer/doc/src/qmlstreamer.qdoc
@@ -0,0 +1,50 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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 qmlstreamer
+    \title Qt 3D Studio: QML Streamer Example
+    \ingroup qtstudio3d-examples-qml
+    \brief Demonstrates using QML as a texture in presentation
+
+    \image qml-streamer.jpg
+
+    \e {This example demonstrates QML as a texture in presentation}
+
+    \include examples-run.qdocinc
+
+    \section1 Description
+
+    The presentation consists of as simple rotating cube with QML item as texture
+
+    The \l {qmlstreamer/qml/qmlstreamer/main.qml}{qml main} loads a presentation, which contains
+    a sub-presentation. The content of the sub-presentation is specified using the
+    \l QmlStream element, which defines an id to the sub-presentation and the content of
+    the sub-presentation. The content is rendered to texture and used wherever the texture is used
+    in the presentation. In this example the content is QML item specified by the
+    \l {qmlstreamer/presentation/scripts/RedFill.qml}{RedFill} script.
+*/