doc/salome/gui/input/common_functionality.doc

   1 /*!
   2
   3 \page common_functionality_page Common functionality
   4
   5 \anchor viewer_background
   6 <h2>Background</h2>
   7
   8 Viewers background can be customized using the "Change background"
   9 popup menu command that opens the following dialog box:
  10
  11 \image html change_background_dlg.png
  12
  13 The following types of the background are supported:
  14
  15 - Single color: the background is colored with the solid color
  16   specified by the user in the dialog box.
  17
  18 - Gradient background: 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:
  21
  22   - Horizontal
  23
  24   - Vertical
  25
  26   - First diagonal
  27
  28   - Second diagonal
  29
  30   - First corner
  31
  32   - Second corner
  33
  34   - Third corner
  35
  36   - Fourth corner
  37
  38 - Image: allows to set image as viewer background and define filling type:
  39
  40   - Center: the image is located at the center of the viewer backgound
  41
  42   - Tile: the image fills the entire viewer backgound one by one
  43
  44   - Stretch: the image is stretched to the entire viewer backgound.
  45
  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".
  49
  50 <hr>
  51
  52 <h2>Selection</h2>
  53
  54 For selecting it is necessary to click by left mouse button on the required
  55 element. Thus, this element will be selected.
  56
  57 Also, holding down the <b>Shift</b> key while selecting objects will
  58 produce multi selection.
  59
  60 In the viewers there are two mechanism for selecting: rectangle and
  61 polyline selection.
  62
  63 <h3>Rectangle selection</h3>
  64
  65 The Rectangle Selection tool is designed to select rectangular regions:
  66 it is the most basic of the selection tools and very commonly used.
  67
  68 For selecting area by rectangle press left mouse button and draw it on
  69 the viewer holding down the left mouse button.
  70
  71 To add an area to the existing selection it is necessary to hold down
  72 <b>Shift</b> key while selecting.
  73
  74 \image html rectselectionvtk.png
  75 As a result, only a rectangle is selected.
  76 \image html rectselectionvtk2.png
  77
  78 <h3>Polyline selection</h3>
  79
  80 OCC and VTK Viewers features a special Polyline Selection mechanism,
  81 which allows selecting an arbitraty part of the graphic area using a
  82 polygon frame (rubber band), instead of the usual selection with a
  83 rectangular frame.
  84
  85 To produce a Polyline Selection, lock the right mouse button and draw
  86 the first side of the polygon, then change the direction by clicking
  87 the left mouse button add draw another side, etc. The whole selection
  88 frame is drawn with the locked right mouse button.
  89
  90 To add an area to the existing selection it is necessary to hold down
  91 <b>Shift</b> key while selecting.
  92
  93 \image html polyselectionvtk11.png
  94 As a result, only the faces within the frame are selected.
  95 \image html polyselectionvtk21.png
  96
  97 <hr>
  98
  99 \anchor viewer_navigation_modes
 100 <h2>Navigation modes</h2>
 101
 102 OCC and VTK 3D viewers support two different navigation modes:
 103
 104 - <b>Salome standard controls</b>
 105
 106   Rectangle selection in this mode is performed by left mouse button,
 107   polyline selection is done by right mouse button;
 108   multiple selection is available when \b Shift button is pressed.
 109
 110   Also, holding \b Ctrl key pressed in conjunction with
 111   mouse buttons performs view transformations:
 112   - \b Ctrl + left mouse button - zooming;
 113   - \b Ctrl + middle mouse button - panning;
 114   - \b Ctrl + right mouse button - rotation.
 115
 116 - <b>Keyboard free style</b>
 117
 118   This mode allows to process all view transformations without using
 119   keyboard (only by mouse):
 120   - \b Left mouse button performs view rotation;
 121   - \b Middle mouse button performs panning;
 122   - \b Right mouse button makes zooming.
 123   .
 124
 125   In this style selection of objects in view is performed by pressing
 126   "S" key or by left mouse button click. Rectangle selection is done
 127   by left mouse button when holding \b Ctrl key; polyline selection
 128   is done by right mouse button with \b Ctrl key pressed.
 129
 130 */