3 \page dependency_tree_page Dependency Tree
6 <li>\ref dependency_tree_general_description_anchor "General description"</li>
7 <li>\ref dependency_tree_nodes_anchor "Nodes" </li>
8 <li>\ref dependency_tree_links_anchor "Links" </li>
9 <li>\ref dependency_tree_operations_anchor "Operations" </li>
10 <li>\ref dependency_tree_navigation_anchor "Navigation" </li>
11 <li>\ref dependency_tree_popup_menu_anchor "Context menu"</li>
14 \anchor dependency_tree_general_description_anchor <h2>General description</h2>
16 In order to better understand the relations between the %GEOM
17 objects in a study the user has a possibility to display the
18 ascendants and descendant of the object(s) in a family tree.
20 User can build the dependency tree by selecting desirable object
21 in Object Browser or OCC Viewer and calling "Show dependency tree"
22 popup item. It will open a new or clear the existing "Dependency
23 Tree" view window (only one view is supported) and display a
24 dependency tree for the selected object or objects (multiple
25 selection is supported). Also user can rebuild the tree if to select
26 some object(s) right in the "Dependency Tree" view and call
27 "Rebuild the tree" popup menu item.
29 \image html tree_example.png
31 User can change all necessary parameters of Dependency Tree Viewer
32 in \ref pref_dependency_tree "Preferences".
35 \anchor dependency_tree_nodes_anchor <h2>Nodes</h2>
37 Tree nodes in the Dependency Viewer are named according to the study
38 names of the corresponding objects.
40 Non-published objects are shown in the tree as "unpublished" and
41 colored in special color.
43 All nodes have the fixed size, so the long names are cut and shown
44 with ellipsis; full name of the object can be seen in the tooltip
45 if to keep the cursor over the node.
47 "Dependency Tree" view supports the following states of nodes:
49 <ul><li><b>Main node</b> - node of main object(s), which were selected in Object
50 Browser, OCC Viewer or Dependency Tree Viewer in order to build the
51 dependency tree;</li></ul>
52 \image html tree_main_node.png
54 <ul><li><b>Default node</b> - node of published in study object, which participate in building of
55 dependency tree as ascendant or descendant;</li></ul>
56 \image html tree_default_node.png
58 <ul><li><b>Unpublished node</b> - the same as "Default node", but
59 corresponding object was not published in study;</li></ul>
60 \image html tree_unpublished_node.png
62 <ul><li><b>Highlighted node</b> - the state of node when mouse
63 cursor is over it;</li></ul>
64 \image html tree_highlighted_node.png
66 <ul><li><b>Selected node</b> - the state of node when user
67 clicks the left mouse button on node.</li></ul>
68 \image html tree_selected_node.png
71 \anchor dependency_tree_links_anchor <h2>Links</h2>
73 Dependency Tree Viewer shows oriented links between nodes to
74 represent dependency direction. Viewer supports the following states
77 <ul><li><b>Unidirectional link</b> - shows that A object depends on
79 \image html tree_unidir_link.png
81 <ul><li><b>Bidirectional link</b> - shows that A object depends on
82 B object and, at the same time, B object depends on
84 \image html tree_bidir_link.png
86 <ul><li><b>Self-dependency link</b> - shows that object depends on
88 \image html tree_selfdep_link.png
90 <ul><li><b>Cyclic dependency links</b> - shows cyclic dependency of
92 \image html tree_cycldep_link.png
95 \anchor dependency_tree_operations_anchor <h2>Operations</h2>
97 The dependency tree of a chosen %GEOM object is displayed in
98 the dedicated 2D view window.
99 \n The functionalities of 2D viewer are available via its Viewer
102 Buttons marked with small downward triangles have extended
103 functionality which can be accessed by locking on them with left
108 <b>Dump View</b> - exports an object from the viewer in bmp, png or
110 \image html tree_view_dump.png
112 <b>Fit all</b> - scales the presentation so that it could fit within
113 the Viewer boundaries.
114 \image html tree_view_fitall.png
116 <b>Fit area</b> - resizes the view to place in the visible area only
117 the contents of a frame drawn with pressed left mouse button.
118 \image html tree_view_fitarea.png
120 <b>Fit selection</b> - resizes the view to fit in the visible area
121 only currently selected objects.
122 \image html tree_view_fitselect.png
124 <b>Zoom</b> - allows to zoom in and out.
125 \image html tree_view_zoom.png
127 <b>Panning</b> - if the represented objects are greater that the
128 visible area and you don't wish to use <b>Fit all</b> functionality,
129 click on this button and you'll be able to drag the scene to see its
131 \image html tree_view_pan.png
133 <b>Global panning</b> - allows to select a point to be the center of
134 the presentation showing all displayed objects in the visible ares.
135 \image html tree_view_glpan.png
137 <b>Hierarchy depth</b> - allows to change the number of hierarchy
138 levels to be shown in the dependency tree.
139 \image html tree_hierarchy_type.png
141 <li>Level 1 corresponds to the parents and children of the selected
143 <li>Level 2 is Level 1 plus the grand-parents and grand-children
144 of the selected object(s);</li>
148 <b>Display ascendants</b> - allows user to control the displaying
150 \image html tree_disp_ascendants.png
152 <b>Display descendants</b> - allows user to control the displaying
154 \image html tree_disp_descendants.png
156 <b>Move nodes</b> - enables/disables of moving the nodes.
157 \image html tree_move_nodes.png
159 <b>Update</b> - allows user to update a dependency tree model and the view.
160 \image html tree_button_update.png
163 \anchor dependency_tree_navigation_anchor <h2>Navigation</h2>
165 Dependency Tree 2D Viewer supports the following navigation mode:
168 <li>rectangle selection in this mode is performed by the left mouse
170 <li>multiple selection is available when \b Shift button
174 Also, holding \b Ctrl key with pressed mouse buttons performs
175 the following view transformations:
177 <li>Ctrl + left mouse button - zooming;</li>
178 <li>Ctrl + middle mouse button - panning;</li>
182 \anchor dependency_tree_popup_menu_anchor <h2>Popup Menu</h2>
184 After the object has appeared in the Dependency Tree 2D Viewer,
185 user can select it with left mouse click to change its presentation
186 parameters and get access to other useful options by right-clicking on
189 \image html tree_popup_menu1.png
192 <li>\b Show - allows to show selected object(s) in OCC 3D Viewer;</li>
193 <li><b> Show Only</b> - allows to show only selected object(s)
194 in OCC 3D Viewer;</li>
195 <li><b> Rebuild the tree</b> - allows to rebuild the dependency tree
196 for selected object(s);</li>
197 <li>\ref reduce_study_page "Reduce study" - allows to reduce study.</li>
200 Some functionalities are available through right-clicking on
201 the viewer background:
203 \image html tree_popup_menu2.png
205 Dependency Tree 2D Viewer background can be customized using the
206 "Change background" popup menu command that opens standard
207 "Select Color" dialog box:
209 \image html selectcolor.png