Salome HOME
First stage of the "0021793: [CEA 625] Clipping : from coordinates or from bounding...
[modules/gui.git] / doc / salome / gui / input / occ_3d_viewer.doc
index 783adee96bcb340f6c88cd82b3255f01eb6f8f35..6473189928e65abff99902b5d80da7e4b758b9c6 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
@@ -151,12 +155,20 @@ scene.
 <b>Clone view</b> - opens a new duplicate scene.
 <hr>
 
+\anchor clipping_planes
 \image html occ_view_clipping.png
 
 <b>Clipping</b> - allows to create cross-section views (clipping
 planes) of geometrical objects.
 
-\image html clipping.png
+To start, click on the \em New button.
+
+Now you must specify what mode of creating plane you want to choose: 
+absolute or relative.
+
+<b>Absolute mode</b>
+
+\image html Clipping_Absolute.png
 
 - <b>Base point</b> - allows to define the coordinates of the base
   point for the clipping plane.
@@ -168,9 +180,23 @@ planes) of geometrical objects.
 
   - <b>Invert</b> - allows to select 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)
+
+
+If the <b>Show preview</b> button is on, you can see the clipping plane
+in the viewer.
+
+If the <b>Auto Apply</b> button is on, you can preview the
+cross-section in the viewer.
 
 <hr>
 
@@ -218,28 +244,8 @@ on/off.
 \image html occ_view_minimized.png
 \image html occ_view_maximized.png
 
-<b>Create sub-views/Maximize</b> - these buttons allow switching the current
+<b>Minimize/Maximize</b> - these buttons allow switching the current
 view area to the minimized / maximized state.
-
-<b>Create sub-views</b> - user can select the layout and types of child sub-views:
-
-\image html create_sub-views_dlg.png
-
-- <b>Sub-views Layout</b>
-
-  - Three radio-buttons to specify numbers of the views to arrange (2, 3 or 4).
-  
-  - Buttons (depending on the chosen number of views) with images to specify 
-    view layout.
-    
-  - Buttons "Previous" and "Next" for possibility to change split schemas.
-
-- <b>Sub-views Properties</b>
-
-  - Type of each sub-view: XZ, YZ, XY or XYZ. 
-
-<b>Maximize</b> - the current view area will be converted to maximized state.
-
 <hr>
 
 \image html occ_view_sync.png
@@ -256,5 +262,68 @@ 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>
+
+\anchor occ_background
+<h2>Background</h2>
+
+OCC 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 occ_preferences "application preferences".
+
+<h2>Polyline selection</h2>
+
+OCC Viewer features a special <b>Polyline Selection</b> mechanism,
+which allows selecting an arbitraty part of the graphic area using a
+polygon frame (rubber band), instead of the usual selection with a
+rectangular frame.
+
+To produce a Polyline Selection, lock the right mouse button and draw
+the first side of the polygon, then change the direction by clicking
+the left mouse button add draw another side, etc. The whole selection
+frame is drawn with the locked right mouse button.
+   
+\image html polyselection1.png
+
+As a result, only the nodes within the frame are selected.
+
+\image html polyselection2.png
 
 */