summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2018-03-19 10:27:08 +0200
committerMats Honkamaa <mats.honkamaa@qt.io>2018-03-19 11:48:00 +0000
commit17d1ff15f67e908ef6e2ee68d115a70d7125ca3b (patch)
tree18352952238e71e8f23547bd889046b74f3d0ca0 /doc
parent113375774600c5297f1be4cb3771dcb4390f8795 (diff)
Add Remote Preview button to documentation
Updated documentation to included the Remote Preview button. Task-number: QT3DS-1288 Change-Id: I896e92d1fbd3d202c020a63220479fa582e3423d Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/03-studio/1-toolbar.qdoc18
-rw-r--r--doc/src/04-viewer/3-remote-deployment.qdoc13
-rw-r--r--doc/src/images/Studio-SceneView.pngbin75541 -> 100829 bytes
-rw-r--r--doc/src/images/Studio-Toolbar-Preview.pngbin500 -> 15347 bytes
-rw-r--r--doc/src/images/addAssets.pngbin34815 -> 51662 bytes
-rw-r--r--doc/src/images/remote-preview-button.pngbin0 -> 15637 bytes
6 files changed, 18 insertions, 13 deletions
diff --git a/doc/src/03-studio/1-toolbar.qdoc b/doc/src/03-studio/1-toolbar.qdoc
index 26f2621e..c869612a 100644
--- a/doc/src/03-studio/1-toolbar.qdoc
+++ b/doc/src/03-studio/1-toolbar.qdoc
@@ -244,11 +244,19 @@ palette.
\section1 Preview
\image Studio-Toolbar-Preview.png
+The preview toolbar buttons are used to preview your presentation.
+\list
+ \li
+ The \b{Preview} button (keyboard shortcut: \c{F5})
+ will launch the Qt 3D Studio Viewer application and preview the
+ application for the presentation.
+ \li
+ The \b{Remote Preview} button will launch the presentation on the connected remote device
+ Qt 3D Studio Viewer application. This button is only enabled if you are connected to a
+ remote device.
+\endlist
-Invoking the \b{Preview} command (keyboard shortcut: \c{F5})
-will launch the Qt 3D Studio Viewer application and preview the
-application for the presentation. If there is no \c{.uia} file in
-the folder for this presentation, then the presentation will be
-previewed by itself (no sub-presentations).
+\note If there is no \c{.uia} file in the folder for the presentation, then the
+presentation will be previewed by itself (no sub-presentations).
*/
diff --git a/doc/src/04-viewer/3-remote-deployment.qdoc b/doc/src/04-viewer/3-remote-deployment.qdoc
index 1c154fc5..3f58fc9e 100644
--- a/doc/src/04-viewer/3-remote-deployment.qdoc
+++ b/doc/src/04-viewer/3-remote-deployment.qdoc
@@ -82,19 +82,16 @@ To connect to the target device Viewer from Qt 3D Studio, follow the steps below
\section1 Preview Presentation
-To preview the presentation on the target device, press the \uicontrol{Preview} button
-\inlineimage preview-button.png
-in the Studio toolbar or press \uicontrol F5.
+To preview the presentation on the target device, press the \uicontrol{Remote Preview} button
+\inlineimage remote-preview-button.png
+in the Studio toolbar.
-After making changes to your presentation, press the \uicontrol{Preview} button to see the changes
-on the target device.
+After making changes to your presentation, press the \uicontrol{Remote Preview} button to see the
+changes on the target device.
\section1 Disconnecting from the Target Device
You can disconnect from the target device either by selecting \uicontrol{File > Connect to Device}
from the Studio file menu, or by selecting \uicontrol{File > Disconnect} from the Viewer file menu.
-After disconnecting, the presentation will be shown in the local Viewer when pressing the
-\uicontrol{Preview} button.
-
*/
diff --git a/doc/src/images/Studio-SceneView.png b/doc/src/images/Studio-SceneView.png
index ca8634b5..dfa0ef4a 100644
--- a/doc/src/images/Studio-SceneView.png
+++ b/doc/src/images/Studio-SceneView.png
Binary files differ
diff --git a/doc/src/images/Studio-Toolbar-Preview.png b/doc/src/images/Studio-Toolbar-Preview.png
index 8381ac7b..66f67519 100644
--- a/doc/src/images/Studio-Toolbar-Preview.png
+++ b/doc/src/images/Studio-Toolbar-Preview.png
Binary files differ
diff --git a/doc/src/images/addAssets.png b/doc/src/images/addAssets.png
index 397faa94..c7af56d9 100644
--- a/doc/src/images/addAssets.png
+++ b/doc/src/images/addAssets.png
Binary files differ
diff --git a/doc/src/images/remote-preview-button.png b/doc/src/images/remote-preview-button.png
new file mode 100644
index 00000000..f588db0b
--- /dev/null
+++ b/doc/src/images/remote-preview-button.png
Binary files differ