Salome HOME
Merge from branch mpa/qwt6_porting
[modules/gui.git] / doc / salome / gui / input / occ_3d_viewer.doc
index e27d346d36225a3f09413236ebb46e0926103f9d..7ab47b2ca118a0be4960a0140548db6f7bb3396c 100644 (file)
@@ -20,9 +20,13 @@ jpeg image format.
 
 \image html occ_view_style_switch.png
 
-<b>Interaction style switch</b> - allows to switch between "Salome 
-standard controls" and "Keyboard free" \ref viewer_navigation_modes "interaction styles". 
-
+<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.
 <hr>
 
 \image html occ_view_zooming_style_switch.png
@@ -37,6 +41,16 @@ current cursor position) zooming styles.
 <b>Show/Hide Trihedron</b> - shows or hides coordinate axes.
 <hr>
 
+\image html occ_view_preselection.png
+
+<b>Enable/Disable preselection</b> - enables or disables preselection (highlighting) in the view.
+<hr>
+
+\image html occ_view_selection.png
+
+<b>Enable/Disable selection</b> - enables or disables selection in the view.
+<hr>
+
 \image html occ_view_fitall.png
 
 <b>Fit all</b> - allows to select a point to be the center of a scene
@@ -141,26 +155,47 @@ scene.
 <b>Clone view</b> - opens a new duplicate scene.
 <hr>
 
-\image html occ_view_clipping.png
+\anchor clipping_planes
+
+\b Clipping allows creating cross-section views (clipping planes)
+of your mesh.
 
-<b>Clipping</b> - allows to create cross-section views (clipping
-planes) of geometrical objects.
+To create a clipping plane, click on the \b New button in the dialog and choose how it is  definition by \b Absolute or \b Relative coordinates.
 
-\image html clipping.png
+<b>Absolute Coordinates</b>
 
-- <b>Base point</b> - allows to define the coordinates of the base
+\image html Clipping_Absolute.png
+
+- <b>Base point</b> - allows defining the coordinates of the base
   point for the clipping plane.
 
   - <b>Reset</b> - returns the base point to coordinate origin.
 
-- <b>Direction</b> - allows to define the orientation of the
+- <b>Direction</b> - allows defining the orientation of the
   clipping plane.
 
-  - <b>Invert</b> - allows to select which part of the object will be
+       - <b>Invert</b> - allows selecting, which part of the object will be
     removed and which will remain after clipping.
+    
+<b>Relative mode</b>  
+
+\image html Clipping_Relative.png
 
-- <b>Preview</b> - allows to see the results of clipping in the
-  viewer.
+- \b Orientation ( ||X-Y, ||X-Z or ||Y-Z).
+
+- \b Distance between the opposite extremities of the boundary box of 
+selected objects, if it is set to 0.5 the boundary box is split in two halves.
+
+- \b Rotation (in angle degrees) <b>around X</b> (Y to Z) and <b>around 
+Y</b> (X to Z) (depending on the chosen Orientation)
+
+The other parameters are available in both modes : 
+- <b>Preview</b> check-box shows the clipping plane in the <b>3D Viewer</b>.
+- <b>Auto Apply</b> check-box shows button is on, you can preview the
+cross-section in the <b>3D Viewer</b>.
+
+It is also possible to interact  with the clipping plane directly in 3D 
+view using the mouse. 
 
 <hr>
 
@@ -212,6 +247,11 @@ on/off.
 view area to the minimized / maximized state.
 <hr>
 
+\image html occ_view_return_3d_view.png
+
+<b>Return to 3D</b> - this button switches from 2D view projection back to the 3D view mode.
+<hr>
+
 \image html occ_view_sync.png
 
 <b>Synchronize view</b> - allows to synchronize 3d view
@@ -226,5 +266,7 @@ 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.
+<hr>
+
 
 */