Salome HOME
0023124: EDF 11219 GEOM: Ray tracing in the OCC viewer
[modules/gui.git] / doc / salome / gui / input / occ_3d_viewer.doc
index 783adee96bcb340f6c88cd82b3255f01eb6f8f35..7f79605ac69ccea8a81486728eed1811a9e9a9f1 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
@@ -39,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
@@ -59,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.
@@ -90,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>
 
@@ -128,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
@@ -151,26 +182,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>  
 
-- <b>Preview</b> - allows to see the results of clipping in the
-  viewer.
+\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>.
+
+It is also possible to interact  with the clipping plane directly in 3D 
+view using the mouse. 
 
 <hr>
 
@@ -218,28 +270,13 @@ 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.
+<hr>
 
-<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.
+\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
@@ -256,5 +293,78 @@ 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>
+
+\image html occ_view_ray_tracing.png
 
+\anchor ray_tracing
+
+<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.
+
+\image html doc_ray_tracing.png
+
+- <b>Ray tracing</b> - specifies rendering mode: OpenGL rasterization (by default) or GPU ray-tracing.
+
+  - <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
+
+\anchor env_texture
+
+<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).
+
+\image html doc_env_texture.png
+
+- <b>Environment texture</b> - enables/disables environment texture in the current OCCT 3D view.
+
+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.
+
+\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. 
+
+<hr>
+
+\image html occ_view_light_source.png
+
+\anchor light_source
+
+<b>Light source</b> - allows to set parameters for light source.
+
+It's possible to choose a type of light source between directional and positional light.
+
+\image html doc_dir_light_source.png
+
+<b>Directional</b> light - creates a directional light source in the viewer.
+It is defined by direction coordinates, color and headlight parameter.
+
+\image html doc_pos_light_source.png
+
+<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.
+
+Click:
+
+- <b>Apply and Close</b> to apply defined light source to the OCC 3D Viewer.
+
+- <b>Default</b> to restore default values of light source.
+
+- <b>Close</b> to return parameters of light source on initial values.
+
+<hr>
 */