1 .. _vtk_3d_viewer_page:
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
15 .. image:: ../images/vtkviewer_toolbar.png
22 .. image:: ../../../../src/VTKViewer/resources/vtk_view_camera_dump.png
25 **Dump View** - exports an object snap-shot from the viewer in bmp, png or jpeg image format.
30 .. image:: ../../../../src/SVTK/resources/vtk_view_style_switch.png
33 **Interaction style switch** - allows to switch between "Salome
34 standard controls" and "Keyboard free" :ref:`viewer_navigation_modes`.
40 .. image:: ../../../../src/SVTK/resources/vtk_view_zooming_style_switch.png
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.
51 .. image:: ../../../../src/SVTK/resources/vtk_view_highlight_std.png
53 .. image:: ../../../../src/SVTK/resources/vtk_view_highlight_dyn.png
55 .. image:: ../../../../src/SVTK/resources/vtk_view_highlight_off.png
58 These buttons allow switching between three pre-selection (highlighting) modes:
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.
68 .. image:: ../../../../src/SVTK/resources/vtk_view_selection.png
71 **Enable/Disable selection** - enables or disables selection in the view.
76 .. image:: ../../../../src/VTKViewer/resources/vtk_view_triedre.png
79 **Show/Hide Trihedron** - shows or hides coordinate axes.
84 .. image:: ../../../../src/VTKViewer/resources/vtk_view_fitall.png
87 **Fit all** - scales the presentation so that it could fit within
88 the Viewer boundaries.
93 .. image:: ../../../../src/VTKViewer/resources/vtk_view_fitarea.png
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.
102 .. image:: ../../../../src/VTKViewer/resources/vtk_view_fitselection.png
105 **Fit selection** - fits view contents to the current selection.
110 .. image:: ../../../../src/VTKViewer/resources/vtk_view_zoom.png
113 **Zoom** - allows to zoom in and out.
118 .. image:: ../../../../src/VTKViewer/resources/vtk_view_pan.png
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.
128 .. image:: ../../../../src/VTKViewer/resources/vtk_view_glpan.png
131 **Global panning** - allows to select a point to be the center of
132 the presentation showing all displayed objects in the visible area.
137 .. image:: ../../../../src/SVTK/resources/vtk_view_rotation_point.png
140 **Change rotation point** - allows to to choose the point around
141 which the rotation is performed.
143 .. image:: ../images/set_rotation_point_dialog1.png
146 By default the rotation point is located in the Center of the bounding
149 .. image:: ../images/set_rotation_point_dialog3.png
152 Unchecking **Use Bounding Box Center** check-box allows you to
153 define the coordinates of the rotation point manually.
155 - **Set to Origin** button restores the default rotation point coordinates.
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.
163 .. image:: ../../../../src/VTKViewer/resources/vtk_view_rotate.png
166 **Rotation** - allows to rotate the selected object using the
172 .. image:: ../../../../src/VTKViewer/resources/vtk_view_front.png
175 .. image:: ../../../../src/VTKViewer/resources/vtk_view_back.png
178 .. image:: ../../../../src/VTKViewer/resources/vtk_view_top.png
181 .. image:: ../../../../src/VTKViewer/resources/vtk_view_bottom.png
184 .. image:: ../../../../src/VTKViewer/resources/vtk_view_left.png
187 .. image:: ../../../../src/VTKViewer/resources/vtk_view_right.png
190 These buttons orientate the scene strictly about coordinate axes:
191 **Front**, **Back**, **Top**, **Bottom**, **Left** or **Right** side.
196 .. image:: ../../../../src/VTKViewer/resources/vtk_view_anticlockwise.png
199 **Rotate counter-clockwise** - rotates view 90 @htmlonly ° @endhtmlonly counter-clockwise.
204 .. image:: ../../../../src/VTKViewer/resources/vtk_view_clockwise.png
207 **Rotate clockwise** - rotates view 90 @htmlonly ° @endhtmlonly clockwise.
212 .. image:: ../../../../src/VTKViewer/resources/vtk_view_reset.png
215 **Reset** - restores the default position (isometric) of objects in
221 .. image:: ../../../../src/SVTK/resources/vtk_view_update_rate.png
224 **Update Rate** - allows to define the Update Rate for the
225 presentations displayed in the viewer.
227 .. image:: ../images/updaterate.png
230 - **Desired Update Rate, FPS** - allows to set the target Update Rate
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
234 - **Current Update Rate, FPS** - shows the Update Rate currently available on your configuration
236 - **Number of Cells** - shows the number of cells currently in display
242 .. image:: ../../../../src/SVTK/resources/vtk_view_scaling.png
245 **Scaling** - represents objects deformed (stretched or stuffed) along the axes of coordinates.
250 .. image:: ../../../../src/SVTK/resources/vtk_view_graduated_axes.png
253 **Graduated axes** - allows to define parameters of axes and graduate them.
255 .. image:: ../images/graduatedaxes1.png
258 - **Axis name** - if checked the axis name is displayed in the viewer.
260 - **Name** - allows to redefine the name of the axis.
262 - **Font** - allows to define color and properties of the font of axis name.
264 - **Labels** - if checked the labels are displayed in the viewer.
266 - **Number** - allows to define the number of labels.
268 - **Offset** - allows to define the distance between labels.
270 - **Font** - allows to define color and properties of the font of labels names.
272 - **Tick marks** - if checked the tick marks are displayed in the viewer.
274 - **Length** - allows to define the length of tick marks.
276 - **Is visible** - if checked the axis is displayed in the viewer.
282 .. image:: ../../../../src/SVTK/resources/vtk_view_parameters.png
285 **Change View Parameters** - this button gives access to the
286 dialog for customization of various view parameters.
288 .. image:: ../images/vtk_view_parameters_dlg.png
291 - **Projection Mode** - switches between the **Orthogonal** and **Perspective** projection modes.
293 - **Focal Point** - allows to specify the focal point of the view
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.
300 - **Camera Position** - allows to specify the position of the view camera:
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.
307 - **View Up Direction** - direction of the "view up" vector.
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).
318 .. image:: ../images/vtk_view_sync.png
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
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.
334 .. image:: ../../../../src/SVTK/resources/vtk_view_parallel.png
337 **Orthogonal mode** - Switches the view to the orthogonal mode.
342 .. image:: ../../../../src/SVTK/resources/vtk_view_perspective.png
345 **Perspective mode** - Switches the view to the perspective mode.
350 .. image:: ../../../../src/SVTK/resources/vtk_view_recording_start.png
353 .. image:: ../../../../src/SVTK/resources/vtk_view_recording_play.png
356 .. image:: ../../../../src/SVTK/resources/vtk_view_recording_pause.png
359 .. image:: ../../../../src/SVTK/resources/vtk_view_recording_stop.png
362 These buttons allow recording viewing operations as a video file in
363 the AVI format using external software (jpeg2yuv):
365 - **Start recording** - specify parameters and start recording;
367 - **Pause recording** - suspend recording;
369 - **Continue recording** - resume recording;
371 - **Stop recording** - stop recording.