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>

8 files changed, 176 insertions, 10 deletions

diff --git a/doc/qt3dstudio-project.qdocconf b/doc/qt3dstudio-project.qdocconf
index 130eb14c..1bc47d4f 100644
--- a/doc/qt3dstudio-project.qdocconf
+++ b/doc/qt3dstudio-project.qdocconf
@@ -52,3 +52,9 @@ navigation.homepage            = Qt 3D Studio
 navigation.cppclassespage      = Qt 3D Studio C++ Classes
 navigation.qmltypespage        = Qt 3D Studio QML Types
 buildversion                   = "Qt 3D Studio $QT_VER Manual"
+
+examplesinstallpath     = qtstudio3d
+exampledirs            += ../examples/studio3d
+
+manifestmeta.highlighted.names = \
+                "QtStudio3D/Qt 3D Studio: Dynamic Keyframes Example"
diff --git a/doc/src/00-concepts.qdoc b/doc/src/00-concepts.qdoc
index e59cef8e..bec19c93 100644
--- a/doc/src/00-concepts.qdoc
+++ b/doc/src/00-concepts.qdoc
@@ -47,6 +47,7 @@
     \endomit
     \li \l {Best Practices}
     \li \l {Requirements}
+    \li \l {Examples}
     \li \l {Copyright Notices}
 \endlist
 
diff --git a/doc/src/06-qml-reference/Qt3DS_QML_Texture_Streaming.qdoc b/doc/src/06-qml-reference/Qt3DS_QML_Texture_Streaming.qdoc
index 2f7fe2af..e58ad402 100644
--- a/doc/src/06-qml-reference/Qt3DS_QML_Texture_Streaming.qdoc
+++ b/doc/src/06-qml-reference/Qt3DS_QML_Texture_Streaming.qdoc
@@ -28,9 +28,9 @@
 /*!
     \qmltype SubPresentationSettings
     \inqmlmodule QtStudio3D 1.0
-    \brief Settings for subpresentations.
+    \brief Settings for sub-presentations.
 
-    This type enables specifying settings for the subpresentations
+    This type enables specifying settings for the sub-presentations
     from Qt Quick application.
 
     \note Currently only 'presentation-qml' settings can be set.
@@ -61,7 +61,7 @@
 /*!
     \qmlproperty list<QmlStream> SubPresentationSettings::qmlStreams
 
-    Holds the list of settings for 'presentation-qml' subpresentations.
+    Holds the list of settings for \c presentation-qml sub-presentations.
  */
 
 /*!
@@ -69,10 +69,10 @@
     \inqmlmodule QtStudio3D
     \brief QML stream.
 
-    This type allows attaching qml-subpresentation with a quick item. The item is rendered to a
+    This type allows attaching QML sub-presentation with a quick item. The item is rendered to a
     texture and used as a part of a Qt 3D Studio presentation.
 
-    The subpresentation element must be specified in the \e assets element of the presentation
+    The sub-presentation element must be specified in the \e assets element of the presentation
     .uia file:
 
      \badcode
@@ -81,22 +81,22 @@
      </assets>
      \endcode
 
-    The 'presentation-id' attribute must contain a unique ID of the subpresentation.
-    The 'args' attribute may contain an optional preview version of the item, which is only
+    The \c presentation-id attribute must contain a unique ID of the sub-presentation.
+    The \c args attribute may contain an optional preview version of the item, which is only
     used in the Viewer application.
  */
 
 /*!
     \qmlproperty string QmlStream::presentationId
 
-    Holds the string ID of the subpresentation the item is attached to. The id must be one of
-    the 'presentation-qml' IDs specified in the .uia file.
+    Holds the string ID of the sub-presentation the item is attached to. The id must be one of
+    the \c presentation-qml IDs specified in the .uia file.
  */
 
 /*!
     \qmlproperty Item QmlStream::item
 
-    Holds the item attached to the subpresentation. The item size is used as the the size of the
+    Holds the item attached to the sub-presentation. The item size is used as the the size of the
     texture the item is rendered to. Default values \c{(256, 256)} are used if the item doesn't
     specify a size.
  */
diff --git a/doc/src/examples-index.qdoc b/doc/src/examples-index.qdoc
new file mode 100644
index 00000000..e4ad81b8
--- /dev/null
+++ b/doc/src/examples-index.qdoc
@@ -0,0 +1,41 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of 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$
+**
+****************************************************************************/
+
+/*!
+\title Examples
+\ingroup qml-examples
+\page qtstudio3d-qml-examples.html
+\noautolist
+
+\section1 QML Examples
+
+\list
+     \li \l {Qt 3D Studio: Dynamic Keyframes Example}
+     \li \l {Qt 3D Studio: QML Streamer Example}
+\endlist
+
+*/
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.
+*/