doc/salome/gui/input/vtk_3d_viewer.doc

   1 /*!
   2
   3 \page vtk_3d_viewer_page VTK 3D Viewer
   4
   5 <h2>Operations</h2>
   6
   7 The functionalities of VTK viewer are available via its Viewer
   8 Toolbar. Buttons marked with small downward triangles have extended
   9 functionality, which can be accessed by locking on them with left mouse
  10 button.
  11
  12 \image html vtkviewer_toolbar.png
  13 <hr>
  14
  15 \image html vtk_view_camera_dump.png
  16
  17 <b>Dump View</b> - exports an object from the viewer in bmp, png or jpeg image format.
  18 <hr>
  19
  20 \image html vtk_view_style_switch.png
  21
  22 <b>Interaction style switch</b> - allows to switch between "Salome
  23 standard controls" and "Keyboard free" \ref viewer_navigation_modes "interaction styles".
  24
  25 <hr>
  26
  27 \image html vtk_view_zooming_style_switch.png
  28
  29 <b>Zooming style switch</b> - allows to switch between standard
  30 (zooming at the center of the view) and advanced (zooming at the
  31 current cursor position) zooming styles. The second mode is available
  32 only for parallel (non-perspective) view's mode.
  33 <hr>
  34
  35 \image html vtk_view_highlight.png
  36
  37 These buttons allow switching between three pre-selection (highlighting) modes:
  38 - <b>Static pre-selection mode</b> - pre-selection is done in terms of bounding boxes;
  39 - <b>Dynamic pre-selection mode</b> - 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);
  40 - <b>Disable pre-selection</b> - pre-selection is disabled.
  41
  42 <hr>
  43
  44 \image html vtk_view_selection.png
  45
  46 <b>Enable/Disable selection</b> - enables or disables selection in the view.
  47 <hr>
  48
  49 \image html vtk_view_triedre.png
  50
  51 <b>Show/Hide Trihedron</b> - shows or hides coordinate axes.
  52 <hr>
  53
  54 \image html vtk_view_fitall.png
  55
  56 <b>Fit all</b> - scales the presentation so that it could fit within
  57 the Viewer boundaries.
  58 <hr>
  59
  60 \image html vtk_view_fitarea.png
  61
  62 <b>Fit area</b> - resizes the view to place in the visible area only
  63 the contents of a frame drawn with pressed left mouse button.
  64 <hr>
  65
  66 \image html vtk_view_zoom.png
  67
  68 <b>Zoom</b> - allows to zoom in and out.
  69 <hr>
  70
  71 \image html vtk_view_pan.png
  72
  73 <b>Panning</b> - if the represented objects are greater that the
  74 visible area and you do not wish to use <b>Fit all</b> functionality,
  75 click on this button to drag the scene to see its remote parts.
  76 <hr>
  77
  78 \image html vtk_view_glpan.png
  79
  80 <b>Global panning</b> - allows to select a point to be the center of
  81 the presentation showing all displayed objects in the visible area.
  82 <hr>
  83
  84 \image html vtk_view_rotation_point.png
  85
  86 <b>Change rotation point</b> - allows to to choose the point around
  87 which the rotation is performed.
  88
  89 \image html set_rotation_point_dialog1.png
  90
  91 By default the rotation point is located in the Center of the bounding
  92 box of an object.
  93
  94 \image html set_rotation_point_dialog2.png
  95
  96 Unchecking <b>Use Bounding Box Center</b> check-box allows you to
  97 define the coordinates of the rotation point manually.
  98
  99 - <b>Set to Origin</b> button restores the default rotation point
 100   coordinates.
 101
 102 - <b>Select Point from View</b> button allows to select the rotation
 103   point in the 3D Viewer.
 104
 105 <hr>
 106
 107 \image html vtk_view_rotate.png
 108
 109 <b>Rotation</b> - allows to rotate the selected object using the
 110 mouse.
 111 <hr>
 112
 113 \image html vtk_view_front.png
 114 \image html vtk_view_back.png
 115 \image html vtk_view_top.png
 116 \image html vtk_view_bottom.png
 117 \image html vtk_view_left.png
 118 \image html vtk_view_right.png
 119
 120 These buttons orientate the scene strictly about coordinate axes:
 121 \b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side.
 122 <hr>
 123
 124 \image html vtk_view_anticlockwise.png
 125
 126 <b>Rotate counter-clockwise</b> - rotates view 90° counter-clockwise.
 127 <hr>
 128
 129 \image html vtk_view_clockwise.png
 130
 131 <b>Rotate clockwise</b> - rotates view 90° clockwise.
 132 <hr>
 133
 134 \image html vtk_view_reset.png
 135
 136 <b>Reset</b> - restores the default position (isometric) of objects in
 137 the scene.
 138 <hr>
 139
 140 \image html vtk_view_update_rate.png
 141
 142 <b>Update Rate</b> - allows to define the Update Rate for the
 143 presentations displayed in the viewer.
 144
 145 \image html updaterate.png
 146
 147 - <b>Desired Update Rate, FPS</b> - allows to set the target Update
 148   Rate
 149
 150 - <b>Still Update Rate, FPS</b> - allows to set the Update Rate for
 151   the periods when both the user and the application do not perform
 152   any actions in the viewer
 153
 154 - <b>Current Update Rate, FPS</b> - shows the Update Rate currently
 155   available on your configuration
 156
 157 - <b>Number of Cells</b> - shows the number of cells currently in
 158   display
 159
 160 <hr>
 161
 162 \image html vtk_view_scaling.png
 163
 164 <b>Scaling</b> - represents objects deformed (stretched or stuffed)
 165 along the axes of coordinates.
 166 <hr>
 167
 168 \image html vtk_view_graduated_axes.png
 169
 170 <b>Graduated axes</b> - allows to define parameters of axes and
 171 graduate them.
 172
 173 \image html graduatedaxes1.png
 174
 175 - <b>Axis name</b> - if checked the axis name is displayed in the viewer.
 176
 177   - <b>Name</b> - allows to redefine the name of the axis.
 178
 179   - <b>Font</b> - allows to define color and properties of the font of axis name.
 180
 181 - <b>Labels</b> - if checked the labels are displayed in the viewer.<
 182
 183   - <b>Number</b> - allows to define the number of labels.
 184
 185   - <b>Offset</b> - allows to define the distance between labels.
 186
 187   - <b>Font</b> - allows to define color and properties of the font of labels names.
 188
 189 - <b>Tick marks</b> - if checked the tick marks are displayed in the viewer.
 190
 191   - <b>Length</b> - allows to define the length of tick marks.
 192
 193 - <b>Is visible</b> - if checked the axis is displayed in the viewer.
 194
 195 <hr>
 196
 197 \image html vtk_view_parameters.png
 198
 199 <b>Change View Parameters</b> - this button gives access to the
 200 dialog for customization of various view parameters.
 201
 202 \image html vtk_view_parameters_dlg.png
 203
 204 - <b>Projection Mode</b> - switches between the \b Orthogonal and \b Perspective projection modes.
 205
 206 - <b>Focal Point</b> - allows to specify the focal point of the view
 207
 208   - <b>Set to Bounding Box Center</b> - chooses the center of the
 209     bounding box of the current scene as the focal point;
 210   - <b>Set to Origin</b> - chooses the global coordinates system origin as
 211     the focal point;
 212   - <b>Select Point from View</b> - allows to specify the focal point by the
 213     direct selection of a point in the view window;
 214   - <b>X</b>, <b>Y</b>, <b>Z</b> - allows to input the coordinates of the focal
 215     point directly.
 216
 217 - <b>Camera Position</b> - allows to specify the position of the view camera:
 218   - <b>Absolute Coordinates</b> - in absolute coordinates;
 219   - <b>Relative to Focal Point</b> - as a offset to the focal point;
 220   - <b>Projection Direction</b> - allows specify the direction of the
 221     projection vector;
 222   - <b>Focal Distance</b> - the focal distance value.
 223
 224 - <b>View Up Direction</b> - direction of the "view up" vector.
 225
 226 - <b>Zooming</b>
 227
 228         - \b Scale - the current zoom factor (available in the <b>Orthogonal
 229   mode</b> only);
 230         - <b>View Angle</b> - the current view angle (available in the <b>Perspective
 231   mode</b> only).
 232
 233 <hr>
 234
 235 \image html vtk_view_sync.png
 236
 237 <b>Synchronize view</b> - allows to synchronize 3d view
 238 parameters. This button has two states - checked and
 239 unchecked. Clicking on this button opens a drop-down menu listing
 240 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
 241 synchronization).
 242
 243 In addition, when this button is "checked", the
 244 views are synchronized dynamically, i.e. any zoom, pan, rotate
 245 or other view operation done in one view is automatically applied to the other view.
 246 <hr>
 247
 248 \image html vtk_view_parallel.png
 249
 250 <b>Orthogonal mode</b> - Switches the view to the orthogonal mode.
 251 <hr>
 252
 253 \image html vtk_view_perspective.png
 254
 255 <b>Perspective mode</b> - Switches the view to the perspective mode.
 256 <hr>
 257
 258 \image html vtk_view_recording_start.png
 259 \image html vtk_view_recording_play.png
 260 \image html vtk_view_recording_pause.png
 261 \image html vtk_view_recording_stop.png
 262
 263 These buttons allow recording viewing operations as a video file in
 264 the AVI format using external software (jpeg2yuv):
 265
 266 - <b>Start recording</b> - specify parameters and start recording;
 267
 268 - <b>Pause recording</b> - suspend recording;
 269
 270 - <b>Continue recording</b> - resume recording;
 271
 272 - <b>Stop recording</b> - stop recording.
 273
 274 */