diff options
Diffstat (limited to 'doc/qtdesignstudio')
142 files changed, 728 insertions, 1327 deletions
diff --git a/doc/qtdesignstudio/config/qtdesignstudio.qdocconf b/doc/qtdesignstudio/config/qtdesignstudio.qdocconf index 72b38940f7..95d1475cf1 100644 --- a/doc/qtdesignstudio/config/qtdesignstudio.qdocconf +++ b/doc/qtdesignstudio/config/qtdesignstudio.qdocconf @@ -120,4 +120,9 @@ macro.function = "\\fn" macro.QMLD = "Qt Design Studio" navigation.landingpage = "$IDE_DISPLAY_NAME Manual" + +# Auto-generate navigation linking based on "All Topics": +navigation.toctitles = "All Topics" +navigation.toctitles.inclusive = false + buildversion = "$IDE_DISPLAY_NAME Manual $QTC_VERSION" diff --git a/doc/qtdesignstudio/examples/doc/FresnelExample.qdoc b/doc/qtdesignstudio/examples/doc/FresnelExample.qdoc new file mode 100644 index 0000000000..8dbc8bcfbf --- /dev/null +++ b/doc/qtdesignstudio/examples/doc/FresnelExample.qdoc @@ -0,0 +1,90 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page fresnel-effect-example.html + \ingroup studioexamples + + \title Fresnel Example + \brief Illustrates how to work with the fresnel effect. + + \image fresnel-example.webp + + The \e{Fresnel} example illustrates how to add and adjust a fresnel effect on + a 3D model. + + The fresnel effect affects how materials reflect light at different viewing angles. Imagine the + water on a lake. If you look down at the water from straight above, you can see through the + water, but if you look from a lower angle, the reflections are stronger. + + \image fresnel-angle.webp + + \section1 Running the Example + + To run the example in \QDS, go to the \uicontrol Welcome screen and select the example + from the \uicontrol Examples tab. + + \section1 The 3D Scene + + The example project consists of a basic 3D scene with the following components: + + \list + \li A 3D model. + \li A directional light. + \li An HDR image used to light the scene (image-based lighting). + \endlist + + \section1 The Material + + The material on the 3D model in this example is a principled material with a + clearcoat. + + \section2 Clearcoat + + A clearcoat is an additional specular layer applied to the surface of a material. The + clearcoating is transparent and doesn't add any color to the material, but it affects + how light interacts with the material. + + You adjust clearcoat properties independently from the base material. + + \section2 Fresnel Properties + + The following properties affect how the fresnel effect renders. These properties are + available both for the base material and the clearcoat layer. Adjusting the settings for the + clearcoat has a bigger visual effect. + + \table + \header + \li Property + \li Description + \row + \li Fresnel power + \li Increasing the fresnel power decreases the head-on reflections (steep viewing angle) + while maintaining the reflections seen from more shallow viewing angles. + \row + \li Enable scale and bias + \li Takes the scale and bias properties into account. + \row + \li Scale + \li Determines the rate of change in reflection intensity as the viewing angle varies. A + large scale value results in a gentler transition between weak and strong reflections, while + a smaller scale creates a more abrupt shift in reflection intensity. + \row + \li Bias + \li Controls the offset for the fresnel power property and determines how quickly the + reflection transitions from weak to strong as the viewing + angle changes. A larger bias value shifts the transition point toward steeper angles. + \endtable + + \section3 Adjusting the Fresnel Settings + + To adjust the settings: + + \list 1 + \li In \uicontrol {Material Browser}, double-click \e {Monkey Material}. + \li In \uicontrol {Material Editor}, find the properties under + \uicontrol {Clearcoat} and \uicontrol {Fresnel} respectively. + \endlist + + \note You see the changes live as you edit them in the \uicontrol 2D view. +*/ diff --git a/doc/qtdesignstudio/examples/doc/images/fresnel-angle.webp b/doc/qtdesignstudio/examples/doc/images/fresnel-angle.webp Binary files differnew file mode 100644 index 0000000000..2fe11380f0 --- /dev/null +++ b/doc/qtdesignstudio/examples/doc/images/fresnel-angle.webp diff --git a/doc/qtdesignstudio/examples/doc/images/fresnel-example.webp b/doc/qtdesignstudio/examples/doc/images/fresnel-example.webp Binary files differnew file mode 100644 index 0000000000..75436595aa --- /dev/null +++ b/doc/qtdesignstudio/examples/doc/images/fresnel-example.webp diff --git a/doc/qtdesignstudio/examples/doc/rainSnowParticles.qdoc b/doc/qtdesignstudio/examples/doc/rainSnowParticles.qdoc index 88dbd5fbdb..5cc040d427 100644 --- a/doc/qtdesignstudio/examples/doc/rainSnowParticles.qdoc +++ b/doc/qtdesignstudio/examples/doc/rainSnowParticles.qdoc @@ -41,7 +41,7 @@ Now you have added a particle system to your scene. - \image rain-snow-tutorial-particle-system + \image rain-snow-tutorial-particle-system.png \section2 Adjusting the Behavior and Apperance of the Particle System Next, you adjust the position, behavior, and apperance of the particle diff --git a/doc/qtdesignstudio/images/3d-view-context-menu.png b/doc/qtdesignstudio/images/3d-view-context-menu.png Binary files differdeleted file mode 100644 index 5b08c568cb..0000000000 --- a/doc/qtdesignstudio/images/3d-view-context-menu.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/3d-view-context-menu.webp b/doc/qtdesignstudio/images/3d-view-context-menu.webp Binary files differnew file mode 100644 index 0000000000..1b58f9bded --- /dev/null +++ b/doc/qtdesignstudio/images/3d-view-context-menu.webp diff --git a/doc/qtdesignstudio/images/camera-look-at-node.webp b/doc/qtdesignstudio/images/camera-look-at-node.webp Binary files differnew file mode 100644 index 0000000000..e5a92308a3 --- /dev/null +++ b/doc/qtdesignstudio/images/camera-look-at-node.webp diff --git a/doc/qtdesignstudio/images/edit-list-model-model-editor.webp b/doc/qtdesignstudio/images/edit-list-model-model-editor.webp Binary files differnew file mode 100644 index 0000000000..e7f47c6402 --- /dev/null +++ b/doc/qtdesignstudio/images/edit-list-model-model-editor.webp diff --git a/doc/qtdesignstudio/images/filesystem-view-design.webp b/doc/qtdesignstudio/images/filesystem-view-design.webp Binary files differnew file mode 100644 index 0000000000..8d59b85482 --- /dev/null +++ b/doc/qtdesignstudio/images/filesystem-view-design.webp diff --git a/doc/qtdesignstudio/images/icons/add_material.png b/doc/qtdesignstudio/images/icons/add_material.png Binary files differnew file mode 100644 index 0000000000..6ecb64a180 --- /dev/null +++ b/doc/qtdesignstudio/images/icons/add_material.png diff --git a/doc/qtdesignstudio/images/icons/add_texture.png b/doc/qtdesignstudio/images/icons/add_texture.png Binary files differnew file mode 100644 index 0000000000..8b94da637d --- /dev/null +++ b/doc/qtdesignstudio/images/icons/add_texture.png diff --git a/doc/qtdesignstudio/images/icons/camera_speed.png b/doc/qtdesignstudio/images/icons/camera_speed.png Binary files differnew file mode 100644 index 0000000000..6fcabb05c8 --- /dev/null +++ b/doc/qtdesignstudio/images/icons/camera_speed.png diff --git a/doc/qtdesignstudio/images/icons/easing-curve-spline.png b/doc/qtdesignstudio/images/icons/easing-curve-spline.png Binary files differnew file mode 100644 index 0000000000..d76bf15f21 --- /dev/null +++ b/doc/qtdesignstudio/images/icons/easing-curve-spline.png diff --git a/doc/qtdesignstudio/images/icons/easing-curve-spline-icon.png b/doc/qtdesignstudio/images/icons/easing-curve-unify.png Binary files differindex c5328bed8a..c5328bed8a 100644 --- a/doc/qtdesignstudio/images/icons/easing-curve-spline-icon.png +++ b/doc/qtdesignstudio/images/icons/easing-curve-unify.png diff --git a/doc/qtdesignstudio/images/icons/export.png b/doc/qtdesignstudio/images/icons/export.png Binary files differnew file mode 100644 index 0000000000..6d6f15bd4a --- /dev/null +++ b/doc/qtdesignstudio/images/icons/export.png diff --git a/doc/qtdesignstudio/images/icons/import.png b/doc/qtdesignstudio/images/icons/import.png Binary files differnew file mode 100644 index 0000000000..b4ca149761 --- /dev/null +++ b/doc/qtdesignstudio/images/icons/import.png diff --git a/doc/qtdesignstudio/images/icons/reverse_order.png b/doc/qtdesignstudio/images/icons/reverse_order.png Binary files differnew file mode 100644 index 0000000000..5e661b29cc --- /dev/null +++ b/doc/qtdesignstudio/images/icons/reverse_order.png diff --git a/doc/qtdesignstudio/images/material-editor-browser.webp b/doc/qtdesignstudio/images/material-editor-browser.webp Binary files differindex 160c96e877..1865bf8a54 100644 --- a/doc/qtdesignstudio/images/material-editor-browser.webp +++ b/doc/qtdesignstudio/images/material-editor-browser.webp diff --git a/doc/qtdesignstudio/images/materials-remove-material.png b/doc/qtdesignstudio/images/materials-remove-material.png Binary files differdeleted file mode 100644 index 9ef0a91e5b..0000000000 --- a/doc/qtdesignstudio/images/materials-remove-material.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/materials-remove-material.webp b/doc/qtdesignstudio/images/materials-remove-material.webp Binary files differnew file mode 100644 index 0000000000..64d1d19891 --- /dev/null +++ b/doc/qtdesignstudio/images/materials-remove-material.webp diff --git a/doc/qtdesignstudio/images/model-editor-new-model.webp b/doc/qtdesignstudio/images/model-editor-new-model.webp Binary files differnew file mode 100644 index 0000000000..6ea705a047 --- /dev/null +++ b/doc/qtdesignstudio/images/model-editor-new-model.webp diff --git a/doc/qtdesignstudio/images/navigator-material-texture.png b/doc/qtdesignstudio/images/navigator-material-texture.png Binary files differdeleted file mode 100644 index 849625e1eb..0000000000 --- a/doc/qtdesignstudio/images/navigator-material-texture.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/navigator-material-texture.webp b/doc/qtdesignstudio/images/navigator-material-texture.webp Binary files differnew file mode 100644 index 0000000000..5ac9152627 --- /dev/null +++ b/doc/qtdesignstudio/images/navigator-material-texture.webp diff --git a/doc/qtdesignstudio/images/open-documents-view.webp b/doc/qtdesignstudio/images/open-documents-view.webp Binary files differnew file mode 100644 index 0000000000..c3080b92b5 --- /dev/null +++ b/doc/qtdesignstudio/images/open-documents-view.webp diff --git a/doc/qtdesignstudio/images/projects-view-design.webp b/doc/qtdesignstudio/images/projects-view-design.webp Binary files differnew file mode 100644 index 0000000000..6fd1e6333c --- /dev/null +++ b/doc/qtdesignstudio/images/projects-view-design.webp diff --git a/doc/qtdesignstudio/images/qmldesigner-canvas-color.png b/doc/qtdesignstudio/images/qmldesigner-canvas-color.png Binary files differdeleted file mode 100644 index 6baef3eb90..0000000000 --- a/doc/qtdesignstudio/images/qmldesigner-canvas-color.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qmldesigner-canvas-color.webp b/doc/qtdesignstudio/images/qmldesigner-canvas-color.webp Binary files differnew file mode 100644 index 0000000000..3474076844 --- /dev/null +++ b/doc/qtdesignstudio/images/qmldesigner-canvas-color.webp diff --git a/doc/qtdesignstudio/images/qmldesigner-element-properties.png b/doc/qtdesignstudio/images/qmldesigner-element-properties.png Binary files differdeleted file mode 100644 index 0a8c4a1041..0000000000 --- a/doc/qtdesignstudio/images/qmldesigner-element-properties.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qmldesigner-element-properties.webp b/doc/qtdesignstudio/images/qmldesigner-element-properties.webp Binary files differnew file mode 100644 index 0000000000..a90062d6be --- /dev/null +++ b/doc/qtdesignstudio/images/qmldesigner-element-properties.webp diff --git a/doc/qtdesignstudio/images/qmldesigner-form-editor-move-cursor.png b/doc/qtdesignstudio/images/qmldesigner-form-editor-move-cursor.png Binary files differdeleted file mode 100644 index 018a94c88f..0000000000 --- a/doc/qtdesignstudio/images/qmldesigner-form-editor-move-cursor.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qmldesigner-form-editor-move-cursor.webp b/doc/qtdesignstudio/images/qmldesigner-form-editor-move-cursor.webp Binary files differnew file mode 100644 index 0000000000..a1b7f83e8d --- /dev/null +++ b/doc/qtdesignstudio/images/qmldesigner-form-editor-move-cursor.webp diff --git a/doc/qtdesignstudio/images/qmldesigner-form-editor.png b/doc/qtdesignstudio/images/qmldesigner-form-editor.png Binary files differdeleted file mode 100644 index f32f6965ba..0000000000 --- a/doc/qtdesignstudio/images/qmldesigner-form-editor.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qmldesigner-form-editor.webp b/doc/qtdesignstudio/images/qmldesigner-form-editor.webp Binary files differnew file mode 100644 index 0000000000..b360c5c241 --- /dev/null +++ b/doc/qtdesignstudio/images/qmldesigner-form-editor.webp diff --git a/doc/qtdesignstudio/images/qmldesigner-preview-size.png b/doc/qtdesignstudio/images/qmldesigner-preview-size.png Binary files differdeleted file mode 100644 index 1a4a5e01ee..0000000000 --- a/doc/qtdesignstudio/images/qmldesigner-preview-size.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qmldesigner-preview-size.webp b/doc/qtdesignstudio/images/qmldesigner-preview-size.webp Binary files differnew file mode 100644 index 0000000000..37f0c32ecf --- /dev/null +++ b/doc/qtdesignstudio/images/qmldesigner-preview-size.webp diff --git a/doc/qtdesignstudio/images/qmldesigner-snap-margins.png b/doc/qtdesignstudio/images/qmldesigner-snap-margins.png Binary files differdeleted file mode 100644 index 703ed8cc9a..0000000000 --- a/doc/qtdesignstudio/images/qmldesigner-snap-margins.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qmldesigner-snap-margins.webp b/doc/qtdesignstudio/images/qmldesigner-snap-margins.webp Binary files differnew file mode 100644 index 0000000000..c6ea462063 --- /dev/null +++ b/doc/qtdesignstudio/images/qmldesigner-snap-margins.webp diff --git a/doc/qtdesignstudio/images/qmldesigner-transition-editor-startup.png b/doc/qtdesignstudio/images/qmldesigner-transition-editor-startup.png Binary files differdeleted file mode 100644 index d269470e0d..0000000000 --- a/doc/qtdesignstudio/images/qmldesigner-transition-editor-startup.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qmldesigner-transition-editor-startup.webp b/doc/qtdesignstudio/images/qmldesigner-transition-editor-startup.webp Binary files differnew file mode 100644 index 0000000000..a246e48411 --- /dev/null +++ b/doc/qtdesignstudio/images/qmldesigner-transition-editor-startup.webp diff --git a/doc/qtdesignstudio/images/qmldesigner-transitions.webp b/doc/qtdesignstudio/images/qmldesigner-transitions.webp Binary files differnew file mode 100644 index 0000000000..ca4aae53ff --- /dev/null +++ b/doc/qtdesignstudio/images/qmldesigner-transitions.webp diff --git a/doc/qtdesignstudio/images/qmldesigner-zooming.gif b/doc/qtdesignstudio/images/qmldesigner-zooming.gif Binary files differindex d8d5beb6b3..82de8223be 100644 --- a/doc/qtdesignstudio/images/qmldesigner-zooming.gif +++ b/doc/qtdesignstudio/images/qmldesigner-zooming.gif diff --git a/doc/qtdesignstudio/images/qtquick-assets-tab.png b/doc/qtdesignstudio/images/qtquick-assets-tab.png Binary files differdeleted file mode 100644 index 11c4fe54b4..0000000000 --- a/doc/qtdesignstudio/images/qtquick-assets-tab.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qtquick-assets-tab.webp b/doc/qtdesignstudio/images/qtquick-assets-tab.webp Binary files differnew file mode 100644 index 0000000000..2e65a7edd9 --- /dev/null +++ b/doc/qtdesignstudio/images/qtquick-assets-tab.webp diff --git a/doc/qtdesignstudio/images/qtquick-designer-rotating-items.png b/doc/qtdesignstudio/images/qtquick-designer-rotating-items.png Binary files differdeleted file mode 100644 index f20669be4e..0000000000 --- a/doc/qtdesignstudio/images/qtquick-designer-rotating-items.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qtquick-designer-rotating-items.webp b/doc/qtdesignstudio/images/qtquick-designer-rotating-items.webp Binary files differnew file mode 100644 index 0000000000..17a3a664c0 --- /dev/null +++ b/doc/qtdesignstudio/images/qtquick-designer-rotating-items.webp diff --git a/doc/qtdesignstudio/images/qtquick-designer-scaling-items.png b/doc/qtdesignstudio/images/qtquick-designer-scaling-items.png Binary files differdeleted file mode 100644 index 891915dae8..0000000000 --- a/doc/qtdesignstudio/images/qtquick-designer-scaling-items.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qtquick-designer-scaling-items.webp b/doc/qtdesignstudio/images/qtquick-designer-scaling-items.webp Binary files differnew file mode 100644 index 0000000000..cabbd7e02a --- /dev/null +++ b/doc/qtdesignstudio/images/qtquick-designer-scaling-items.webp diff --git a/doc/qtdesignstudio/images/qtquick-item-properties-common.png b/doc/qtdesignstudio/images/qtquick-item-properties-common.png Binary files differdeleted file mode 100644 index 6311b1ce58..0000000000 --- a/doc/qtdesignstudio/images/qtquick-item-properties-common.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qtquick-item-properties-common.webp b/doc/qtdesignstudio/images/qtquick-item-properties-common.webp Binary files differnew file mode 100644 index 0000000000..5177534146 --- /dev/null +++ b/doc/qtdesignstudio/images/qtquick-item-properties-common.webp diff --git a/doc/qtdesignstudio/images/qtquick-library-context-menu.png b/doc/qtdesignstudio/images/qtquick-library-context-menu.png Binary files differdeleted file mode 100644 index f611ea6f1c..0000000000 --- a/doc/qtdesignstudio/images/qtquick-library-context-menu.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qtquick-library-context-menu.webp b/doc/qtdesignstudio/images/qtquick-library-context-menu.webp Binary files differnew file mode 100644 index 0000000000..32fce38c93 --- /dev/null +++ b/doc/qtdesignstudio/images/qtquick-library-context-menu.webp diff --git a/doc/qtdesignstudio/images/qtquick-transition-editor-settings.png b/doc/qtdesignstudio/images/qtquick-transition-editor-settings.png Binary files differdeleted file mode 100644 index a0fef65a51..0000000000 --- a/doc/qtdesignstudio/images/qtquick-transition-editor-settings.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qtquick-transition-editor-settings.webp b/doc/qtdesignstudio/images/qtquick-transition-editor-settings.webp Binary files differnew file mode 100644 index 0000000000..71734e3eaa --- /dev/null +++ b/doc/qtdesignstudio/images/qtquick-transition-editor-settings.webp diff --git a/doc/qtdesignstudio/images/qtquick-transition-editor-view.png b/doc/qtdesignstudio/images/qtquick-transition-editor-view.png Binary files differdeleted file mode 100644 index 3d747783af..0000000000 --- a/doc/qtdesignstudio/images/qtquick-transition-editor-view.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qtquick-transition-editor-view.webp b/doc/qtdesignstudio/images/qtquick-transition-editor-view.webp Binary files differnew file mode 100644 index 0000000000..b409b5d57f --- /dev/null +++ b/doc/qtdesignstudio/images/qtquick-transition-editor-view.webp diff --git a/doc/qtdesignstudio/images/repeater3d-listmodel-navigator.png b/doc/qtdesignstudio/images/repeater3d-listmodel-navigator.png Binary files differindex f4b3093bbb..302d7d397a 100644 --- a/doc/qtdesignstudio/images/repeater3d-listmodel-navigator.png +++ b/doc/qtdesignstudio/images/repeater3d-listmodel-navigator.png diff --git a/doc/qtdesignstudio/images/repeater3d-model-editor.webp b/doc/qtdesignstudio/images/repeater3d-model-editor.webp Binary files differnew file mode 100644 index 0000000000..e0e6087366 --- /dev/null +++ b/doc/qtdesignstudio/images/repeater3d-model-editor.webp diff --git a/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.webp b/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.webp Binary files differindex d0a13907e5..c1388d72ed 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.webp +++ b/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.webp diff --git a/doc/qtdesignstudio/images/studio-3d-editor-move.webp b/doc/qtdesignstudio/images/studio-3d-editor-move.webp Binary files differindex d2ff9b9aac..ac40c5cf1a 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-move.webp +++ b/doc/qtdesignstudio/images/studio-3d-editor-move.webp diff --git a/doc/qtdesignstudio/images/studio-3d-editor-rotate.webp b/doc/qtdesignstudio/images/studio-3d-editor-rotate.webp Binary files differindex 7cd8fe1bf6..368a2d57fd 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-rotate.webp +++ b/doc/qtdesignstudio/images/studio-3d-editor-rotate.webp diff --git a/doc/qtdesignstudio/images/studio-3d-editor-scale.webp b/doc/qtdesignstudio/images/studio-3d-editor-scale.webp Binary files differindex be0270d34b..6523539449 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-scale.webp +++ b/doc/qtdesignstudio/images/studio-3d-editor-scale.webp diff --git a/doc/qtdesignstudio/images/studio-3d-editor.webp b/doc/qtdesignstudio/images/studio-3d-editor.webp Binary files differindex 903ad69b25..2218505917 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor.webp +++ b/doc/qtdesignstudio/images/studio-3d-editor.webp diff --git a/doc/qtdesignstudio/images/studio-3d-properties-type.png b/doc/qtdesignstudio/images/studio-3d-properties-type.png Binary files differdeleted file mode 100644 index c0363d0233..0000000000 --- a/doc/qtdesignstudio/images/studio-3d-properties-type.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-3d-properties-type.webp b/doc/qtdesignstudio/images/studio-3d-properties-type.webp Binary files differnew file mode 100644 index 0000000000..7f353ff655 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-3d-properties-type.webp diff --git a/doc/qtdesignstudio/images/studio-3d-scene-environment-ambient-occlusion.webp b/doc/qtdesignstudio/images/studio-3d-scene-environment-ambient-occlusion.webp Binary files differnew file mode 100644 index 0000000000..91e01bc809 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-3d-scene-environment-ambient-occlusion.webp diff --git a/doc/qtdesignstudio/images/studio-3d-scene-environment-antialiasing.webp b/doc/qtdesignstudio/images/studio-3d-scene-environment-antialiasing.webp Binary files differnew file mode 100644 index 0000000000..a8cae264d3 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-3d-scene-environment-antialiasing.webp diff --git a/doc/qtdesignstudio/images/studio-3d-scene-environment-image-based-lighting.webp b/doc/qtdesignstudio/images/studio-3d-scene-environment-image-based-lighting.webp Binary files differnew file mode 100644 index 0000000000..d5a9da81fb --- /dev/null +++ b/doc/qtdesignstudio/images/studio-3d-scene-environment-image-based-lighting.webp diff --git a/doc/qtdesignstudio/images/studio-3d-scene-environment-light-probe.png b/doc/qtdesignstudio/images/studio-3d-scene-environment-light-probe.png Binary files differdeleted file mode 100644 index 7a062a2a36..0000000000 --- a/doc/qtdesignstudio/images/studio-3d-scene-environment-light-probe.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-3d-scene-environment-properties.png b/doc/qtdesignstudio/images/studio-3d-scene-environment-properties.png Binary files differdeleted file mode 100644 index 353e0c3584..0000000000 --- a/doc/qtdesignstudio/images/studio-3d-scene-environment-properties.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-3d-scene-environment-properties.webp b/doc/qtdesignstudio/images/studio-3d-scene-environment-properties.webp Binary files differnew file mode 100644 index 0000000000..bb3e62d716 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-3d-scene-environment-properties.webp diff --git a/doc/qtdesignstudio/images/studio-3d-split-view.webp b/doc/qtdesignstudio/images/studio-3d-split-view.webp Binary files differindex 630fdb48fe..aec301c91f 100644 --- a/doc/qtdesignstudio/images/studio-3d-split-view.webp +++ b/doc/qtdesignstudio/images/studio-3d-split-view.webp diff --git a/doc/qtdesignstudio/images/studio-curve-editor.png b/doc/qtdesignstudio/images/studio-curve-editor.png Binary files differdeleted file mode 100644 index 01cd7f5ab4..0000000000 --- a/doc/qtdesignstudio/images/studio-curve-editor.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-curve-editor.webp b/doc/qtdesignstudio/images/studio-curve-editor.webp Binary files differnew file mode 100644 index 0000000000..79624624d1 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-curve-editor.webp diff --git a/doc/qtdesignstudio/images/studio-ext-scene-environment.webp b/doc/qtdesignstudio/images/studio-ext-scene-environment.webp Binary files differnew file mode 100644 index 0000000000..cc26498c95 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-ext-scene-environment.webp diff --git a/doc/qtdesignstudio/images/studio-flow-item.png b/doc/qtdesignstudio/images/studio-flow-item.png Binary files differdeleted file mode 100644 index 905174d600..0000000000 --- a/doc/qtdesignstudio/images/studio-flow-item.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-flow-item.webp b/doc/qtdesignstudio/images/studio-flow-item.webp Binary files differnew file mode 100644 index 0000000000..1b3c54d818 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-flow-item.webp diff --git a/doc/qtdesignstudio/images/studio-flow-view-properties.png b/doc/qtdesignstudio/images/studio-flow-view-properties.png Binary files differdeleted file mode 100644 index 95fe403b76..0000000000 --- a/doc/qtdesignstudio/images/studio-flow-view-properties.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-flow-view-properties.webp b/doc/qtdesignstudio/images/studio-flow-view-properties.webp Binary files differnew file mode 100644 index 0000000000..7592e57954 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-flow-view-properties.webp diff --git a/doc/qtdesignstudio/images/studio-project-wizards.png b/doc/qtdesignstudio/images/studio-project-wizards.png Binary files differdeleted file mode 100644 index 3a329bd16e..0000000000 --- a/doc/qtdesignstudio/images/studio-project-wizards.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-project-wizards.webp b/doc/qtdesignstudio/images/studio-project-wizards.webp Binary files differnew file mode 100644 index 0000000000..fcb7c22ff0 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-project-wizards.webp diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-components.png b/doc/qtdesignstudio/images/studio-qtquick-3d-components.png Binary files differdeleted file mode 100644 index 25974ab326..0000000000 --- a/doc/qtdesignstudio/images/studio-qtquick-3d-components.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-components.webp b/doc/qtdesignstudio/images/studio-qtquick-3d-components.webp Binary files differnew file mode 100644 index 0000000000..54be760fd2 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-qtquick-3d-components.webp diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-view.png b/doc/qtdesignstudio/images/studio-qtquick-3d-view.png Binary files differdeleted file mode 100644 index 9c0e8fc82b..0000000000 --- a/doc/qtdesignstudio/images/studio-qtquick-3d-view.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-view.webp b/doc/qtdesignstudio/images/studio-qtquick-3d-view.webp Binary files differnew file mode 100644 index 0000000000..7351317e10 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-qtquick-3d-view.webp diff --git a/doc/qtdesignstudio/images/studio-qtquick-camera-properties.webp b/doc/qtdesignstudio/images/studio-qtquick-camera-properties.webp Binary files differnew file mode 100644 index 0000000000..e54afe807e --- /dev/null +++ b/doc/qtdesignstudio/images/studio-qtquick-camera-properties.webp diff --git a/doc/qtdesignstudio/images/studio-timeline-empty.png b/doc/qtdesignstudio/images/studio-timeline-empty.png Binary files differdeleted file mode 100644 index 861a1021bb..0000000000 --- a/doc/qtdesignstudio/images/studio-timeline-empty.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-timeline-empty.webp b/doc/qtdesignstudio/images/studio-timeline-empty.webp Binary files differnew file mode 100644 index 0000000000..16aa728a52 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-timeline-empty.webp diff --git a/doc/qtdesignstudio/images/texture-editor.png b/doc/qtdesignstudio/images/texture-editor.png Binary files differdeleted file mode 100644 index e8eecbd13b..0000000000 --- a/doc/qtdesignstudio/images/texture-editor.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/texture-editor.webp b/doc/qtdesignstudio/images/texture-editor.webp Binary files differnew file mode 100644 index 0000000000..092a6f0dab --- /dev/null +++ b/doc/qtdesignstudio/images/texture-editor.webp diff --git a/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc b/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc index 34140b8894..7fb95a9880 100644 --- a/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc +++ b/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -26,7 +26,7 @@ \li Group \li \l{Organizing Components} \row - \li Position + \li Positioner \li \l{Using Positioners} \row \li Layout @@ -53,8 +53,8 @@ \li Move Component Instances into Separate Files \li \l{Turning Component Instances into Custom Components} \row - \li Add New Signal Handler - \li \l{Adding Signal Handlers} + \li Connecting Components to Signals + \li \l{Connecting Components to Signals in the Connection View} \row \li Go to Implementation \li \l{Using UI Files} diff --git a/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc b/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc index 400e264d02..b93b745bc2 100644 --- a/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc @@ -142,17 +142,17 @@ To edit list models: \list 1 - \li Drag-and-drop a \uicontrol {Grid View} or \uicontrol {List View} + \li Drag a \uicontrol {Grid View} or \uicontrol {List View} from \uicontrol Components > \uicontrol {Default Components} > \uicontrol Views to the \uicontrol Navigator or \uicontrol {2D} view. \li Right-click the view in \uicontrol Navigator, and select - \uicontrol {Edit List Model} in the context-menu to open - the list model editor: - \image qtquick-designer-edit-list-model.png "List view in model editor" - \li Double-click the column headings and cells to change their values. - \li Use the toolbar buttons to add, remove, or move rows and columns. - In a list, each column represents a property and each row adds a + \uicontrol {Edit Model} in the context-menu to open the + \uicontrol {Model Editor} view. + \image edit-list-model-model-editor.webp "List view in Model Editor" + \li Double-click a cell to edit its value. + \li Use the toolbar buttons to add or remove rows and columns. + In a list, each column represents a property, and each row adds a list item. \endlist diff --git a/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc b/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc index 19ee8e60dd..4920cf582d 100644 --- a/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -58,7 +58,7 @@ \li \l {Custom Effects and Materials} \li \l {Lights} \li \l {Cameras} - \li \l {Scene Environment} + \li \l {Scene Environments} \li \l {Morph Target} \li \l {Repeater3D} \li \l {Loader3D} diff --git a/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc b/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc index 0a6531fe12..e8c6c8e329 100644 --- a/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc +++ b/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc @@ -10,7 +10,7 @@ \note In this section, you are using advanced menu items. These are not visible by default. To toggle the visibility of advanced menu items, see - \l{Customizing the Menu}. + \l{Customizing the Menu Bar}. \QDS enables designers and developers to work together on common projects to develop applications. Designers use the \l{Design Views}{views} @@ -46,7 +46,7 @@ \li Select \uicontrol {File} > \uicontrol {Export Project} > \uicontrol {Generate CMake Build Files}. \image studio-project-export.webp "Export the \QDS project for Qt Creator" - \li Select \uicontrol {Details} to access the \l {Advanced Options}. + \li Select \uicontrol {Details} to access the \uicontrol {Advanced Options}. \image studio-project-export-advanced.webp "Access Advanced Options in the project exporter" \note The project exporter has default settings selected. This works better if the project @@ -68,7 +68,7 @@ After exporting the project from the \QDS, you have to open it from Qt Creator. If you have used any version before \QDS 4.0 to create the project, manually include this code - in the \l {CMakeLists.txt} file so the exported project works in Qt Creator. + in the \e {CMakeLists.txt} file so the exported project works in Qt Creator. \code set(BUILD_QDS_COMPONENTS ON CACHE BOOL "Build design studio components") @@ -83,6 +83,6 @@ \endcode \note If you have created the project with the \QDS version 4.0 or above, you already have this code in - \l {CMakeLists.txt} by default. + \e {CMakeLists.txt} by default. */ diff --git a/doc/qtdesignstudio/src/mcus/qtdesignstudio-compatibility-with-mcu-sdks.qdoc b/doc/qtdesignstudio/src/mcus/qtdesignstudio-compatibility-with-mcu-sdks.qdoc index de94f59d80..0e833cead1 100644 --- a/doc/qtdesignstudio/src/mcus/qtdesignstudio-compatibility-with-mcu-sdks.qdoc +++ b/doc/qtdesignstudio/src/mcus/qtdesignstudio-compatibility-with-mcu-sdks.qdoc @@ -16,10 +16,16 @@ \li \QDS Version \li \QMCU SDK Version \row - \li 4.3 or later - \li 2.6 or later + \li 4.5 or later + \li 2.8 or later \row - \li 4.2 or later + \li 4.4 + \li 2.7 + \row + \li 4.3 + \li 2.6 + \row + \li 4.2 \li 2.5 \row \li 4.0 up to 4.1 diff --git a/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc index a5e05f8beb..1ea19bac4b 100644 --- a/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc @@ -84,7 +84,7 @@ \li \l{Connecting Components to Signals} \row \li Formatting connections - \li \l{Adding Actions and Assignments} + \li \l{Actions and Conditions} \row \li Dynamically changing the behavior of a component \li \l{Adding Bindings Between Properties} diff --git a/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc index f9ae3b8d7b..f083f85f8e 100644 --- a/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc @@ -10,7 +10,7 @@ \note In this section, you are using advanced menu items. These are not visible by default. To toggle the visibility of advanced menu items, see - \l{Customizing the Menu}. + \l{Customizing the Menu Bar}. \l{glossary-component}{Components} contained in \l{UI Files} {UI files} (.ui.qml) can be exported to JSON metadata format and PNG assets. diff --git a/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc index 3cf0c1336b..937362450b 100644 --- a/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc @@ -21,7 +21,7 @@ \endlist For more useful information for application developers, see - \l {Performance Considerations And Suggestions}. + \l {QML Performance Considerations And Suggestions}. For more information about optimizing 3D scenes, see \l{Creating Optimized 3D Scenes}. diff --git a/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc index fcf1a4c455..068a7c140b 100644 --- a/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc @@ -28,7 +28,7 @@ to upload the draw primitives to the graphics hardware. The frames-per-second (FPS) refresh rate of animations is displayed in the - \uicontrol FPS field on the \l{Summary of Main Toolbar Actions}{toolbar} + \uicontrol FPS field on the toolbar in the \uicontrol Design mode. To improve the FPS rate, application developers should: diff --git a/doc/qtdesignstudio/src/qtdesignstudio-app-flows.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-app-flows.qdoc index 05906cba86..2c7564fe86 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-app-flows.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-app-flows.qdoc @@ -66,8 +66,11 @@ \title Adding Flow Views - You can add a flow view to an existing project or create a new project - for it, as described in \l {Creating Projects}. + A flow view is the base component of the flow diagram that you can use to wireframe + the UI of your application. For more information, see \l{Designing Application Flows}. + + Add a flow view to an existing project or create a new project for it, as described in + \l {Creating Projects}. To create the flow view, select \uicontrol File > \uicontrol {New File} > @@ -76,24 +79,18 @@ \image studio-flow-view-create.png "Create Flow View wizard template" - You only need to select the \uicontrol {Use Event Simulator} check box if - you want to add an event simulator to the flow view. The event simulator - needs the project to be imported to the flow view, so you also need - to select the \uicontrol {Use Application Import} check box. You need the + If you want to add an event simulator to the flow view, select the + \uicontrol {Use Event Simulator} checkbox. In this case, select also the + \uicontrol {Use Application Import} checkbox to import the project to the flow view + as the event simulator requires it to work correctly. You need the import also for access to the project \c Constants.qml file that contains - global settings for the project. - - The flow view properties enable you to adjust the appearance of all - the items in the flow: action areas, transition lines, decisions, and - wildcards. You can change the global settings for all items by editing - flow view properties, or you can select an individual action area or - transition line and change the appearance of just that component, including - the color, line thickness, dotted or solid lines, and even the curve of - the line. This enables you to add extra semantics to the design - of the flow diagram itself. + global settings for the project. For more information, see \l {Simulating Events}. - You can \l{Adding Flow Items}{add flow items} to the flow view to design - the UI. + You can adjust the appearance of all the items in the flow: action areas, + transition lines, decisions, and wildcards. Change the global settings for all items + by editing the flow view properties. To add additional semantics to the flow diagram + design, select an individual action area or transition line and change the appearance + of just that component. \section1 Flow View Properties @@ -102,12 +99,12 @@ \l Visibility sections in the \l Properties view. Specify flow view properties in the \uicontrol {Flow View} section. - \image studio-flow-view-properties.png "Flow View component properties" + \image studio-flow-view-properties.webp "Flow View component properties" To specify the \uicontrol {Flow Item} that is currently visible in the flow view, set its index in the \uicontrol {Current index} field. - You can use the \l{Picking Colors}{color picker} to set colors for: + Use the \l{Picking Colors}{color picker} to set colors for: \list \li Transition lines @@ -133,9 +130,6 @@ area or transition line, see \l{Flow Action Area Properties} and \l{Flow Transition Properties}. - In the \uicontrol Layout tab, you can use \l{Setting Anchors and Margins} - {anchors} to position the component. - In the \uicontrol Advanced section, you can manage the more \l{Specifying Developer Properties}{advanced properties} of components. @@ -148,29 +142,26 @@ \title Adding Flow Items - After you create a \l{Adding Flow Views}{Flow View} component, you can - use a project wizard template to add a \uicontrol {Flow Item} component - for each screen in the UI. + After you create a \l{Adding Flow Views}{Flow View} component, use a project wizard + template to add a \uicontrol {Flow Item} component for each screen in the UI. If you \l{Importing 2D Assets}{imported} your screen designs from a design tool as individual \l{glossary-component}{components} - (\e {.ui.qml} files), you can use them as content for flow items. + (\e {.ui.qml} files), you can use them as content for flow items like any other components. The imported components are listed in \uicontrol Components > \uicontrol {My Components}. - If you are building your UI from scratch in \QDS, you must first add - components to the flow items to create the screens as you would any - components. For more information, see \l {Using Components}. The - flow items that you attach the components to are listed under + If you are building your UI from scratch in \QDS, add components to the flow items + first to create the screens as you would any components. For more information, see + \l {Using Components}. The flow items that you attach the components to are listed under \uicontrol {My Components}. - \image studio-flow-item.png "Custom Flow Item in Components" + \image studio-flow-item.webp "Custom Flow Item in Components" \note You must use the wizard to create the flow items. After you create a flow view, the \uicontrol {Flow View} module is added to - \uicontrol Components. It contains a \uicontrol {Flow Item} component that - you can use to \l{Applying States in Flows}{apply states to flow items}, and - that you should use solely for that purpose. + \uicontrol Components. It contains the \uicontrol {Flow Item} component for + \l{Applying States in Flows}{applying states to flow items}, and solely for that purpose. To add flow items: @@ -181,7 +172,7 @@ to create flow items for each screen in the UI. \li Add content to the flow item in one of the following ways: \list - \li Drag-and-drop components from \uicontrol Components to a + \li Drag components from \uicontrol Components to a flow item in the \l {2D} view or \l Navigator. \li Drag a screen from \uicontrol Components > \uicontrol {My Components} to a flow item in @@ -190,10 +181,9 @@ \li In \l Properties, edit the properties of each flow item. \endlist - You can now drag the flow items from \uicontrol Components - > \uicontrol {My Components} to the flow view in the \uicontrol {2D} - or \uicontrol Navigator view. When you have all the flow items in place, you can - \l{Adding Action Areas and Transitions}{add action areas} to them to create + Now, drag the flow items from \uicontrol Components > \uicontrol {My Components} to the + flow view in the \uicontrol {2D} or \uicontrol Navigator view. When you have all the flow + items in place, \l{Adding Action Areas and Transitions}{add action areas} to them to create transitions between them. \section1 Flow Item Properties @@ -209,23 +199,20 @@ properties are used to \l{Applying States in Flows}{apply states} in flows. - To include another flow view into a flow view, select the UI file (.ui.qml) + To include another flow view as a flow item into a flow view, select the UI file (.ui.qml) that specifies the flow view in the \uicontrol {Loader source} field. Usually, a flow item is inactive and invisible when it is not currently selected in the flow. Especially, all events from the flow item are ignored. To make a flow item always active, so that another flow item within it can respond to events and trigger the opening of a dialog, for example, - select the \uicontrol {Force active} check box. + select the \uicontrol {Force active} checkbox. - By default, transitions are drawn from action areas to the target flow item. + In the flow view, transitions are drawn from action areas to the target flow item by default. To draw the transitions from the edges of flow items instead, select the - \uicontrol {Join lines} check box in the \uicontrol {Transition Lines} + \uicontrol {Join lines} checkbox in the \uicontrol {Transition Lines} section. - In the \uicontrol Layout tab, you can use \l{Setting Anchors and Margins} - {anchors} to position the component. - In the \uicontrol Advanced section, you can manage the more \l{Specifying Developer Properties}{advanced properties} of components. */ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-faq.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-faq.qdoc deleted file mode 100644 index 8f7267e0d3..0000000000 --- a/doc/qtdesignstudio/src/qtdesignstudio-faq.qdoc +++ /dev/null @@ -1,139 +0,0 @@ -// Copyright (C) 2021 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only - -/*! - \previouspage creator-how-to-get-help.html - \page studio-faq.html - \nextpage studio-platforms.html - - \title Frequently Asked Questions - - This section contains answers to some frequently asked questions about \QDS - grouped by categories. You might also find answers to your questions in the - product documentation by searching or browsing the index in the - \l{Get help}{Help mode}. Many questions are also answered by the - \l{Examples}{examples} and \l{Tutorials}{video tutorials}. - - \list - \li \l {FAQ - \QB}{\QB} - \li \l {FAQ - Assets}{Assets} - \li \l {FAQ - Components}{Components} - \li \l {FAQ - Views}{Views} - \li \l {FAQ - Integration Between \QDS and Qt Creator}{Integration Between \QDS and Qt Creator} - \li \l {FAQ - Performance}{Performance} - \li \l {FAQ - Data Simulation}{Data Simulation} - \endlist - - \section1 FAQ - \QB - - \section2 How does \QBPS differ from \QBSK and \QBF? - - \QBPS, \QBSK, and \QBF are functionally similar. The biggest difference - between the tools is that \QBSK and \QBF can export .svg (vector), .png, and - .jpeg files, while \QBPS only supports .png and .jpeg. Adobe Illustrator - users can port their designs into Photoshop, but they must be rasterized - into \e {smart objects}. - - For more information, see \l {Exporting from Design Tools}. - - \section2 Do I need to copy the .qml files in the resource folder after each design modification? - - No you don't. When you add new or modified .metadata files to your project - from Photoshop, \QBPS, \QBSK, or \QBF, select the \uicontrol {Merge QML} - check box in the \uicontrol {Asset Import} dialog to merge the changes into - existing QML files instead of overwriting them. - - For more information, see \l {Importing 2D Assets}. - - \section2 Where can I find log files generated by \QB while exporting metadata? - - On Windows, the logs are stored inside the temp folder in - \c {C:\Users\<USERNAME>\AppData\Local\Temp}. The log files are named as - \e csxs<versionNumber>-<HostID>.log. Please note that you might have to set - the log level to generate logs. Also note the CEP version while setting the - log level. The CEP version depends on the Photoshop version you are using. - Currently the latest version is version 10. - - \section1 FAQ - Assets - - \section2 Can I import my organization's preferred font in \QDS? - - Yes, you can import your custom fonts, for example, in .ttf or .otf formats. - Fonts installed on your system will be available to use in your imported - designs. If you need to deploy the device, you will have to import the font - into the project. - - For more information, see \l {Using Custom Fonts}. - - \section1 FAQ - Components - - \section2 Can I use custom components? - - Yes, you can create custom components and controls by using wizard templates - or move component instances into separate files to turn them into new - components that you can create instances of. For more information, see - \l {Using Components}. - - \section2 What are the 3D import formats for \QDS? - - You can import files stored in several widely-used formats, such as .fbx, - .obj, .gltf, .glb, .blend, .dae, .uia, and .uip. - - For more information, see \l {Importing 3D Assets}. - - \section2 How can I integrate custom C++ components into QDS? - - You must create your own QML module that contains the components and - provides additional information about your components. For more information, - see \l {Using QML Modules with Plugins}. - - \section1 FAQ - Views - - \section2 What are the keyboard shortcuts for moving around in the \uicontrol{3D} view? - - \list - \li To pan: \key Alt + middle mouse button - \li To orbit (rotate): \key Alt (or \key Option on \macos) + left mouse button - \li To zoom: \key Alt + right mouse button - \endlist - - For more information, see the \l {3D} view. - - \section1 FAQ - Integration Between \QDS and Qt Creator - - \section2 Can I automatically propagate name changes between \QDS and Qt Creator? - - Unfortunately we do not automate renaming files between tools at the moment. - If you decide to change the name of a property, alias, or signal in \QDS, - you need to manually change the name in Qt Creator to maintain the connection. - However, you can rename symbols in all files within a project. To rename a - QML type in a project, select \uicontrol Tools > \uicontrol QML/JS > - \uicontrol {Rename Symbol Under Cursor} or press \key Ctrl+Shift+R. For more - information, see \l {Rename symbols}. - - \section2 How can I add .qml files to my project in Qt Creator? - - Use the project wizard templates to create an application in \QDS and copy - your .qml files to the project folder. Then make some changes to the project - configuration and source files, as instructed in - \l {Converting UI Projects to Applications}. - - \section1 FAQ - Performance - - \section2 Will my application with 3D components run at 60 FPS? - - With the ability to test the full (2D/3D) UI in \QDS on target hardware, - you will quickly be able to determine if a 3D object is causing performance - issues using the \uicontrol FPS field in the \uicontrol Design mode. - \uicontrol FPS displays the frames-per-second (FPS) refresh rate of - previewed animations. - - See \l {Optimizing Your 3D Scene} to learn how you can enhance the - performance by optimizing your scene. - - \section1 FAQ - Data Simulation - - \section2 Can I automatically generate dummy data? - No, this is not supported at the moment. For more information about creating - the data manually, see \l {Loading Placeholder Data}. - */ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-finding-qt-runtime-version.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-finding-qt-runtime-version.qdoc index cb9c7e86e9..5f2bc9bdad 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-finding-qt-runtime-version.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-finding-qt-runtime-version.qdoc @@ -34,5 +34,8 @@ \row \li 4.4 \li 6.6.2 + \row + \li 4.5 + \li 6.7.0 (with additional Quick3D features) \endtable */ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc index be9e6b4ed5..36fbc8c015 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc @@ -11,8 +11,7 @@ \table \row \li \image qds-front-help.png - \li Learn more about using the \uicontrol Help mode, frequently - asked questions, and supported platforms. + \li Learn more about using the \uicontrol Help mode and supported platforms. \endtable \list @@ -23,9 +22,6 @@ and index functions to find particular topics in the helps, or request context-sensitive help by pressing \key F1 in the Design mode. - \li \l{Frequently Asked Questions} - - Contains answers to some frequently asked questions about \QDS. \li \l{Supported Platforms} You can install and run \QDS on several operating systems to design diff --git a/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc index 1e426f011e..4158a7b545 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc @@ -10,7 +10,7 @@ \note In this section, you are using advanced menu items. These are not visible by default. To toggle the visibility of advanced menu items, see - \l{Customizing the Menu}. + \l{Customizing the Menu Bar}. When you are ready to deliver your application to users or upload it to app stores, you can use \QDS to create suitable packages that contain all diff --git a/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc index 5a50eb2bf4..501e30adc7 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -11,20 +11,20 @@ You can install and run \QDS on several operating systems to create applications for multiple desktop, embedded, and mobile device platforms. - \section1 Development Platforms + \section1 Host Platforms \QDS is available in binary packages for the following operating systems: \list - \li \macOS 11.0 - \li Linux: - \list - \li CentOS 8.1 - \li openSUSE Leap 15.1 - \li SUSE Linux Enterprise Server 15 (SLES 15) - \li Ubuntu 20.04 - \endlist - \li Windows 10, version 2004 + \li Windows 11 + \li Windows 10 64-bit + \li \macOS 12, 13 + \list + \li ARM-based Mac + \li Intel Mac + \endlist + \li Linux Ubuntu 22.04 (latest LTS) + \li Linux Ubuntu 20.04 \endlist \note For a good user experience on Windows 10, we recommend the following @@ -36,9 +36,9 @@ \QB is available for the following design tools: \list - \li Adobe Photoshop version 24.0 - \li Adobe XD version 55.0.12 - \li Figma version 116.4 - \li Sketch version 90.0 + \li Adobe Photoshop 25.0 + \li Adobe XD 57.1.12.2 + \li Figma 116.15.15 + \li Sketch 99.1 \endlist */ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc index 3daf6e7089..46b2ac8fbb 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc @@ -37,7 +37,7 @@ \li \li Lists your most recently used presets. \row - \li {1,2} General + \li {1,3} General \li Empty \li Creates a project that uses default components such as rectangles, images, and text. You can run the application on all target @@ -47,6 +47,11 @@ \li Creates a project that uses default and 3D components such as cameras, lights, 3D models, and materials. \row + \li 3D Extended + \li Creates a project that uses default and 3D components, such as + camera, light, model and materials. Extended scene environment is + also included to enable various built-in effects. + \row \li \QMCU \li MCU \li Creates an application that uses a subset of default components @@ -77,7 +82,7 @@ \note This tab is not visible if there are no saved custom presets. \endtable - \image studio-project-wizards.png "The Create Project wizard" + \image studio-project-wizards.webp "The Create Project wizard" To test how well your designs work, you can preview the UIs on the desktop, embedded Linux devices, or Android devices. For more diff --git a/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc index 9c517f9846..70ff56517c 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc @@ -30,7 +30,7 @@ An \e asset is an image, font file, 3D model, or other supported file that you add to your \l{glossary-project}{project}. - \image qtquick-assets-tab.png "Assets" + \image qtquick-assets-tab.webp "Assets" Assets are packaged with \l{glossary-component}{components} for delivery to users. @@ -187,7 +187,7 @@ also be modified by another component, unless a particular component type has explicitly disallowed this for a specific property. - \image qtquick-item-properties-common.png "Properties view" + \image qtquick-item-properties-common.webp "Properties view" Read more about properties: diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 636cbfeb19..659e446bb3 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -16,29 +16,30 @@ \list \li \l{2D} \li \l{3D} - \li \l{Material Editor and Browser} - \li \l{Components} \li \l{Assets} - \li \l{Navigator} - \li \l{Properties} - \li \l{Connections} - \li \l{States} - \li \l{Translations} - \li \l{Transitions} - \li \l{Timeline} - \li \l{Curves} \li \l{Code} \generatelist studio-how-to-code \generatelist studio-how-to-refactor-code \generatelist studio-how-to-search \generatelist studio-preferences-code - \li \l{Projects} + \li \l{Components} + \li \l{Connections} + \li \l{Content Library} + \li \l{Curves} + \li \l{Effect Composer} \li \l{File System} + \li \l{Material Editor and Browser} + \li \l{Model Editor} + \li \l{Navigator} \li \l{Open Documents} - \li \l{Content Library} - \li \l{Texture Editor} + \li \l{Projects} + \li \l{Properties} \li \l{Qt Insight} - \li \l{Effect Composer} + \li \l{States} + \li \l{Texture Editor} + \li \l{Timeline} + \li \l{Transitions} + \li \l{Translations} \endlist \li \l{Managing Workspaces} \li \l{Manage sessions} @@ -89,7 +90,7 @@ \li \l{Custom Effects and Materials} \li \l{Lights} \li \l{Cameras} - \li \l{Scene Environment} + \li \l{Scene Environments} \li \l{Morph Target} \li \l{Repeater3D} \li \l{Loader3D} @@ -264,7 +265,6 @@ \li \l {Search from documentation} \li \l {Select the help start page} \endlist - \li \l{Frequently Asked Questions} \li \l{Supported Platforms} \endlist \li \l{Technical Support} diff --git a/doc/qtdesignstudio/src/qtdesignstudio.qdoc b/doc/qtdesignstudio/src/qtdesignstudio.qdoc index 6d84474605..6aab55a1ad 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio.qdoc @@ -86,7 +86,6 @@ \li \b {\l Help} \list \li \l{Get help}{Getting Help} - \li \l{Frequently Asked Questions} \li \l{Supported Platforms} \endlist \row diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-camera.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-camera.qdoc index 202249188d..89da3cbb34 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-camera.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-camera.qdoc @@ -8,13 +8,13 @@ \title Cameras - A camera is always necessary to view the content of a 3D scene. A camera + A camera is necessary to view the content of a 3D scene. A camera defines how to project the content of a 3D scene into a 2D coordinate space, which can then be used on a 2D surface. When a camera is present in the scene, it can be used to direct what is displayed in a \l {3D Views} {3D view}. - \image studio-qtquick-3d-components.png "Qt Quick 3D components in Components" + \image studio-qtquick-3d-components.webp "Qt Quick 3D components in Components" To add a camera component to your UI, do one of the following: \list @@ -31,7 +31,7 @@ \uicontrol QtQuick3D module to your project, as described in \l {Adding and Removing Modules}. - You can use the following components in your scenes to determine camera + The following components in your scenes determine the camera projection: \list @@ -65,7 +65,7 @@ You can edit the camera properties in the \uicontrol Properties view. - \image studio-qtquick-camera-properties "Properties view for Perspective Camera" + \image studio-qtquick-camera-properties.webp "Properties view for Perspective Camera" \section1 Setting Camera Field of View @@ -73,6 +73,8 @@ when \l {Creating Projects}{creating your project}, the camera properties will be slightly different. + \note Orthographic cameras don't have the FOV property. + The camera frustum can be obtained by taking a frustum (that is, a truncation with parallel planes) of the cone of vision that a camera or eye would have to the rectangular viewports typically used in computer graphics. @@ -112,10 +114,10 @@ \note The \uicontrol {Horizontal magnification} and \uicontrol {Vertical magnification} properties are not available in Qt 5. - The \uicontrol {Frustum culling enabled} property determines whether the + The \uicontrol {Frustum culling} property determines whether the objects outside the camera frustum will be culled, which means they will not be passed to the renderer. - \note The \uicontrol {Frustum culling enabled} property is not available in + \note The \uicontrol {Frustum culling} property is not available in Qt 5. The default values are intended to cause anything within the view @@ -124,5 +126,22 @@ better results with ambient occlusion or with effects that use the depth buffer of the camera, such as the \e {depth of field} effect. - \note Orthographic cameras don't have the FOV property. + \section1 Setting a Camera to Look at an Object + + Setting the camera to look at a specific object can be useful, for example, + if you want to create a cinematic effect or have the camera follow a user-controlled object. + + To set a camera to look at an object: + + \list 1 + \li In \uicontrol Navigator, select the camera. + \li In \uicontrol Properties > \uicontrol {Look-at-Node}, select the object that + the camera should look at. + \image camera-look-at-node.webp + \endlist + + When you set a camera to look at an object, the camera automatically rotates to + point toward the assigned object, even if the object or the camera moves. The rotation only + happens around the x and y axes. + */ diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-custom-shaders.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-custom-shaders.qdoc index b559fd2230..f053834f0d 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-custom-shaders.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-custom-shaders.qdoc @@ -29,7 +29,7 @@ \uicontrol {Custom Material} components, in \uicontrol Components > \uicontrol {Qt Quick3D} > \uicontrol {Qt Quick 3D}. - \image studio-qtquick-3d-components.png "Effect and Custom Material Components in Components" + \image studio-qtquick-3d-components.webp "Effect and Custom Material Components in Components" \note In Qt 5 the \uicontrol Effect component is located in \uicontrol {Qt Quick 3D Effects} > @@ -218,7 +218,7 @@ \row \li \l Blending - \li \inlineimage ok.png + \li \li A pass command that specifies the source blending function. The \uicontrol Source property specifies the source blending diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc index 7111d2db90..ebe842a555 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2022 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,8 +6,12 @@ \page studio-3d-editor.html \nextpage studio-material-editor.html + \ingroup studio-views + \title 3D + \brief Edit a 3D scene. + When editing a 3D scene, you view the scene in the \uicontrol{3D} view. You can change the projection of the view by switching between \e {perspective camera} and \e {orthographic camera} modes. When using the @@ -25,7 +29,7 @@ components from \uicontrol Components > \inlineimage icons/plus.png > \uicontrol {Qt Quick 3D} > \uicontrol {Qt Quick 3D}. - You can use the \l{Summary of the 3D View Toolbar Buttons}{toolbar buttons} + You can use the toolbar buttons to \e transform 3D components and manipulate the 3D scene. Transformation refers to moving, rotating, or scaling of a component. The \e pivot of the component is used as the origin for transformations. You can set a @@ -56,7 +60,7 @@ \li Delete components \endlist - \image 3d-view-context-menu.png + \image 3d-view-context-menu.webp "The context menu in the 3D view" To refresh the contents of the \uicontrol{3D} view, press \key P or select the \inlineimage icons/reset.png @@ -71,6 +75,8 @@ \section1 Controlling the 3D View Camera + \section2 Toggling Camera Mode + To switch to perspective camera mode, select \inlineimage perspective_camera.png (\uicontrol {Toggle Perspective/Orthographic Edit Camera}). @@ -78,14 +84,16 @@ \inlineimage orthographic_camera.png . You can also Toggle the camera mode by using the keyboard shortcut \key T. + \section2 Navigating in the 3D Scene + You can navigate the scene by panning, rotating, and zooming the 3D view camera: \list \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 It is not possible to pan using Magic Mouse. + view to slide the view around. Alternatively, press and hold \key {right mouse + button} and \key {left mouse button} and drag anywhere in the view to pan. \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 @@ -104,6 +112,17 @@ selected, the camera is pointed at the world origin. This does not affect the camera zoom level. + \image studio-3d-editor-axis-helper.webp "Axis helper in the 3D view" + + You can use scene cameras (2) to view the \uicontrol View3D component from a + specific angle in the \l {2D} view while editing scenes. Different types of + cameras are available in \uicontrol Components + > \uicontrol {Qt Quick 3D} > \uicontrol {Qt Quick 3D}. For more information + about using cameras in the scene, the available camera types, and their + properties, see \l{Cameras}. + + \section2 Using Split View + To view the scene in a split view of four different point of views, select \inlineimage icons/split-view.png. @@ -114,14 +133,44 @@ independently. Navigate each split by panning, rotating, and zooming, as described above. - \image studio-3d-editor-axis-helper.webp "Axis helper in the 3D view" + \section2 Using Fly Mode - You can use scene cameras (2) to view the \uicontrol View3D component from a - specific angle in the \l {2D} view while editing scenes. Different types of - cameras are available in \uicontrol Components - > \uicontrol {Qt Quick 3D} > \uicontrol {Qt Quick 3D}. For more information - about using cameras in the scene, the available camera types, and their - properties, see \l{Cameras}. + You can move around freely in the 3D scene with fly mode. To navigate the scene with + fly mode, keep the \key {right mouse button} pressed and use the listed keys to move + around the scene. + + \table + \header + \li Key + \li Action + \row + \li \key W or \key {Up arrow} + \li Move forward. + \row + \li \key S or \key {Down arrow} + \li Move backward. + \row + \li \key A or \key {Left arrow} + \li Move left. + \row + \li \key D or \key {Right arrow} + \li Move right. + \row + \li \key E or \key {Page up} + \li Move up. + \row + \li \key Q or \key {Page down} + \li Move down. + \endtable + + To adjust the movement speed, select \inlineimage icons/camera_speed.png in the + \uicontrol 3D view toolbar to open the configuration dialog. + + In the configuration dialog, you can: + \list + \li Adjust the movement speed of the camera with a slider. + \li Set a value multiplier for the speed slider. + \endlist \section1 Using Global and Local Orientation @@ -423,120 +472,4 @@ Select \uicontrol{Reset All Viewports} to reset the shading of the scene in all of the splits. - \section1 Summary of the 3D View Toolbar Buttons - - The \uicontrol{3D} view toolbar contains the following buttons: - - \table - \header - \li Button - \li Tooltip - \li Keyboard Shortcut - \li Read More - \row - \li \inlineimage icons/select_group.png - \inlineimage icons/select_item.png - \li Toggle Group/Single Selection Mode - \li \key Q - \li \l{Selecting Components} - \row - \li \inlineimage icons/move_off.png - \li Activate the Move Tool - \li \key W - \li \l{moving components 3d view}{Moving Components} - \row - \li \inlineimage icons/rotate_off.png - \li Activate Rotate Tool - \li \key E - \li \l{Rotating Components} - \row - \li \inlineimage icons/scale_off.png - \li Activate Scale Tool - \li \key R - \li \l{Scaling Components} - \row - \li \inlineimage icons/fit_selected.png - \li Fit Selected Object to View - \li \key F - \li \l{Controlling the 3D View Camera} - \row - \li \inlineimage icons/perspective_camera.png - \inlineimage icons/orthographic_camera.png - \li Toggle Perspective/Orthographic Edit Camera - \li \key T - \li \l{Controlling the 3D View Camera} - \row - \li \inlineimage icons/global.png - \li Toggle Global/Local Orientation - \li \key Y - \li \l{Using Global and Local Orientation} - \row - \li \inlineimage icons/edit_light_off.png - \inlineimage icons/edit_light_on.png - \li Toggle Edit Light On/Off - \li \key U - \li \l{Using Edit Light} - \row - \li \inlineimage icons/snapping-3d.png - \li Toggle Snapping During Node Drag - \li \key Shift + \key Tab - \li \l{Snapping} - \row - \li \inlineimage icons/snapping-3d-conf.png - \li Open Snap Configuration Dialog - \li - \li \l{Configuring Snapping} - \row - \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/3d-background-color.png - \li Background Color Actions - \li - \li \l{Changing Colors} - \row - \li \inlineimage icons/split-view.png - \li Toggle Split View On/Off - \li \key Ctrl + \key Alt + \key Q - \li \l{Using Split View} - \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 - \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 P - \li - \endtable - */ diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-effects.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-effects.qdoc index 158932dff8..95eb3232d7 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-effects.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-effects.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -263,7 +263,7 @@ be transparent in the \uicontrol {Background Mode} field of the \uicontrol {Scene Environment} component. Otherwise, the clear color of the background hides the blur. For more information, see - \l {Scene Environment}. + \l {Scene Environments}. The \uicontrol {Fade Amount} property defines the fade speed of the trail. diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-lights.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-lights.qdoc index af994d5877..c7ae1e955e 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-lights.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-lights.qdoc @@ -9,7 +9,7 @@ \title Lights Light components are the primary source of lighting in a \QDS scene. - As a secondary light source, you can use \l{Setting the Light Probe} + As a secondary light source, you can use \l{Setting Image Based Lighting} {image-based lighting}. To add a light component to your UI, do one of the following: diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-model.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-model.qdoc index 4159269bc7..e1f6edd8de 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-model.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-model.qdoc @@ -27,11 +27,14 @@ \note You can not create \uicontrol Empty models this way. \endlist + Double-clicking a 3D model in \uicontrol 2D view opens the \uicontrol 3D view with + the 3D model selected. + If you cannot find the model components in \uicontrol {Components}, add the \uicontrol QtQuick3D module to your project, as described in \l {Adding and Removing Modules}. - \image studio-qtquick-3d-components.png "The Qt Quick 3D section in Components" + \image studio-qtquick-3d-components.webp "The Qt Quick 3D section in Components" \section1 Model Properties diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-repeater-3d.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-repeater-3d.qdoc index 9e181a8aae..0f0d0634ca 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-repeater-3d.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-repeater-3d.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -8,10 +8,6 @@ \title Repeater3D - \note The \uicontrol Repeater3D component is released as a tech preview - feature in \QDS 2.2, and its functionality will be improved in future - releases. - The \uicontrol Repeater3D component is used to create multiple similar items. Like other view types, \uicontrol Repeater3D needs a model and a delegate. The delegate sets the item to use and the model sets the @@ -100,90 +96,58 @@ \endlist \image repeater3d-numeric-model.webp - \section1 Adding a Repeater3D Component with a List Model + \section1 Adding a Repeater3D Component with a Model This section explains how to add a \uicontrol Repeater3D component with - a ListModel to your \QDS project: + a model to your \QDS project: To add a \uicontrol Repeater3D component: \list 1 \li Drag a \uicontrol Repeater3D component from \uicontrol Components to \e scene in \uicontrol Navigator. - \li You need to enter the QML code for the \uicontrol ListModel manually. - Go to the \uicontrol {Code} view and enter the following code somewhere - inside the root object: - \code qml - ListModel { - id: planetModel - ListElement { - name: "Mars" - radius: 3.39 - } - ListElement { - name: "Earth" - radius: 6.37 - } - ListElement { - name: "Venus" - radius: 6.05 - } - } - \endcode - The default root object for a \QDS project is \uicontrol Rectangle, so - you can paste the \uicontrol ListModel code, for example, like this: - \code qml - Rectangle { - width: Constants.width - height: Constants.height - color: Constants.backgroundColor - - ListModel { - id: planetModel - ListElement { - name: "Mars" - radius: 3.39 - } - ListElement { - name: "Earth" - radius: 6.37 - } - ListElement { - name: "Venus" - radius: 6.05 - } - } - - View3D { - id: view3D - anchors.fill: parent - ... - \endcode - \li In the \uicontrol {Code} view, add \c {model: planetModel} to the - \uicontrol Repeater3D object to tell that you want to use your - \uicontrol ListModel as the model for the \uicontrol Repeater3D object. - \code qml - Repeater3D { - id: repeater3D - model: planetModel - } - \endcode + \li Go to \uicontrol {Model Editor} and create a new model with the name + \e planetModel. + \li Add the following columns and data to the model. + \raw HTML + <table> + <tr> + <th>name (<i>String</i>)</th> + <th>radius (<i>Real</i>)</th> + </tr> + <tr> + <td>Mars</td> + <td>3.39</td> + </tr> + <tr> + <td>Earth</td> + <td>6.37</td> + </tr> + <tr> + <td>Venus</td> + <td>6.05</td> + </tr> + </table> + \endraw + \note You can also import a model in JSON or CSV format. See \l {Importing a Data Model}. + \image repeater3d-model-editor.webp + \li In \uicontrol Navigator, select \e{_3DRepeater}. + \li In \uicontrol Properties, set \uicontrol Model to \e {DataStore.planetModel}. \endlist - Now, you have set up the \uicontrol Repeater3D component to use a \uicontrol ListModel to draw the items. Next, you need to add the - item to draw. In this example we are using a \uicontrol Sphere. + item to draw. In this example, you are using a \uicontrol Sphere. \list 1 - \li From \uicontrol Components, drag a \uicontrol Sphere to \e repeater3D + \li From \uicontrol Components, drag a \uicontrol Sphere to \e _3DRepeater in \uicontrol Navigator. \image repeater3d-listmodel-navigator.png - \li Select \e sphere in \uicontrol Navigator and select + \li Select \e sphere in \uicontrol Navigator and in the \Properties view, select \inlineimage icons/action-icon.png next to \uicontrol Scale > \uicontrol X. \li Select \uicontrol {Set binding} to open \uicontrol {Binding Editor}. \li In the binding editor, enter \c{radius}. This sets the X - scale to the radius value defined in the ListModel for each of the sphere + scale to the radius value defined in the model for each of the sphere instances. \image repeater3d-radius-binding.png \li Select \uicontrol OK. @@ -195,7 +159,7 @@ position so you need to change the position to see all spheres. \list 1 - \li Select \e sphere in \uicontrol Navigator and select + \li Select \e sphere in \uicontrol Navigator and in the \uicontrol Properties view, select \inlineimage icons/action-icon.png next to \uicontrol Translation > \uicontrol X. \li Select \uicontrol {Set binding} to open \uicontrol {Binding Editor}. 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 6e9db7012c..5d18f39a83 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2020 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,31 +6,43 @@ \previouspage studio-3d-camera.html \nextpage studio-3d-morph-target.html - \title Scene Environment + \title Scene Environments - You can use the \uicontrol {Scene Environment} component to specify - how a scene is rendered globally. You can specify settings for antialiasing, - scene background, ambient occlusion, and image-based lighting in the - \l Properties view. The \uicontrol {Scene Environment} component is available - in \uicontrol Components > \uicontrol {Qt Quick 3D}. It is - automatically included under the 3D view component in \l{Creating Projects} - {projects created} using the \uicontrol {Qt Quick 3D Application} wizard - template. + The \uicontrol {Scene Environment} and the \uicontrol {Extended Scene Environment} + components define how a scene is rendered globally. - \note If you select \uicontrol {Qt 5} as the \uicontrol {Target Qt Version} - when \l {Creating Projects}{creating your project}, the available properties - for this component will be slightly different. The properties may also be - situated differently in the \uicontrol Properties view. + \note The available properties for the scene environments and their location in the + \uicontrol Properties view vary according to \uicontrol {Target Qt Version} that + you select when \l {Creating Projects}{creating your project}. + + \note \uicontrol {Extended Scene Environment} is available in projects created with + Qt 6.5 or higher as the \uicontrol {Target Qt Version}. + + \section1 Adding Scene Environments to Projects + + Add the scene environment components to projects by selecting a suitable preset when + \l{Creating Projects}{creating your project}. + + Use the \uicontrol {3D} preset to create a project with a \uicontrol View3D + component that includes a scene environment. If you need to add it manually, it is + available in \uicontrol Components > \uicontrol {Qt Quick 3D}. + + Use the \uicontrol {Extended 3D} preset to create a project with a 3D view + component that includes an extended scene environment. It is also + available in \uicontrol Components > \uicontrol {Qt Quick 3D Helpers}. \section1 Setting the Scene Environment - In the \uicontrol {Scene Environment} section of the \uicontrol Properties - view, you can specify whether and how the background of the scene should be - cleared, specify whether you wish to perform depth-tests on the scene, - apply post-processing effects to the scene, and define how colors are - tonemapped before the scene is rendered. + To define properties for the scene environment, select \uicontrol {Scene Environment} + in \uicontrol Navigator and specify its properties in the \uicontrol Properties view. - \image studio-3d-scene-environment-properties.png "The Scene Environment properties" + Set the properties in the \uicontrol {Scene Environment} section of the + \uicontrol Properties view to specify whether and how the background + of the scene should be cleared, to apply post-processing effects to the scene, + to define how colors are tonemapped before the scene is rendered, and to + specify fog settings. + + \image studio-3d-scene-environment-properties.webp "The Scene Environment properties" The \uicontrol {Clear color} property specifies which color will be used to clear the background of the scene if \uicontrol {Background mode} is defined @@ -64,23 +76,22 @@ image as a \uicontrol SkyBox using the \uicontrol Image property in the \uicontrol {Light probe} section (In Qt 5, the \uicontrol {Light Probe} property in - the \uicontrol {Image-Based Lighting} group. + the \uicontrol {Image-Based Lighting} group). + \row + \li SkyBoxCubeMap + \li The scene will not be cleared, but instead a + \uicontrol SkyBox or Skydome that uses a \uicontrol CubeMapTexture + will be rendered. A cube map texture has six faces + (X+, X-, Y+, Y-, Z+, and Z-), where each face is an individual + 2D image. Selecting this mode allows custom materials and post-processing + effects to work with cube map textures in their shaders. \endtable To leave the scene uncleared, select \uicontrol {Unspecified} as the \uicontrol {Background mode}. - You can perform depth tests to optimize the scene environment. To skip the - depth tests, deselect the \uicontrol {Enable depth test} checkbox. Note that - skipping the tests can cause rendering errors. - - To have the renderer write to the depth buffer as part of the color pass, - deselect the \uicontrol {Enable depth prepass} checkbox. Deselecting the - checkbox disables the depth prepass on any GPU that uses tiled rendering - architecture. - - The \uicontrol Effect property defines a post-processing effect to the - scene. Use the dropdown menu to select one of the effects that will be + The \uicontrol Effects property defines post-processing effects applied + to the scene. Use the dropdown menu to select one of the effects that will be applied to the entire scene. The order of the effects is significant since the result of each effect is fed to the next. @@ -92,14 +103,21 @@ tonemapping, or \uicontrol ToneMapModeFilmic to apply filmic tonemapping. \note The \uicontrol {Tonemap mode} property is not available in Qt 5. + The \uicontrol Fog property defines settings for fog applied to the + scene. When the \uicontrol Fog property of a scene environment is set to a + valid \uicontrol Fog object, the properties are used to configure the + rendering of fog. The simple fog provided by this type is implemented by + the materials. Use the dropdown menu to select a \uicontrol Fog object for + your scene. + \section1 Applying Antialiasing - Antialiasing is used to make curved lines smoother on the screen. In the + Use antialiasing to make curved lines smoother on the screen. In the \uicontrol Antialiasing section of the \uicontrol Properties view, you can specify the mode and quality of antialiasing and also enable temporal antialiasing and define its strength. - \image studio-3d-scene-environment-antialiasing.png "The Antialiasing properties" + \image studio-3d-scene-environment-antialiasing.webp "The antialiasing properties" The \uicontrol {Antialiasing mode} property specifies the mode of antialiasing applied when the scene is rendered. Select one of the following @@ -174,11 +192,12 @@ animations stop. The \uicontrol {Temporal AA strength} property modifies the amount of - temporal movement in antialiasing. This property only has an effect when + temporal movement in antialiasing. This property is only available when the \uicontrol {Temporal AA} property is set to true. - \note In Qt 5, the antialiasing properties are located in - \uicontrol Properties > \uicontrol {Scene Environment}. + The \uicontrol {Specular AA} property enables specular antialiasing. Specular + aliasing is often visible in form of bright dots and flickering when moving the + camera around. \section1 Applying Ambient Occlusion @@ -188,14 +207,17 @@ \uicontrol {Sample rate}, and \uicontrol Bias properties in the \uicontrol {Ambient Occlusion} section of the \uicontrol Properties view. - \image studio-3d-scene-environment-ambient-occlusion.png "The Ambient Occlusion properties" + \image studio-3d-scene-environment-ambient-occlusion.webp "The ambient occlusion properties" + + In \uicontrol Properties > \uicontrol {Ambient Occlusion}, select the + \uicontrol Enabled checkbox to define settings for ambient occlusion. - You can set the strength of the shadows using the \uicontrol Strength - property, which defines the amount of ambient occlusion applied. A value of - 100 causes full darkness shadows, while lower values cause the shadowing to - appear lighter. A value of 0 disables ambient occlusion entirely, thus - improving performance at a cost to the visual realism of 3D objects rendered - in the scene. All values other than 0 have the same impact on performance. + Set the strength of the shadows using the \uicontrol Strength property, + which defines the amount of ambient occlusion applied. A value of 100 causes + full darkness shadows, while lower values cause the shadowing to appear lighter. + A value of 0 disables ambient occlusion entirely, thus improving performance at + a cost to the visual realism of 3D objects rendered in the scene. All values other + than 0 have the same impact on performance. The \uicontrol Distance property defines roughly how far the ambient occlusion shadows spread away from objects. Greater distances cause increasing impact @@ -213,7 +235,7 @@ occlusion, try adjusting the value in the \uicontrol {Clip far} field in the \l{Cameras}{scene camera} properties. - The \uicontrol {Sample rate} property specifies the number of shades of gray, + The \uicontrol {Sample Rate} property specifies the number of shades of gray, thus defining the quality of ambient occlusion at the expense of performance. The \uicontrol Bias property defines a cutoff distance preventing objects @@ -227,15 +249,15 @@ differently: \uicontrol {AO strength}, \uicontrol {AO distance}, \uicontrol {AO softness}, \uicontrol {AO dither}, and \uicontrol {AO bias}. - \section1 Setting the Light Probe + \section1 Setting Image Based Lighting - In the \uicontrol {Light Probe} section of the \uicontrol Properties view, - you can set the \uicontrol Image, \uicontrol Exposure, \uicontrol Horizon, + In the \uicontrol {Image Based Lighting} section of the \uicontrol Properties view, + you can set the \uicontrol {HDR Image}, \uicontrol Exposure, \uicontrol Horizon, and \uicontrol Orientation properties for image-based lighting. - \image studio-3d-scene-environment-light-probe.png "The Light Probe properties" + \image studio-3d-scene-environment-image-based-lighting.webp "Image based lighting properties" - The \uicontrol Image property defines an image used to light the scene + The \uicontrol {HDR Image} property defines an image used to light the scene instead of or in addition to standard lights. The image is preferably a high-dynamic range image or a pre-generated cubemap. Pre-baking provides significant performance improvements at run time because no time is spent on @@ -286,4 +308,45 @@ The value of the \uicontrol {Probe FOV} property sets the angle of the image source field of view when using a camera source as the IBL probe. + + \section2 Advanced Scene Environment settings + + You can perform depth tests to optimize the scene environment. To skip the + depth tests, clear the \uicontrol {Enable depth test} checkbox. Note that + skipping the tests can cause rendering errors. + + To have the renderer write to the depth buffer as part of the color pass, + clear the \uicontrol {Enable depth prepass} checkbox. Clearing the + checkbox disables the depth prepass on any GPU that uses tiled rendering + architecture. + + To specify additional render settings for debugging scenes, define + \uicontrol {Debug Settings}. + + To define lightmap baking settings for direct and indirect lighting, use + the \uicontrol {Light Mapper} property to specify a lightmapper object. + These settings are not relevant at other times, such as when using already + generated lightmaps to render a scene. + + \section1 Setting the Extended Scene Environment + + In addition to properties described above, in the extended scene environment + you can apply effects to your scene by defining them as properties. When enabling + one or more of these effects, the result is similar to manually adding + \l {3D Effects}{effects} to \uicontrol {Scene Environment}. + + Use \uicontrol {Extended Scene Environment} instead of \uicontrol {Scene Environment} + to add multiple and complex effects to your scene. Because the \uicontrol + {Extended Scene Environment} combines the effects that are enabled, the number of + render passes is reduced, which results in significantly better performance + than applying individual post-processing effects to the scene. + + For the extended scene environment, you can also define \uicontrol {Local Custom Properties}. + + \image studio-ext-scene-environment.webp "Properties of Extended Scene Environment" + + \note If additional post-processing effects are manually added to + \uicontrol {Scene Environment}, those effects will be applied before the effects + defined in the properties of \uicontrol {Extended 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 5f2f53ca96..1ada3625ff 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -8,42 +8,61 @@ \title 3D Views - To create a Qt Quick 3D UI project, we recommend using a \uicontrol - {Qt Quick 3D Application} wizard template that adds the + To create a Qt Quick 3D UI project, use the \uicontrol {3D} preset that adds the \l {3D Components}{Qt Quick 3D} components to \uicontrol Components - and contains a 3D view. A 3D view component includes a - \l {Scene Environment}{scene environment} as well as a scene - \l {Lights}{light}, \l {Cameras}{camera}, and - \l {3D Models}{model}. A default \l {Materials and Shaders}{material} - is attached to the model. You can attach \l {Textures}{textures} - to materials. For more information about creating projects, see \l{Creating Projects}. - - To add a 3D view to some other kind of a project, you first need to add the + and contains a 3D view component. The \uicontrol {View3D} component + includes a \l {Scene Environments}{scene environment} as well as a scene \l {Lights}{light}, + \l {Cameras}{camera}, and \l {3D Models}{model}. A default \l {Materials and Shaders}{material} + is attached to the model. You can attach \l {Textures}{textures} to materials. + + To create a project with many complex effects, use the \uicontrol {Extended 3D} preset + that creates a project with an \uicontrol {Extended View3D} component. + The extended 3D view includes an {Extended Scene Environment} + component that enables using various effects by defining them as properties. + + \note The extended 3D view is available in projects created with Qt 6.5 + or higher set as the target version. + + For more information about creating projects, see \l{Creating Projects}. + + To manually add a 3D view to your project, you first need to add the \uicontrol {Qt Quick 3D} module to \uicontrol {Components}, as described in \l {Adding and Removing Modules}. - \image studio-qtquick-3d-components.png "Qt Quick 3D components in Components" + \note \uicontrol {The Qt Quick 3D} module is not available in projects created + with Qt 5 set as the target version. - You can now drag-and-drop a \uicontrol View3D component to the \l Navigator - or \l {2D} view. + \image studio-qtquick-3d-components.webp "QtQuick3D components" - \image studio-navigator-view3d.png "A View 3D component in the Navigator" + You can now drag a \uicontrol View3D or an \uicontrol {Extended View3D} component from + \l Components > \uicontrol QtQuick3D > \uicontrol Items to \l Navigator or to the + \l {2D} view. - 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 the \uicontrol{3D} or - \uicontrol Navigator view and change the type of the component in the \uicontrol - Type field in \l Properties. For example, to use a point light, enter - \e {PointLight}. + To switch to the \uicontrol 3D view while maintaining the camera orientation of the + \uicontrol View3D, right-click a \uicontrol View3D or an \uicontrol {Extended View3D} + component in the \uicontrol Navigator or \uicontrol 2D view and select + \uicontrol {Edit in 3D View}. Alternatively, you can double-click a \uicontrol View3D + or an \uicontrol {Extended View3D} component in the \uicontrol 2D view to open the + \uicontrol 3D view. Double-clicking a 3D model in the \uicontrol 2D view opens the + \uicontrol 3D view with the 3D model selected. - \image studio-3d-properties-type.png "Type field in Properties view" + \image studio-navigator-view3d.png "A View 3D component in Navigator" - Similarly to other components, you can select a 3D view in \uicontrol - Navigator or the \uicontrol{3D} view and modify its property values in the - \uicontrol Properties view. Use the properties in the \uicontrol View3D - tab to set properties specific to a 3D view component. + By default, a directional light and a perspective camera are used in 3D + scenes created by using the \uicontrol 3D and \uicontrol {Extended 3D} + presets. To use other light and camera types, select the component in + the \uicontrol {3D} or \uicontrol Navigator view and change the type of + the component in the \uicontrol Type field in \l Properties. For example, + to use a point light, enter \c {PointLight}. - \image studio-qtquick-3d-view.png "View 3D component properties" + \image studio-3d-properties-type.webp "Type field in the Properties view" + + Select a 3D view in \uicontrol Navigator or in \uicontrol{3D} to modify + its property values in the \uicontrol Properties view. Use the properties + in the \uicontrol View3D tab to set properties specific to a 3D view + component. + + \image studio-qtquick-3d-view.webp "View 3D component properties" The \uicontrol Camera property defines which camera is used to render the scene to the \uicontrol {2D} view. If this property is not defined, the @@ -63,4 +82,7 @@ \note The \uicontrol {Import Scene} property can only be set once. Subsequent changes will have no effect. + + The \uicontrol {Render Format} property defines the format of the backing + texture. */ diff --git a/doc/qtdesignstudio/src/reference/qtdesignstudio-keyboard-shortcuts.qdoc b/doc/qtdesignstudio/src/reference/qtdesignstudio-keyboard-shortcuts.qdoc index ac6354ca90..21b195b522 100644 --- a/doc/qtdesignstudio/src/reference/qtdesignstudio-keyboard-shortcuts.qdoc +++ b/doc/qtdesignstudio/src/reference/qtdesignstudio-keyboard-shortcuts.qdoc @@ -112,6 +112,9 @@ \li Previous open document in history \li \key{Ctrl+Tab} \row + \li Toggle \uicontrol {Menu Bar} visibility + \li \key{Ctrl+Alt+M} + \row \li Switch to \uicontrol Welcome mode \li \key{Ctrl+1} \row @@ -201,7 +204,10 @@ \li Action \li Keyboard shortcut \row - \li Open the QML file that defines the selected component + \li Open the project with \uicontrol {Live Preview}. + \li \key{Alt+P} (\key{Opt+P} on \macos) + \row + \li Open the QML file that defines the selected component. \li \key{F2} \row \li Jump to the \uicontrol {Code} view. diff --git a/doc/qtdesignstudio/src/views/qtquick-assets.qdoc b/doc/qtdesignstudio/src/views/qtquick-assets.qdoc index b95bf1e889..fad871debd 100644 --- a/doc/qtdesignstudio/src/views/qtquick-assets.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-assets.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2022 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,43 +6,31 @@ \previouspage quick-components-view.html \nextpage qtquick-navigator.html + \ingroup studio-views + \title Assets + \brief Select assets such as images and fonts to use in your application. + The \uicontrol Assets view lists available assets. \uicontrol {Assets} displays the images and other files - that you add to the project folder by dragging-and-dropping external asset + that you add to the project folder by dragging external asset files to \QDS or by selecting \inlineimage icons/plus.png . For more information about importing assets to \QDS, see \l {Importing 2D Assets} and \l {Importing 3D Assets}. - To add assets to your UI, drag-and-drop them from + To add assets to your UI, drag them from \uicontrol Assets to the \l Navigator, \l {2D}, or \l {3D} view. To add multiple assets to your UI simultaneously, multiselect them first by holding \key Ctrl and clicking the asset files you wish to select. - \image qtquick-assets-tab.png "Assets view" + \image qtquick-assets-tab.webp "Assets view" - When you drag-and-drop assets from \uicontrol Assets to the \l Navigator + When you drag assets from \uicontrol Assets to the \l Navigator or \l {2D} view, component instances with a suitable type are automatically created for you. For example, instances of the \l{Images}{Image} component will be created for graphics files. - \section1 Context Menu Commands - - \image qtquick-library-context-menu.png "Context menu commands in Assets" - - To use the context menu commands in \uicontrol Assets, right-click the - name of a folder and select one of the following commands: - - \list - \li \uicontrol {Expand All}: expands all folders. - \li \uicontrol {Collapse All}: collapses all folders. - \li \uicontrol {Rename Folder}: prompts you to enter a new name - for the folder. - \li \uicontrol {New Folder}: creates a new folder. - \li \uicontrol {Delete Folder}: deletes the folder. - \endlist - */ diff --git a/doc/qtdesignstudio/src/views/qtquick-components-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-components-view.qdoc index 1e2786bfbc..5933e4be70 100644 --- a/doc/qtdesignstudio/src/views/qtquick-components-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-components-view.qdoc @@ -1,13 +1,18 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page quick-components-view.html \previouspage studio-material-editor.html \nextpage quick-assets.html + \sa {Using Components} + + \ingroup studio-views \title Components + \brief Select preset components and your own components to use in your application. + The \uicontrol Component view lists the available components. \image qtquick-components-tab.png "Components view" @@ -52,7 +57,7 @@ \li \l{Custom Shaders} \li \l{Lights} \li \l{Cameras} - \li \l{Scene Environment} + \li \l{Scene Environments} \li \l{Morph Target} \li \l{Repeater3D} \li \l{Particles} @@ -86,27 +91,4 @@ final application package, it is recommended that you select \uicontrol {Remove Module} to remove the ones you don't use in the project. - \section1 Context Menu Commands - - \image qtquick-components-context-menu.png "Context menu commands in Components" - \image qtquick-components-context-menu-hide.png "Context menu command Hide Category" - - To use the context menu commands in \uicontrol Components, right-click the - name of a module or category and select one of the following commands: - - \list - \li \uicontrol {Remove Module}: removes the module and all of its - components from \uicontrol Components. - \li \uicontrol {Expand All}: expands all the modules. - \li \uicontrol {Collapse All}: collapses all the modules. - \li \uicontrol {Hide Category}: hides the category from the module. - \li \uicontrol {Show Module Hidden Categories}: shows the hidden - categories of the module. - \li \uicontrol {Show All Hidden Categories}: shows the hidden - categories in all of the modules. - \endlist - - \note The context menu commands for the \uicontrol Components categories do - not function if you have entered something into the \uicontrol Search field. - Clear the \uicontrol Search field to resume using the context menu commands. */ diff --git a/doc/qtdesignstudio/src/views/qtquick-connection-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-connection-view.qdoc index 5cc2c4a667..066ff1c9dc 100644 --- a/doc/qtdesignstudio/src/views/qtquick-connection-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-connection-view.qdoc @@ -1,13 +1,19 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page qtquick-connection-view.html \previouspage qtquick-properties-view.html \nextpage qtquick-states-view.html + \sa {Working with Connections} + + \ingroup studio-views \title Connections + \brief Add functionality to the UI by creating connections between components, + signals, and component properties. + The \uicontrol {Connections} view is a collection of views that enable you to create connections between components and the application, to bind component properties together, and to add custom properties for components. @@ -36,29 +42,4 @@ {preset properties} that you can specify values for. You can add custom properties that would not otherwise exist for a particular \l{Component Types}{component type}. - - \section1 Summary of the Connections View Tabs - - \table - \header - \li Tab - \li Purpose - \li Read More - \row - \li \uicontrol Connections - \li Create connections between components and the application logic - by accessing signals outside of the components that emit them. - \li \l{Connecting Components to Signals} - \row - \li \uicontrol Bindings - \li Dynamically change the behavior of a component by creating a - binding between the properties of two components. - \li \l{Adding Bindings Between Properties} - \row - \li \uicontrol Properties - \li Add custom properties that would not otherwise exist for a - particular preset component or your own custom component. - \li \l{Specifying Custom Properties} - - \endtable */ diff --git a/doc/qtdesignstudio/src/views/qtquick-curve-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-curve-editor.qdoc index 88ba762f53..52e1ba5963 100644 --- a/doc/qtdesignstudio/src/views/qtquick-curve-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-curve-editor.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,12 +6,16 @@ \previouspage qtquick-timeline-view.html \nextpage qtquick-text-editor.html + \ingroup studio-views + \title Curves + \brief View and modify the animation curve. + The \uicontrol {Curves} view shows the interpolated values of an animated property over the animation range. - \image studio-curve-editor.png "Curves" + \image studio-curve-editor.webp "Curves" When you edit an animation curve, you implicitly edit the \l{Editing Easing Curves}{easing curves} that the underlying system uses @@ -20,11 +24,22 @@ simultaneously. You can use the toolbar buttons to add \uicontrol Linear, \uicontrol Step, - or \uicontrol Spline interpolation between two keyframes. + or \uicontrol Spline interpolation between keyframes. + + To apply interpolation between keyframes: + \list 1 + \li Select the keyframes. To select multiple keyframes, press and hold + \key Ctrl, and then select them. + \li Select \inlineimage icons/easing-curve-linear-icon.png (\uicontrol Linear), + \inlineimage icons/easing-curve-step-icon.png (\uicontrol Step) or + \inlineimage icons/easing-curve-spline.png (\uicontrol Spline) depending on + which interpolation method you want to use. + \endlist When you set interpolation to \uicontrol Spline, handles appear in \uicontrol {Curves} that you can use to modify the curve. Select - \uicontrol Unify to lock the handle on the left of a keyframe to the one + \inlineimage icons/easing-curve-unify.png (\uicontrol Unify) to lock the handle on the + left of a keyframe to the one on the right of it so that moving the left handle also moves the right handle. @@ -32,53 +47,14 @@ in \l Navigator, you can select \inlineimage icons/lockon.png to unlock it. You can also lock individual easing curves for editing. - To lock an animation curve, hover the mouse over the keyframe in the list, + To lock an animation curve, hover the mouse over the property in the list, and then select \inlineimage icons/lockoff.png . - To pin an animation curve, hover the mouse over the keyframe in the list, + To pin an animation curve, hover the mouse over the property in the list, and then select \inlineimage icons/pin.png . - \section1 Curves Toolbar - - The \uicontrol {Curves} toolbar contains the following buttons and - fields. - - \table - \header - \li Button/Field - \li Action - \row - \li \inlineimage icons/easing-curve-linear-icon.png - \li \uicontrol Linear specifies that the interpolation between - keyframes is linear. - \row - \li \inlineimage icons/easing-curve-step-icon.png - \li \uicontrol Step uses steps for interpolation between keyframes. - \row - \li \inlineimage icons/easing-curve-spline-icon.png - \li \uicontrol Spline uses bezier spline curves for interpolation - between keyframes and displays handles for managing them. - \row - \li \uicontrol {Set Default} - \li Currently not used. - \row - \li \uicontrol Unify - \li For \uicontrol Spline curves, locks the handle on the left of a - keyframe to the one on the right. - \row - \li Start Frame - \li Specifies the first frame of the curve. - \row - \li End Frame - \li Specifies the last frame of the curve. - \row - \li Current Frame - \li Displays the frame that the playhead is currently on. Enter a - number in the field to move the playhead to the respective frame. - \endtable - \section1 Editing Animation Curves To edit animation curves: @@ -90,14 +66,14 @@ \uicontrol {Curves} to open the animation curve editor. \li Right-click in \uicontrol {Curves}, and select \uicontrol {Insert Keyframe} to add a keyframe. - \li Select keyframes to display the easing curves attached to them. - To select multiple keyframes, press and hold \key Ctrl. + \li Select properties in the list to display the easing curves attached to them. + To select multiple properties, press and hold \key Ctrl, and then select them. \endlist Your changes are automatically saved when you close the view. \section1 Deleting Keyframes in Curves - To delete the selected keyframe, select \uicontrol {Delete All Keyframes} + To delete the selected keyframe, select \uicontrol {Delete Selected Keyframes} in the context menu. */ diff --git a/doc/qtdesignstudio/src/views/qtquick-designer.qdoc b/doc/qtdesignstudio/src/views/qtquick-designer.qdoc index 3ca0149437..d4fb09efc6 100644 --- a/doc/qtdesignstudio/src/views/qtquick-designer.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-designer.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // ********************************************************************** @@ -27,218 +27,8 @@ \section1 Summary of Design Views - In addition to the summary of design views, the table below includes an MCU - column that indicates the views which are fully supported on MCU projects. - For more information, see \l {\QDS Features on MCU Projects}. + The following table provides a summary of the design views. For information on + MCU support, see \l {\QDS Features on MCU Projects}. - \table - \header - \li View - \li Purpose - \li MCU - \li Read More - \row - \li \l {2D} - \li Provides a working area for designing 2D UIs. - When you are editing 3D scenes, the \uicontrol {2D} view is - used as a canvas for the 3D scene projected by the camera. - \li \image ok.png - \li \l {2D} - \row - \li \l {3D} - \li Provides an editor for files you created using 3D graphics - applications and stored in one of the supported formats. - \li - \li \l {3D} - \row - \li \l {Material Editor and Browser} - \li In the \uicontrol {Material Editor} and - \uicontrol {Material Browser} views, you create and manage materials and - textures. - \li - \li \l {Material Editor and Browser} - \row - \li \l Components - \li Contains preset components and your own components, that you can use - to design you application. - \li \image ok.png - \li \l{Using Components} - \row - \li \l Assets - \li Contains assets such as images and fonts that you can use in your - application. - \li \image ok.png - \li \l Assets - \row - \li \l Navigator - \li Displays the composition of the current component file as - a tree structure. A component file can contain references - to other components and assets. - \li \image ok.png - \li \l Navigator - \row - \li \l Properties - \li Enables you to modify the properties of the selected component. - \li \image ok.png - \li \l {Specifying Component Properties} - \row - \li \l{Connections} - \li Enables you to add functionality to the UI by creating - connections between components, signals, and component properties. - \li \image ok.png - \li \l{Working with Connections} - \row - \li \l States - \li Displays the different states that can be applied to a component. - Typically, states describe UI configurations, such as the - visibility and behavior of components and the available user - actions. - \li \image ok.png - \li \l{Working with States} - \row - \li \l{Transitions} - \li Enables you to make movement between states smooth by animating - the changes between states. - \li \image ok.png - \li \l{Animating Transitions Between States} - \row - \li \l Translations - \li Provides functionality to add multi-language support to your - project. - \li - \li \l{Translations} - \row - \li \l Timeline - \li Provides a timeline and keyframe based editor for animating - the properties of components. - \li \image ok.png - \li \l{Creating Timeline Animations} - \row - \li \l{Curves} - \li Enables you to view and modify the whole animation curve by - inserting keyframes to the curve and dragging them and the point - handlers to modify the curve. - \li - \li \l {Editing Animation Curves} - \row - \li \l{Code} - \li Provides a code editor for viewing and modifying the code - generated by the visual editors. - \li \image ok.png - \li \l {Code} - \row - \li \l Projects - \li Shows a list of open projects and the files they contain. - \li \image ok.png - \li \l Projects - \row - \li \l{File System} - \li Shows all files in the currently selected directory. - \li \image ok.png - \li \l{File System} - \row - \li \l{Open Documents} - \li Shows currently open files. - \li \image ok.png - \li \l{Open Documents} - \row - \li \l{Content Library} - \li The \uicontrol {Content Library} view contains material, texture, - and environment bundles with assets that you can use in your project. - \li - \li \l{Content Library} - \row - \li \l{Texture Editor} - \li In the \uicontrol {Texture Editor} view, you create and manage - textures. - \li - \li \l{Texture Editor} - \row - \li \l{Effect Composer} - \li Use \uicontrol {Effect Composer} to compose custom effects. - \li - \li \l{Effect Composer} - \endtable - - \section1 Summary of Main Toolbar Actions - - The top level toolbar in the \uicontrol Design mode contains shortcuts to - widely used actions. - - \table - \header - \li Button/Field - \li Action - \li Keyboard Shortcut - \li Read More - - \row - \li \inlineimage icons/home.png - \li \uicontrol {Home}: opens the welcome page. - \li - \li - \row - \li \inlineimage icons/start_playback.png - \li \uicontrol {Play}: runs the application. - \li - \li - \row - \li \uicontrol {Live Preview} - \li Shows a preview of the current file or the entire UI. The changes you - make to the UI are instantly visible to you in the preview. - \li \key Alt+P (\key Opt+P on \macos) - \li \l{Validating with Target Hardware} - - \row - \li Currently open file - \li Displays the location and filename of the currently open file. You - can select another file in the list of open files to view it in - the \uicontrol {2D} and \uicontrol Navigator views. - \li - \li \l{Open Documents} - \row - \li \inlineimage icons/prev.png - \li \uicontrol {Go Back}: moves a step backwards in your location history. - That is, returns the focus to the last location in the last file it - was on. - \li \key Alt+< (\key Opt+Cmd+< on \macos) - \li - \row - \li \inlineimage icons/next.png - \li \uicontrol {Go Forward}: moves a step forward in your location history. - \li \key Alt+> (\key Opt+Cmd+> on \macos) - \li - \row - \li \inlineimage icons/close.png - \li \uicontrol {Close Document}: closes the current file. - \li \key Ctrl+W (\key Cmd+W on \macos) - \li - \row - \li \inlineimage icons/create_component.png - \li Creates a custom component from the selected item. - \li - \li \l{Creating Custom Components} - \row - \li \inlineimage icons/edit_component.png - \li Edits the selected custom component. - \li - \li \l{Creating Custom Components} - \row - \li Workspace - \li Displays the currently selected workspace. To switch to another - workspace, select it in the list. - \li - \li \l{Managing Workspaces} - \row - \li \inlineimage icons/lockoff.png - / \inlineimage icons/lockon.png - \li Toggles the views to locked or movable in \QDS. - \li - \li \l{Managing Workspaces} - \row - \li \uicontrol Share - \li Shares the application online using Qt Design Viewer. - \li - \li \l{Sharing Applications Online} - \endtable + \annotatedlist studio-views */ diff --git a/doc/qtdesignstudio/src/views/qtquick-easing-curve-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-easing-curve-editor.qdoc index ef518989ce..66b54c0d55 100644 --- a/doc/qtdesignstudio/src/views/qtquick-easing-curve-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-easing-curve-editor.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -79,7 +79,7 @@ \endlist When you attach easing curves to keyframes, the shape of the - \l{keyframe_marker}{keyframe marker} on a keyframe track in + keyframe marker on a keyframe track in \l Timeline changes from \inlineimage icons/keyframe_linear_active.png to a marker that describes the type of the selected easing curve. diff --git a/doc/qtdesignstudio/src/views/qtquick-effect-maker-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-effect-maker-view.qdoc index 3d7e046d85..f0de1a3522 100644 --- a/doc/qtdesignstudio/src/views/qtquick-effect-maker-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-effect-maker-view.qdoc @@ -4,10 +4,14 @@ /*! \page qtquick-effect-composer-view.html \previouspage studio-qt-insight.html - \nextpage creator-project-managing-workspaces.html + \nextpage studio-model-editor.html + + \ingroup studio-views \title Effect Composer + \brief Compose custom effects. + Use \uicontrol {Effect Composer} to create post-processing effects that can be applied to 2D or 3D components. The effects created with \uicontrol {Effect Composer} are shader effects, which can be used in any \QDS projects. @@ -86,4 +90,4 @@ \uicontrol Navigator, and in \uicontrol Properties > \uicontrol {Exposed Custom Properties}, select or clear the \uicontrol timeRunning checkbox. - +*/ diff --git a/doc/qtdesignstudio/src/views/qtquick-form-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-form-editor.qdoc index 3ac3027392..7ecd0a77db 100644 --- a/doc/qtdesignstudio/src/views/qtquick-form-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-form-editor.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,13 +6,17 @@ \previouspage creator-using-qt-quick-designer.html \nextpage studio-3d-editor.html + \ingroup studio-views + \title 2D + \brief Design 2D UIs. + You design applications in the \uicontrol {2D} view by opening component files and placing instances of \l{Component Types}{2D components} and \l{Assets}{assets} into them. - \image qmldesigner-form-editor.png "The 2D view" + \image qmldesigner-form-editor.webp "The 2D view" When you select component instances in the \uicontrol {2D} view, markers appear around their edges and in their corners. Depending on the shape of @@ -25,60 +29,12 @@ \li \l{Rotating 2D Components}{Rotate} \endlist - \section1 Summary of 2D View Buttons - - The \uicontrol {2D} view toolbar contains the following buttons and - fields. - - \table - \header - \li Button/Field - \li Tooltip - \li Read More - \row - \li \uicontrol {Override Width} - \li Shows a preview of the component using the specified width. - \li \l{Previewing Component Size} - \row - \li \uicontrol {Override Height} - \li Shows a preview of the component using the specified height. - \li \l{Previewing Component Size} - \row - \li \inlineimage icons/canvas-color.png - \li Sets the color of the \uicontrol {2D} view working area. - \li \l{Setting Canvas Color} - \row - \li \inlineimage icons/zoomIn.png - \li Zooms in. - \li \l{Zooming} - \row - \li \inlineimage icons/zoomOut.png - \li Zooms out. - \li \l{Zooming} - \row - \li Zoom level - \li Sets the zoom level that you select from the list. - \li \l{Zooming} - \row - \li \inlineimage icons/zoomAll.png - \li Zooms to fit all content. - \li \l{Zooming} - \row - \li \inlineimage icons/zoomSelection.png - \li Zooms to fit the current selection. - \li \l{Zooming} - \row - \li \inlineimage icons/reset.png - \li Refreshes the contents of the \uicontrol {2D} view. - \li \l{Refreshing 2D View Contents} - \endtable - \section1 Moving Components When the move cursor is displayed, you can move the selected component instance to any position in the \uicontrol {2D} view. - \image qmldesigner-form-editor-move-cursor.png "Move cursor in the 2D view" + \image qmldesigner-form-editor-move-cursor.webp "Move cursor in the 2D view" For more information about alternative ways of positioning component instances in UIs, see \l{Scalable Layouts}. @@ -88,7 +44,7 @@ When the resize cursor is displayed, you can drag the markers to resize component instances. - \image qtquick-designer-scaling-items.png "The 2D view" + \image qtquick-designer-scaling-items.webp "The 2D view" To have the resizing done from the center of the selected component instance rather than from its edges, press \key Alt (or \key Opt on \macos). @@ -110,7 +66,7 @@ clockwise or counter-clockwise to freely rotate the component instance around its origin. - \image qtquick-designer-rotating-items.png "2D rotation tool" + \image qtquick-designer-rotating-items.webp "2D rotation tool" Additionally, press \key Shift or \key Alt (or \key Opt on \macos) to rotate component instances in steps of 5 or 45 degrees, respectively. @@ -152,9 +108,9 @@ \image qtquick-designer-options.png "Qt Quick Designer preferences" The following image shows the snapping lines (1) when - \uicontrol {Parent component padding} is set to 5 pixels. + \uicontrol {Parent component padding} is set to 10 pixels. - \image qmldesigner-snap-margins.png "Snapping lines on canvas" + \image qmldesigner-snap-margins.webp "Snapping lines on canvas" For alternative ways of aligning and distributing component instances by using the \l Properties view, see \l{Aligning and Distributing Components}. @@ -181,7 +137,7 @@ values are not changed permanently in the UI file. You can permanently change the property values in the \uicontrol Properties view (4). - \image qmldesigner-preview-size.png "Component width and height" + \image qmldesigner-preview-size.webp "Component width and height" To set the initial size of the root component, select \uicontrol Edit > \uicontrol Preferences > \uicontrol {Qt Quick} > \uicontrol {Qt Quick Designer} @@ -204,7 +160,7 @@ not affect the background color of your root component or component instances in any way. - \image qmldesigner-canvas-color.png "Transparent canvas color for a transparent component instance" + \image qmldesigner-canvas-color.webp "Transparent canvas color for a transparent component instance" \section1 Refreshing 2D View Contents @@ -219,6 +175,4 @@ To refresh the contents of the \uicontrol {2D} view, press \key R or select the \inlineimage icons/reset.png (\uicontrol {Reset View}) button. - - \include qtquick-component-context-menu.qdocinc context-menu */ diff --git a/doc/qtdesignstudio/src/views/qtquick-navigator.qdoc b/doc/qtdesignstudio/src/views/qtquick-navigator.qdoc index f0cd1fe235..cfba22dc60 100644 --- a/doc/qtdesignstudio/src/views/qtquick-navigator.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-navigator.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,8 +6,12 @@ \previouspage quick-assets.html \nextpage qtquick-properties-view.html + \ingroup studio-views + \title Navigator + \brief View the composition of the current component file as a tree structure. + The \uicontrol Navigator view displays the components in the current component file and their relationships. \l{glossary-component}{Components} (1) are listed in a tree structure, below their parent (2). You can preview @@ -36,57 +40,11 @@ you can change the source of an Image component by selecting \uicontrol {Change Source URL} in the context menu. - \section1 Summary of Navigator Buttons - - The following table lists the \uicontrol Navigator buttons: - - \table - \header - \li Icon - \li Tooltip - \li Read More - \row - \li \inlineimage icons/arrowleft.png - \li Moves the component one level up in the component tree, so that - it becomes the last sibling of its current parent. - \li \l{Arranging Components} - \row - \li \inlineimage icons/arrowright.png - \li Moves the component one level down in the component tree, so that it - becomes the child of its last sibling. - \li \l{Arranging Components} - \row - \li \inlineimage icons/navigator-arrowdown.png - \li Moves the component down within its parent. - \li \l{Arranging Components} - \row - \li \inlineimage icons/navigator-arrowup.png - \li Moves the component up within its parent. - \li \l{Arranging Components} - \row - \li \inlineimage icons/filtericon.png - \li Shows and hides invisible components in \uicontrol Navigator. - \li \l{Showing and Hiding Components} - \row - \li \inlineimage icons/alias.png - \li Adds a property alias that you can use from outside of the - component. - \li \l{Adding Property Aliases} - \row - \li \inlineimage icons/visibilityon.png - \li Shows and hides components in the \uicontrol {2D} view. - \li \l{Showing and Hiding Components} - \row - \li \inlineimage icons/lockon.png - \li Locks components in all views. - \li \l{Locking Components} - \endtable - \section1 Showing and Hiding Components To show and hide components in the \uicontrol {2D} view when focusing on - specific parts of the application, click \inlineimage icons/visibilityon.png - in \uicontrol Navigator. + specific parts of the application, select \inlineimage icons/eye_open.png and + \inlineimage icons/visibility-off.png in \uicontrol Navigator. To change the visibility of a component in the application code, select the \uicontrol Visibility check box in the \uicontrol Properties view or select @@ -99,10 +57,8 @@ component. To hide or show child components, edit the properties of the parent component. - To hide invisible components in \uicontrol Navigator, click - \inlineimage icons/filtericon.png - (\uicontrol {Filter Tree}) and select - \uicontrol {Show Only Visible Components}. + To show and hide invisible components in \uicontrol Navigator, select + \inlineimage {icons/visibilityon.png}. \section1 Locking Components @@ -141,9 +97,8 @@ By default, components that are located at the top of the file are listed at the bottom of the \uicontrol Navigator tree and behind overlapping components in the \uicontrol {2D} view. To list the components in the order - in which they appear in the file, as some other tools do, click - \inlineimage icons/filtericon.png - (\uicontrol {Filter Tree}), and select \uicontrol {Reverse Component Order}. + in which they appear in the file, as some other tools do, select + \inlineimage {icons/reverse_order.png}. To move a component to the top or bottom of the tree within its parent, right-click it in the \uicontrol Navigator or \uicontrol {2D} view @@ -156,20 +111,18 @@ \image qtquick-designer-navigator-arrange.gif "Reversing component order" - You can also drag-and-drop the component to another position in the tree or - use the arrow buttons to move the component in the tree. You can use the - left and right arrow buttons to change the parent of the component. + You can also drag the component to another position in the tree or use the + \inlineimage {icons/navigator-arrowup.png} and \inlineimage {icons/navigator-arrowdown.png} + buttons to move the component in the tree. You can use the \inlineimage {icons/arrowleft.png} + and \inlineimage {icons/arrowright.png} buttons to change the parent of the component. \image qmldesigner-navigator-arrows.png "Navigator buttons" - When you drag-and-drop instances of components to the \uicontrol {2D} view, + When you drag instances of components to the \uicontrol {2D} view, the new component is added as a child of the component beneath it. When you move the components, it is not possible to determine whether you want to adjust their position or attach them to a new parent component. - Therefore, the parent component is not automatically changed. To change the - parent of the component, press down the \key Shift key before you drag-and-drop - the component into a new position. The topmost component under the cursor becomes the - new parent of the component. + Therefore, the parent component is not automatically changed. \section1 Adding Property Aliases @@ -236,5 +189,4 @@ \image qmldesigner-breadcrumbs.png "Component hierarchy" - \include qtquick-component-context-menu.qdocinc context-menu */ diff --git a/doc/qtdesignstudio/src/views/qtquick-properties-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-properties-view.qdoc index acde01a951..2d660c9951 100644 --- a/doc/qtdesignstudio/src/views/qtquick-properties-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-properties-view.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,21 +6,25 @@ \previouspage qtquick-navigator.html \nextpage qtquick-connection-view.html + \ingroup studio-views + \title Properties + \brief Modify the properties of the selected component. + The \uicontrol Properties view displays all the properties of the selected \l{glossary-component}{component}. The properties are grouped by type. The top part of the view displays properties that are common to all components, such as component type, ID, name, geometry, and visibility. - \image qtquick-item-properties-common.png "Basic component properties" + \image qtquick-item-properties-common.webp "Basic component properties" The bottom part of the view displays properties that have been defined for the component type. For example, the following image displays the predefined properties you can set for \l{basic-rectangle}{Rectangle} and \l Text components. - \image qmldesigner-element-properties.png "Rectangle and Text properties" + \image qmldesigner-element-properties.webp "Rectangle and Text properties" \section1 Custom Properties @@ -42,46 +46,6 @@ \image custom-properties.png - \section1 Summary of Properties View Buttons - - The following table lists the \uicontrol Properties view buttons: - - \table - \header - \li Icon - \li Tooltip - \li Read More - \row - \li \inlineimage icons/alias.png - \li Adds a property alias that you can use from outside of the - component for the root component. You can use a menu item - in the actions menu to add property aliases for property - values of child components. - \li \l{Adding Property Aliases} - \row - \li \inlineimage icons/action-icon.png - \li Opens a menu with actions for: - \list - \li Resetting property values to their default values - \li Setting property bindings - \li Creating property aliases - \li Inserting keyframes for timeline animations - \endlist - \li - \list - \li \l{Viewing Changes in Properties} - \li \l{Adding Bindings Between Properties} - \li \l{Adding Property Aliases} - \li \l{Setting Keyframe Values} - \endlist - \row - \li \inlineimage icons/action-icon-binding.png - \li Indicates that the value of the property is bound to the value - of another property. Opens the same menu as the action icon. - \li \l{Adding Bindings Between Properties} - - \endtable - \section1 Viewing Changes in Properties The default values of properties are displayed in white color, while the diff --git a/doc/qtdesignstudio/src/views/qtquick-properties.qdoc b/doc/qtdesignstudio/src/views/qtquick-properties.qdoc index fc8ba92e93..87dfd7a341 100644 --- a/doc/qtdesignstudio/src/views/qtquick-properties.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-properties.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -17,7 +17,7 @@ All components share a set of properties that you can specify in the \uicontrol Properties view. - \image qtquick-item-properties-common.png "Basic component properties" + \image qtquick-item-properties-common.webp "Basic component properties" \section2 Type diff --git a/doc/qtdesignstudio/src/views/qtquick-states-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-states-view.qdoc index 407e2f5769..5270df5b06 100644 --- a/doc/qtdesignstudio/src/views/qtquick-states-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-states-view.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -7,12 +7,16 @@ \nextpage studio-translations.html \sa {Working with States} + \ingroup studio-views + \title States + \brief Apply states to a component. + The \uicontrol States view displays the different \l{Working with States}{states} of a UI. - \image qmldesigner-transitions.png "States view" + \image qmldesigner-transitions.webp "States view" To open the \uicontrol States view, select \uicontrol View > \uicontrol Views > \uicontrol States. diff --git a/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc index f202df3c37..6941a1c2ec 100644 --- a/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc @@ -6,8 +6,12 @@ \previouspage qtquick-curve-editor.html \nextpage creator-projects-view.html + \ingroup studio-views + \title Code + \brief View and modify the code generated by the visual editors. + To view and modify the code in a \l{UI Files}{UI file} (.ui.qml) or component file (.qml), go to \uicontrol View and select \uicontrol Views > \uicontrol Code. \QDS generates the code when you create components in the diff --git a/doc/qtdesignstudio/src/views/qtquick-timeline-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-timeline-view.qdoc index 8194726184..2e34d70dc4 100644 --- a/doc/qtdesignstudio/src/views/qtquick-timeline-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-timeline-view.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,14 +6,18 @@ \previouspage qtquick-transition-editor.html \nextpage qtquick-curve-editor.html + \ingroup studio-views + \title Timeline + \brief Animate the properties of components. + You can use the timeline and keyframe based editor in the \uicontrol Timeline view to animate the properties of \l{glossary_component}{components}. The view is empty until you create a timeline. - \image studio-timeline-empty.png "Empty Timeline view" + \image studio-timeline-empty.webp "Empty Timeline view" Select the \inlineimage icons/plus.png (\uicontrol {Add Timeline}) button to @@ -23,7 +27,7 @@ \image studio-timeline-settings.png "Timeline Settings dialog" When you select \uicontrol Close, the \uicontrol Timeline view appears. - It now displays a \l{Timeline Toolbar}{toolbar} and a ruler but no + It now displays a toolbar and a ruler but no keyframe tracks. \image studio-timeline-no-tracks.webp "Timeline view without keyframe tracks" @@ -86,171 +90,4 @@ \image studio-timeline-keyframe-track-colors.webp "Keyframe track colors in Timeline" - \section1 Timeline Toolbar - - The \uicontrol Timeline toolbar contains the following buttons and fields. - - \table - \header - \li Button/Field - \li Action - \li Read More - \row - \li \inlineimage icons/settings.png - \li Opens the \uicontrol {Timeline Settings} dialog for editing - timeline settings. - \li \l{Creating a Timeline} - \row - \li Timeline ID - \li Displays the ID of the current timeline. - \li \l{Creating a Timeline} - \row - \li \inlineimage icons/to_first_frame.png - \li \uicontrol {To Start (Home)} moves to the first frame on the - timeline. - \li \l{Navigating in Timeline} - \row - \li \inlineimage icons/back_one_frame.png - \li \uicontrol {Previous (,)} moves to the previous frame on the - timeline. - \li \l{Navigating in Timeline} - \row - \li \inlineimage icons/start_playback.png - \li \uicontrol {Play (Space)} previews the animation. - \li \l{Viewing the Animation} - \row - \li \inlineimage icons/forward_one_frame.png - \li \uicontrol {Next (.)} moves to the next frame on the timeline. - \li \l{Navigating in Timeline} - \row - \li \inlineimage icons/to_last_frame.png - \li \uicontrol {To End (End)} moves to the last frame on the timeline. - \li \l{Navigating in Timeline} - \row - \li Current Keyframe - \li Displays the frame that the playhead is currently on. Enter a - number in the field to move the playhead to the respective frame. - \li \l{Navigating in Timeline} - \row - \li \inlineimage icons/global_record_keyframes.png - \li Records changes in keyframe values. - \li \l {Setting Keyframe Values} - \row - \li \inlineimage icons/curve_editor.png - \li Opens \uicontrol {Easing Curve Editor} for attaching an easing - curve to the selected transition. - \li \l{Editing Easing Curves} - \row - \li Start Frame - \li Specifies the first frame of the timeline. Negative values are - allowed. The difference between the start frame and the end frame - determines the duration of the animation. - \li \l{Creating a Timeline} - \row - \li \inlineimage icons/zoomOut.png - \li \uicontrol {Zoom Out} (\key Ctrl+-) zooms out of the view. - \li \l{Zooming in Timeline} - \row - \li Slider - \li Sets the zooming level. - \li \l{Zooming in Timeline} - \row - \li \inlineimage icons/zoomIn.png - \li \uicontrol {Zoom In} (\key Ctrl++) zooms into the view. - \li \l{Zooming in Timeline} - \row - \li End Frame - \li Specifies the last frame of the timeline. The difference between - the start frame and the end frame determines the duration of the - animation, so if the start frame is 0, the end frame equals the - duration. - \li \l{Creating a Timeline} - \row - \li State Name - \li Displays the name of the current state. - \li \l{Binding Animations to States} - \endtable - - \section1 Keyframe Track Icons - - Each keyframe track can contain the following buttons and markers. - - \table - \header - \li Button/Icon - \li Action - \li Read More - \row - \li \inlineimage icons/previous_keyframe.png - \li Jumps to the previous frame on the timeline. - \li \l{Setting Keyframe Values} - \row - \li \inlineimage icons/next_keyframe.png - \li Jumps to the next frame on the timeline. - \li \l{Setting Keyframe Values} - \row - \li \inlineimage icons/local_record_keyframes.png - \li Records changes in keyframe values for a particular property. - \li \l {Setting Keyframe Values} - \target keyframe_marker - \row - \li \inlineimage icons/keyframe.png - \li Indicates the type of easing curve attached to the keyframe. - When a keyframe track is selected, the keyframe markers on it turn - gray, and when a keyframe itself is selected, its marker turns - brown: - \list - \li \inlineimage icons/keyframe_linear_active.png - - linear easing curve - \li \inlineimage icons/keyframe_manualbezier_active.png - - manually set Bezier curve - \li \inlineimage icons/keyframe_autobezier_active.png - - automatically set Bezier curve - \li \inlineimage icons/keyframe_lineartobezier_active.png - - linear-to-Bezier curve - \endlist - \li \l {Editing Easing Curves} - \endtable - - \section1 Timeline Context Menu - - The following table summarizes the context menu items available for each - keyframe track for a component, property, or keyframe marker and provides - links to more information about them. - - \table - \header - \li To Learn About - \li Go To - \row - \li Delete All Keyframes - \li \l{Deleting Keyframes} - \row - \li Add Keyframes at Current Frame - \li \l{Setting Keyframe Values} - \row - \li Copy All Keyframes - \li \l{Copying Keyframes} - \row - \li Paste Keyframes - \li \l{Copying Keyframes} - \row - \li Remove Property - \li \l{Setting Keyframe Values} - \row - \li Delete Keyframe - \li \l{Deleting Keyframes} - \row - \li Edit Easing Curve - \li \l{Editing Easing Curves} - \row - \li Edit Keyframe - \li \l{Editing Keyframe Values} - \row - \li Override Color - \li \l{Setting Keyframe Track Color} - \row - \li Reset Color - \li \l{Setting Keyframe Track Color} - \endtable */ diff --git a/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc b/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc index c6a33f62c7..b599932ed0 100644 --- a/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -191,7 +191,7 @@ position of the playhead, right-click the component name on the timeline and select \uicontrol {Add Keyframes at Current Frame}. - Keyframes are marked on the timeline by using \l{keyframe_marker}{markers} + Keyframes are marked on the timeline by using markers of different colors and shapes, depending on whether they are active or inactive or whether you have applied \l{Editing Easing Curves} {easing curves} to them. diff --git a/doc/qtdesignstudio/src/views/qtquick-transition-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-transition-editor.qdoc index b21207259e..7f73e0ceca 100644 --- a/doc/qtdesignstudio/src/views/qtquick-transition-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-transition-editor.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,8 +6,12 @@ \previouspage studio-translations.html \nextpage qtquick-timeline-view.html + \ingroup studio-views + \title Transitions + \brief Make movement between states smooth. + To make movement between states smooth, you can use \uicontrol {Transitions} to animate the changes between states. @@ -17,7 +21,7 @@ animated, such as colors or numbers, in the \l Properties view. For example, you can animate the changes in the position of a component. - \image qtquick-transition-editor-view.png "Transitions view" + \image qtquick-transition-editor-view.webp "Transitions view" In \uicontrol {Transitions}, you can set the start frame, end frame, and duration for the transition of each property. You can also @@ -31,46 +35,6 @@ and \inlineimage icons/zoom_big.png buttons to zoom out of or into the view. - \section1 Summary of Transitions Toolbar Actions - - \table - \header - \li Button/Field - \li Action - \li Read More - \row - \li \inlineimage icons/settings.png - \li Opens \uicontrol {Transition Settings} dialog for editing - transition settings. - \li \l{Specifying Transition Settings} - \row - \li Transition ID - \li Displays a list of transitions that you can open in - \uicontrol {Transitions}. - \li \l{Animating Transitions Between States} - \row - \li \inlineimage icons/curve_editor.png - \li Opens \uicontrol {Easing Curve Editor} for attaching an easing - curve to the selected transition. - \li \l{Editing Easing Curves} - \row - \li \inlineimage icons/zoomOut.png - \li \uicontrol {Zoom Out} (\key Ctrl+-): zooms out of the view. - \li \l{Zooming in Transitions} - \row - \li Slider - \li Sets the zooming level. - \li \l{Zooming in Transitions} - \row - \li \inlineimage icons/zoomIn.png - \li \uicontrol {Zoom In} (\key Ctrl++): zooms into the view. - \li \l{Zooming in Transitions} - \row - \li Maximum Duration - \li Specifies the maximum duration of the transition. - \li - \endtable - \section1 Animating Transitions Between States To animate transitions: @@ -78,12 +42,12 @@ \list 1 \li Select \uicontrol View > \uicontrol Views > \uicontrol {Transition Editor}. - \image qmldesigner-transition-editor-startup.png "Empty Transitions view" + \image qmldesigner-transition-editor-startup.webp "Empty Transitions view" \li Select the \inlineimage icons/plus.png (\uicontrol {Add Transition}) button to add a transition. This works only if you have added at least one state and modified at least one property in it. - \image qtquick-transition-editor-view.png "Transitions view" + \image qtquick-transition-editor-view.webp "Transitions view" \li Move the blue bar next to the component or property name to set the start and end frame of the animation of the property. Pull its left and right edges to set the duration of the animation. @@ -98,7 +62,7 @@ (\uicontrol {Transition Settings (S)}) button in \uicontrol {Transition Editor}. - \image qtquick-transition-editor-settings.png "Transitions settings" + \image qtquick-transition-editor-settings.webp "Transitions settings" To add transitions: diff --git a/doc/qtdesignstudio/src/views/studio-content-library.qdoc b/doc/qtdesignstudio/src/views/studio-content-library.qdoc index e2785149e1..b3dbb28065 100644 --- a/doc/qtdesignstudio/src/views/studio-content-library.qdoc +++ b/doc/qtdesignstudio/src/views/studio-content-library.qdoc @@ -6,8 +6,13 @@ \previouspage creator-open-documents-view.html \nextpage studio-texture-editor.html + \ingroup studio-views + \title Content Library + \brief Select material, texture, and environment bundles with assets to + use in your application. + \note The \uicontrol {Content Library} view is included in the \l{https://www.qt.io/pricing}{Qt Design Studio Enterprise license}. diff --git a/doc/qtdesignstudio/src/views/studio-material-editor.qdoc b/doc/qtdesignstudio/src/views/studio-material-editor.qdoc index bb2923a7ab..44cea9504a 100644 --- a/doc/qtdesignstudio/src/views/studio-material-editor.qdoc +++ b/doc/qtdesignstudio/src/views/studio-material-editor.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2022 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,9 +6,12 @@ \previouspage studio-3d-editor.html \nextpage quick-components-view.html + \ingroup studio-views \title Material Editor and Browser + \brief Create and manage materials and textures. + In the \uicontrol {Material Editor} and \uicontrol {Material Browser} views, you create and manage materials and textures. @@ -21,7 +24,8 @@ To create a new material, do one of the following: \list - \li In \uicontrol {Material Browser}, select \inlineimage icons/plus.png + \li In \uicontrol {Material Browser}, select \inlineimage icons/add_material.png + \inlineimage icons/plus.png . \li In \uicontrol {Material Editor}, select \inlineimage icons/plus.png . @@ -67,7 +71,7 @@ \li In \uicontrol{Properties}, select \inlineimage icons/close.png next to the material. - \image materials-remove-material.png + \image materials-remove-material.webp "Remove a material in model properties" \endlist \section2 Copying and Pasting Material Properties @@ -82,7 +86,7 @@ want to copy properties from. \li Select \uicontrol {Copy properties} and then \uicontrol All or a property group. - \image material-copy-properties.png + \image material-copy-properties.png "Copy material properties in Material Browser" \li Right-click the material that you want to copy the properties to. \li Select \uicontrol {Paste properties}. \endlist @@ -114,11 +118,10 @@ \li From \uicontrol{Assets}, drag an image to \uicontrol{Reflection Map}. \li In \uicontrol {Navigator}, select - \inlineimage icons/filtericon.png - and then clear \uicontrol {Show Only Visible Components}. Now the + \inlineimage {icons/visibilityon.png}. Now the texture you just added to the material is visible in \uicontrol {Navigator}. - \image navigator-material-texture.png + \image navigator-material-texture.webp "Materials visible in Navigator" \li In \uicontrol {Navigator}, select the texture. \li In \uicontrol {Properties}, set \uicontrol {Texture Mapping} to \uicontrol {Environment}. @@ -276,8 +279,8 @@ To create a new texture, do one of the following in \uicontrol {Material Browser}: \list - \li Select \inlineimage icons/plus.png - in the \uicontrol Textures section. + \li Select \inlineimage icons/add_texture.png \inlineimage icons/plus.png + . \li Right-click anywhere in the \uicontrol Textures section and select \uicontrol {Create new texture}. \endlist diff --git a/doc/qtdesignstudio/src/views/studio-model-editor.qdoc b/doc/qtdesignstudio/src/views/studio-model-editor.qdoc new file mode 100644 index 0000000000..4d10f87552 --- /dev/null +++ b/doc/qtdesignstudio/src/views/studio-model-editor.qdoc @@ -0,0 +1,62 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page studio-model-editor.html + \previouspage qtquick-effect-composer-view.html + \nextpage creator-project-managing-workspaces.html + + \ingroup studio-views + + \title Model Editor + + \brief Create, manage, import, and export data models. + + In the \uicontrol {Model Editor} view, you can create, manage, import, and export + data models. With data models, you can, for example, populate views with data. + + \image edit-list-model-model-editor.webp + + For examples of how to use data models, see + \l {Adding a Repeater3D Component with a List Model}. + + \section1 Creating a Data Model + + To create a data model: + \list 1 + \li In \uicontrol {Model Editor}, select \inlineimage {icons/zoomIn.png}. + \li Enter a name and select \uicontrol {Create}. + \endlist + + This creates a single-cell table. + + \image model-editor-new-model.webp + + Next, add columns, rows, and data to the model. + + \note You must manually save the table after you have made changes. To do this, + select \inlineimage {icons/save-effect-composer.png}. + + \section1 Editing a Data Model + + Edit a data model in one of the following ways: + \list + \li Right-click a column name to edit its name and type, delete, or sort it. + \li Double-click a cell to edit its content. + \li Use the toolbar to add and remove columns and rows. + \endlist + + \note You must manually save the table after you have made changes. To do this, + select \inlineimage {icons/save-effect-composer.png}. + + \section1 Importing a Data Model + + Import data models from JSON or CSV files. To do this, select \inlineimage {icons/import.png} + in \uicontrol {Model Editor}. + + \section1 Exporting a Data Model + + Export data models to JSON or CSV files. To do this, select \inlineimage {icons/export.png} + in \uicontrol {Model Editor}. + +*/ diff --git a/doc/qtdesignstudio/src/views/studio-qtinsight.qdoc b/doc/qtdesignstudio/src/views/studio-qtinsight.qdoc index 6af9b071e1..6f420e1cb7 100644 --- a/doc/qtdesignstudio/src/views/studio-qtinsight.qdoc +++ b/doc/qtdesignstudio/src/views/studio-qtinsight.qdoc @@ -6,8 +6,12 @@ \previouspage studio-texture-editor.html \nextpage qtquick-effect-composer-view.html + \ingroup studio-views + \title Qt Insight + \brief Manage your Qt Insight. + In the \uicontrol {Qt Insight} view, you manage your Qt Insight. Qt Insight is an analytics solution that provides real user insights on the usage of Qt diff --git a/doc/qtdesignstudio/src/views/studio-texture-editor.qdoc b/doc/qtdesignstudio/src/views/studio-texture-editor.qdoc index ef45d8efdf..62b0eb147c 100644 --- a/doc/qtdesignstudio/src/views/studio-texture-editor.qdoc +++ b/doc/qtdesignstudio/src/views/studio-texture-editor.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2022 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,11 +6,15 @@ \previouspage studio-content-library.html \nextpage studio-qt-insight.html + \ingroup studio-views + \title Texture Editor + \brief Create and manage textures. + In the \uicontrol {Texture Editor} view, you create and manage textures. - \image texture-editor.png + \image texture-editor.webp "Texture Editor" \section1 Creating a Texture @@ -38,7 +42,7 @@ \li Select \inlineimage icons/apply.png . \li Select the material and property that you want to add the texture to. - \image select-material-property.png + \image select-material-property.png "Select a material property" \endlist \note You can also apply textures to materials in the diff --git a/doc/qtdesignstudio/src/views/studio-translations.qdoc b/doc/qtdesignstudio/src/views/studio-translations.qdoc index a2a610b313..ecf43369a4 100644 --- a/doc/qtdesignstudio/src/views/studio-translations.qdoc +++ b/doc/qtdesignstudio/src/views/studio-translations.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -6,8 +6,12 @@ \previouspage qtquick-states-view.html \nextpage qtquick-timeline-view.html + \ingroup studio-views + \title Translations + \brief Handle translations and multi-language support. + The \uicontrol Translations view is included in the \l{https://www.qt.io/pricing}{Qt Design Studio Enterprise license}. @@ -16,49 +20,6 @@ \image studio-translations-view.png "Translations view" - \section1 Summary of Translations View Buttons - - The \uicontrol {Translations} view contains the following buttons. - - \table - \header - \li Button - \li Function - \li Read More - \row - \li \inlineimage icons/select-languages.png - \li Select which languages you want your project to support. - \li - \row - \li \inlineimage icons/export-json-translations.png - \li Export all your translations to a JSON file. - \li \l{Importing and Exporting Translations} - \row - \li \inlineimage icons/import-json-translations.png - \li Import translations from a JSON file. - \li \l{Importing and Exporting Translations} - \row - \li \inlineimage icons/generate-translation-files.png - \li Generate Qt compiled translation source files (\e{.qm}) - and Qt translation source files (\e{.ts}). - \li \l{Generating Qt Translation Source Files} - \row - \li \inlineimage icons/project-translation-test.png - \li Run translation test for several documents and create a test report. - \li \l{Running Translation Test for Several Documents} - \row - \li \inlineimage icons/qml-translation-test.png - \li Run translation test for the currently open document. This test - shows translation warnings in the \uicontrol{2D} view and creates a - test report. - \li \l{Running Translation Test for a Single Document} - \row - \li \inlineimage icons/export-translations.png - \li Export all translations used in your project or all translations - currently visible in your UI. - \li \l{Exporting Translations in Other Ways} - \endtable - \section1 Importing and Exporting Translations You can import and export translations using JSON files. diff --git a/doc/qtdesignstudio/src/views/studio-workspaces.qdoc b/doc/qtdesignstudio/src/views/studio-workspaces.qdoc index 407513c40f..ed79be99d1 100644 --- a/doc/qtdesignstudio/src/views/studio-workspaces.qdoc +++ b/doc/qtdesignstudio/src/views/studio-workspaces.qdoc @@ -3,7 +3,7 @@ /*! \page creator-project-managing-workspaces.html - \previouspage qtquick-effect-composer-view.html + \previouspage studio-model-editor.html \nextpage creator-project-managing-sessions.html \title Managing Workspaces |
