Salome HOME
0023124: EDF 11219 GEOM: Ray tracing in the OCC viewer
[modules/gui.git] / doc / salome / gui / input / occ_3d_viewer.doc
index 6473189928e65abff99902b5d80da7e4b758b9c6..7f79605ac69ccea8a81486728eed1811a9e9a9f1 100644 (file)
@@ -43,7 +43,7 @@ current cursor position) zooming styles.
 
 \image html occ_view_preselection.png
 
-<b>Enable/Disable preselection</b> - enables or disables preselection in the view.
+<b>Enable/Disable preselection</b> - enables or disables preselection (highlighting) in the view.
 <hr>
 
 \image html occ_view_selection.png
@@ -63,6 +63,11 @@ representing all displayed objects in the visible area.
 the contents of a frame drawn with pressed left mouse button.
 <hr>
 
+\image html occ_view_fitselection.png
+
+<b>Fit selection</b> - fits view contents to the current selection.
+<hr>
+
 \image html occ_view_zoom.png
 
 <b>Zoom</b> - allows to zoom in and out.
@@ -94,14 +99,14 @@ box of an object.
 
 \image html set_rotation_point_dialog2.png
 
-Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
+Disabling <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>
 
@@ -132,6 +137,28 @@ These buttons orientate the scene strictly about coordinate axes:
 <b>Rotate clockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly clockwise.
 <hr>
 
+\image html occ_view_orthographic.png
+
+<b>Ortographic projection</b> - default OCC viewer projection mode.
+<hr>
+
+\image html occ_view_perspective.png
+
+<b>Perspective projection</b> - perspective OCC viewer projection mode.
+<hr>
+
+\image html occ_view_stereo.png
+
+<b>Stereo projection</b> - stereoscopic rendering of the view.
+\note Activation of this mode also switches the view to perpective projection 
+in case if the orthographic one has been active.
+\note By default, quad-buffered stereo is activated, if it is supported by the graphic card. 
+If no stereo capabilities are available, an error message is shown.
+\note The stereoscopic view settings can be defined in 
+\ref occ_preferences "OCC 3D Viewer" preferences.
+
+<hr>
+
 \image html occ_view_reset.png
 
 <b>Reset</b> - restores the default position (isometric) of objects in
@@ -156,29 +183,25 @@ 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.
+\b Clipping allows creating cross-section views (clipping planes)
+of your mesh.
 
-To start, click on the \em New button.
+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.
 
-Now you must specify what mode of creating plane you want to choose: 
-absolute or relative.
-
-<b>Absolute mode</b>
+<b>Absolute Coordinates</b>
 
 \image html Clipping_Absolute.png
 
-- <b>Base point</b> - allows to define the coordinates of the base
+- <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>  
@@ -186,17 +209,20 @@ absolute or relative.
 \image html Clipping_Relative.png
 
 - \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>.
 
-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.
+It is also possible to interact  with the clipping plane directly in 3D 
+view using the mouse. 
 
 <hr>
 
@@ -248,6 +274,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
@@ -264,66 +295,76 @@ or other view operation done in one view is automatically applied to
 the other view.
 <hr>
 
-\anchor occ_background
-<h2>Background</h2>
+\image html occ_view_ray_tracing.png
 
-OCC Viewer background can be customized using the "Change background"
-popup menu command that opens the following dialog box:
+\anchor ray_tracing
 
-\image html change_background_dlg.png
+<b>Ray tracing</b> - allows to switch between rendering methods in run-time 
+in the current OCCT 3D view. It can be used to produce images with photorealistic quality.
 
-The following types of the background are supported:
+\image html doc_ray_tracing.png
 
-- Single color: the background is colored with the solid color
-  specified by the user in the dialog box.
+- <b>Ray tracing</b> - specifies rendering mode: OpenGL rasterization (by default) or GPU ray-tracing.
 
-- 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:
+  - <b>Depth</b> - defines maximum ray-tracing depth.
+  
+  - <b>Specular reflections</b> - enables/disables specular reflections.
+  
+  - <b>Adaptive anti-aliasing</b> - enables/disables adaptive anti-aliasing.
+    
+  - <b>Shadows rendering</b> - enables/disables shadows rendering.
+  
+  - <b>Transparent shadow</b> - enables/disables light propagation through transparent media.
+  
+<hr>
+
+\image html occ_view_env_texture.png
 
-  - Horizontal
+\anchor env_texture
 
-  - Vertical
+<b>Environment texture</b> - allows to set parameters for environment texture.
+This is a special mode of texture mapping when specular reflection of environment texture 
+is simulated by OpenGL using a special texture coordinates generation algorithm (a sphere map).
 
-  - First diagonal
+\image html doc_env_texture.png
 
-  - Second diagonal
+- <b>Environment texture</b> - enables/disables environment texture in the current OCCT 3D view.
 
-  - First corner
+User can select one of 7 predefined environment texture from the list or define its texture from file by 
+choosing item <b>"Custom..."</b> in a combo box.
 
-  - Second corner
+\note Note that the environment texture file should normally satisfy the following requirements 
+in order to produce good visual result:
+- The image file should have 2:1 width-to-height ratio.
+- It should constitute a 360-degrees panoramic image created using a fish-eye lens. 
 
-  - Third corner
+<hr>
+
+\image html occ_view_light_source.png
 
-  - Fourth corner
+\anchor light_source
 
-- Image: allows to set image as viewer background and define filling type:
+<b>Light source</b> - allows to set parameters for light source.
 
-  - Center: the image is located at the center of the viewer backgound
+It's possible to choose a type of light source between directional and positional light.
 
-  - Tile: the image fills the entire viewer backgound one by one
+\image html doc_dir_light_source.png
 
-  - Stretch: the image is stretched to the entire viewer backgound.
+<b>Directional</b> light - creates a directional light source in the viewer.
+It is defined by direction coordinates, color and headlight parameter.
 
-Default background for the viewer is specified via the
-\ref occ_preferences "application preferences".
+\image html doc_pos_light_source.png
 
-<h2>Polyline selection</h2>
+<b>Positional</b> light - creates an isolated light source X,Y,Z in the viewer. 
+It is also defined by the color and headlight parameter.
 
-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.
+Click:
 
-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
+- <b>Apply and Close</b> to apply defined light source to the OCC 3D Viewer.
 
-As a result, only the nodes within the frame are selected.
+- <b>Default</b> to restore default values of light source.
 
-\image html polyselection2.png
+- <b>Close</b> to return parameters of light source on initial values.
 
+<hr>
 */