Salome HOME
0022380: EDF 2746 GEOM: Accept compounds of points as an input for "Smoothing surface...
[modules/geom.git] / doc / salome / gui / GEOM / input / viewing_geom_obj.doc
index a9e42b2db1305b956e5e45bb448ce2a6ee7602c1..b6b5a4f4eda33bc0de12cd1b43739bb92e3401db 100644 (file)
@@ -1,13 +1,14 @@
 /*!
 
-\page view_geom_obj_page Overview
+\page view_geom_obj_page Viewing geometrical objects
 
-\n Newly created geometrical objects are automatically displayed in
+Newly created geometrical objects are automatically displayed in
 the <b>OCC 3D Viewer</b>.
 
-\n <b>OCC 3D Viewer</b> is described in the documentation on <b>GUI
+<b>OCC 3D Viewer</b> is described in the documentation on <b>GUI
 module</b>.
-\n After the object has appeared in the Viewer, you can select it with
+
+After the object has appeared in the Viewer, you can select it with
 left mouse click to change its presentation parameters and access to
 other useful options by right-clicking on the selected object.
 
@@ -18,38 +19,104 @@ other useful options by right-clicking on the selected object.
 object.</li>
 <li><b>Delete</b> - irreversibly deletes the selected object from the
 viewer and from the Object Browser.</li> 
-<li>\ref display_mode_page "Display Mode" - allows to select between
+<li>\subpage display_mode_page "Display Mode" - allows to select between
 Wireframe and Shading presentation.</li>
-<li>\ref color_page "Color" - allows to change the filling color in
+<li>\subpage bring_to_front_page "Bring To Front" - allows to bring to 
+front of the viewer the selected geometrical object.</li>
+<li><b>Clear Top Level State</b> - allows to remove from the viewer foreground 
+geometrical objects that have been placed there via <b>Bring To Front</b> command.</li>
+<li>\subpage color_page "Color" - allows to change the filling color in
 the standard <b>Select Color</b> menu.</li>
-<li>\ref transparency_page "Transparency" - allows to change the
+<li>\subpage transparency_page "Transparency" - allows to change the
 transparency of geometrical objects.</li>
-<li>\ref isolines_page "Isos" - allows to change the number of
+<li>\subpage isolines_page "Isos" - allows to change the number of
 isolines displayed within a shape.</li>
+<li>\subpage deflection_page "Deflection" - allows to change the
+deflection coefficient of a shape.</li>
+<li>\subpage material_page "Material" - allows to change the
+material properties of a shape.</li>
+<li>\subpage point_marker_page "Point Marker" - allows to change the
+representation of geometrical vertices.</li>
+<li>\subpage line_width_page "Line Width" - allows to change the
+width of edges and isolines.</li>
+<li><b>Auto color</b> / <b>Disable auto color</b> - activates the auto color
+mode. When the auto color mode is enabled, the groups created on the
+sub-shapes of the selected geometrical object are automatically
+coloured by the unique colors. TUI Commands :
+<em>go.SetAutoColor(enable)</em>, <em>enabled = go.GetAutoColor()</em></li>
 <li><b>Hide</b> - allows to hide the selected geometrical object from the
-viewer. TUI Command : <em>sg.EraseOnly(ID)</em>
-\n \image html image18.gif
-</li>
-<li><b>Hide all</b> - allows to hide all objects from the viewer. TUI
-Command: <em>sg.EraseAll()</em>
-\n \image html image26.gif
-</li>
-<li><b>Display Only</b> - allows to display only the selected
-geometrical object. TUI Command: <em>sg.DisplayOnly(ID)</em>
-\n \image html image33.gif
-</li>
-<li><b>Update</b> - refreshes the presentation of your geometrical object in the
-Object Browser, applying all recent changes.</li>
+viewer. TUI Command : <em>sg.EraseOnly(ID)</em></li>
+
+\image html image18.png
+
+<li><b>Hide all</b> - hides all objects from the viewer. TUI
+Command: <em>sg.EraseAll()</em></li>
+
+\image html image26.png
+
+<li><b>Show Only</b> - displays only the selected
+geometrical object. TUI Command: <em>sg.DisplayOnly(ID)</em></li>
+
+\image html image33.png
+
+<li><b>Show all dimensions</b> - shows all of the persistent dimensions created for the selected geometrical object.</li>
+<li><b>Hide all dimensions</b> - hides all of the persistent dimensions created for the selected geometrical object.</li>
 <li><b>Dump view</b> - exports an object from the viewer in bmp, png,
 jpg or jpeg image format.</li>
 <li><b>Change background</b> - allows to redefine the background
-color. By default it is black.
-\n\n Some of these functionalities are available through right-clicking
+color. By default it is black.</li>
+</ul>
+
+Some of these functionalities are available through right-clicking
 on the viewer background:
 
-\image html image2.jpg <br></li>
+\image html image22.png <br>
 
+<ul>
 <li><b>Select Only</b> provides a filter for exclusive selection of objects of a certain type.</li>
 </ul>
 
+The following commands appear in the Object Browser context menu
+under certain conditions:
+
+\image html ob_popup_menu.png <br>
+
+<ul>
+<li>\ref work_with_groups_page "Create Group" - allows creating groups of geometrical objects.</li>
+
+<li><b>Conceal child items</b> / <b>Disclose child items</b> - hides / shows child
+sub-objects in the Object Browser, if the selected geometric object has
+child objects. When some child objects are hidden, the name of the
+parent object is hilghlighted with bold font.</li>
+
+<li><b>Show Only Children</b> - erases from the current viewer all objects
+and then displays only the children of the selected object(s).
+</li>
+
+<li><b>Unpublish</b> - unpublishes the selected geometric object from the Object Browser 
+  and erase it from all viewers. To publish unpublished geometric objects select in the 
+  context menu of the <b>Geometry</b> root object <b>Publish...</b> item. 
+  The following dialog box will appear
+
+  \image html publish_dlg.png <br>
+
+  Switch the checkbox near the appropriate object and
+  click <b>Publish</b> or <b>Publish And Close</b> button. 
+
+  "Eye" icons in this dialog box allow previewing unpublished objects in the viewer. By default all 
+  unpublished objects are sorted by name in ascending order. It is possible
+  to change the order (ascending / descending) by clicking the corresponding title bar of the objects list.
+</li>
+</ul>
+
+At the bottom of the Object Browser, there is \b Information
+window providing some information on a selected geometric object:
+
+\image html creation_op_info.png Information window
+
+- <b>Creation operation</b> shows a name of the operation
+used to create the selected object.
+- The table below lists \b Parameters used to create the
+selected object and their \b Values.
+
 */