summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2018-01-26 10:42:28 +0200
committerTomi Korpipää <tomi.korpipaa@qt.io>2018-02-06 06:58:46 +0000
commit1b2665ac7d6d63663e061682f8b31d66fd3ffdfb (patch)
tree157059a89928252b7ac4096d16601a207ac481b2 /doc
parent7dcf86dcb49ecf82077cfd207af92c0a6838adac (diff)
Add remote deployment documentation
Added remote deployment documentation. Additionally small restructure of command line usage documentation. Task-number: QT3DS-562 Change-Id: I9d5b9337883aca3657f5c189b52c9a7bb996a3a5 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/04-viewer/2-commandline.qdoc10
-rw-r--r--doc/src/04-viewer/3-remote-deployment.qdoc100
-rw-r--r--doc/src/04-viewer/viewer-index.qdoc1
-rw-r--r--doc/src/images/preview-button.pngbin0 -> 533 bytes
4 files changed, 107 insertions, 4 deletions
diff --git a/doc/src/04-viewer/2-commandline.qdoc b/doc/src/04-viewer/2-commandline.qdoc
index 97449b8e..bd15896d 100644
--- a/doc/src/04-viewer/2-commandline.qdoc
+++ b/doc/src/04-viewer/2-commandline.qdoc
@@ -31,12 +31,11 @@
\page viewer-commandline.html
\ingroup qt3dstudio-viewer
-\section1 Command Line Usage
-
The Qt 3D Studio Viewer supports launching a specific presentation and generating image
sequences using command line arguments.
-Usage:
+\section1 Usage
+
\badcode
Qt3DViewer [options] [presentation file]
\endcode
@@ -106,7 +105,10 @@ The following command line options are supported:
\li Specifies scaling mode. The default value is \c{center}.
\endtable
-Example - Creating a one minute 4k image sequence of a presentation:
+\section1 Example
+
+Creating a one minute 4k image sequence of a presentation:
+
\badcode
Qt3DViewer --seq-end 60000 --seq-width 3840 --seq-height 2160 MyPresentation.uip
\endcode
diff --git a/doc/src/04-viewer/3-remote-deployment.qdoc b/doc/src/04-viewer/3-remote-deployment.qdoc
new file mode 100644
index 00000000..1c154fc5
--- /dev/null
+++ b/doc/src/04-viewer/3-remote-deployment.qdoc
@@ -0,0 +1,100 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 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 Viewer: Remote Deployment
+\page viewer-remote-deployment.html
+\ingroup qt3dstudio-viewer
+
+Qt 3D Studio supports remote deployment to Qt 3D Studio Viewer. This enables seeing design changes
+live in the target device, for example an Android tablet.
+
+\note For supported devices and operating systems see the \l{Requirements} page.
+
+\section1 Setting Up the Target Device
+
+To set up the target device for remote deployment, follow the steps below.
+
+\section2 Android Devices
+
+\list 1
+ \li Download Qt 3D Viewer from
+ \l{https://play.google.com/store/apps/details?id=org.qtproject.qt3dviewer}{Google Play}
+ and install it on the target device.
+ \li Run Qt 3D Viewer.
+ \li Connection information, IP address and port, will display in the Viewer.
+\endlist
+
+\section2 Embedded Systems
+
+For embedded systems you will have to compile the application on the target device.
+
+\section3 Command Line
+
+You can run the Viewer from the command line. The default mode is connection mode. To start the
+Viewer, use the following command:
+\badcode
+Qt3DViewer
+\endcode
+
+When you run the Viewer in connection mode it will display connection details, IP address and port,
+right away.
+
+For full usage, see the \l{Viewer: Command Line Usage}{Command line usage documentation}.
+
+\section1 Connecting to the Target Device
+
+To connect to the target device Viewer from Qt 3D Studio, follow the steps below.
+
+\list 1
+ \li From the file menu, select \uicontrol {File > Connect to Device}.
+ \li Enter the connection information displaying in the Viewer on the target device, then press
+ \uicontrol{OK}.
+ \note Previous used IP and port is automatically inserted when you click
+ \uicontrol {Connect to Device}.
+ \li You are now connected. The Viewer on the target device should display \e{Remote Connected}.
+\endlist
+
+\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.
+
+After making changes to your presentation, press the \uicontrol{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/04-viewer/viewer-index.qdoc b/doc/src/04-viewer/viewer-index.qdoc
index 16f13d84..b3997e68 100644
--- a/doc/src/04-viewer/viewer-index.qdoc
+++ b/doc/src/04-viewer/viewer-index.qdoc
@@ -39,6 +39,7 @@
\li \l {Viewer: Menu}
\li \l {Viewer: Keyboard Shortcuts}
\li \l {Viewer: Command Line Usage}
+ \li \l {Viewer: Remote Deployment}
\endlist
//! [toc]
diff --git a/doc/src/images/preview-button.png b/doc/src/images/preview-button.png
new file mode 100644
index 00000000..e0314a61
--- /dev/null
+++ b/doc/src/images/preview-button.png
Binary files differ