[bos #40619][CEA] Add Fuzzy parameter to partition and boolean operators

[modules/geom.git] / doc / salome / gui / GEOM / input / dependency_tree.doc

diff --git a/doc/salome/gui/GEOM/input/dependency_tree.doc b/doc/salome/gui/GEOM/input/dependency_tree.doc
index 12d0387e26d7c8ca5a9c70ee7a6e2dcd936143bb..b9bbe9566423190ef2ab915a37f7ff73489b9dcd 100644 (file)
--- a/doc/salome/gui/GEOM/input/dependency_tree.doc
+++ b/doc/salome/gui/GEOM/input/dependency_tree.doc
@@ -2,86 +2,82 @@
 
 \page dependency_tree_page Dependency Tree
 
 
 \page dependency_tree_page Dependency Tree
 

-\n In order to better understand the relations between the %GEOM 
-objects in a study the user has a possibility to display the 
-ascendants and descendant of the object(s) in a family tree.
-
-User can build the dependency tree by selecting desirable object 
-in Object Browser or OCC Viewer and calling "Show dependency tree" 
-popup item. It will open a new or clear the existing "Dependency 
-Tree" view window (only one view is supported) and display a 
-dependency tree for the selected object or objects (multiple 
-selection is supported). Also user can rebuild the tree if to select 
-some object(s) right in the "Dependency Tree" view and call 
-"Rebuild the tree" popup menu item.
+<ul>
+<li>\ref dependency_tree_general_description_anchor "General description"</li>
+<li>\ref dependency_tree_nodes_anchor "Nodes" </li>
+<li>\ref dependency_tree_links_anchor "Links" </li>
+<li>\ref dependency_tree_operations_anchor "Operations" </li>
+<li>\ref dependency_tree_navigation_anchor "Navigation" </li>
+<li>\ref dependency_tree_popup_menu_anchor "Context menu"</li>
+</ul>
+
+\anchor dependency_tree_general_description_anchor <h2>General description</h2>
+
+You can display the ascendants and descendants of object(s) in a tree structure to better understand the relations between the %GEOM 
+objects in a study .
+
+To build the dependency tree, select the necessary object or objects (multiple 
+selection is supported) in the Object Browser or OCC Viewer and call "Show dependency tree" context menu item. 

 
 \image html tree_example.png
 
 
 \image html tree_example.png
 

-User can change all necessary parameters of Dependency Tree Viewer 
-in \ref pref_dependency_tree "Preferences".
+
+"Dependency Tree" view window will display the dependency tree for the selected object. 
+It is also possible to select an object(s) directly in the "Dependency Tree" view and to rebuild the tree by selecting 
+"Rebuild the tree" context menu item.
+
+All necessary parameters of Dependency Tree Viewer can be edited in the \ref pref_dependency_tree "Preferences".
+
+\note This functionality is available only if the GUI module is built with Graphics view (option SALOME_USE_GRAPHICSVIEW is ON when building GUI module).

 
 <hr>
 
 <hr>

-\anchor dependency_tree_nodes <h2>Nodes</h2>
+\anchor dependency_tree_nodes_anchor <h2>Nodes</h2>

 
 Tree nodes in the Dependency Viewer are named according to the study 
 names of the corresponding objects. 
 
 
 Tree nodes in the Dependency Viewer are named according to the study 
 names of the corresponding objects. 
 

-Non-published objects are shown in the tree as "unpublished" and 
-colored in special color.
-
-All nodes have the fixed size, so the long names are cut and shown 
-with ellipsis; full name of the object can be seen in the tooltip 
-if to keep the cursor over the node.
+All nodes have fixed size, so long names are cut; the full object name can be seen in the tool-tip 
+when the cursor is hovered over the node.

 
 "Dependency Tree" view supports the following states of nodes:
 
 
 "Dependency Tree" view supports the following states of nodes:
 

-<ul><li><b>Main node</b> - node of main object(s), which were selected in Object 
-Browser, OCC Viewer or Dependency Tree Viewer in order to build the 
-dependency tree;</li></ul>
+<ul><li><b>Main node</b> - corresponds to the main object(s) selected in Object 
+Browser, OCC Viewer or Dependency Tree Viewer;</li></ul>

 \image html tree_main_node.png
 
 \image html tree_main_node.png
 

-<ul><li><b>Default node</b> - node of published in study object, which participate in building of 
-dependency tree as ascendant or descendant;</li></ul>
+<ul><li><b>Default node</b> - ascendant or descendant node of the dependency tree corresponding to an object published in the study;</li></ul>

 \image html tree_default_node.png
 
 \image html tree_default_node.png
 

-<ul><li><b>Unpublished node</b> - the same as "Default node", but 
-corresponding object was not published in study;</li></ul>
+<ul><li><b>Unpublished node</b> - corresponds to an object that was not published in the study;</li></ul>

 \image html tree_unpublished_node.png
 
 \image html tree_unpublished_node.png
 

-<ul><li><b>Highlighted node</b> - the state of node when mouse 
-cursor is over it;</li></ul>
+<ul><li><b>Highlighted node</b> - the state of a node when the mouse cursor is hovered over it;</li></ul>

 \image html tree_highlighted_node.png
 
 \image html tree_highlighted_node.png
 

-<ul><li><b>Selected node</b> - the state of node when user 
-clicks the left mouse button on node.</li></ul>
+<ul><li><b>Selected node</b> - the state of node when the user clicks the left mouse button it.</li></ul>

 \image html tree_selected_node.png
 
 <hr>
 \image html tree_selected_node.png
 
 <hr>

-\anchor dependency_tree_links <h2>Links</h2>
+\anchor dependency_tree_links_anchor <h2>Links</h2>

 
 Dependency Tree Viewer shows oriented links between nodes to 
 
 Dependency Tree Viewer shows oriented links between nodes to 

-represent dependency direction. Viewer supports the following states 
-of links:
+represent the dependency direction. The viewer supports the following states of links:

 
 

-<ul><li><b>Unidirectional link</b> - shows that A object depends on 
-B object;</li></ul>
+<ul><li><b>Unidirectional link</b> - shows that object \b B depends on object \b A;</li></ul>

 \image html tree_unidir_link.png
 
 \image html tree_unidir_link.png
 

-<ul><li><b>Bidirectional link</b> - shows that A object depends on 
-B object and, at the same time, B object depends on 
-A object;</li></ul>
+<ul><li><b>Bidirectional link</b> - shows that object \b B depends on 
+object \b A and, at the same time, object \b A depends on object \b B;</li></ul>

 \image html tree_bidir_link.png
 
 \image html tree_bidir_link.png
 

-<ul><li><b>Self-dependency link</b> - shows that object depends on 
-itself;</li></ul>
+<ul><li><b>Self-dependency link</b> - shows that an object depends on itself;</li></ul>

 \image html tree_selfdep_link.png
 
 \image html tree_selfdep_link.png
 

-<ul><li><b>Cyclic dependency links</b> - shows cyclic dependency of 
-some nodes.</li></ul>
+<ul><li><b>Cyclic dependency links</b> - shows cyclic dependency of some nodes.</li></ul>

 \image html tree_cycldep_link.png
 
 <hr>
 \image html tree_cycldep_link.png
 
 <hr>

-\anchor dependency_tree_operations <h2>Operations</h2>
+\anchor dependency_tree_operations_anchor <h2>Viewer Operations</h2>

 
 The dependency tree of a chosen %GEOM object is displayed in 
 the dedicated 2D view window.
 
 The dependency tree of a chosen %GEOM object is displayed in 
 the dedicated 2D view window.


@@ -92,10 +88,9 @@ Buttons marked with small downward triangles have extended
 functionality which can be accessed by locking on them with left 
 mouse button.
 
 functionality which can be accessed by locking on them with left 
 mouse button.
 

-\image tree_tool_bar
+\image html tree_tool_bar.png

 
 

-<b>Dump View</b> - exports an object from the viewer in bmp, png or
-jpeg image format.
+<b>Dump View</b> - exports the current scene in bmp, png or jpeg image format.

 \image html tree_view_dump.png
 
 <b>Fit all</b> - scales the presentation so that it could fit within
 \image html tree_view_dump.png
 
 <b>Fit all</b> - scales the presentation so that it could fit within


@@ -129,38 +124,32 @@ levels to be shown in the dependency tree.
 <ul>
 <li>Level 1 corresponds to the parents and children of the selected 
 object(s);</li>
 <ul>
 <li>Level 1 corresponds to the parents and children of the selected 
 object(s);</li>

-<li>Level 2 is Level 1 plus the grand-parents and grand-children 
+<li>Level 2 adds the grand-parents and grand-children 

 of the selected object(s);</li>
 <li>etc...</li>
 </ul>
 
 of the selected object(s);</li>
 <li>etc...</li>
 </ul>
 

-<b>Display ascendants</b> - allows user to control the displaying 
-of ascendants.
+<b>Display ascendants</b> - allows showing/hiding the ascendants.

 \image html tree_disp_ascendants.png
 
 \image html tree_disp_ascendants.png
 

-<b>Display descendants</b> - allows user to control the displaying 
-of descendants.
+<b>Display descendants</b> - allows showing/hiding the descendants.

 \image html tree_disp_descendants.png
 
 \image html tree_disp_descendants.png
 

-<b>Move nodes</b> - enables/disables of moving the nodes.
+<b>Move nodes</b> -if checked, it is possible to move nodes in the viewer.

 \image html tree_move_nodes.png
 
 \image html tree_move_nodes.png
 

-<b>Update</b> - allows user to update a dependency tree model and the view.
+<b>Update</b> - updates the dependency tree view, reflecting changes introduced in the hierarchy.

 \image html tree_button_update.png
 
 <hr>
 \image html tree_button_update.png
 
 <hr>

-\anchor dependency_tree_navigation <h2>Navigation</h2>
-
-Dependency Tree 2D Viewer supports the following navigation mode:
+\anchor dependency_tree_navigation_anchor <h2>Selection and Shortcuts</h2>

 
 <ul>
 
 <ul>

-<li>rectangle selection in this mode is performed by the left mouse 
-button</li>;
-<li>multiple selection is available when \b Shift button 
+<li>It is possible to select multiple nodes in the view by rectangle selection or by clicking nodes when \b Shift button 

 is pressed.</li>
 </ul>
 
 is pressed.</li>
 </ul>
 

-Also, holding \b Ctrl key with pressed mouse buttons performs 
+Holding \b Ctrl key with pressed mouse buttons performs 

 the following view transformations:
 <ul>
 <li>Ctrl + left mouse button - zooming;</li>
 the following view transformations:
 <ul>
 <li>Ctrl + left mouse button - zooming;</li>


@@ -168,33 +157,23 @@ the following view transformations:
 </ul>
 
 <hr>
 </ul>
 
 <hr>

-\anchor dependency_tree_popup_menu <h2>Popup Menu</h2>
+\anchor dependency_tree_popup_menu_anchor <h2>Context Menu</h2>

 
 

-After the object has appeared in the Dependency Tree 2D Viewer, 
-user can select it with left mouse click to change its presentation 
-parameters and get access to other useful options by right-clicking on 
-the selected object.
+The following operations are available from the context menu of the selected object.

 
 \image html tree_popup_menu1.png
 
 <ul>
 
 \image html tree_popup_menu1.png
 
 <ul>

-<li>\b Show - allows to show selected object(s) in OCC 3D Viewer;</li>
-<li><b> Show Only</b> - allows to show only selected object(s) 
-in OCC 3D Viewer;</li>
-<li><b> Rebuild the tree</b> - allows to rebuild the dependency tree 
+<li>\b Show - shows the selected object(s) in OCC 3D Viewer;</li>
+<li><b> Show Only</b> - shows only the selected object(s) in OCC 3D Viewer;</li>
+<li><b> Rebuild the tree</b> - rebuilds the dependency tree 

 for selected object(s);</li>
 for selected object(s);</li>

-<li>\ref reduce_study_page "Reduce study" - allows to reduce study.</li>
-</ul>
-
-Some functionalities are available through right-clicking on 
-the viewer background:
+<li>\ref reduce_study_page "Reduce study" - allows reducing the study.</li>

 
 \image html tree_popup_menu2.png
 
 
 \image html tree_popup_menu2.png
 

-Dependency Tree 2D Viewer background can be customized using the 
-"Change background" popup menu command that opens standard 
-"Select Color" dialog box:
-
-\image html selectcolor.png
+<li>It is also possible to customize the background of Dependency Tree 2D Viewer using the 
+corresponding context menu command.</li>  
+</ul>

 
 */
 
 */