X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fdependency_tree.doc;h=b9bbe9566423190ef2ab915a37f7ff73489b9dcd;hb=e3ce834889860adba76bbcf27743ab15a96c4765;hp=e44dba4004e11d2995b53040551f5384bbaa9f21;hpb=3cd92817cb4c5ee5911d6f40fe977b5e57b980e1;p=modules%2Fgeom.git
diff --git a/doc/salome/gui/GEOM/input/dependency_tree.doc b/doc/salome/gui/GEOM/input/dependency_tree.doc
old mode 100755
new mode 100644
index e44dba400..b9bbe9566
--- a/doc/salome/gui/GEOM/input/dependency_tree.doc
+++ b/doc/salome/gui/GEOM/input/dependency_tree.doc
@@ -13,23 +13,22 @@
\anchor dependency_tree_general_description_anchor
General description
-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.
+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
-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).
\anchor dependency_tree_nodes_anchor Nodes
@@ -37,62 +36,48 @@ in \ref pref_dependency_tree "Preferences".
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:
-- Main node - node of main object(s), which were selected in Object
-Browser, OCC Viewer or Dependency Tree Viewer in order to build the
-dependency tree;
+- Main node - corresponds to the main object(s) selected in Object
+Browser, OCC Viewer or Dependency Tree Viewer;
\image html tree_main_node.png
-- Default node - node of published in study object, which participate in building of
-dependency tree as ascendant or descendant;
+- Default node - ascendant or descendant node of the dependency tree corresponding to an object published in the study;
\image html tree_default_node.png
-- Unpublished node - the same as "Default node", but
-corresponding object was not published in study;
+- Unpublished node - corresponds to an object that was not published in the study;
\image html tree_unpublished_node.png
-- Highlighted node - the state of node when mouse
-cursor is over it;
+- Highlighted node - the state of a node when the mouse cursor is hovered over it;
\image html tree_highlighted_node.png
-- Selected node - the state of node when user
-clicks the left mouse button on node.
+- Selected node - the state of node when the user clicks the left mouse button it.
\image html tree_selected_node.png
\anchor dependency_tree_links_anchor Links
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:
-- Unidirectional link - shows that A object depends on
-B object;
+- Unidirectional link - shows that object \b B depends on object \b A;
\image html tree_unidir_link.png
-- Bidirectional link - shows that A object depends on
-B object and, at the same time, B object depends on
-A object;
+- Bidirectional link - shows that object \b B depends on
+object \b A and, at the same time, object \b A depends on object \b B;
\image html tree_bidir_link.png
-- Self-dependency link - shows that object depends on
-itself;
+- Self-dependency link - shows that an object depends on itself;
\image html tree_selfdep_link.png
-- Cyclic dependency links - shows cyclic dependency of
-some nodes.
+- Cyclic dependency links - shows cyclic dependency of some nodes.
\image html tree_cycldep_link.png
-\anchor dependency_tree_operations_anchor Operations
+\anchor dependency_tree_operations_anchor Viewer Operations
The dependency tree of a chosen %GEOM object is displayed in
the dedicated 2D view window.
@@ -103,10 +88,9 @@ Buttons marked with small downward triangles have extended
functionality which can be accessed by locking on them with left
mouse button.
-\image tree_tool_bar
+\image html tree_tool_bar.png
-Dump View - exports an object from the viewer in bmp, png or
-jpeg image format.
+Dump View - exports the current scene in bmp, png or jpeg image format.
\image html tree_view_dump.png
Fit all - scales the presentation so that it could fit within
@@ -140,38 +124,32 @@ levels to be shown in the dependency tree.
- Level 1 corresponds to the parents and children of the selected
object(s);
-- Level 2 is Level 1 plus the grand-parents and grand-children
+
- Level 2 adds the grand-parents and grand-children
of the selected object(s);
- etc...
-Display ascendants - allows user to control the displaying
-of ascendants.
+Display ascendants - allows showing/hiding the ascendants.
\image html tree_disp_ascendants.png
-Display descendants - allows user to control the displaying
-of descendants.
+Display descendants - allows showing/hiding the descendants.
\image html tree_disp_descendants.png
-Move nodes - enables/disables of moving the nodes.
+Move nodes -if checked, it is possible to move nodes in the viewer.
\image html tree_move_nodes.png
-Update - allows user to update a dependency tree model and the view.
+Update - updates the dependency tree view, reflecting changes introduced in the hierarchy.
\image html tree_button_update.png
-\anchor dependency_tree_navigation_anchor Navigation
-
-Dependency Tree 2D Viewer supports the following navigation mode:
+\anchor dependency_tree_navigation_anchor Selection and Shortcuts
-- rectangle selection in this mode is performed by the left mouse
-button
;
-- multiple selection is available when \b Shift button
+
- It is possible to select multiple nodes in the view by rectangle selection or by clicking nodes when \b Shift button
is pressed.
-Also, holding \b Ctrl key with pressed mouse buttons performs
+Holding \b Ctrl key with pressed mouse buttons performs
the following view transformations:
- Ctrl + left mouse button - zooming;
@@ -179,33 +157,23 @@ the following view transformations:
-\anchor dependency_tree_popup_menu_anchor Popup Menu
+\anchor dependency_tree_popup_menu_anchor Context Menu
-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
-- \b Show - allows to show selected object(s) in OCC 3D Viewer;
-- Show Only - allows to show only selected object(s)
-in OCC 3D Viewer;
-- Rebuild the tree - allows to rebuild the dependency tree
+
- \b Show - shows the selected object(s) in OCC 3D Viewer;
+- Show Only - shows only the selected object(s) in OCC 3D Viewer;
+- Rebuild the tree - rebuilds the dependency tree
for selected object(s);
-- \ref reduce_study_page "Reduce study" - allows to reduce study.
-
-
-Some functionalities are available through right-clicking on
-the viewer background:
+\ref reduce_study_page "Reduce study" - allows reducing the study.
\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
+It is also possible to customize the background of Dependency Tree 2D Viewer using the
+corresponding context menu command.
+
*/