doc/salome/gui/input/vtk_3d_viewer.rst

   1 .. _vtk_3d_viewer_page:
   2
   3 *************
   4 VTK 3D Viewer
   5 *************
   6
   7 Operations
   8 ##########
   9
  10 The functionalities of VTK viewer are available via its Viewer
  11 Toolbar. Buttons marked with small downward triangles have extended
  12 functionality, which can be accessed by locking on them with left mouse
  13 button.
  14
  15 .. image:: ../images/vtkviewer_toolbar.png
  16         :align: center
  17
  18
  19 ____
  20
  21
  22 .. image:: ../../../../src/VTKViewer/resources/vtk_view_camera_dump.png
  23         :align: center
  24
  25 **Dump View** - exports an object snap-shot from the viewer in bmp, png or jpeg image format.
  26
  27 ____
  28
  29
  30 .. image:: ../../../../src/SVTK/resources/vtk_view_style_switch.png
  31         :align: center
  32
  33 **Interaction style switch** - allows to switch between "Salome
  34 standard controls" and "Keyboard free" :ref:`viewer_navigation_modes`.
  35
  36
  37 ____
  38
  39
  40 .. image:: ../../../../src/SVTK/resources/vtk_view_zooming_style_switch.png
  41         :align: center
  42
  43 **Zooming style switch** - allows to switch between standard
  44 (zooming at the center of the view) and advanced (zooming at the
  45 current cursor position) zooming styles. The second mode is available
  46 only for parallel (non-perspective) view's mode.
  47
  48 ____
  49
  50
  51 .. image:: ../../../../src/SVTK/resources/vtk_view_highlight.png
  52         :align: center
  53
  54 These buttons allow switching between three pre-selection (highlighting) modes:
  55
  56 - **Static pre-selection mode** - pre-selection is done in terms of bounding boxes;
  57 - **Dynamic pre-selection mode** - pre-selection is done in terms of cells, i.e. an object can be selected by clicking the point/cell belonging to this object. This mode causes some performance loss. It is advisable to switch dynamic pre-selection off to have a good performance on big objects (for example, huge meshes);
  58 - **Disable pre-selection** - pre-selection is disabled.
  59
  60
  61 ____
  62
  63
  64 .. image:: ../../../../src/SVTK/resources/vtk_view_selection.png
  65         :align: center
  66
  67 **Enable/Disable selection** - enables or disables selection in the view.
  68
  69 ____
  70
  71
  72 .. image:: ../../../../src/VTKViewer/resources/vtk_view_triedre.png
  73         :align: center
  74
  75 **Show/Hide Trihedron** - shows or hides coordinate axes.
  76
  77 ____
  78
  79
  80 .. image:: ../../../../src/VTKViewer/resources/vtk_view_fitall.png
  81         :align: center
  82
  83 **Fit all** - scales the presentation so that it could fit within
  84 the Viewer boundaries.
  85
  86 ____
  87
  88
  89 .. image:: ../../../../src/VTKViewer/resources/vtk_view_fitarea.png
  90         :align: center
  91
  92 **Fit area** - resizes the view to place in the visible area only
  93 the contents of a frame drawn with pressed left mouse button.
  94
  95 ____
  96
  97
  98 .. image:: ../../../../src/VTKViewer/resources/vtk_view_fitselection.png
  99         :align: center
 100
 101 **Fit selection** - fits view contents to the current selection.
 102
 103 ____
 104
 105
 106 .. image:: ../../../../src/VTKViewer/resources/vtk_view_zoom.png
 107         :align: center
 108
 109 **Zoom** - allows to zoom in and out.
 110
 111 ____
 112
 113
 114 .. image:: ../../../../src/VTKViewer/resources/vtk_view_pan.png
 115         :align: center
 116
 117 **Panning** - if the represented objects are greater that the
 118 visible area and you do not wish to use **Fit all** functionality,
 119 click on this button to drag the scene to see its remote parts.
 120
 121 ____
 122
 123
 124 .. image:: ../../../../src/VTKViewer/resources/vtk_view_glpan.png
 125         :align: center
 126
 127 **Global panning** - allows to select a point to be the center of
 128 the presentation showing all displayed objects in the visible area.
 129
 130 ____
 131
 132
 133 .. image:: ../../../../src/SVTK/resources/vtk_view_rotation_point.png
 134         :align: center
 135
 136 **Change rotation point** - allows to to choose the point around
 137 which the rotation is performed.
 138
 139 .. image:: ../images/set_rotation_point_dialog1.png
 140         :align: center
 141
 142 By default the rotation point is located in the Center of the bounding
 143 box of an object.
 144
 145 .. image:: ../images/set_rotation_point_dialog3.png
 146         :align: center
 147
 148 Unchecking **Use Bounding Box Center** check-box allows you to
 149 define the coordinates of the rotation point manually.
 150
 151 - **Set to Origin** button restores the default rotation point coordinates.
 152
 153 - **Gravity Center of Selected Object** button allows using the gravity center of the object selected in the viewer as the center of the rotation point. When you click this button, you should first choose the type of selectable object: Point, Edge, Face or Solid and only then proceed with selection in the viewer.
 154
 155
 156 ____
 157
 158
 159 .. image:: ../../../../src/VTKViewer/resources/vtk_view_rotate.png
 160         :align: center
 161
 162 **Rotation** - allows to rotate the selected object using the
 163 mouse.
 164
 165 ____
 166
 167
 168 .. image:: ../../../../src/VTKViewer/resources/vtk_view_front.png
 169         :align: center
 170
 171 .. image:: ../../../../src/VTKViewer/resources/vtk_view_back.png
 172         :align: center
 173
 174 .. image:: ../../../../src/VTKViewer/resources/vtk_view_top.png
 175         :align: center
 176
 177 .. image:: ../../../../src/VTKViewer/resources/vtk_view_bottom.png
 178         :align: center
 179
 180 .. image:: ../../../../src/VTKViewer/resources/vtk_view_left.png
 181         :align: center
 182
 183 .. image:: ../../../../src/VTKViewer/resources/vtk_view_right.png
 184         :align: center
 185
 186 These buttons orientate the scene strictly about coordinate axes:
 187 **Front**, **Back**, **Top**, **Bottom**, **Left** or **Right** side.
 188
 189 ____
 190
 191
 192 .. image:: ../../../../src/VTKViewer/resources/vtk_view_anticlockwise.png
 193         :align: center
 194
 195 **Rotate counter-clockwise** - rotates view 90 @htmlonly &deg; @endhtmlonly counter-clockwise.
 196
 197 ____
 198
 199
 200 .. image:: ../../../../src/VTKViewer/resources/vtk_view_clockwise.png
 201         :align: center
 202
 203 **Rotate clockwise** - rotates view 90 @htmlonly &deg; @endhtmlonly clockwise.
 204
 205 ____
 206
 207
 208 .. image:: ../../../../src/VTKViewer/resources/vtk_view_reset.png
 209         :align: center
 210
 211 **Reset** - restores the default position (isometric) of objects in
 212 the scene.
 213
 214 ____
 215
 216
 217 .. image:: ../../../../src/SVTK/resources/vtk_view_update_rate.png
 218         :align: center
 219
 220 **Update Rate** - allows to define the Update Rate for the
 221 presentations displayed in the viewer.
 222
 223 .. image:: ../images/updaterate.png
 224         :align: center
 225
 226 - **Desired Update Rate, FPS** - allows to set the target Update Rate
 227
 228 - **Still Update Rate, FPS** - allows to set the Update Rate for the periods when both the user and the application do not perform any actions in the viewer
 229
 230 - **Current Update Rate, FPS** - shows the Update Rate currently available on your configuration
 231
 232 - **Number of Cells** - shows the number of cells currently in display
 233
 234
 235 ____
 236
 237
 238 .. image:: ../../../../src/SVTK/resources/vtk_view_scaling.png
 239         :align: center
 240
 241 **Scaling** - represents objects deformed (stretched or stuffed) along the axes of coordinates.
 242
 243 ____
 244
 245
 246 .. image:: ../../../../src/SVTK/resources/vtk_view_graduated_axes.png
 247         :align: center
 248
 249 **Graduated axes** - allows to define parameters of axes and graduate them.
 250
 251 .. image:: ../images/graduatedaxes1.png
 252         :align: center
 253
 254 - **Axis name** - if checked the axis name is displayed in the viewer.
 255
 256   - **Name** - allows to redefine the name of the axis.
 257
 258   - **Font** - allows to define color and properties of the font of axis name.
 259
 260 - **Labels** - if checked the labels are displayed in the viewer.
 261
 262   - **Number** - allows to define the number of labels.
 263
 264   - **Offset** - allows to define the distance between labels.
 265
 266   - **Font** - allows to define color and properties of the font of labels names.
 267
 268 - **Tick marks** - if checked the tick marks are displayed in the viewer.
 269
 270   - **Length** - allows to define the length of tick marks.
 271
 272 - **Is visible** - if checked the axis is displayed in the viewer.
 273
 274
 275 ____
 276
 277
 278 .. image:: ../../../../src/SVTK/resources/vtk_view_parameters.png
 279         :align: center
 280
 281 **Change View Parameters** - this button gives access to the
 282 dialog for customization of various view parameters.
 283
 284 .. image:: ../images/vtk_view_parameters_dlg.png
 285         :align: center
 286
 287 - **Projection Mode** - switches between the **Orthogonal** and **Perspective** projection modes.
 288
 289 - **Focal Point** - allows to specify the focal point of the view
 290
 291   - **Set to Bounding Box Center** - chooses the center of the bounding box of the current scene as the focal point;
 292   - **Set to Origin** - chooses the global coordinates system origin as the focal point;
 293   - **Select Point from View** - allows to specify the focal point by the direct selection of a point in the view window;
 294   - **X**, **Y**, **Z** - allows to input the coordinates of the focal point directly.
 295
 296 - **Camera Position** - allows to specify the position of the view camera:
 297
 298   - **Absolute Coordinates** - in absolute coordinates;
 299   - **Relative to Focal Point** - as a offset to the focal point;
 300   - **Projection Direction** - allows specify the direction of the projection vector;
 301   - **Focal Distance** - the focal distance value.
 302
 303 - **View Up Direction** - direction of the "view up" vector.
 304
 305 - **Zooming**
 306
 307         - **Scale** - the current zoom factor (available in the **Orthogonal mode** only);
 308         - **View Angle** - the current view angle (available in the **Perspective mode** only).
 309
 310
 311 ____
 312
 313
 314 .. image:: ../images/vtk_view_sync.png
 315         :align: center
 316
 317 **Synchronize view** - allows to synchronize 3d view
 318 parameters. This button has two states - checked and
 319 unchecked. Clicking on this button opens a drop-down menu listing
 320 compatible 3d views. When a view is selected in the list , the parameters (view point, position, zoom coefficient, etc.) of the current view are synchronized with the selected view (static
 321 synchronization).
 322
 323 In addition, when this button is "checked", the
 324 views are synchronized dynamically, i.e. any zoom, pan, rotate
 325 or other view operation done in one view is automatically applied to the other view.
 326
 327 ____
 328
 329
 330 .. image:: ../../../../src/SVTK/resources/vtk_view_parallel.png
 331         :align: center
 332
 333 **Orthogonal mode** - Switches the view to the orthogonal mode.
 334
 335 ____
 336
 337
 338 .. image:: ../../../../src/SVTK/resources/vtk_view_perspective.png
 339         :align: center
 340
 341 **Perspective mode** - Switches the view to the perspective mode.
 342
 343 ____
 344
 345
 346 .. image:: ../../../../src/SVTK/resources/vtk_view_recording_start.png
 347         :align: center
 348
 349 .. image:: ../../../../src/SVTK/resources/vtk_view_recording_play.png
 350         :align: center
 351
 352 .. image:: ../../../../src/SVTK/resources/vtk_view_recording_pause.png
 353         :align: center
 354
 355 .. image:: ../../../../src/SVTK/resources/vtk_view_recording_stop.png
 356         :align: center
 357
 358 These buttons allow recording viewing operations as a video file in
 359 the AVI format using external software (jpeg2yuv):
 360
 361 - **Start recording** - specify parameters and start recording;
 362
 363 - **Pause recording** - suspend recording;
 364
 365 - **Continue recording** - resume recording;
 366
 367 - **Stop recording** - stop recording.
 368
 369