diff options
author | Mats Honkamaa <mats.honkamaa@qt.io> | 2022-02-18 10:29:35 +0200 |
---|---|---|
committer | Mats Honkamaa <mats.honkamaa@qt.io> | 2022-03-04 10:17:49 +0000 |
commit | f268c2b1fad19bc906cf72bb03bd88b2e9a653ce (patch) | |
tree | 4b99fc1adf11279706cedf2920bfc0bd7ae976ab /doc | |
parent | c250d31ca0befccf08cf74bbe9349ad4f481cfc3 (diff) |
Doc: Update 3D Editor docs
Updates to 3D Editor docs:
- Add info about Camera/View alignment
- Add info about Particle Editor
- Add info about visibility toggles
- Update screenshots
Task-number: QDS-6079
Change-Id: Ie1949956f61bbb51ea37e4fd58ca2817638297df
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
Diffstat (limited to 'doc')
14 files changed, 117 insertions, 16 deletions
diff --git a/doc/qtdesignstudio/images/icons/align-camera-on.png b/doc/qtdesignstudio/images/icons/align-camera-on.png Binary files differnew file mode 100644 index 0000000000..382a2ac6b3 --- /dev/null +++ b/doc/qtdesignstudio/images/icons/align-camera-on.png diff --git a/doc/qtdesignstudio/images/icons/align-view-on.png b/doc/qtdesignstudio/images/icons/align-view-on.png Binary files differnew file mode 100644 index 0000000000..3617416f6f --- /dev/null +++ b/doc/qtdesignstudio/images/icons/align-view-on.png diff --git a/doc/qtdesignstudio/images/icons/particle-animation-off.png b/doc/qtdesignstudio/images/icons/particle-animation-off.png Binary files differnew file mode 100644 index 0000000000..e3cd945edb --- /dev/null +++ b/doc/qtdesignstudio/images/icons/particle-animation-off.png diff --git a/doc/qtdesignstudio/images/icons/particle-animation-on.png b/doc/qtdesignstudio/images/icons/particle-animation-on.png Binary files differnew file mode 100644 index 0000000000..d240b34c2a --- /dev/null +++ b/doc/qtdesignstudio/images/icons/particle-animation-on.png diff --git a/doc/qtdesignstudio/images/icons/particle-pause.png b/doc/qtdesignstudio/images/icons/particle-pause.png Binary files differnew file mode 100644 index 0000000000..442a77211f --- /dev/null +++ b/doc/qtdesignstudio/images/icons/particle-pause.png diff --git a/doc/qtdesignstudio/images/icons/particle-play.png b/doc/qtdesignstudio/images/icons/particle-play.png Binary files differnew file mode 100644 index 0000000000..cc04c94897 --- /dev/null +++ b/doc/qtdesignstudio/images/icons/particle-play.png diff --git a/doc/qtdesignstudio/images/icons/particle-restart.png b/doc/qtdesignstudio/images/icons/particle-restart.png Binary files differnew file mode 100644 index 0000000000..dc1c06bd49 --- /dev/null +++ b/doc/qtdesignstudio/images/icons/particle-restart.png diff --git a/doc/qtdesignstudio/images/icons/particles-seek.png b/doc/qtdesignstudio/images/icons/particles-seek.png Binary files differnew file mode 100644 index 0000000000..c6c76fe4ca --- /dev/null +++ b/doc/qtdesignstudio/images/icons/particles-seek.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.png b/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.png Binary files differindex 0e0f690881..788b498991 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.png +++ b/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor-move.png b/doc/qtdesignstudio/images/studio-3d-editor-move.png Binary files differindex 6cc885655d..1e8be3f865 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-move.png +++ b/doc/qtdesignstudio/images/studio-3d-editor-move.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor-rotate.png b/doc/qtdesignstudio/images/studio-3d-editor-rotate.png Binary files differindex e53f38f942..b6c4ce167a 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-rotate.png +++ b/doc/qtdesignstudio/images/studio-3d-editor-rotate.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor-scale.png b/doc/qtdesignstudio/images/studio-3d-editor-scale.png Binary files differindex 7902d02103..19d4258275 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-scale.png +++ b/doc/qtdesignstudio/images/studio-3d-editor-scale.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor.png b/doc/qtdesignstudio/images/studio-3d-editor.png Binary files differindex 7ac86341d4..a62a6deb76 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor.png +++ b/doc/qtdesignstudio/images/studio-3d-editor.png diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc index ea415a20cc..7b147fe684 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2021 The Qt Company Ltd. +** Copyright (C) 2022 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Design Studio documentation. @@ -26,7 +26,7 @@ /*! \previouspage qtquick-form-editor.html \page studio-3d-editor.html - \nextpage quick-library.html + \nextpage quick-components-view.html \title 3D Editor @@ -64,11 +64,11 @@ affect only the local transformations of the component or whether they transform with respect to the global space. - Additional helpful features when editing 3D scenes are the \e {edit light}, - which is a quick way to light the scene, and the grid that helps you to - navigate in 3D space. Select the \inlineimage grid_on.png - (\uicontrol {Toggle Grid Visibility}) or press \key G to show or hide the - grid. + Another helpful feature when editing 3D scenes is the \e {edit light}, + which is a quick way to light the scene. + + Additionally, you can toggle the visibility of the grid, selection boxes, + icon gizmos, and camera frustums in the 3D scene. To refresh the contents of \uicontrol {3D Editor}, press \key P or select the \inlineimage icons/reset.png @@ -97,7 +97,7 @@ \li To pan, press \key Alt (or \key Option on \macos) and use the middle mouse button to click and drag anywhere in the rendered view to slide the view around. - \note At the moment it is not possible to pan using Magic Mouse. + \note It is not possible to pan using Magic Mouse. \li To orbit, press \key Alt and click and drag anywhere in the rendered view to rotate the view. \li To zoom, use the mouse wheel or press \key Alt and right-click @@ -109,7 +109,7 @@ select \inlineimage fit_selected.png (\uicontrol {Fit Selected}) or press \key F. - The world axis helper (1) shows the direction of the world axes in view. + The world axis helper (1) shows the direction of the world axes in the view. To point the camera at the currently selected component in the direction of an axis, click the axis. Clicking the dot at the end of the axis will point the camera at the opposite direction of the axis. If no component is @@ -179,6 +179,7 @@ {keyboard shortcuts} applicable to your operating system, for example, \key Ctrl+C and \key Ctrl+V on Windows to copy-paste components. + \target moving components 3d editor \section1 Moving Components \image studio-3d-editor-move.png "3D Editor in move mode" @@ -233,6 +234,76 @@ gray handle at the center of the component. \endlist + \section1 Aligning Views and Cameras + + To align a camera to the \uicontrol {3D Editor} view: + \list 1 + \li Select a camera in \uicontrol {3D Editor} or \uicontrol {Navigator}. + \li In \uicontrol {3D Editor}, + select \inlineimage icons/align-camera-on.png + . + \endlist + + This moves and rotates the camera so that the camera shows the same view + as the current view in \uicontrol {3D Editor}. + + To align the \uicontrol {3D Editor} view to a camera: + \list 1 + \li Select a camera in \uicontrol {3D Editor} or \uicontrol {Navigator}. + \li In \uicontrol {3D Editor}, + select \inlineimage icons/align-view-on.png + . + \endlist + + This copies the position as well as x and y rotation values from the + camera and applies them to \uicontrol {3D Editor}. + + \section1 Toggling Visibility + + To toggle the visibility of objects in \uicontrol {3D Editor}, select + \inlineimage icons/visibilityon.png + in the toolbar. This opens a menu with the following options: + + \table + \row + \li Show Grid + \li Toggles the visibility of the helper grid. + \row + \li Show Selection Boxes + \li Toggles the visibility of selection boxes for selected 3D objects. + \row + \li Show Icon Gizmos + \li Toggles the visibility of icon gizmos for object such as cameras, + lights, and particle systems. + \row + \li Always Show Camera Frustums + \li Toggles between always showing the camera frustum and showing it + only for cameras selected in \uicontrol {3D Editor}. + \endtable + + \section1 Particle Editor + + The particle editor tools help you preview your particle systems in + \uicontrol {3D Editor}. You can select one particle system to preview at a + time. + + To preview a particle system in \uicontrol{3D Editor}: + + \list 1 + \li Select a particle system in \uicontrol Navigator or + \uicontrol {3D Editor}. + \li In the \uicontrol {3D Editor}, select + \inlineimage icons/particle-animation-on.png + to activate particle animation. Now you can see the particle animation in + \uicontrol{3D Editor}. + \endlist + + You can pause the particle animation by selecting + \inlineimage icons/particle-animation-on.png + . When the animation is paused, you can use + \inlineimage icons/particles-seek.png + to manually seek forward or backward in the particle animation. + \section1 Summary of the 3D Editor Toolbar Buttons The \uicontrol {3D Editor} toolbar contains the following buttons: @@ -254,7 +325,7 @@ \inlineimage move_on.png \li Activate the Move Tool \li \key W - \li \l{Moving Components} + \li \l{moving components 3d editor}{Moving Components} \row \li \inlineimage rotate_off.png \inlineimage rotate_on.png @@ -291,17 +362,47 @@ \li \key U \li \l{Using Edit Light} \row - \li \inlineimage grid_off.png - \inlineimage grid_on.png - \li Toggle Grid Visibility - \li \key G + \li \inlineimage icons/align-camera-on.png + \li Align Selected Cameras to View + \li + \li\l{Aligning Views and Cameras} + \row + \li \inlineimage icons/align-view-on.png + \li Align View to Selected Camera + \li + \li \l{Aligning Views and Cameras} + \row + \li \inlineimage icons/visibilityon.png + \li Visibility Toggles \li + \li \l{Toggling Visibility} + \row + \li \inlineimage icons/particles-seek.png + \li Seek Particle System Time + \li + \li \l{Particle Editor} + \row + \li \inlineimage icons/particle-animation-on.png + \inlineimage icons/particle-animation-off.png + \li Toggle Particle Animation + \li \key V + \li \l{Particle Editor} + \row + \li \inlineimage icons/particle-play.png + \inlineimage icons/particle-pause.png + \li Play/Pause Particles + \li \key , + \li \l{Particle Editor} + \row + \li \inlineimage icons/particle-restart.png + \li Restart Particles + \li \key / + \li \l{Particle Editor} \row \li \inlineimage icons/reset.png \li Reset View - \li \key R + \li \key P \li \endtable - */ |