summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2019-05-15 08:52:55 +0300
committerMats Honkamaa <mats.honkamaa@qt.io>2019-05-15 07:59:25 +0000
commit85a2d0748c5c60dc235fb9ee3dc0a3f693fff253 (patch)
tree52d8b1907b83cb6967a7ddbbadac3c5443cae857
parentb9866ce98ab6844380a3c54d179c01591bd2e4aa (diff)
Update variant filtering documentation
Added information that variant filtering can be used on components, groups, models and text objects. Task-number: Qt3DS-3502 Change-Id: I2b24fb4ec406992f9376a832152952ddcf621601 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
-rw-r--r--doc/src/variant-tags.qdoc23
1 files changed, 12 insertions, 11 deletions
diff --git a/doc/src/variant-tags.qdoc b/doc/src/variant-tags.qdoc
index d3705d03..417a0c20 100644
--- a/doc/src/variant-tags.qdoc
+++ b/doc/src/variant-tags.qdoc
@@ -44,8 +44,9 @@ be loaded from the QML application.
\section1 Create Variant Groups and Tags
-Variant filtering is done on layer level, to add a variant group and tags to that group,
-select a layer in the scene graph and follow the steps below:
+Variant filtering can be applied to layers, component, groups, models, and text objects. To add a
+variant group and tags to that group, select the desired element in the scene graph and follow the
+steps below:
\list 1
\li In the inspector palette, press \uicontrol {+ Group} in the Variant Tags section.
@@ -64,15 +65,15 @@ follow the steps below:
\section1 Using Variant Tags
-To use a variant tag on a layer, follow the steps below:
+To use a variant tag on an element, follow the steps below:
\list 1
- \li In the scene graph, select desired layer
+ \li In the scene graph, select desired element.
\li In the inspector palette, under the variant tag section, click desired variant tags to use
- them on the layer.
+ them on the element.
\endlist
-Once you have assigned variant tags to a layer, it is indicated in the scene graph which layers
+Once you have assigned variant tags to an element, it is indicated in the scene graph which elements
are using tags from which variant groups.
\image variant-tags-layer.png
@@ -126,18 +127,18 @@ in the toolbar or by pressing the \c F7 key.
\image variant-tags-panel.png
In this panel, you can select the variant filtering tags you wish to render when previewing in the
-Viewer. Only the layers satisfying the selection will be rendered.
+Viewer. Only the elements satisfying the selection will be rendered.
Variant filtering works the following way:
\list
\li
- With no tags selected, all layers will render.
+ With no tags selected, all elements will render.
\li
- With tags selected in one variant group, criteria for a layer to be rendered is that is should
- have one of the selected tags or no tag in the selected group.
+ With tags selected in one variant group, criteria for an element to be rendered is that it
+ should have one of the selected tags or no tag in the selected group.
\li
- With tags selected in more than one variant group, the layers will need to fulfill criteria
+ With tags selected in more than one variant group, the elements will need to fulfill criteria
for each of the variant groups to be rendered.
\endlist