summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2018-11-19 15:44:21 +0200
committerMats Honkamaa <mats.honkamaa@qt.io>2018-11-21 10:15:26 +0000
commitaa76c5dedf4dbd393bf997c216952d9026e90d24 (patch)
treeb3bcbecc42c7b9d4b6aa9137878e8d3fa71c135a /doc
parent71a3b96215eacac975f5bc08fe90eb91b7e8ea00 (diff)
Restructure index page
This is the first step of restructuring the content for documentation, included in this commit is the following: - new index page - new page About Qt3DS, most content here comes from old index page - new page about Layers Main task for this is QT3DS-808, and its sub-tasks QT3DS-2613, QT3DS-2617, QT3DS-2608. Task-number: QT3DS-808 Change-Id: I230e27ca0777e3b95b765380ef0a7097d524b1af Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Janne Kangas <janne.kangas@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/00-concepts.qdoc152
-rw-r--r--doc/src/about-qt3dstudio.qdoc130
-rw-r--r--doc/src/images/add-layer-context.pngbin0 -> 5016 bytes
-rw-r--r--doc/src/images/delete-layer-context.pngbin0 -> 6586 bytes
-rw-r--r--doc/src/layers.qdoc115
5 files changed, 291 insertions, 106 deletions
diff --git a/doc/src/00-concepts.qdoc b/doc/src/00-concepts.qdoc
index b2dfe452..9f0303ae 100644
--- a/doc/src/00-concepts.qdoc
+++ b/doc/src/00-concepts.qdoc
@@ -31,122 +31,62 @@
\title Qt 3D Studio Index
\page qt3dstudio-index.html
-\section1 Table of Contents
+Qt 3D Studio is a compositing tool where you import 3D models, images and other assets to create
+interactive presentations, UIs and applications.
-\list
- \li \l {Getting started}
- \li \l {Studio Index}{Studio}
- \li \l {Viewer Index}{Viewer}
- \li \l {File Formats}
- \omit
- TODO: Needs to be checked. Maybe a rewrite, or just remove it all.
- \li \l {Integrating with Qt 3D Studio}
- \endomit
- \li \l {Best Practices}
- \li \l {Requirements}
- \li \l {Experimental Features}
- \li \l {Copyright Notices}
-\endlist
-
-\section1 Applications
-
-The Qt 3D Studio suite includes:
\table
- \header
- \li \section2 Studio
- \li \section2 Viewer
\row
- \li \inlineimage studio_128.png
- \li \inlineimage viewer_128.png
+ \li
+ \li
+ \li
+ \li
\row
- \li An authoring tool for creating interactive 3D presentations and applications.
- \li A runtime player to test and deploy interfaces created in Studio.
+ \li \b {Getting Started}
+ \list
+ \li \l{About Qt 3D Studio}
+ \li \l{Getting Started}{Quick Start Guide}
+ \li \l{Best Practices}
+ \li \l{Studio Index}
+ \li \l{Viewer Index}
+ \endlist
+ \li \b {Graphics}
+ \list
+ \li \l{Working with 3D Content}{3D Assets}
+ \li \l{Layers}
+ \li \l{Light Properties}{Lights}
+ \li \l{Using Sub-Presentations}{Sub-Presentations}
+ \endlist
+ \li \b {Animations}
+ \list
+ \li \l{Studio: Timeline Palette}{The Timeline}
+ \li \l{Dynamic Keyframes}
+ \endlist
+ \li \b {Scripting}
+ \list
+ \li \l{Using Data Inputs}{Data Input}
+ \li \l{Using Behavior Scripts}{Behavior}
+ \li \l{File Formats}
+ \endlist
\row
\li
+ \li
+ \li
+ \li
+ \row
+ \li \b {Deployment}
\list
- \li \l {Getting started}
- \li \l {Studio Index}
+ \li \l{Viewer Remote Deployment}
\endlist
- \li
+ \li \b {Getting Help}
\list
- \li \l {Viewer Index}
+ \li \l{Studio Keyboard Shortcuts}
+ \li \l{Viewer Keyboard Shortcuts}
\endlist
+ \li
+ \li
+ \row
+ \li {4,1} \note To report bugs and suggestions to the Qt Bug
+ Tracker, visit \l https://bugreports.qt.io.
\endtable
-\section1 Concepts
-
-\section2 Project
-
-A \e{\"project\"} is simply a folder on your computer holding all the art and other assets needed
-for your application. You can create a \e project by creating folders in your file system, or you
-can also have a template project created for you (with suggested folders for organization) from
-\l Studio application.
-
-\section2 Application
-
-Your \e{\"application\"} is the entry point of your project. It is represented by a single \c{.uia}
-file at the root of your project folder. This file references the presentation and
-sub-presentations in your project. The \e application is what is displayed by the \l Viewer.
-
-\omit
-TODO: To be updated for the open source release. Not really needed or even usable now.
-\e{Learn more about the file format for an application in}
-\l{file-formats-uia.html}{The .uia File Format}.
-\endomit
-
-\section2 Presentation
-
-Artists use \l Studio to create \e{presentation} files, represented by \c{.uip} files in your
-project. A presentation has one or more \e{layers} composited to the screen, comprised of 2D and
-3D assets created in other applications.
-
-Each application can only have one main presentation shown on screen (specified by the \c{.uia})
-but this presentation may reference other \e{sub-presentations}, either on flat layers or as images
-and textures drawn in a scene.
-
-\e{Learn more about creating presentations in the reference for}
-\l{Studio Index}{Studio application}.
-
-\section2 QML
-
-Additional functionality can be built on top of the Qt 3D Studio presentations with QML by
-incorporating applications or presentations into QML with the \l Studio3D element.
-
-\e{Learn more in}
-\l{QML API}{QML API Reference}.
-
-\section2 Layer
-
-A single \l Studio presentation combines one or more \e{layers}. The visual result of each \e layer
-comes from rendering a 3D scene, 2D scene (via an orthographic camera), or sub-presentation. Layers
-are then composited with items on upper layers drawing on top of the content on lower layers.
-
-\e{Learn more about the properties of layers in}
-\l{studio-inspector-palette.html#layer-properties}{Layer Properties}.
-
-\section2 Slide
-
-A \l Studio presentation combines 3D assets with animations and \e{slides}. Slides provide visual
-variations within the presentation.
-
-\e{Learn more about slides in}
-\l{studio-slide-palette.html}{Slide Palette}.
-
-\section1 Known Issues
-
-\section2 Possible problems after automatic mesh optimization
-
-When loading a presentation made with an earlier version (2.0 beta2 or older) of Qt 3D Studio
-which has imported FBX or DAE models, you may see the following messagebox:
-
-\image {mesh_optimization.png}{Old presentation version}
-
-If your \b{imported} models are not visible in the Viewer after seeing the message, you need to
-edit your \c{*.uip} file(s) manually. Some older versions of Studio referenced meshes with revision
-number in the \c{*.uip} file, and that revision causes it to be missing in the scope of the
-Viewer.
-
-You'll need to find all occurrences of \c{.mesh#<revision_number>} from you \c{*.uip} and
-replace them with \c{.mesh}.
-
*/
diff --git a/doc/src/about-qt3dstudio.qdoc b/doc/src/about-qt3dstudio.qdoc
new file mode 100644
index 00000000..4e0560a5
--- /dev/null
+++ b/doc/src/about-qt3dstudio.qdoc
@@ -0,0 +1,130 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+
+\title About Qt 3D Studio
+\page about-qt3dstudio.html
+
+\section1 Applications
+
+The Qt 3D Studio suite includes:
+\table
+ \header
+ \li
+ \div {align="center"}
+ Studio
+ \enddiv
+ \li
+ \div {align="center"}
+ Viewer
+ \enddiv
+ \row
+ \li
+ \div {align="center"}
+ \inlineimage studio_128.png
+ \enddiv
+ \li
+ \div {align="center"}
+ \inlineimage viewer_128.png
+ \enddiv
+ \row
+ \li An authoring tool for creating interactive 3D presentations and applications.
+ \li A runtime player to test and deploy interfaces created in Studio.
+ \row
+ \li
+ \list
+ \li \l {Getting started}
+ \li \l {Studio Index}
+ \endlist
+ \li
+ \list
+ \li \l {Viewer Index}
+ \endlist
+\endtable
+
+For software and hardware requirements, see the \l{Requirements} page. For list of third-party
+modules and copyright notices, see the \l{Copyright Notices} page.
+
+\section1 Concepts
+
+\section2 Project
+
+A \e project is simply a folder on your computer holding all the assets needed
+for your application. When you start a new project, a default folder structure will be created.
+
+\section2 Application
+
+Your \e application is the entry point of your project. It is represented by a single \c{.uia}
+file at the root of your project folder. This file references the presentation and
+sub-presentations in your project. The \e application is what is displayed by the Viewer.
+
+\section2 Presentation
+
+Artists use Studio to create \e presentation files, represented by \c{.uip} files in your
+project. A presentation has one or more \e layers composited to the screen, comprised of 2D and
+3D assets created in other applications.
+
+Each application can only have one main presentation shown on screen
+(specified by the \c{.uia} file) but this presentation may reference other \e{sub-presentations},
+either on flat layers or as images and textures drawn in a scene.
+
+\section2 QML
+
+Additional functionality can be built on top of the Qt 3D Studio presentations with QML by
+incorporating applications or presentations into QML with the Studio3D element.
+
+\section2 Layer
+
+A single Studio presentation combines one or more \e layers. The visual result of each \e layer
+comes from rendering a 3D scene, 2D scene (via an orthographic camera), or sub-presentation. Layers
+are then composited with items on upper layers drawing on top of the content on lower layers.
+
+\section2 Slide
+
+A Studio presentation combines 3D assets with animations and \e{slides}. Slides can be thought
+of as states and provide visual variations within the presentation.
+
+
+\section1 Known Issues
+
+\section2 Possible problems after automatic mesh optimization
+
+When loading a presentation made with an earlier version (2.0 beta2 or older) of Qt 3D Studio
+which has imported FBX or DAE models, you may see the following messagebox:
+
+\image {mesh_optimization.png}{Old presentation version}
+
+If your \b{imported} models are not visible in the Viewer after seeing the message, you need to
+edit your \c{*.uip} file(s) manually. Some older versions of Studio referenced meshes with revision
+number in the \c{*.uip} file, and that revision causes it to be missing in the scope of the
+Viewer.
+
+You'll need to find all occurrences of \c{.mesh#<revision_number>} from you \c{*.uip} and
+replace them with \c{.mesh}.
+
+*/
diff --git a/doc/src/images/add-layer-context.png b/doc/src/images/add-layer-context.png
new file mode 100644
index 00000000..4846fc27
--- /dev/null
+++ b/doc/src/images/add-layer-context.png
Binary files differ
diff --git a/doc/src/images/delete-layer-context.png b/doc/src/images/delete-layer-context.png
new file mode 100644
index 00000000..3c33d0cb
--- /dev/null
+++ b/doc/src/images/delete-layer-context.png
Binary files differ
diff --git a/doc/src/layers.qdoc b/doc/src/layers.qdoc
new file mode 100644
index 00000000..1128e0c1
--- /dev/null
+++ b/doc/src/layers.qdoc
@@ -0,0 +1,115 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+
+\title Layers
+\page layers.html
+
+A single Studio presentation combines one or more \e layers. The visual result of each \e layer
+comes from rendering a 3D scene, 2D scene (via an orthographic camera), or sub-presentation. Layers
+are then composited with items on upper layers drawing on top of the content on lower layers.
+
+A new presentation will be created with one layer by default. It is possible to add and remove
+layers as desired, but there must always be at least one layer in a presentation.
+
+When working with layers, keep it as simple as possible. For best performance:
+\list
+ \li Use as few layers as possible
+ \li Use as small layers as possible
+\endlist
+
+\section1 Add a layer
+
+To add a layer to a presentation, do one of the following:
+\list
+ \li In the bottom of the scene graph, press the
+ \inlineimage Studio-Timeline-NewLayer.png
+ icon.
+ \li
+ Right-click on the scene element in the scene graph, then select \uicontrol{Add Layer}
+ \image add-layer-context.png
+ \li
+ Press \c{Ctrl + L}.
+\endlist
+
+\section1 Delete a layer
+
+Deleting a layer will delete the layer itself, as well as all the elements on the layer.
+
+To delete a layer, do one of the following:
+
+\list
+ \li
+ Select the layer in the scene graph, then press \c{Del}.
+ \li
+ Select the layer in the scene graph, then press the
+ \inlineimage Studio-Timeline-DeleteLayer.png
+ icon in the bottom of the scene graph.
+ \li
+ Select the layer in the scene graph, then select \uicontrol{Edit > Delete Object} from the
+ menu bar.
+ \li
+ Right-click on the layer in the scene graph, then select \uicontrol{Delete Object} from the
+ context menu.
+ \image delete-layer-context.png
+\endlist
+
+\section1 Rearranging layers
+
+You can rearrange layers by dragging them in the scene graph as described in the
+\l {Rearranging Elements}{timeline palette documentation}.
+
+\note Layers must exist directly under the scene element, you can not move layers under other
+elements.
+
+The order of layers in the scene graph determines the order they are rendered. The top-most layer
+will render last, hence it will render on top of below layers.
+
+\section1 More About Layers
+
+\section2 Layer Properties
+
+For full list of layer properties, see the \l{layer-properties}{layer properties documentation}
+
+\section2 Layer Effects
+
+Each layer in a presentation may have one or more post-processing effects applied to the visual
+result. A library of predefined effects is included in Qt 3D Studio.
+Read more about \l{Applying Layer Effects}.
+
+\section2 Blend Mode
+
+The \l{Blend Mode} property controls how the colors of the active layer or object are blended with
+the colors of the background layer or object.
+
+\section2 Disable Depth Test
+
+The \l{Disable Depth Test} property can be used to simultaneously override depth testing and
+the order objects are rendered.
+
+*/