summaryrefslogtreecommitdiffstats
path: root/doc/src/about-qt3dstudio.qdoc
blob: 9e4290a83a1386450e1a4549dc2134bc28289a44 (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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/****************************************************************************
**
** 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 About Qt 3D Studio
\page about-qt3dstudio.html

\section1 Applications

The Qt 3D Studio suite includes:
\table
  \header
    \li
      \div {align="center"}
         Studio
      \enddiv
    \li
      \div {align="center"}
        Viewer
      \enddiv
  \row
    \li
      \div {align="center"}
        \inlineimage studio_128.png
      \enddiv
    \li
      \div {align="center"}
        \inlineimage viewer_128.png
      \enddiv
  \row
    \li An authoring tool for creating interactive 3D presentations and applications.
    \li A runtime player to test and deploy interfaces created in Studio.
  \row
    \li
      \list
        \li \l {Getting started}
        \li \l {Studio Index}
      \endlist
    \li
      \list
        \li \l {Viewer Index}
      \endlist
\endtable

For software and hardware requirements, see the \l{Requirements} page. For list of third-party
modules and copyright notices, see the \l{Copyright Notices} page.

\section1 Qt 3D vs. Qt 3D Studio
See the \l{Comparison of Qt 3D and Qt 3D Studio} section for a full comparison of Qt 3D and
Qt 3D Studio.

\section1 Concepts

\section2 Project

A \e project is simply a folder on your computer holding all the assets needed
for your application. When you start a new project, a default folder structure will be created.

\section2 Application

Your \e application is the entry point of your project. It is represented by a single \c{.uia}
file at the root of your project folder. This file references the presentation and
sub-presentations in your project. The \e application is what is displayed by the Viewer.

\section2 Presentation

Artists use Studio to create \e presentation files, represented by \c{.uip} files in your
project. A presentation has one or more \e layers composited to the screen, comprised of 2D and
3D assets created in other applications.

Each application can only have one main presentation shown on screen
(specified by the \c{.uia} file) but this presentation may reference other \e{sub-presentations},
either on flat layers or as images and textures drawn in a scene.

\section2 QML

Additional functionality can be built on top of the Qt 3D Studio presentations with QML by
incorporating applications or presentations into QML with the Studio3D element.

\section2 Layer

A single Studio presentation combines one or more \e layers. The visual result of each \e layer
comes from rendering a 3D scene, 2D scene (via an orthographic camera), or sub-presentation. Layers
are then composited with items on upper layers drawing on top of the content on lower layers.

\section2 Slide

A Studio presentation combines 3D assets with animations and \e{slides}. Slides can be thought
of as states and provide visual variations within the presentation.


\section1 Known Issues

\section2 Possible problems after automatic mesh optimization

When loading a presentation made with an earlier version (2.0 beta2 or older) of Qt 3D Studio
which has imported FBX or DAE models, you may see the following messagebox:

\image {mesh_optimization.png}{Old presentation version}

If your \b{imported} models are not visible in the Viewer after seeing the message, you need to
edit your \c{*.uip} file(s) manually. Some older versions of Studio referenced meshes with revision
number in the \c{*.uip} file, and that revision causes it to be missing in the scope of the
Viewer.

You'll need to find all occurrences of \c{.mesh#<revision_number>} from you \c{*.uip} and
replace them with \c{.mesh}.

*/