Salome HOME
Implementation of the "0020839: EDF 1370 DOC : Update of the TUI features documentati...
[modules/geom.git] / 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 color_page "Color" - allows to change the filling color in
25 the standard <b>Select Color</b> menu.</li>
26 <li>\subpage transparency_page "Transparency" - allows to change the
27 transparency of geometrical objects.</li>
28 <li>\subpage isolines_page "Isos" - allows to change the number of
29 isolines displayed within a shape.</li>
30 <li>\subpage deflection_page "Deflection" - allows to change the
31 deflection coefficient of a shape.</li>
32 <li>\subpage material_page "Material" - allows to change the
33 material properties of a shape.</li>
34 <li>\subpage point_marker_page "Point Marker" - allows to change the
35 representation of geometrical vertices.</li>
36 <li><b>Auto color</b> / <b>Disable auto color</b> - activates the auto color
37 mode. When the auto color mode is enabled, the groups created on the
38 sub-shapes of the selected geometrical object are automatically
39 coloured by the unique colors. TUI Commands :
40 <em>go.SetAutoColor(enable)</em>, <em>enabled = go.GetAutoColor()</em></li>
41 <li><b>Hide</b> - allows to hide the selected geometrical object from the
42 viewer. TUI Command : <em>sg.EraseOnly(ID)</em></li>
43
44 \image html image18.png
45
46 <li><b>Hide all</b> - allows to hide all objects from the viewer. TUI
47 Command: <em>sg.EraseAll()</em></li>
48
49 \image html image26.png
50
51 <li><b>Show Only</b> - allows to display only the selected
52 geometrical object. TUI Command: <em>sg.DisplayOnly(ID)</em></li>
53
54 \image html image33.png
55
56 <li><b>Dump view</b> - exports an object from the viewer in bmp, png,
57 jpg or jpeg image format.</li>
58 <li><b>Change background</b> - allows to redefine the background
59 color. By default it is black.</li>
60 </ul>
61
62 Some of these functionalities are available through right-clicking
63 on the viewer background:
64
65 \image html image22.png <br>
66
67 <ul>
68 <li><b>Select Only</b> provides a filter for exclusive selection of objects of a certain type.</li>
69 </ul>
70
71 The the following commands appear in the Object Browser context menu
72 under certain conditions:
73
74 \image html ob_popup_menu.png <br>
75
76 <ul>
77 <li>\ref work_with_groups_page "Create Group" - allows creating groups of geometrical objects.</li>
78 <li><b>Hide Children</b> / <b>Show Children</b> - hides / shows child
79 sub-objects in the Object Browser, if the selected geometric object has
80 child objects. When some child objects are hidden, the name of the
81 parent object is hilghlighted with bold font.</li>
82
83 <li><b>Unpublish</b> - unpublish the selected geometric object from the Object Browser 
84 and erase it from all viewers. To publish unpublished geometric objects select in the 
85 context menu of the <b>Geometry</b> root object <b>Publish...</b> item. 
86 The following dialog box will appear</li>
87 </ul>
88
89 \image html publish_dlg.png <br>
90
91 Switch the checkbox near the appropriate object and click <b>Publish</b> or <b>Publish And Close</b> button.
92 */