\image html occ_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 from the viewer in bmp, png,
+jpeg or another image format.
<hr>
\image html occ_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.
+mouse). By default, rotation in this mode is performed by left mouse
+button, panning - by middle mouse button, zooming - by right mouse
+button. Selection in view by pressing "s" key works in both
+styles.
<hr>
\image html occ_view_zooming_style_switch.png
\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
\image html occ_view_fitall.png
-<b>Fit all</b> - allows to select a point to be the center of a scene
-representing all displayed objects in the visible area.
+<b>Fit all</b> - represents all displayed objects in the
+visible area.
<hr>
\image html occ_view_fitarea.png
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.
\image html occ_view_glpan.png
-<b>Global panning</b> - represents all displayed objects in the
-visible area.
+<b>Global panning</b> - allows to select a point to be the center of a scene
+representing all displayed objects in the visible area.
<hr>
\image html occ_view_rotation_point.png
-<b>Change rotation point</b> - allows to to choose the point around
+<b>Change rotation point</b> - allows to choose the point around
which the rotation is performed.
\image html set_rotation_point_dialog1.png
By default the rotation point is located in the Center of the bounding
-box of an object.
+box of represented objects.
\image html set_rotation_point_dialog2.png
-Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
-define the coordinates of the rotation point manually.
+Unchecking <b>Use Bounding Box Center</b> check-box allows you to
+change rotation point:
+
+- <b>Set to Origin</b> button sets the rotation point to
+origin of coordinates: (0, 0, 0).
-- <b>Set to Origin</b> button restores the default rotation point
- coordinates.
+- <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.
-- <b>Select Point from View</b> button allows to select the rotation
- point in the 3D Viewer.
+- Also you can define the coordinates of the rotation point manually.
<hr>
\image html occ_view_rotate.png
-<b>Rotation</b> - allows to rotate the selected object using the
-mouse.
+<b>Rotation</b> - allows to rotate the scene using the mouse.
<hr>
\image html occ_view_front.png
<b>Rotate clockwise</b> - rotates view 90 @htmlonly ° @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
\image html occ_view_shoot.png
-<b>Memorise view</b> - saves the current position of objects in the
+<b>Memorize view</b> - saves the current position of objects in the
scene.
<hr>
<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 will be defined 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>
\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.
+represented 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>Active</b> checkbox is used to apply/erase current plane and it's affect to/from view.
+- <b>Delete</b> removes the active clipping plane and discards it's view changes.
+- <b>Disable all</b> deactivates all created clipping planes and clears <b>Auto Apply</b> checkbox.
+- <b>Preview</b> check-box shows the clipping plane in the <b>3D Viewer</b>.
+- <b>Auto Apply</b> check-box allows you to see the result of clipping
+in the <b>3D Viewer</b> immediately. Be careful, it is not a preview
+and Close button could not cancel the applied modifications.
-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>
- <b>Number</b> - allows to define the number of labels.
- - <b>Offset</b> - allows to define the distance between labels.
+ - <b>Offset</b> - allows to define the distance between axis and labels.
- <b>Font</b> - allows to define the font color of labels names.
- <b>Length</b> - allows to define the length of tick marks.
-- <b>Is visible</b> - if checked the axis is displayed in the viewer.
+- <b>Is visible</b> - if checked the graduated axes are displayed in the viewer.
<hr>
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
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>
- - Horizontal
+\image html occ_view_env_texture.png
- - Vertical
+\anchor env_texture
- - First diagonal
+<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).
- - Second diagonal
+\image html doc_env_texture.png
- - First corner
+- <b>Environment texture</b> - enables/disables environment texture in the current OCCT 3D view.
- - Second 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.
- - Third corner
+\note 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.
- - Fourth corner
+<hr>
-- Image: allows to set image as viewer background and define filling type:
+\image html occ_view_light_source.png
- - Center: the image is located at the center of the viewer backgound
+\anchor light_source
- - Tile: the image fills the entire viewer backgound one by one
+<b>Light source</b> - allows to set parameters for light source.
- - Stretch: the image is stretched to the entire viewer backgound.
+It's possible to choose a type of light source between directional and positional light.
-Default background for the viewer is specified via the
-\ref occ_preferences "application preferences".
+\image html doc_dir_light_source.png
-<h2>Polyline selection</h2>
+<b>Directional</b> light - creates a directional light source in the viewer.
+It is defined by direction coordinates, 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.
+\image html doc_pos_light_source.png
-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>Positional</b> light - creates an isolated light source X,Y,Z in the viewer.
+It is also defined by the color and headlight parameter.
-As a result, only the nodes within the frame are selected.
+Click:
-\image html polyselection2.png
+- <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>
*/
