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 snap-shot 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_fitselection.png
  67
  68 <b>Fit selection</b> - fits view contents to the current selection.
  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 do not wish to use <b>Fit all</b> functionality,
  80 click on this button to drag the scene to see its remote parts.
  81 <hr>
  82
  83 \image html vtk_view_glpan.png
  84
  85 <b>Global panning</b> - allows to select a point to be the center of
  86 the presentation showing all displayed objects in the visible area.
  87 <hr>
  88
  89 \image html vtk_view_rotation_point.png
  90
  91 <b>Change rotation point</b> - allows to to choose the point around
  92 which the rotation is performed.
  93
  94 \image html set_rotation_point_dialog1.png
  95
  96 By default the rotation point is located in the Center of the bounding
  97 box of an object.
  98
  99 \image html set_rotation_point_dialog3.png
 100
 101 Unchecking <b>Use Bounding Box Center</b> check-box allows you to
 102 define the coordinates of the rotation point manually.
 103
 104 - <b>Set to Origin</b> button restores the default rotation point
 105   coordinates.
 106
 107 - <b>Gravity Center of Selected Object</b> button allows using the gravity center of the object selected in the viewer as the center of the rotation point.
 108 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.
 109
 110 <hr>
 111
 112 \image html vtk_view_rotate.png
 113
 114 <b>Rotation</b> - allows to rotate the selected object using the
 115 mouse.
 116 <hr>
 117
 118 \image html vtk_view_front.png
 119 \image html vtk_view_back.png
 120 \image html vtk_view_top.png
 121 \image html vtk_view_bottom.png
 122 \image html vtk_view_left.png
 123 \image html vtk_view_right.png
 124
 125 These buttons orientate the scene strictly about coordinate axes:
 126 \b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side.
 127 <hr>
 128
 129 \image html vtk_view_anticlockwise.png
 130
 131 <b>Rotate counter-clockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly counter-clockwise.
 132 <hr>
 133
 134 \image html vtk_view_clockwise.png
 135
 136 <b>Rotate clockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly clockwise.
 137 <hr>
 138
 139 \image html vtk_view_reset.png
 140
 141 <b>Reset</b> - restores the default position (isometric) of objects in
 142 the scene.
 143 <hr>
 144
 145 \image html vtk_view_update_rate.png
 146
 147 <b>Update Rate</b> - allows to define the Update Rate for the
 148 presentations displayed in the viewer.
 149
 150 \image html updaterate.png
 151
 152 - <b>Desired Update Rate, FPS</b> - allows to set the target Update
 153   Rate
 154
 155 - <b>Still Update Rate, FPS</b> - allows to set the Update Rate for
 156   the periods when both the user and the application do not perform
 157   any actions in the viewer
 158
 159 - <b>Current Update Rate, FPS</b> - shows the Update Rate currently
 160   available on your configuration
 161
 162 - <b>Number of Cells</b> - shows the number of cells currently in
 163   display
 164
 165 <hr>
 166
 167 \image html vtk_view_scaling.png
 168
 169 <b>Scaling</b> - represents objects deformed (stretched or stuffed)
 170 along the axes of coordinates.
 171 <hr>
 172
 173 \image html vtk_view_graduated_axes.png
 174
 175 <b>Graduated axes</b> - allows to define parameters of axes and
 176 graduate them.
 177
 178 \image html graduatedaxes1.png
 179
 180 - <b>Axis name</b> - if checked the axis name is displayed in the viewer.
 181
 182   - <b>Name</b> - allows to redefine the name of the axis.
 183
 184   - <b>Font</b> - allows to define color and properties of the font of axis name.
 185
 186 - <b>Labels</b> - if checked the labels are displayed in the viewer.<
 187
 188   - <b>Number</b> - allows to define the number of labels.
 189
 190   - <b>Offset</b> - allows to define the distance between labels.
 191
 192   - <b>Font</b> - allows to define color and properties of the font of labels names.
 193
 194 - <b>Tick marks</b> - if checked the tick marks are displayed in the viewer.
 195
 196   - <b>Length</b> - allows to define the length of tick marks.
 197
 198 - <b>Is visible</b> - if checked the axis is displayed in the viewer.
 199
 200 <hr>
 201
 202 \image html vtk_view_parameters.png
 203
 204 <b>Change View Parameters</b> - this button gives access to the
 205 dialog for customization of various view parameters.
 206
 207 \image html vtk_view_parameters_dlg.png
 208
 209 - <b>Projection Mode</b> - switches between the \b Orthogonal and \b Perspective projection modes.
 210
 211 - <b>Focal Point</b> - allows to specify the focal point of the view
 212
 213   - <b>Set to Bounding Box Center</b> - chooses the center of the
 214     bounding box of the current scene as the focal point;
 215   - <b>Set to Origin</b> - chooses the global coordinates system origin as
 216     the focal point;
 217   - <b>Select Point from View</b> - allows to specify the focal point by the
 218     direct selection of a point in the view window;
 219   - <b>X</b>, <b>Y</b>, <b>Z</b> - allows to input the coordinates of the focal
 220     point directly.
 221
 222 - <b>Camera Position</b> - allows to specify the position of the view camera:
 223   - <b>Absolute Coordinates</b> - in absolute coordinates;
 224   - <b>Relative to Focal Point</b> - as a offset to the focal point;
 225   - <b>Projection Direction</b> - allows specify the direction of the
 226     projection vector;
 227   - <b>Focal Distance</b> - the focal distance value.
 228
 229 - <b>View Up Direction</b> - direction of the "view up" vector.
 230
 231 - <b>Zooming</b>
 232
 233         - \b Scale - the current zoom factor (available in the <b>Orthogonal
 234   mode</b> only);
 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
 245 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
 246 synchronization).
 247
 248 In addition, when this button is "checked", the
 249 views are synchronized dynamically, i.e. any zoom, pan, rotate
 250 or other view operation done in one view is automatically applied to the other view.
 251 <hr>
 252
 253 \image html vtk_view_parallel.png
 254
 255 <b>Orthogonal mode</b> - Switches the view to the orthogonal mode.
 256 <hr>
 257
 258 \image html vtk_view_perspective.png
 259
 260 <b>Perspective mode</b> - Switches the view to the perspective mode.
 261 <hr>
 262
 263 \image html vtk_view_recording_start.png
 264 \image html vtk_view_recording_play.png
 265 \image html vtk_view_recording_pause.png
 266 \image html vtk_view_recording_stop.png
 267
 268 These buttons allow recording viewing operations as a video file in
 269 the AVI format using external software (jpeg2yuv):
 270
 271 - <b>Start recording</b> - specify parameters and start recording;
 272
 273 - <b>Pause recording</b> - suspend recording;
 274
 275 - <b>Continue recording</b> - resume recording;
 276
 277 - <b>Stop recording</b> - stop recording.
 278
 279 */