aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJohanna Vanhatapio <johanna.vanhatapio@qt.io>2020-11-17 15:43:11 +0200
committerJohanna Vanhatapio <johanna.vanhatapio@qt.io>2020-11-18 13:43:37 +0000
commit4e7665503ff556303a4c61ce01cac8338cc9f324 (patch)
treea60153b3aa0e2beeed890b45c485a15f54802099 /doc
parentcaace5da7b8c7739acd29622d44f528e9077d339 (diff)
Doc: Update the Adding 3D Views topic
Task-number: QDS-3087 Change-Id: I8255064fcbf3cbfeb140ecdec8cbda9ca9342fe3 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/qtdesignstudio/images/studio-3d-properties-type.pngbin3681 -> 7075 bytes
-rw-r--r--doc/qtdesignstudio/images/studio-navigator-view3d.pngbin8922 -> 11057 bytes
-rw-r--r--doc/qtdesignstudio/images/studio-qtquick-3d-components.pngbin8561 -> 13839 bytes
-rw-r--r--doc/qtdesignstudio/images/studio-qtquick-3d-view.pngbin19953 -> 11960 bytes
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc62
5 files changed, 43 insertions, 19 deletions
diff --git a/doc/qtdesignstudio/images/studio-3d-properties-type.png b/doc/qtdesignstudio/images/studio-3d-properties-type.png
index 7589d8dc17..1bdcadf4f9 100644
--- a/doc/qtdesignstudio/images/studio-3d-properties-type.png
+++ b/doc/qtdesignstudio/images/studio-3d-properties-type.png
Binary files differ
diff --git a/doc/qtdesignstudio/images/studio-navigator-view3d.png b/doc/qtdesignstudio/images/studio-navigator-view3d.png
index a3bce1238b..9c5bab7f8c 100644
--- a/doc/qtdesignstudio/images/studio-navigator-view3d.png
+++ b/doc/qtdesignstudio/images/studio-navigator-view3d.png
Binary files differ
diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-components.png b/doc/qtdesignstudio/images/studio-qtquick-3d-components.png
index 07ca30b550..c256af07b5 100644
--- a/doc/qtdesignstudio/images/studio-qtquick-3d-components.png
+++ b/doc/qtdesignstudio/images/studio-qtquick-3d-components.png
Binary files differ
diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-view.png b/doc/qtdesignstudio/images/studio-qtquick-3d-view.png
index 77a130d8cd..6e96bd5bf6 100644
--- a/doc/qtdesignstudio/images/studio-qtquick-3d-view.png
+++ b/doc/qtdesignstudio/images/studio-qtquick-3d-view.png
Binary files differ
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc
index 3cc6c92d2f..7886acbfcd 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc
@@ -30,37 +30,61 @@
\title Adding 3D Views
- You can use a wizard to create a Qt Quick 3D UI project that imports
- the \l{Qt Quick 3D} QML types to the \uicontrol {QML Types} tab in
- \uicontrol Library and contains a 3D view, scene light, camera, and
- model. A default material is attached to the model. You can attach
- textures to materials. For more information about creating projects,
- see \l{Creating Projects}.
+ To create a Qt Quick 3D UI project, we recommend using a \uicontrol
+ {Qt Quick 3D Application Template} wizard template that imports the
+ \l{Qt Quick 3D} QML types to the \uicontrol {QML Types} tab in
+ \uicontrol Library and contains a 3D view. A 3D view type includes a
+ \l {Setting Scene Environment}{scene environment} as well as a scene
+ \l {Using Lights}{light}, \l {Using Scene Camera}{camera}, and \l {Adding
+ Models}{model}. A default \l {Using Materials and Shaders}{material} is
+ attached to the model. You can attach \l {Attaching Textures to Materials}
+ {textures} to materials. For more information about creating projects, see
+ \l{Creating Projects}.
To add a 3D view to some other kind of project and to display the Qt Quick
3D QML types in \uicontrol Library, select \uicontrol Library >
\uicontrol {QML Imports} > \uicontrol {Add Import} > \uicontrol QtQuick3D.
- \image studio-qtquick-3d-components.png
+ \image studio-qtquick-3d-components.png "Qt Quick 3D components in Library"
- To add components to the scene, drag and drop them to \uicontrol Navigator
- or \uicontrol {Form Editor}.
+ After importing the Qt Quick 3D QML types, drag and drop a \uicontrol
+ View3D type to \uicontrol Navigator or to \uicontrol {Form Editor}.
- \image studio-navigator-view3d.png "View 3D component in the Navigator"
+ \image studio-navigator-view3d.png "A View 3D component in the Navigator"
- By default, a directional light and a perspective camera are used.
- To use other light and camera types, change the type of the component
- in the \uicontrol Type field in \uicontrol Properties. For example,
- to use a point light, enter \e {PointLight}.
+ By default, a directional light and a perspective camera are used in a 3D
+ scene created by using the wizard template mentioned above. To use other
+ light and camera types, select the component in \uicontrol {3D Editor} or
+ \uicontrol Navigator and change the type of the component in the \uicontrol
+ Type field in \uicontrol Properties. For example, to use a point light,
+ enter \e {PointLight}.
\image studio-3d-properties-type.png "Type field in Properties view"
- To edit component properties, select the component in
- \uicontrol {Form Editor} or \uicontrol Navigator and
- modify the property values in \uicontrol Properties.
+ Similarly to other components, you can select a 3D view in \uicontrol
+ Navigator or \uicontrol {3D Editor} and modify its property values in the
+ \uicontrol Properties view. Use the properties in the \uicontrol View3D
+ tab to set some properties specific to a 3D view component.
\image studio-qtquick-3d-view.png "View 3D component properties"
- For more information about the available components and their properties,
- see \l{Using 3D Components}.
+ The \uicontrol Camera property defines which camera is used to render the
+ scene to \uicontrol {Form Editor}. If this property is not defined, the
+ first enabled camera in the scene will be used.
+
+ The \uicontrol Environment property specifies the \uicontrol
+ {Scene Environment} used to render the scene. By default, the first
+ \uicontrol {Scene Environment} in the scene is set as the property value.
+
+ The \uicontrol {Import Scene} property defines the ID of the component to
+ render to \uicontrol {Form Editor}. The component does not have to be a
+ child of a 3D view type. This referenced component becomes a sibling to
+ child items of a 3D view, if there are any. You can use this property, for
+ example, to create a split screen view showing your scene from multiple
+ cameras. For more information on how to to use a 3D view to show a scene
+ from multiple cameras, see \l {Qt Quick 3D - View3D Example}.
+
+ \note The \uicontrol {Import Scene} property can only be set once.
+ Subsequent changes will have no effect.
+
*/