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