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