doc/salome/gui/GEOM/input/viewing_geom_obj.doc

   1 /*!
   2
   3 \page view_geom_obj_page Viewing geometrical objects
   4
   5 Newly created geometrical objects are automatically displayed in
   6 the <b>OCC 3D Viewer</b>.
   7
   8 <b>OCC 3D Viewer</b> is described in the documentation on <b>GUI
   9 module</b>.
  10
  11 After the object has appeared in the Viewer, you can select it with
  12 left mouse click to change its presentation parameters and access to
  13 other useful options by right-clicking on the selected object.
  14
  15 \image html dialog.png
  16
  17 <ul>
  18 <li><b>Rename</b> - allows to change the name of the geometric
  19 object.</li>
  20 <li><b>Delete</b> - irreversibly deletes the selected object from the
  21 viewer and from the Object Browser.</li>
  22 <li>\subpage display_mode_page "Display Mode" - allows to select between
  23 Wireframe and Shading presentation.</li>
  24 <li>\subpage bring_to_front_page "Bring To Front" - allows to bring to
  25 front of the viewer the selected geometrical object.</li>
  26 <li><b>Clear Top Level State</b> - allows to remove from the viewer foreground
  27 geometrical objects that have been placed there via <b>Bring To Front</b> command.</li>
  28 <li>\subpage color_page "Color" - allows to change the filling color in
  29 the standard <b>Select Color</b> menu.</li>
  30 <li>\subpage transparency_page "Transparency" - allows to change the
  31 transparency of geometrical objects.</li>
  32 <li>\subpage isolines_page "Isos" - allows to change the number of
  33 isolines displayed within a shape.</li>
  34 <li>\subpage deflection_page "Deflection" - allows to change the
  35 deflection coefficient of a shape.</li>
  36 <li>\subpage material_page "Material" - allows to change the
  37 material properties of a shape.</li>
  38 <li>\subpage point_marker_page "Point Marker" - allows to change the
  39 representation of geometrical vertices.</li>
  40 <li>\subpage line_width_page "Line Width" - allows to change the
  41 width of edges and isolines.</li>
  42 <li><b>Auto color</b> / <b>Disable auto color</b> - activates the auto color
  43 mode. When the auto color mode is enabled, the groups created on the
  44 sub-shapes of the selected geometrical object are automatically
  45 coloured by the unique colors. TUI Commands :
  46 <em>go.SetAutoColor(enable)</em>, <em>enabled = go.GetAutoColor()</em></li>
  47 <li><b>Hide</b> - allows to hide the selected geometrical object from the
  48 viewer. TUI Command : <em>sg.EraseOnly(ID)</em></li>
  49
  50 \image html image18.png
  51
  52 <li><b>Hide all</b> - hides all objects from the viewer. TUI
  53 Command: <em>sg.EraseAll()</em></li>
  54
  55 \image html image26.png
  56
  57 <li><b>Show Only</b> - displays only the selected
  58 geometrical object. TUI Command: <em>sg.DisplayOnly(ID)</em></li>
  59
  60 \image html image33.png
  61
  62 <li><b>Dump view</b> - exports an object from the viewer in bmp, png,
  63 jpg or jpeg image format.</li>
  64 <li><b>Change background</b> - allows to redefine the background
  65 color. By default it is black.</li>
  66 </ul>
  67
  68 Some of these functionalities are available through right-clicking
  69 on the viewer background:
  70
  71 \image html image22.png <br>
  72
  73 <ul>
  74 <li><b>Select Only</b> provides a filter for exclusive selection of objects of a certain type.</li>
  75 </ul>
  76
  77 The following commands appear in the Object Browser context menu
  78 under certain conditions:
  79
  80 \image html ob_popup_menu.png <br>
  81
  82 <ul>
  83 <li>\ref work_with_groups_page "Create Group" - allows creating groups of geometrical objects.</li>
  84
  85 <li><b>Conceal child items</b> / <b>Disclose child items</b> - hides / shows child
  86 sub-objects in the Object Browser, if the selected geometric object has
  87 child objects. When some child objects are hidden, the name of the
  88 parent object is hilghlighted with bold font.</li>
  89
  90 <li><b>Show Only Children</b> - erases from the current viewer all objects
  91 and then displays only the children of the selected object(s).
  92 </li>
  93
  94 <li><b>Unpublish</b> - unpublishes the selected geometric object from the Object Browser
  95   and erase it from all viewers. To publish unpublished geometric objects select in the
  96   context menu of the <b>Geometry</b> root object <b>Publish...</b> item.
  97   The following dialog box will appear
  98
  99   \image html publish_dlg.png <br>
 100
 101   Switch the checkbox near the appropriate object and
 102   click <b>Publish</b> or <b>Publish And Close</b> button.
 103
 104   "Eye" icons in this dialog box allow previewing unpublished objects in the viewer. By default all
 105   unpublished objects are sorted by name in ascending order. It is possible
 106   to change the order (ascending / descending) by clicking the corresponding title bar of the objects list.
 107 </li>
 108 </ul>
 109
 110 At the bottom of the Object Browser, there is \b Information
 111 window providing some information on a selected geometric object:
 112
 113 \image html creation_op_info.png Information window
 114
 115 - <b>Creation operation</b> shows a name of the operation
 116 used to create the selected object.
 117 - The table below lists \b Parameters used to create the
 118 selected object and their \b Values.
 119
 120 */