Add documentation on using QML streaming in editor

Added documentation on how to use QML streaming as sub-presentation on
the editor side.

Task-number: QT3DS-1271
Change-Id: I00eebb0deb803e489c1b6eb63744f3366588bd2b
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Reviewed-by: Janne Kangas <janne.kangas@qt.io>
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>

1 files changed, 25 insertions, 15 deletions

diff --git a/doc/src/10-best-practices/30-using-sub-presentations.qdoc b/doc/src/10-best-practices/30-using-sub-presentations.qdoc
index 625ea968..3534cd15 100644
--- a/doc/src/10-best-practices/30-using-sub-presentations.qdoc
+++ b/doc/src/10-best-practices/30-using-sub-presentations.qdoc
@@ -34,14 +34,8 @@
 
 \section1 Introduction
 
-Sub-Presentations is a feature which allows one presentation to be
-embedded in another.
-
-The main benefit of doing this is that you can author different parts of
-a large presentation as separate smaller presentations. This can help
-control complexity in single \c{.uip} files, as well as allow
-different parts of a presentation to be authored separately and
-simultaneously.
+Sub-Presentations is a feature which allows a Studio presentation or a QML file to be
+embedded in a Studio presentation.
 
 Sub-presentations execute independently, albeit inside the same Runtime
 process as the initial presentation. The rendered frame from each
@@ -57,6 +51,11 @@ or on an image element on an existing layer.
 \target sub-presentation layer
 \section2 Sub-presentation on a Layer
 
+One of the main benefits of adding a sub-presentation on a layer is that you can author different
+parts of a large presentation as separate smaller presentations. This can help control complexity
+in single \c{.uip} files, as well as allow different parts of a presentation to be authored
+separately and simultaneously.
+
 \list 1
 \li
   From the file menu, select \uicontrol{Edit} > \uicontrol{Sub-presentations}.
@@ -66,13 +65,17 @@ or on an image element on an existing layer.
   Enter desired name for the sub-presentation in the \uicontrol{Name} field. In case you have
   several sub-presentations in your project the names need to be unique.
 \li
-  Set \uicontrol{Type} to \c{Presentation}.
+  Set \uicontrol{Type} to \c{Presentation} or \c{QML stream} depending on the content you want to
+  embed.
 \li
   Click \uicontrol{Browse}, the combobox will display the following options:
   \list a
     \li
-    \e{Browse} - Browse to the folder of an existing project and select the \c{.uip} file
-    to add that project as a sub-presentation.
+    \e{Browse} - Browse to the folder of desired content and select the \c{.uip} or \c{.qml} file
+    to add as sub-presentation.
+  \endlist
+  The options below are only available for \c{Presentation} type.
+  \list b
     \li
     \e{Create} - Creates a new empty presentation, which is added as a sub-presentation to the
     project. You may start editing it at once, or return to the main presentation by opening it
@@ -91,6 +94,12 @@ or on an image element on an existing layer.
 \endlist
 
 \section2 Sub-presentation on an Image Element
+
+One benefit of displaying a sub-presentation on an image element is that you can use Studio
+presentations and QML files to map the materials of objects in your presentation. You can apply
+sub-presentations as any kind of map to object materials, i.e. diffuse maps, specular maps and
+displacement maps. This way you can for example create animated textures.
+
 \list 1
 \li
   Follow step 1 to 5 in the \l {sub-presentation layer}{Sub-presentation on a layer}
@@ -98,12 +107,13 @@ or on an image element on an existing layer.
 \li
   Add a basic object to your layer.
 \li
-  Add any image as a diffuse map for the material of the object by first selecting the material
-  of the object in the \e{timeline palette} and then selecting \uicontrol{Diffuse Map} in the
-  \e{inspector palette}.
+  Add any image as a map for the material of the object by first selecting the material
+  of the object in the \e{timeline palette} and then selecting desired map in the
+  \e{inspector palette}. This image will act only as a placeholder, it does not matter what
+  image you use.
   \image add-diffuse-map.png
 \li
-  Select the \e{diffuse map} in the \e{timeline palette} and then select the desired
+  Select the \e{map} in the \e{timeline palette} and then select the desired
   sub-presentation in the \uicontrol{Sub-Presentation} field. All sub-presentations added in
   the \c{.uia} will be listed here.
   \image add-diffuse-map-subpresentation.png