3 \page common_functionality_page Functionality common for OCC and VTK viewers
5 \anchor viewer_background
8 Viewers background can be customized using the "Change background"
9 popup menu command that opens the following dialog box:
11 \image html change_background_dlg.png
13 The following types of the background are supported:
15 - <b> Single color: </b> the background is colored with the solid color
16 specified by the user in the dialog box.
18 - <b> Gradient background: </b> the background is gradiently colored according
19 to two colors and the gradient type specified in the dialog box. The
20 following types of background are supported:
38 - \b Image: allows to set image as viewer background and define filling type:
40 - \b Center: the image is located at the center of the viewer backgound
42 - \b Tile: the image fills the entire viewer backgound one by one
44 - \b Stretch: the image is stretched to the entire viewer backgound.
46 Default background for the OCC viewer is specified via the
47 \ref occ_preferences "OCC 3D Viewer Preferences" and for the
48 VTK viewer via the \ref vtk_preferences "VTK 3D Viewer Preferences".
54 An element can be selected by clicking on it with the left mouse button.
55 Selecting objects with locked \em Shift key produces a multi selection.
57 Additionally, when the viewer owns an input focus, an object can be selected
58 by pressing \em "S" on the keyboard. Pressing \em "S" when holding
59 \em Shift key allows adding/removing an object to/from the current selection.
61 OCC viewer provides a way to navigate between the selectable objects.
62 This feature (disabled by default) is used in some dialog boxes (for example,
63 in Geometry module). When there are several objects which suit current
64 selection requirements (specified by the dialog) under the current mouse cursor,
65 it is possible to switch between them by means of mouse scroll wheel.
66 The same can be also done by pressing \em "N" and \em "P" keys.
68 There are also two additional selection mechanisms: rectangle and
71 <h3>Rectangle selection</h3>
73 Rectangle Selection is the basic and commonly used selection tool.
75 To select a rectangle area press and hold the left mouse button while drawing the diagonal of the selection rectangle in the viewer.
77 \image html rectselectionvtk.png
79 As a result, the objects within the rectangle are selected.
81 \image html rectselectionvtk2.png
83 \note It is possible to add an area to the existing selection by holding down
84 \em Shift key while selecting.
86 <h3>Polyline selection</h3>
88 OCC and VTK Viewers feature a special Polyline Selection mechanism,
89 which allows selecting an arbitrary part of the graphic area using a
90 polygon frame (rubber band), instead of the usual selection with a
93 To produce a Polyline Selection, press and hold the right mouse button and draw
94 the first side of the selection polygon, then change the direction by clicking
95 the left mouse button add draw another side, etc.
97 \image html polyselectionvtk11.png
99 As a result, the objects within the polygon are selected.
101 \image html polyselectionvtk21.png
103 To add an area to the existing selection it is necessary to hold down
104 \em Shift key while selecting.
108 \anchor viewer_navigation_modes
109 <h2>Navigation modes</h2>
111 OCC and VTK 3D viewers support two different navigation modes:
113 - <b>Salome standard controls</b>
115 Rectangle selection in this mode is performed by the left mouse button
116 and polyline selection by the right mouse button;
117 multiple selection is available when \em Shift button is pressed.
119 Also, holding \em Ctrl key with pressed mouse buttons performs the following view transformations:
120 - \em Ctrl + left mouse button - zooming;
121 - \em Ctrl + middle mouse button - panning;
122 - \em Ctrl + right mouse button - rotation.
124 - <b>Keyboard free style</b>
126 This mode allows performing all view transformations without using the
127 keyboard (only by the mouse):
128 - Left mouse button performs view rotation;
129 - Middle mouse button performs panning;
130 - Right mouse button makes zooming.
132 In this style rectangle selection is done by the left mouse button with \em Ctrl key pressed;
133 polyline selection is done by the right mouse button with \em Ctrl key pressed.
135 In both styles selection of objects in the viewer can be performed by pressing
136 \em "S" key or by the left mouse button click.
138 Zooming can be alternatively done by scrolling mouse wheel.