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