Salome HOME
Update GEOM gui documentation
[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><b>Auto color</b> / <b>Disable auto color</b> - activates the auto color
31 mode. When the auto color mode is enabled, the groups created on the
32 sub-shapes of the selected geometrical object are automatically
33 coloured by the unique colors. TUI Commands :
34 <em>go.SetAutoColor(enable)</em>, <em>enabled = go.GetAutoColor()</em></li>
35 <li><b>Hide</b> - allows to hide the selected geometrical object from the
36 viewer. TUI Command : <em>sg.EraseOnly(ID)</em></li>
37
38 \image html image18.png
39
40 <li><b>Hide all</b> - allows to hide all objects from the viewer. TUI
41 Command: <em>sg.EraseAll()</em></li>
42
43 \image html image26.png
44
45 <li><b>Show Only</b> - allows to display only the selected
46 geometrical object. TUI Command: <em>sg.DisplayOnly(ID)</em></li>
47
48 \image html image33.png
49
50 <li><b>Dump view</b> - exports an object from the viewer in bmp, png,
51 jpg or jpeg image format.</li>
52 <li><b>Change background</b> - allows to redefine the background
53 color. By default it is black.</li>
54 </ul>
55
56 Some of these functionalities are available through right-clicking
57 on the viewer background:
58
59 \image html image22.png <br>
60
61 <ul>
62 <li><b>Select Only</b> provides a filter for exclusive selection of objects of a certain type.</li>
63 </ul>
64
65 The the following commands appear in the Object Browser context menu
66 under certain conditions:
67
68 \image html ob_popup_menu.png <br>
69
70 <ul>
71 <li>\subpage work_with_groups_page "Create Group" - allows creating groups of geometrical objects.</li>
72 <li><b>Hide Children</b> / <b>Show Children</b> - hides / shows child
73 sub-objects in the Object Browser, if the selected geometr object has
74 child objects. When some child objects are hidden, the name of the
75 parent object is hilghlighted with bold font.</li>
76 </ul>
77
78 */