Salome HOME
Merge branch 'V8_4_BR'
[modules/gui.git] / doc / salome / gui / input / vtk_3d_viewer.doc
index 529bf3a39983379e921a7371ccb0fed7e59d3de4..0905cb3973d45aee150cade6f531a94e3d756b17 100644 (file)
@@ -6,7 +6,7 @@
 
 The functionalities of VTK viewer are available via its Viewer
 Toolbar. Buttons marked with small downward triangles have extended
-functionality which can be accessed by locking on them with left mouse
+functionality, which can be accessed by locking on them with left mouse
 button.  
 
 \image html vtkviewer_toolbar.png
@@ -14,19 +14,14 @@ button.
 
 \image html vtk_view_camera_dump.png
 
-<b>Dump View</b> - exports an object from the viewer in bmp, png or
-jpeg image format.
+<b>Dump View</b> - exports an object snap-shot from the viewer in bmp, png or jpeg image format.
 <hr>
 
 \image html vtk_view_style_switch.png
 
-<b>Interaction style switch</b> - allows to switch between standard
-and "keyboard free" interaction styles. "Keyboard free" style allows
-to process all view transformations without using keyboard (only by
-mouse) and perform selection in view by pressing "S" key. By default,
-rotation in this mode is performed by left mouse button, panning - by
-middle mouse button, zooming - by left and middle mouse buttons
-pressed simultaneously.
+<b>Interaction style switch</b> - allows to switch between "Salome 
+standard controls" and "Keyboard free" \ref viewer_navigation_modes "interaction styles". 
+
 <hr>
 
 \image html vtk_view_zooming_style_switch.png
@@ -39,12 +34,16 @@ only for parallel (non-perspective) view's mode.
 
 \image html vtk_view_highlight.png
 
-<b>Dynamic pre-selection switch</b> - allows to switch on/off dynamic
-pre-selection of objects. When the dynamic pre-selection is switched
-on, an objects can be selected by clicking the point/cell belonging to
-this object, with some performance loss. Switch dynamic pre-selection
-off to have a good performance on big objects (for example, huge
-meshes).
+These buttons allow switching between three pre-selection (highlighting) modes:
+- <b>Static pre-selection mode</b> - pre-selection is done in terms of bounding boxes;
+- <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);
+- <b>Disable pre-selection</b> - pre-selection is disabled.
+
+<hr>
+
+\image html vtk_view_selection.png
+
+<b>Enable/Disable selection</b> - enables or disables selection in the view.
 <hr>
 
 \image html vtk_view_triedre.png
@@ -64,6 +63,11 @@ the Viewer boundaries.
 the contents of a frame drawn with pressed left mouse button.
 <hr>
 
+\image html vtk_view_fitselection.png
+
+<b>Fit selection</b> - fits view contents to the current selection.
+<hr>
+
 \image html vtk_view_zoom.png
 
 <b>Zoom</b> - allows to zoom in and out.
@@ -72,15 +76,14 @@ the contents of a frame drawn with pressed left mouse button.
 \image html vtk_view_pan.png
 
 <b>Panning</b> - if the represented objects are greater that the
-visible area and you don't wish to use <b>Fit all</b> functionality,
-click on this button and you'll be able to drag the scene to see its
-remote parts.
+visible area and you do not wish to use <b>Fit all</b> functionality,
+click on this button to drag the scene to see its remote parts.
 <hr>
 
 \image html vtk_view_glpan.png
 
 <b>Global panning</b> - allows to select a point to be the center of
-the presentation showing all displayed objects in the visible ares.
+the presentation showing all displayed objects in the visible area.
 <hr>
 
 \image html vtk_view_rotation_point.png
@@ -93,16 +96,16 @@ which the rotation is performed.
 By default the rotation point is located in the Center of the bounding
 box of an object.
 
-\image html set_rotation_point_dialog2.png
+\image html set_rotation_point_dialog3.png
 
-Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
+Unchecking <b>Use Bounding Box Center</b> check-box allows you to
 define the coordinates of the rotation point manually.
 
 - <b>Set to Origin</b> button restores the default rotation point
   coordinates.
 
-- <b>Select Point from View</b> button allows to select the rotation
-  point in the 3D Viewer.
+- <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. 
+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.
 
 <hr>
 
@@ -125,12 +128,12 @@ These buttons orientate the scene strictly about coordinate axes:
 
 \image html vtk_view_anticlockwise.png
 
-<b>Rotate counterclockwise</b> - rotates view 90° counterclockwise.
+<b>Rotate counter-clockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly counter-clockwise.
 <hr>
 
 \image html vtk_view_clockwise.png
 
