diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 1daf929e54d..e38b0bdea64 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -131,6 +131,7 @@ \li \l{Lists and Other Data Models} \li \l{Animations} \li \l{3D Views} + \li \l{Node} \li \l{Group} \li \l{Instanced Rendering} \li \l{Skeletal Animation} diff --git a/doc/qtcreator/src/qtquick/library/qtquick-preset-components.qdoc b/doc/qtcreator/src/qtquick/library/qtquick-preset-components.qdoc index 0f110e2fee8..cc896f78c9c 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-preset-components.qdoc +++ b/doc/qtcreator/src/qtquick/library/qtquick-preset-components.qdoc @@ -69,6 +69,7 @@ \list \li \l {3D Views} + \li \l {Node} \li \l {Group} \li \l {Instanced Rendering} \li \l {Skeletal Animation} diff --git a/doc/qtcreator/src/qtquick/qtquick-library.qdoc b/doc/qtcreator/src/qtquick/qtquick-library.qdoc index 46b7dfeb8ef..3c73fcfa4ae 100644 --- a/doc/qtcreator/src/qtquick/qtquick-library.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-library.qdoc @@ -70,6 +70,7 @@ \endif \li \l Animations \li \l{3D Views} + \li \l{Node} \li \l{Group} \li \l{Instanced Rendering} \li \l{Skeletal Animation} diff --git a/doc/qtdesignstudio/images/studio-3d-properties-node.png b/doc/qtdesignstudio/images/studio-3d-properties-node.png new file mode 100644 index 00000000000..62db01c2f4d Binary files /dev/null and b/doc/qtdesignstudio/images/studio-3d-properties-node.png differ diff --git a/doc/qtdesignstudio/images/studio-3d-properties-transform.png b/doc/qtdesignstudio/images/studio-3d-properties-transform.png new file mode 100644 index 00000000000..e0b25a6d420 Binary files /dev/null and b/doc/qtdesignstudio/images/studio-3d-properties-transform.png differ diff --git a/doc/qtdesignstudio/images/studio-3d-properties-type.png b/doc/qtdesignstudio/images/studio-3d-properties-type.png index 3b171820c09..c0363d0233b 100644 Binary files a/doc/qtdesignstudio/images/studio-3d-properties-type.png and b/doc/qtdesignstudio/images/studio-3d-properties-type.png differ diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-view.png b/doc/qtdesignstudio/images/studio-qtquick-3d-view.png index 9cba7fcd1a4..9c0e8fc82bf 100644 Binary files a/doc/qtdesignstudio/images/studio-qtquick-3d-view.png and b/doc/qtdesignstudio/images/studio-qtquick-3d-view.png differ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index de254f33961..12bae906f41 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -88,6 +88,7 @@ \li \l{Logic Helpers} \li \l Animations \li \l{3D Views} + \li \l{Node} \li \l{Group} \li \l{Instanced Rendering} \li \l{Skeletal Animation} diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-group.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-group.qdoc new file mode 100644 index 00000000000..25a9d5f90d4 --- /dev/null +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-group.qdoc @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** Copyright (C) 2021 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Design Studio 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. +** +****************************************************************************/ + +/*! + \page studio-3d-group.html + \previouspage studio-3d-node.html + \nextpage studio-3d-instancing.html + + \title Group + + The \uicontrol Group component is a \l Node component that can be + used to wrap other objects for the purpose of grouping them. This allows you + to transform and set the opacity and visibility of multiple 3D components in + the \l Properties view simultaneously. + + To add a \uicontrol Group component + to your scene, drag-and-drop it from \l Library > \uicontrol Components > + \uicontrol {Qt Quick 3D} > \uicontrol {Qt Quick 3D} to the \l {3D Editor} + view or to \l Navigator > \uicontrol View3D > \uicontrol {Scene Environment} + > \uicontrol Scene. + + If the \uicontrol Group component is not displayed in + \uicontrol Library, you should add the \uicontrol {Qt Quick 3D} module to + your project, as described in \l {Adding and Removing Modules}. + + Select the \uicontrol Group component in \uicontrol Navigator to modify + \uicontrol Node properties for its child components in the + \uicontrol Properties view. +*/ diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-instancing.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-instancing.qdoc index 91863bd40b4..31a9c90be95 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-instancing.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-instancing.qdoc @@ -25,7 +25,7 @@ /*! \page studio-3d-instancing.html - \previouspage studio-3d-node.html + \previouspage studio-3d-group.html \nextpage studio-skeletal-components.html \title Instanced Rendering diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc index d524fd8da00..871e6664150 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2020 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Design Studio documentation. @@ -25,27 +25,22 @@ /*! \page studio-3d-node.html - \previouspage quick-animations.html - \nextpage studio-3d-instancing.html + \previouspage studio-3d-view.html + \nextpage studio-3d-group.html - \title Group + \title Node - The \uicontrol Group component is a \uicontrol Node component that can be - used to wrap other objects for the purpose of grouping them. This allows you - to transform and set the opacity and visibility of multiple 3D components in - the \l Properties view simultaneously. To add a \uicontrol Group component - to your scene, drag-and-drop it from \l Library > \uicontrol Components > - \uicontrol {Qt Quick 3D} > \uicontrol {Qt Quick 3D} to the \l {3D Editor} - view or to \l Navigator > \uicontrol View3D > \uicontrol {Scene Environment} - > \uicontrol Scene. If the \uicontrol Group component is not displayed in - \uicontrol Library, you should add the \uicontrol {Qt Quick 3D} module to - your project, as described in \l {Adding and Removing Modules}. - - Select the \uicontrol Group component in \uicontrol Navigator to modify its - properties in the \uicontrol Properties view. + You can set properties for 3D components that are based on the + \uicontrol Node component in \uicontrol Properties > \uicontrol Node + and \uicontrol Transform. \section1 Setting Node Opacity and Visibility + You can set the opacity and visibility of 3D components that are based on + the \uicontrol Node component in \uicontrol Properties > \uicontrol Node. + + \image studio-3d-properties-node.png "Node properties" + All components have an \uicontrol Opacity value applied to them. The opacity of 100 makes a component fully opaque, while the opacity of 0 prevents a component from rendering at all. @@ -61,8 +56,15 @@ show components. It is useful when you want to show a component in a particular state, but hide it in another state, for example. + The \uicontrol {Static flags} property is currently not used. + \section1 Managing 3D Transformations + You can manage 3D transformations for components that are based on the + \uicontrol Node component in \uicontrol Transform. + + \image studio-3d-properties-transform.png "Transform properties" + The value of the \uicontrol Translation property contains the position translation of the component in the local coordinate space established by the parent component. The \uicontrol Orientation property specifies whether diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc index 1e285e9ec15..c80e6ffcba3 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc @@ -31,7 +31,7 @@ \title 3D Views To create a Qt Quick 3D UI project, we recommend using a \uicontrol - {Qt Quick 3D Application Template} wizard template that adds the + {Qt Quick 3D Application} wizard template that adds the \l {3D Components}{Qt Quick 3D} components to \l Library > \uicontrol Components and contains a 3D view. A 3D view component includes a \l {Scene Environment}{scene environment} as well as a scene