From: vsv Date: Tue, 30 Jul 2019 16:08:49 +0000 (+0300) Subject: Issue #2957: Amelioration of help pages for new and modified features. X-Git-Tag: VEDF2019Lot4~68 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=df3f1a26fc5600ef36e582127ab5c2c4e7541f7b;p=modules%2Fshaper.git Issue #2957: Amelioration of help pages for new and modified features. --- diff --git a/src/CollectionPlugin/doc/fieldFeature.rst b/src/CollectionPlugin/doc/fieldFeature.rst index 97c555ee4..c0aa1b279 100644 --- a/src/CollectionPlugin/doc/fieldFeature.rst +++ b/src/CollectionPlugin/doc/fieldFeature.rst @@ -53,6 +53,23 @@ Input fields: - **Add Step** button adds a new time step; - **Remove Step** button deletes the current time step. +**Visualization of field** + +When a field is created then its result in data tree looks like following. + +.. image:: images/field_steps_tree.png + :align: center + +.. centered:: + Result of created field with two steps. + +It consists of a Field result object and steps as sub-objects. Only one object can be displayed at one moment: field or one of its step. Field result presentation repersents entities used for the Field definition. +Step presentation shows field entities and values defined on them. For example a step defined on faces with double values looks like following. + +.. image:: images/step_faces_double.png + :align: center + +Color bar for displayed step is shown only if the setep is selected in **Object Browser**. Desirable parameters of the Color bar (position, number of intervals, text color) can be defined in **Preferences** dialog box. **TUI Commands**: diff --git a/src/CollectionPlugin/doc/groupFeature.rst b/src/CollectionPlugin/doc/groupFeature.rst index c5f6bf1b9..1522bf7e0 100644 --- a/src/CollectionPlugin/doc/groupFeature.rst +++ b/src/CollectionPlugin/doc/groupFeature.rst @@ -1,4 +1,7 @@ .. |shape_group.icon| image:: images/shape_group.png +.. |plus.icon| image:: images/add.png +.. |minus.icon| image:: images/reverce.png +.. |delete.icon| image:: images/delete.png Group ===== @@ -48,7 +51,7 @@ Input fields: **Selection by filters** -If user press this button then following property panel will be opened. +If user presses this button then following property panel appears. .. image:: images/selection_by_filters.png :align: center @@ -56,6 +59,30 @@ If user press this button then following property panel will be opened. .. centered:: Selection by filters property panel +In this panel: + +- **Filters** a panel for added filters. + +- **Add new filter** combo box. It contains accessible filters according to the selection mode defined in **Group** property panel. When user selects an item from this combo box a filter item appears in **Filters** panel like in the following example: + +.. image:: images/selection_by_filters_added.png + :align: center + +.. centered:: + Filters **Horizontal faces** and **On plane** added to the property panel. + +Each filter item can be deleted with help of |delete.icon| button. A filter can be reverced with help of toggle button |plus.icon|/|minus.icon|. Also a filter could have input fields in case +if the filter has arguments. + +- **Select** button traverces all objects of a current document and selects entities acceptable by currently defined set of filters. All selected entities will be shown in viewer 3d with +blue semi-transparent color. Any modification in filters clears current selection. + +- **Number of selected objects** shows number currently selected entities. + +- **Show only** check box lets to hide all non-selected objects. + +**Accept** button in the **Selection by filters** property panel reopens **Group** property panel again and transfers all selected entities to the corresponded list. + **TUI Command**: .. py:function:: model.addGroup(Part_1_doc, [model.selection("EDGE", "Cone_1_1/Face_1&Cone_1_1/Face_2"), model.selection("EDGE", "Cone_1_1/Face_1")]) diff --git a/src/CollectionPlugin/doc/images/add.png b/src/CollectionPlugin/doc/images/add.png new file mode 100644 index 000000000..388f8ffed Binary files /dev/null and b/src/CollectionPlugin/doc/images/add.png differ diff --git a/src/CollectionPlugin/doc/images/delete.png b/src/CollectionPlugin/doc/images/delete.png new file mode 100644 index 000000000..6d2aea896 Binary files /dev/null and b/src/CollectionPlugin/doc/images/delete.png differ diff --git a/src/CollectionPlugin/doc/images/field_steps_tree.png b/src/CollectionPlugin/doc/images/field_steps_tree.png new file mode 100644 index 000000000..1c3f3a887 Binary files /dev/null and b/src/CollectionPlugin/doc/images/field_steps_tree.png differ diff --git a/src/CollectionPlugin/doc/images/reverce.png b/src/CollectionPlugin/doc/images/reverce.png new file mode 100644 index 000000000..40239ade4 Binary files /dev/null and b/src/CollectionPlugin/doc/images/reverce.png differ diff --git a/src/CollectionPlugin/doc/images/selection_by_filters_added.png b/src/CollectionPlugin/doc/images/selection_by_filters_added.png new file mode 100644 index 000000000..a3e0a25f2 Binary files /dev/null and b/src/CollectionPlugin/doc/images/selection_by_filters_added.png differ diff --git a/src/CollectionPlugin/doc/images/step_faces_double.png b/src/CollectionPlugin/doc/images/step_faces_double.png new file mode 100644 index 000000000..5b8a70860 Binary files /dev/null and b/src/CollectionPlugin/doc/images/step_faces_double.png differ