-<b>Rotate clockwise</b> - rotates view 90° clockwise.
+<b>Rotate clockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly clockwise.
 <hr>
 
 \image html vtk_view_reset.png
@@ -198,46 +201,39 @@ graduate them.
 
 \image html vtk_view_parameters.png
 
-<b>Change View Parameters</b> - this button provides access to the
-dialog box allowing customization different parameters of the view.
+<b>Change View Parameters</b> - this button gives access to the
+dialog for customization of various view parameters.
 
 \image html vtk_view_parameters_dlg.png
 
-- <b>Projection Mode</b> - switchs to the Orthogonal / Perspective
-  projection mode
+- <b>Projection Mode</b> - switches between the \b Orthogonal and \b Perspective projection modes.
 
 - <b>Focal Point</b> - allows to specify the focal point of the view
 
   - <b>Set to Bounding Box Center</b> - chooses the center of the
-    bounding box of the current scene as the focal point.
-
+    bounding box of the current scene as the focal point;
   - <b>Set to Origin</b> - chooses the global coordinates system origin as
-    the focal point
-
+    the focal point;
   - <b>Select Point from View</b> - allows to specify the focal point by the
-    direct selection of a point in the view window
-
+    direct selection of a point in the view window;
   - <b>X</b>, <b>Y</b>, <b>Z</b> - allows to input the coordinates of the focal
-    point directly
+    point directly.
 
 - <b>Camera Position</b> - allows to specify the position of the view camera:
-
-  - <b>Absolute Coordinates</b> - either in absolute coordinates,
-
-  - <b>Relative to Focal Point</b> - or as a offset to the focal point;
-
+  - <b>Absolute Coordinates</b> - in absolute coordinates;
+  - <b>Relative to Focal Point</b> - as a offset to the focal point;
   - <b>Projection Direction</b> - allows specify the direction of the
     projection vector;
+  - <b>Focal Distance</b> - the focal distance value.
 
-  - <b>Focal Distance</b> - the focal distance value;
-
-  - <b>View Up Direction</b> - direction of the "view up" vector.
+- <b>View Up Direction</b> - direction of the "view up" vector.
 
-- <b>Zooming</b> - the current zoom factor (available in the <b>Orthogonal
-  mode</b> only)
+- <b>Zooming</b> 
 
-- <b>View Angle</b> - the current view angle (available in the <b>Perspective
-  mode</b> only)
+       - \b Scale - the current zoom factor (available in the <b>Orthogonal
+  mode</b> only);
+       - <b>View Angle</b> - the current view angle (available in the <b>Perspective
+  mode</b> only).
 
 <hr>
 
@@ -245,16 +241,13 @@ dialog box allowing customization different parameters of the view.
 
 <b>Synchronize view</b> - allows to synchronize 3d view
 parameters. This button has two states - checked and
-unchecked. Clicking on this button opens a drop-down menu listing the
-compatible 3d views. As soon as the user selects any view from the
-list, the parameters (view point, position, zoom coefficient, etc.) of
-the current view are synchronized with the selected view (static
+unchecked. Clicking on this button opens a drop-down menu listing 
+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
 synchronization).
 
-In addition, when this button is in the "checked" state, the dynamic
-synchronization of the views is performed, i.e. any zoom, pan, rotate
-or other view operation done in one view is automatically applied to
-the other view.
+In addition, when this button is "checked", the 
+views are synchronized dynamically, i.e. any zoom, pan, rotate
+or other view operation done in one view is automatically applied to the other view.
 <hr>
 
 \image html vtk_view_parallel.png
@@ -283,51 +276,4 @@ the AVI format using external software (jpeg2yuv):
 
 - <b>Stop recording</b> - stop recording.
 
-<hr>
-
-\anchor vtk_background
-<h2>Background</h2>
-
-VTK Viewer background can be customized using the "Change background"
-popup menu command that opens the following dialog box:
-
-\image html change_background_dlg.png
-
-The following types of the background are supported:
-
-- Single color: the background is colored with the solid color
-  specified by the user in the dialog box.
-
-- Gradient background: the background is gradiently colored according
-  to two colors and the gradient type specified in the dialog
-  box. The following types of background are supported:
-
-  - Horizontal
-
-  - Vertical
-
-  - First diagonal
-
-  - Second diagonal
-
-  - First corner
-
-  - Second corner
-
-  - Third corner
-
-  - Fourth corner
-
-- Image: allows to set image as viewer background and define filling type:
-
-  - Center: the image is located at the center of the viewer backgound
-
-  - Tile: the image fills the entire viewer backgound one by one
-
-  - Stretch: the image is stretched to the entire viewer backgound.
-
-
-Default background for the viewer is specified via the
-\ref vtk_preferences "application preferences".
-
 */