diff options
Diffstat (limited to 'doc/qtdesignstudio/src')
20 files changed, 237 insertions, 365 deletions
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-setup.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-setup.qdoc index 0268fd04af..1261ee4d85 100644 --- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-setup.qdoc +++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-setup.qdoc @@ -25,7 +25,7 @@ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \previouspage psqtbridge.html \page qtbridge-ps-setup.html \nextpage qtbridge-ps-using.html diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-setup.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-setup.qdoc index 4c761b90d0..1f7a49d2e0 100644 --- a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-setup.qdoc +++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-setup.qdoc @@ -25,7 +25,7 @@ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \previouspage sketchqtbridge.html \page qtbridge-sketch-setup.html \nextpage qtbridge-sketch-using.html diff --git a/doc/qtdesignstudio/src/qtdesignstudio-adding-dynamics.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-adding-dynamics.qdoc deleted file mode 100644 index 60891e2aa3..0000000000 --- a/doc/qtdesignstudio/src/qtdesignstudio-adding-dynamics.qdoc +++ /dev/null @@ -1,70 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2019 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Design Studio documentation. -** -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** -****************************************************************************/ - -/*! - \contentspage {Qt Design Studio Manual} - \page studio-adding-dynamics.html - \previouspage studio-fonts.html - \nextpage studio-timeline.html - - \title Adding Dynamics - - You can animate the properties of UI components and create connections - between them to enable them to communicate with each other. - - \list - \li \l {Creating Animations} - - You can use a timeline and keyframe based editor in the - \uicontrol Timeline view to animate the properties of UI - components. Animating properties enables their values to - move through intermediate values at specified keyframes - instead of immediately changing to the target value. - \li \l {Adding Connections} - - You can create connections between the UI components and - the application to enable them to communicate with each other. For - example, how does the appearance of a button change on a mouse click - and which action does the application need to perform in response to - it. - - You can also create connections between UI components by - binding their properties together. This way, when the value of a - property changes in a parent component, it can be automatically - changed in all the child components, for example. - \li \l {Adding States} - - Qt Quick allows you to declare various UI states that describe - how component properties change from a base state. Therefore, - states can be a useful way of organizing your UI - logic. You can associate transitions with items to define - how their properties will animate when they change due to a state - change. - \li \l {Editing PathView Properties} - - You can use a graphical spline editor to specify \l{PathView} paths. - A path view lays out data provided by data models on a \l{Path}. - \endlist -*/ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc index b10c89527c..1b4fc73284 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \previouspage qt-design-viewer.html \page studio-advanced.html \nextpage studio-platforms.html diff --git a/doc/qtdesignstudio/src/qtdesignstudio-fonts.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-fonts.qdoc deleted file mode 100644 index 39073a2d53..0000000000 --- a/doc/qtdesignstudio/src/qtdesignstudio-fonts.qdoc +++ /dev/null @@ -1,55 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2020 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Design Studio documentation. -** -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** -****************************************************************************/ - -/*! - - \contentspage {Qt Design Studio} - \previouspage qtquick-properties.html - \page studio-fonts.html - \nextpage studio-adding-dynamics.html - - \title Using Custom Fonts - - For your UI to use custom fonts when you preview it on a device, - you have to import the fonts to the project folder. \QDS deploys them to - the device along with your UI. - - \note Use fixed-width fonts if you plan to animate running numbers, so that - they do not appear to jump around the screen when they change. - - To add fonts: - - \list 1 - \li Select \uicontrol Library > \uicontrol Assets > - \uicontrol {Add New Assets}. - \li Browse to the folder that contains the font files and select them. - \li Enter the name of the directory to save the fonts. By default, \QDS - suggests the project directory. - \li Select \uicontrol OK to save the fonts. - \endlist - - The fonts are added to the list of fonts for the \uicontrol Font property - in \uicontrol Properties. -*/ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-importing-2d.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-importing-2d.qdoc new file mode 100644 index 0000000000..9b9bd85604 --- /dev/null +++ b/doc/qtdesignstudio/src/qtdesignstudio-importing-2d.qdoc @@ -0,0 +1,109 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Bridge documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +/*! + \contentspage index.html + \previouspage studio-importing-designs.html + \page studio-importing-2d.html + \nextpage studio-importing-3d.html + + \title Importing 2D Assets + + \image studio-imported-assets.png "Artwork imported into Qt Design Studio" + + You can import assets that you exported with \QB to a \QDS project as image + and QML files and edit them in the Design mode. If you make changes to your + design in the design tool, you can merge the changes into existing QML files + without overwriting the changes you have made in \QDS. + + \note Attempting to import assets exported on another system might fail. + + The following instructions use an empty project as an example. For more + information about the options you have, see + \l {Creating Projects}. + + To import designs to \QDS projects: + + \list 1 + \li Select \uicontrol File > \uicontrol {New File or Project} > + \uicontrol General > \uicontrol Choose, and follow the + instructions of the wizard to create an empty project. + \li In \uicontrol Projects, double-click \e Screen01.ui.qml to move to + the Design mode. + \li Select \uicontrol Library > \uicontrol Assets > + \uicontrol {Add New Assets}. + \li Select the folder where you exported the assets. + \li Select \uicontrol {Exported Assets (*.metadata)} in the dropdown + menu to filter \e .metadata files. + \li Select a \e .metadata file to import, and then select + \uicontrol Open. + \li Select \uicontrol Details next to the + \uicontrol {Metadata Import Paths} field to display the path where + the metadata is imported from. + \image studio-import-metadata.png "Asset Import dialog" + \li Select \uicontrol Details next to the + \uicontrol {QML/Asset Export Paths} field to display the paths to + copy the assets to. + \li In the \uicontrol QML field, you can change the folder to copy the + QML files to. + \li In the \uicontrol Assets field, you can change the folder to copy + the image files to. + \li Deselect the \uicontrol {Import assets} check box if you only want + to create QML files. + \li Deselect the \uicontrol {Generate QML} check box if you only + want to import assets. + \li Select the \uicontrol {Merge QML} check box if you have imported the + assets before and want to merge the changes into existing QML files + instead of overwriting the existing files. + \li Select \uicontrol Import to import the QML files and assets. This + might take a little while for complex projects. + \endlist + + The imported assets are displayed in the \uicontrol Assets tab in the + \uicontrol Library as PNG images. The components that you specified in + the design tool are displayed in the \uicontrol {My QML Components} tab, + as well as in the \uicontrol Project tab of the \uicontrol Navigator as + separate QML files. + + \note The layer that was the bottom layer in the design tool becames the top + layer in the \uicontrol Navigator to reflect the QML code model. You + can view the QML code in the \uicontrol {Text Editor} tab. + + If asset importer conflicts, warnings, and errors are displayed in the + \uicontrol {Asset Import} dialog while importing, fix the issues in + design tool and export the assets again. + + \section1 \QB Videos + + For more information about importing assets from Adobe Photoshop, watch a + video tutorial and webinar about using \QB: + + \list + \li \l{https://resources.qt.io/development-topic-ui-design/qtdesignstudio-clustertutorial-partone} + {Building an Instrument Cluster for Your Car HMI, Part 1} + \li \l{https://www.youtube.com/watch?v=ZzbucmQPU44} + {From Photoshop to Prototype with Qt Design Studio} + \endlist +*/ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-importing-designs.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-importing-designs.qdoc index ce53ae2ccd..8ad05eba81 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-importing-designs.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-importing-designs.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Bridge documentation. @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \previouspage creator-vcs-git.html \page studio-importing-designs.html \nextpage studio-importing-2d.html @@ -47,131 +47,3 @@ You can then edit them in the Design mode. \endlist */ - -/*! - \contentspage {Qt Design Studio} - \previouspage studio-importing-designs.html - \page studio-importing-2d.html - \nextpage studio-importing-3d.html - - \title Importing 2D Assets - - \image studio-imported-assets.png "Artwork imported into Qt Design Studio" - - You can import assets that you exported with \QB to a \QDS project as image - and QML files and edit them in the Design mode. If you make changes to your - design in the design tool, you can merge the changes into existing QML files - without overwriting the changes you have made in \QDS. - - \note Attempting to import assets exported on another system might fail. - - The following instructions use an empty project as an example. For more - information about the options you have, see - \l {Creating Projects}. - - To import designs to \QDS projects: - - \list 1 - \li Select \uicontrol File > \uicontrol {New File or Project} > - \uicontrol General > \uicontrol Choose, and follow the - instructions of the wizard to create an empty project. - \li In \uicontrol Projects, double-click \e Screen01.ui.qml to move to - the Design mode. - \li Select \uicontrol Library > \uicontrol Assets > - \uicontrol {Add New Assets}. - \li Select the folder where you exported the assets. - \li Select \uicontrol {Exported Assets (*.metadata)} in the dropdown - menu to filter \e .metadata files. - \li Select a \e .metadata file to import, and then select - \uicontrol Open. - \li Select \uicontrol Details next to the - \uicontrol {Metadata Import Paths} field to display the path where - the metadata is imported from. - \image studio-import-metadata.png "Asset Import dialog" - \li Select \uicontrol Details next to the - \uicontrol {QML/Asset Export Paths} field to display the paths to - copy the assets to. - \li In the \uicontrol QML field, you can change the folder to copy the - QML files to. - \li In the \uicontrol Assets field, you can change the folder to copy - the image files to. - \li Deselect the \uicontrol {Import assets} check box if you only want - to create QML files. - \li Deselect the \uicontrol {Generate QML} check box if you only - want to import assets. - \li Select the \uicontrol {Merge QML} check box if you have imported the - assets before and want to merge the changes into existing QML files - instead of overwriting the existing files. - \li Select \uicontrol Import to import the QML files and assets. This - might take a little while for complex projects. - \endlist - - The imported assets are displayed in the \uicontrol Assets tab in the - \uicontrol Library as PNG images. The components that you specified in - the design tool are displayed in the \uicontrol {My QML Components} tab, - as well as in the \uicontrol Project tab of the \uicontrol Navigator as - separate QML files. - - \note The layer that was the bottom layer in the design tool becames the top - layer in the \uicontrol Navigator to reflect the QML code model. You - can view the QML code in the \uicontrol {Text Editor} tab. - - If asset importer conflicts, warnings, and errors are displayed in the - \uicontrol {Asset Import} dialog while importing, fix the issues in - design tool and export the assets again. - - \section1 \QB Videos - - For more information about importing assets from Adobe Photoshop, watch a - video tutorial and webinar about using \QB: - - \list - \li \l{https://resources.qt.io/development-topic-ui-design/qtdesignstudio-clustertutorial-partone} - {Building an Instrument Cluster for Your Car HMI, Part 1} - \li \l{https://www.youtube.com/watch?v=ZzbucmQPU44} - {From Photoshop to Prototype with Qt Design Studio} - \endlist -*/ - -/*! - \contentspage {Qt Design Studio} - \previouspage studio-importing-2d.html - \page studio-importing-3d.html - \nextpage quick-converting-ui-projects.html - - \title Importing 3D Assets - - You can import files you created using 3D graphics applications and stored - in several widely-used formats, such as .blend, .dae, .fbx, .glb, .gltf, - .obj, .uia, or .uip. For a list of formats supported by each \l{Qt Quick 3D} - version, see the module documentation. - - For more information about exporting 3D graphics from Maya, see - \l{Exporting from Maya}. - - During the import, you can optimize the files for \QDS. You can remove - components from meshes to reduce the cache size, find and fix issues in - the files, optimize graphs and meshes, and so on. The available options - depend on whether you are importing files that you created with Qt 3D Studio - or with other 3D graphics tools. See the tooltips in the options dialog - for more information about a particular option. - - \image studio-import-3d.png - - To import 3D assets to \QDS projects: - - \list 1 - \li In the Design mode, select \uicontrol Library > \uicontrol Assets - > \uicontrol {Add New Assets}. - \li Select \uicontrol {3D Assets} in the dropdown menu to filter 3D - graphics files. - \li Select a file to import, and then select \uicontrol Open. - \li In the \uicontrol {3D Scene Options} tab, select options for - importing the file. - \li Select \uicontrol Import to import the 3D graphics file. - \li When the import is done, select \uicontrol Close. - \endlist - - You can open the imported files in the Design mode for editing in the - \l{Editing 3D Scenes}{3D editor}. -*/ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-javascript.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-javascript.qdoc index a0e5926adb..a182ba7951 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-javascript.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-javascript.qdoc @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \previouspage creator-editor-options-text.html \page studio-javascript.html \nextpage studio-debugging.html diff --git a/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc index 2f48bdf68d..0e4e52a278 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \previouspage studio-advanced.html \page studio-platforms.html \nextpage creator-keyboard-shortcuts.html diff --git a/doc/qtdesignstudio/src/qtdesignstudio-prototyping.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-prototyping.qdoc deleted file mode 100644 index d511c23359..0000000000 --- a/doc/qtdesignstudio/src/qtdesignstudio-prototyping.qdoc +++ /dev/null @@ -1,91 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2020 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Design Studio documentation. -** -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** -****************************************************************************/ - -/*! - \contentspage {Qt Design Studio Manual} - \previouspage quick-converting-ui-projects.html - \page studio-prototyping.html - \nextpage quick-components.html - - \title Creating UIs - - When you install \QDS, everything you'll need to design UIs - using \l{Qt Quick} and to preview them on the desktop or on Android or - embedded Linux devices is automatically installed and configured correctly - for you. - - Qt Quick enables you to build UIs around the behavior of - \e components and how they connect with one another. You - create components using Qt Quick and QML types that are available in - the Design mode. You can specify values for the \e properties of a - component to change its appearance and behavior. All QML types have a - set of predefined properties, some of which control things that are - visible to users, while others are used behind the scene. - - While it is useful to learn the basics of Qt Quick, you can also rely on - \QDS to write the code for you when you drag-and-drop the ready-made - components to the working area and change them to your liking by modifying - their properties in the Design mode. You can always check up details in - the extensive Qt Quick documentation by pressing \key F1. - - \list - - \li \l {Creating Components} - - In addition to your imported artwork, you can use the Design - mode to customize ready-made components or design any custom form - and shape directly as QML types. You can import visual assets in - various formats, such as PNG, JPG, and SVG for use in the - components. - - \li \l {Managing Item Hierarchy} - - You can manage the items in the current QML file and their - relationships in the \uicontrol Navigator. - - \li \l {Specifying Item Properties} - - You can specify values for the properties of a component to change - its appearance and behavior. All QML types have a set of predefined - properties. Some properties, such as position, size, and visibility, - are common to all QML types, whereas others are specific to the QML - type. You can specify properties for your components in the - \uicontrol Properties view. - - \li \l {Using Custom Fonts} - - You can load custom fonts to \QDS and use them in your designs. - \endlist - - \section1 Related Topics - - \list - \li \l{Qt Quick UI Forms} - - Some of the wizards create Qt Quick projects that contain UI forms - (.ui.qml files). The forms use a purely declarative subset of the - QML language and you can edit them in the Design mode. - \endlist -*/ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 4c7af21e01..b68214a15a 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \page qtdesignstudio-toc.html \title All Topics @@ -90,7 +90,7 @@ \li \l{Adding States} \li \l{Editing PathView Properties} \endlist - \li \b {\l{Editing 3D Scenes}} + \li \l{Editing 3D Scenes} \list \li \l{Editing 3D Assets in Design Mode} \li \l{Working in the 3D Editor} diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-3d-assets.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-3d-assets.qdoc index e0cc8e0933..ce448c3f20 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-3d-assets.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-3d-assets.qdoc @@ -27,9 +27,13 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \page exporting-3d-assets.html + \if defined(qtdesignstudio) \previouspage qtbridge-sketch-using.html + \else + \previouspage studio-3d.html + \endif \nextpage exporting-from-blender.html \title Exporting 3D Assets diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-from-maya.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-from-maya.qdoc index 53d3009a78..8903bc238a 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-from-maya.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/exporting-3d/exporting-from-maya.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of Qt Design Studio. @@ -26,10 +26,14 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio Manual} + \contentspage index.html \page exporting-from-maya.html - \previouspage qtbridge-sketch-using.html + \previouspage exporting-from-blender.html + \if defined (qtdesignstudio) \nextpage creator-quick-tour.html + \else + \nextpage studio-importing-3d.html + \endif \title Exporting from Maya diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc index da2964d5ba..947e72cc25 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc @@ -24,9 +24,13 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} - \previouspage studio-3d.html + \contentspage index.html \page studio-3d-design-mode.html + \if defined (qtdesignstudio) + \previouspage studio-3d.html + \else + \previouspage studio-importing-3d.html + \endif \nextpage studio-3d-editor.html \title Editing 3D Assets in Design Mode diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc index 1e340182b5..71eedd4dfb 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \previouspage studio-3d-design-mode.html \page studio-3d-editor.html \nextpage studio-3d-view.html diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-importing.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-importing.qdoc new file mode 100644 index 0000000000..17f7482233 --- /dev/null +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-importing.qdoc @@ -0,0 +1,72 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Bridge documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +/*! + \contentspage index.html + \page studio-importing-3d.html + \if defined(qtdesignstudio) + \previouspage studio-importing-2d.html + \nextpage quick-converting-ui-projects.html + \else + \previouspage exporting-from-maya.html + \nextpage studio-3d-design-mode.html + \endif + + \title Importing 3D Assets + + You can import files you created using 3D graphics applications and stored + in several widely-used formats, such as .blend, .dae, .fbx, .glb, .gltf, + .obj, .uia, or .uip. For a list of formats supported by each \l{Qt Quick 3D} + version, see the module documentation. + + For more information about exporting 3D graphics from Maya, see + \l{Exporting from Maya}. + + During the import, you can optimize the files for \QDS. You can remove + components from meshes to reduce the cache size, find and fix issues in + the files, optimize graphs and meshes, and so on. The available options + depend on whether you are importing files that you created with Qt 3D Studio + or with other 3D graphics tools. See the tooltips in the options dialog + for more information about a particular option. + + \image studio-import-3d.png + + To import 3D assets to \QDS projects: + + \list 1 + \li In the Design mode, select \uicontrol Library > \uicontrol Assets + > \uicontrol {Add New Assets}. + \li Select \uicontrol {3D Assets} in the dropdown menu to filter 3D + graphics files. + \li Select a file to import, and then select \uicontrol Open. + \li In the \uicontrol {3D Scene Options} tab, select options for + importing the file. + \li Select \uicontrol Import to import the 3D graphics file. + \li When the import is done, select \uicontrol Close. + \endlist + + You can open the imported files in the Design mode for editing in the + \l{Editing 3D Scenes}{3D editor}. +*/ diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc index 211085fd3c..b9fb65731c 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-node.qdoc @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \previouspage studio-3d-components.html \page studio-3d-node.html \nextpage studio-3d-model.html 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 0951110886..3844439569 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of Qt Design Studio. @@ -29,7 +29,11 @@ \contentspage {Qt Design Studio Manual} \page studio-3d-scene-environment.html \previouspage studio-3d-camera.html + \if defined (qtdesignstudio) \nextpage creator-live-preview.html + \else + \nextpage qtquick-iso-icon-browser.html + \endif \title Setting 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 4c61d12a12..ae1e50e0d3 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio} + \contentspage index.html \previouspage studio-3d-editor.html \page studio-3d-view.html \nextpage studio-3d-components.html diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc index 03f3085ad6..976ae9aca4 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Design Studio documentation. @@ -24,10 +24,15 @@ ****************************************************************************/ /*! - \contentspage {Qt Design Studio Manual} + \contentspage index.html \page studio-3d.html \previouspage qmldesigner-pathview-editor.html + \if defined(qtdesignstudio) \nextpage studio-3d-design-mode.html + \else + \nextpage exporting-3d-assets.html + \endif + \title Editing 3D Scenes @@ -45,6 +50,20 @@ The following topics contain information about working with Qt Quick 3D: \list + \if defined (qtcreator) + \li \l {Exporting 3D Assets} + + You can import files you created using 3D graphics applications and + stored in several widely-used formats, such as .blend, .dae, .fbx, + .glb, .gltf, .obj, .uia, or .uip. + + \li \l{Importing 3D Assets} + + You can import 3D assets that you created using 3D graphics + applications and stored in one of the supported file formats. + You can then edit them in the Design mode. + \endif + \li \l {Editing 3D Assets in Design Mode} \QDS opens QML files that contain 3D scenes in the Design mode and |