doc/salome/gui/input/common_functionality.doc

   1 /*!
   2
   3 \page common_functionality_page  Functionality common for OCC and VTK viewers
   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 - <b> Single color: </b> the background is colored with the solid color
  16   specified by the user in the dialog box.
  17
  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:
  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 - \b Image: allows to set image as viewer background and define filling type:
  39
  40   - \b Center: the image is located at the center of the viewer backgound
  41
  42   - \b Tile: the image fills the entire viewer backgound one by one
  43
  44   - \b 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 An element can be selected by clicking on it with the left mouse button.
  55 Selecting objects with locked <b>Shift</b> key produces a multi selection.
  56
  57 In the viewers there are two selection mechanisms: rectangle and
  58 polyline selection.
  59
  60 <h3>Rectangle selection</h3>
  61
  62 Rectangle Selection is the basic and commonly used selection tool.
  63
  64 To select a rectangle area press and hold the left mouse button while drawing the diagonal of the selection rectangle in the viewer.
  65
  66 \image html rectselectionvtk.png
  67
  68 As a result, the objects within the rectangle are selected.
  69
  70 \image html rectselectionvtk2.png
  71
  72
  73 \note It is possible to add an area to the existing selection by holding down
  74 <b>Shift</b> key while selecting.
  75
  76
  77 <h3>Polyline selection</h3>
  78
  79 OCC and VTK Viewers feature a special Polyline Selection mechanism,
  80 which allows selecting an arbitrary part of the graphic area using a
  81 polygon frame (rubber band), instead of the usual selection with a
  82 rectangular frame.
  83
  84 To produce a Polyline Selection, press and hold the right mouse button and draw
  85 the first side of the selection polygon, then change the direction by clicking
  86 the left mouse button add draw another side, etc.
  87
  88 \image html polyselectionvtk11.png
  89
  90 As a result, the objects within the polygon are selected.
  91
  92 \image html polyselectionvtk21.png
  93
  94 To add an area to the existing selection it is necessary to hold down
  95 <b>Shift</b> key while selecting.
  96
  97
  98 <hr>
  99
 100 \anchor viewer_navigation_modes
 101 <h2>Navigation modes</h2>
 102
 103 OCC and VTK 3D viewers support two different navigation modes:
 104
 105 - <b>Salome standard controls</b>
 106
 107   Rectangle selection in this mode is performed by the left mouse button
 108   and polyline selection by the right mouse button;
 109   multiple selection is available when \b Shift button is pressed.
 110
 111   Also, holding \b Ctrl key with pressed mouse buttons performs the following 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 performing all view transformations without using the
 119   keyboard (only by the 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   In this style selection of objects in the viewer is performed by pressing
 125   "S" key or by the left mouse button click. Rectangle selection is done
 126   by the left mouse button with \b Ctrl key pressed; polyline selection
 127   is done by the right mouse button with \b Ctrl key pressed.
 128
 129 */