summaryrefslogtreecommitdiff
path: root/doc/qtdesignstudio/src/qtquick3d-editor
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2020-02-26 09:36:22 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2020-03-12 08:40:41 +0000
commit9e915ecba0e89b113b431ead327e590d630364f0 (patch)
tree971eb196e902a973c68a5d88b8f2d16755f37f19 /doc/qtdesignstudio/src/qtquick3d-editor
parent9c50a783e0625494d32fea1b4f563a313ff0beff (diff)
downloadqt-creator-9e915ecba0e89b113b431ead327e590d630364f0.tar.gz
Doc: Describe Qt Quick Designer 3D editor
- Pull source files from /doc/qtdesignstudio/srcqtquick3d-editor - Add the necessary defines to link to additional Qt modules - Use the same structure and files for the Qt Quick Designer parts as in Qt Design Studio Manual - Move some overviews to /doc/qtcreator folder - Fix the TOC and the navigation links Change-Id: I2103a8e635e537fd276b3e14feeb8f50beb92cae Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Diffstat (limited to 'doc/qtdesignstudio/src/qtquick3d-editor')
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-3d-assets.qdoc6
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-from-maya.qdoc10
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc8
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc2
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-importing.qdoc72
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc2
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc6
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc2
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc23
9 files changed, 119 insertions, 12 deletions
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-3d-assets.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-3d-assets.qdoc
index e0cc8e0933..ce448c3f20 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-3d-assets.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-3d-assets.qdoc
@@ -27,9 +27,13 @@
****************************************************************************/
/*!
- \contentspage {Qt Design Studio}
+ \contentspage index.html
\page exporting-3d-assets.html
+ \if defined(qtdesignstudio)
\previouspage qtbridge-sketch-using.html
+ \else
+ \previouspage studio-3d.html
+ \endif
\nextpage exporting-from-blender.html
\title Exporting 3D Assets
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-from-maya.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-from-maya.qdoc
index 53d3009a78..8903bc238a 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-from-maya.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-from-maya.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Design Studio.
@@ -26,10 +26,14 @@
****************************************************************************/
/*!
- \contentspage {Qt Design Studio Manual}
+ \contentspage index.html
\page exporting-from-maya.html
- \previouspage qtbridge-sketch-using.html
+ \previouspage exporting-from-blender.html
+ \if defined (qtdesignstudio)
\nextpage creator-quick-tour.html
+ \else
+ \nextpage studio-importing-3d.html
+ \endif
\title Exporting from Maya
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc
index da2964d5ba..947e72cc25 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc
@@ -24,9 +24,13 @@
****************************************************************************/
/*!
- \contentspage {Qt Design Studio}
- \previouspage studio-3d.html
+ \contentspage index.html
\page studio-3d-design-mode.html
+ \if defined (qtdesignstudio)
+ \previouspage studio-3d.html
+ \else
+ \previouspage studio-importing-3d.html
+ \endif
\nextpage studio-3d-editor.html
\title Editing 3D Assets in Design Mode
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc
index 1e340182b5..71eedd4dfb 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc
@@ -24,7 +24,7 @@
****************************************************************************/
/*!
- \contentspage {Qt Design Studio}
+ \contentspage index.html
\previouspage studio-3d-design-mode.html
\page studio-3d-editor.html
\nextpage studio-3d-view.html
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-importing.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-importing.qdoc
new file mode 100644
index 0000000000..17f7482233
--- /dev/null
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-importing.qdoc
@@ -0,0 +1,72 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt Bridge documentation.
+**
+** 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.
+**
+****************************************************************************/
+
+/*!
+ \contentspage index.html
+ \page studio-importing-3d.html
+ \if defined(qtdesignstudio)
+ \previouspage studio-importing-2d.html
+ \nextpage quick-converting-ui-projects.html
+ \else
+ \previouspage exporting-from-maya.html
+ \nextpage studio-3d-design-mode.html
+ \endif
+
+ \title Importing 3D Assets
+
+ You can import files you created using 3D graphics applications and stored
+ in several widely-used formats, such as .blend, .dae, .fbx, .glb, .gltf,
+ .obj, .uia, or .uip. For a list of formats supported by each \l{Qt Quick 3D}
+ version, see the module documentation.
+
+ For more information about exporting 3D graphics from Maya, see
+ \l{Exporting from Maya}.
+
+ During the import, you can optimize the files for \QDS. You can remove
+ components from meshes to reduce the cache size, find and fix issues in
+ the files, optimize graphs and meshes, and so on. The available options
+ depend on whether you are importing files that you created with Qt 3D Studio
+ or with other 3D graphics tools. See the tooltips in the options dialog
+ for more information about a particular option.
+
+ \image studio-import-3d.png
+
+ To import 3D assets to \QDS projects:
+
+ \list 1
+ \li In the Design mode, select \uicontrol Library > \uicontrol Assets
+ > \uicontrol {Add New Assets}.
+ \li Select \uicontrol {3D Assets} in the dropdown menu to filter 3D
+ graphics files.
+ \li Select a file to import, and then select \uicontrol Open.
+ \li In the \uicontrol {3D Scene Options} tab, select options for
+ importing the file.
+ \li Select \uicontrol Import to import the 3D graphics file.
+ \li When the import is done, select \uicontrol Close.
+ \endlist
+
+ You can open the imported files in the Design mode for editing in the
+ \l{Editing 3D Scenes}{3D editor}.
+*/
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc
index 211085fd3c..b9fb65731c 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc
@@ -24,7 +24,7 @@
****************************************************************************/
/*!
- \contentspage {Qt Design Studio}
+ \contentspage index.html
\previouspage studio-3d-components.html
\page studio-3d-node.html
\nextpage studio-3d-model.html
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc
index 0951110886..3844439569 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Design Studio.
@@ -29,7 +29,11 @@
\contentspage {Qt Design Studio Manual}
\page studio-3d-scene-environment.html
\previouspage studio-3d-camera.html
+ \if defined (qtdesignstudio)
\nextpage creator-live-preview.html
+ \else
+ \nextpage qtquick-iso-icon-browser.html
+ \endif
\title Setting Scene Environment
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc
index 4c61d12a12..ae1e50e0d3 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc
@@ -24,7 +24,7 @@
****************************************************************************/
/*!
- \contentspage {Qt Design Studio}
+ \contentspage index.html
\previouspage studio-3d-editor.html
\page studio-3d-view.html
\nextpage studio-3d-components.html
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc
index 03f3085ad6..976ae9aca4 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Design Studio documentation.
@@ -24,10 +24,15 @@
****************************************************************************/
/*!
- \contentspage {Qt Design Studio Manual}
+ \contentspage index.html
\page studio-3d.html
\previouspage qmldesigner-pathview-editor.html
+ \if defined(qtdesignstudio)
\nextpage studio-3d-design-mode.html
+ \else
+ \nextpage exporting-3d-assets.html
+ \endif
+
\title Editing 3D Scenes
@@ -45,6 +50,20 @@
The following topics contain information about working with Qt Quick 3D:
\list
+ \if defined (qtcreator)
+ \li \l {Exporting 3D Assets}
+
+ You can import files you created using 3D graphics applications and
+ stored in several widely-used formats, such as .blend, .dae, .fbx,
+ .glb, .gltf, .obj, .uia, or .uip.
+
+ \li \l{Importing 3D Assets}
+
+ You can import 3D assets that you created using 3D graphics
+ applications and stored in one of the supported file formats.
+ You can then edit them in the Design mode.
+ \endif
+
\li \l {Editing 3D Assets in Design Mode}
\QDS opens QML files that contain 3D scenes in the Design mode and