Doc: Update View 3D, Node, and Group properties

- Update screenshots
- Add missing properties
- Divide the Group topic into Node and Group topics because
  the Node properties are common to all components that inherit
  Node.

Task-number: QDS-4888
Change-Id: Iaf114cd09ead755c9754423fb6b47eff0292cb3f
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
This commit is contained in:
Leena Miettinen
2021-09-24 16:03:50 +02:00
parent d5cb1e81a2
commit 077a807f01
12 changed files with 76 additions and 19 deletions

View File

@@ -131,6 +131,7 @@
\li \l{Lists and Other Data Models} \li \l{Lists and Other Data Models}
\li \l{Animations} \li \l{Animations}
\li \l{3D Views} \li \l{3D Views}
\li \l{Node}
\li \l{Group} \li \l{Group}
\li \l{Instanced Rendering} \li \l{Instanced Rendering}
\li \l{Skeletal Animation} \li \l{Skeletal Animation}

View File

@@ -69,6 +69,7 @@
\list \list
\li \l {3D Views} \li \l {3D Views}
\li \l {Node}
\li \l {Group} \li \l {Group}
\li \l {Instanced Rendering} \li \l {Instanced Rendering}
\li \l {Skeletal Animation} \li \l {Skeletal Animation}

View File

@@ -70,6 +70,7 @@
\endif \endif
\li \l Animations \li \l Animations
\li \l{3D Views} \li \l{3D Views}
\li \l{Node}
\li \l{Group} \li \l{Group}
\li \l{Instanced Rendering} \li \l{Instanced Rendering}
\li \l{Skeletal Animation} \li \l{Skeletal Animation}

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.5 KiB

After

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 6.2 KiB

View File

@@ -88,6 +88,7 @@
\li \l{Logic Helpers} \li \l{Logic Helpers}
\li \l Animations \li \l Animations
\li \l{3D Views} \li \l{3D Views}
\li \l{Node}
\li \l{Group} \li \l{Group}
\li \l{Instanced Rendering} \li \l{Instanced Rendering}
\li \l{Skeletal Animation} \li \l{Skeletal Animation}

View File

@@ -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.
*/

View File

@@ -25,7 +25,7 @@
/*! /*!
\page studio-3d-instancing.html \page studio-3d-instancing.html
\previouspage studio-3d-node.html \previouspage studio-3d-group.html
\nextpage studio-skeletal-components.html \nextpage studio-skeletal-components.html
\title Instanced Rendering \title Instanced Rendering

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2020 The Qt Company Ltd. ** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Design Studio documentation. ** This file is part of the Qt Design Studio documentation.
@@ -25,27 +25,22 @@
/*! /*!
\page studio-3d-node.html \page studio-3d-node.html
\previouspage quick-animations.html \previouspage studio-3d-view.html
\nextpage studio-3d-instancing.html \nextpage studio-3d-group.html
\title Group \title Node
The \uicontrol Group component is a \uicontrol Node component that can be You can set properties for 3D components that are based on the
used to wrap other objects for the purpose of grouping them. This allows you \uicontrol Node component in \uicontrol Properties > \uicontrol Node
to transform and set the opacity and visibility of multiple 3D components in and \uicontrol Transform.
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.
\section1 Setting Node Opacity and Visibility \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 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 of 100 makes a component fully opaque, while the opacity of 0 prevents a
component from rendering at all. component from rendering at all.
@@ -61,8 +56,15 @@
show components. It is useful when you want to show a component in a show components. It is useful when you want to show a component in a
particular state, but hide it in another state, for example. particular state, but hide it in another state, for example.
The \uicontrol {Static flags} property is currently not used.
\section1 Managing 3D Transformations \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 The value of the \uicontrol Translation property contains the position
translation of the component in the local coordinate space established by translation of the component in the local coordinate space established by
the parent component. The \uicontrol Orientation property specifies whether the parent component. The \uicontrol Orientation property specifies whether

View File

@@ -31,7 +31,7 @@
\title 3D Views \title 3D Views
To create a Qt Quick 3D UI project, we recommend using a \uicontrol 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 > \l {3D Components}{Qt Quick 3D} components to \l Library >
\uicontrol Components and contains a 3D view. A 3D view component includes a \uicontrol Components and contains a 3D view. A 3D view component includes a
\l {Scene Environment}{scene environment} as well as a scene \l {Scene Environment}{scene environment} as well as a scene