From 7f38975c2e9c06cf12a34aadef44bbe59ad333a1 Mon Sep 17 00:00:00 2001 From: akl Date: Wed, 6 Apr 2016 17:25:20 +0300 Subject: [PATCH] OCC viewer documentation correction. --- doc/salome/gui/input/occ_3d_viewer.doc | 67 +++++++++++++++----------- 1 file changed, 38 insertions(+), 29 deletions(-) diff --git a/doc/salome/gui/input/occ_3d_viewer.doc b/doc/salome/gui/input/occ_3d_viewer.doc index 7f79605ac..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 @@ -53,8 +53,8 @@ current cursor position) zooming styles. \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 @@ -83,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 -Disabling Use Bounding Box Center check-box 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 sets the rotation point to +origin of coordinates: (0, 0, 0). -- Set to Origin button restores the default rotation point - coordinates. +- 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. -- 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 @@ -167,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.
@@ -187,7 +192,7 @@ scene. \b Clipping allows creating cross-section views (clipping planes) of your mesh. -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. +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. Absolute Coordinates @@ -211,17 +216,21 @@ To create a clipping plane, click on the \b New button in the dialog and choose - \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) around X (Y to Z) and around Y (X to Z) (depending on the chosen Orientation) 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 shows button is on, you can preview the -cross-section 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 +It is also possible to interact with the clipping plane directly in 3D view using the mouse.
@@ -249,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. @@ -257,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.
@@ -333,7 +342,7 @@ is simulated by OpenGL using a special texture coordinates generation algorithm 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. -\note Note that the environment texture file should normally satisfy the following requirements +\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. -- 2.39.2