X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2Finput%2Focc_3d_viewer.doc;h=fcbb1438473d481dc31b5c6a528fd78e01c5cf85;hb=bf4f33e12f47caaa39edde16c7308e24ae7b515e;hp=e59aafe3febe6011f985e247cf1be91e616d9ce6;hpb=e07448c48ea5b2127e34fc7b8c3427d01c7ce17b;p=modules%2Fgui.git diff --git a/doc/salome/gui/input/occ_3d_viewer.doc b/doc/salome/gui/input/occ_3d_viewer.doc index e59aafe3f..fcbb14384 100644 --- a/doc/salome/gui/input/occ_3d_viewer.doc +++ b/doc/salome/gui/input/occ_3d_viewer.doc @@ -14,8 +14,8 @@ button. \image html occ_view_camera_dump.png -Dump View - exports an object from the viewer in bmp, png or -jpeg image format. +Dump View - exports an object from the viewer in bmp, png, +jpeg or another image format.
\image html occ_view_style_switch.png @@ -23,10 +23,10 @@ jpeg image format. Interaction style switch - 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.
\image html occ_view_zooming_style_switch.png @@ -41,10 +41,20 @@ current cursor position) zooming styles. Show/Hide Trihedron - shows or hides coordinate axes.
+\image html occ_view_preselection.png + +Enable/Disable preselection - enables or disables preselection (highlighting) in the view. +
+ +\image html occ_view_selection.png + +Enable/Disable selection - enables or disables selection in the view. +
+ \image html occ_view_fitall.png -Fit all - allows to select a point to be the center of a scene -representing all displayed objects in the visible area. +Fit all - represents all displayed objects in the +visible area.
\image html occ_view_fitarea.png @@ -53,6 +63,11 @@ representing all displayed objects in the visible area. the contents of a frame drawn with pressed left mouse button.
+\image html occ_view_fitselection.png + +Fit selection - fits view contents to the current selection. +
+ \image html occ_view_zoom.png Zoom - allows to zoom in and out. @@ -68,37 +83,42 @@ remote parts. \image html occ_view_glpan.png -Global panning - represents all displayed objects in the -visible area. +Global panning - allows to select a point to be the center of a scene +representing all displayed objects in the visible area.
\image html occ_view_rotation_point.png -Change rotation point - allows to to choose the point around +Change rotation point - 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 Use Bounding Box Center checkbox allows you to -define the coordinates of the rotation point manually. +Unchecking Use Bounding Box Center check-box allows you to +change rotation point: -- Set to Origin button restores the default rotation point - coordinates. +- Set to Origin button sets the rotation point to +origin of coordinates: (0, 0, 0). -- Select Point from View button allows to select the rotation - point in the 3D Viewer. +- Gravity Center of Selected Object 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. + +- Also you can define the coordinates of the rotation point manually.
\image html occ_view_rotate.png -Rotation - allows to rotate the selected object using the -mouse. +Rotation - allows to rotate the scene using the mouse.
\image html occ_view_front.png @@ -122,6 +142,28 @@ These buttons orientate the scene strictly about coordinate axes: Rotate clockwise - rotates view 90 @htmlonly ° @endhtmlonly clockwise.
+\image html occ_view_orthographic.png + +Ortographic projection - default OCC viewer projection mode. +
+ +\image html occ_view_perspective.png + +Perspective projection - perspective OCC viewer projection mode. +
+ +\image html occ_view_stereo.png + +Stereo projection - 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. + +
+ \image html occ_view_reset.png Reset - restores the default position (isometric) of objects in @@ -130,7 +172,7 @@ the scene. \image html occ_view_shoot.png -Memorise view - saves the current position of objects in the +Memorize view - saves the current position of objects in the scene.
@@ -145,26 +187,51 @@ scene. Clone view - opens a new duplicate scene.
-\image html occ_view_clipping.png +\anchor clipping_planes + +\b Clipping allows creating cross-section views (clipping planes) +of your mesh. -Clipping - 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 will be defined by \b Absolute or \b Relative coordinates. -\image html clipping.png +Absolute Coordinates -- Base point - allows to define the coordinates of the base +\image html Clipping_Absolute.png + +- Base point - allows defining the coordinates of the base point for the clipping plane. - Reset - returns the base point to coordinate origin. -- Direction - allows to define the orientation of the +- Direction - allows defining the orientation of the clipping plane. - - Invert - allows to select which part of the object will be + - Invert - allows selecting, which part of the object will be removed and which will remain after clipping. + +Relative mode + +\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 +represented objects, if it is set to 0.5 the boundary box is split in two halves. + +- \b Rotation (in angle degrees) around X (Y to Z) and around +Y (X to Z) (depending on the chosen Orientation) -- Preview - allows to see the results of clipping in the - viewer. +The other parameters are available in both modes : +- Active checkbox is used to apply/erase current plane and it's affect to/from view. +- Delete removes the active clipping plane and discards it's view changes. +- Disable all deactivates all created clipping planes and clears Auto Apply checkbox. +- Preview check-box shows the clipping plane in the 3D Viewer. +- Auto Apply check-box allows you to see the result of clipping +in the 3D Viewer immediately. Be careful, it is not a preview +and Close button could not cancel the applied modifications. + +It is also possible to interact with the clipping plane directly in 3D +view using the mouse.
@@ -191,7 +258,7 @@ them. - Number - allows to define the number of labels. - - Offset - allows to define the distance between labels. + - Offset - allows to define the distance between axis and labels. - Font - allows to define the font color of labels names. @@ -199,7 +266,7 @@ them. - Length - allows to define the length of tick marks. -- Is visible - if checked the axis is displayed in the viewer. +- Is visible - if checked the graduated axes are displayed in the viewer.
@@ -216,6 +283,11 @@ on/off. view area to the minimized / maximized state.
+\image html occ_view_return_3d_view.png + +Return to 3D - this button switches from 2D view projection back to the 3D view mode. +
+ \image html occ_view_sync.png Synchronize view - allows to synchronize 3d view @@ -232,66 +304,76 @@ or other view operation done in one view is automatically applied to the other view.
-\anchor occ_background -

