summaryrefslogtreecommitdiffstats
path: root/doc/src/04-viewer/3-remote-deployment.qdoc
blob: b9da5e8fb5c3388bf4d2ab3ca47bfe1cda206e45 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/****************************************************************************
**
** 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{Remote Preview} button
\inlineimage remote-preview-button.png
in the Studio toolbar.

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 by selecting \uicontrol{File > Connect to Device}
from the Studio file menu.

*/