Background

+\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 +Ray tracing - 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. +- Ray tracing - 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: + - Depth - defines maximum ray-tracing depth. + + - Specular reflections - enables/disables specular reflections. + + - Adaptive anti-aliasing - enables/disables adaptive anti-aliasing. + + - Shadows rendering - enables/disables shadows rendering. + + - Transparent shadow - enables/disables light propagation through transparent media. + +
- - Horizontal +\image html occ_view_env_texture.png - - Vertical +\anchor env_texture - - First diagonal +Environment texture - 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 +- Environment texture - 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 "Custom..." 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 +
+ +\image html occ_view_light_source.png -- Image: allows to set image as viewer background and define filling type: +\anchor light_source - - Center: the image is located at the center of the viewer backgound +Light source - allows to set parameters for light source. - - Tile: the image fills the entire viewer backgound one by one +It's possible to choose a type of light source between directional and positional light. - - Stretch: the image is stretched to the entire viewer backgound. +\image html doc_dir_light_source.png -Default background for the viewer is specified via the -\ref occ_preferences "application preferences". +Directional light - creates a directional light source in the viewer. +It is defined by direction coordinates, color and headlight parameter. -

Polyline selection

+\image html doc_pos_light_source.png -OCC Viewer features a special Polyline Selection 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. +Positional light - creates an isolated light source X,Y,Z in the viewer. +It is also defined by the color and headlight parameter. -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 +Click: -As a result, only the nodes within the frame are selected. +- Apply and Close to apply defined light source to the OCC 3D Viewer. -\image html polyselection2.png +- Default to restore default values of light source. +- Close to return parameters of light source on initial values. + +
*/