From: vsr Date: Mon, 14 May 2012 06:05:59 +0000 (+0000) Subject: Update user documentation X-Git-Tag: V6_5_0~11 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=c6a1bda94f5977fa1e4863af4227c19fe8c10f7e;p=modules%2Fgeom.git Update user documentation --- diff --git a/doc/salome/gui/GEOM/images/bring_example.png b/doc/salome/gui/GEOM/images/bring_example.png deleted file mode 100755 index 62be78dfd..000000000 Binary files a/doc/salome/gui/GEOM/images/bring_example.png and /dev/null differ diff --git a/doc/salome/gui/GEOM/images/front1.png b/doc/salome/gui/GEOM/images/front1.png new file mode 100644 index 000000000..863772bee Binary files /dev/null and b/doc/salome/gui/GEOM/images/front1.png differ diff --git a/doc/salome/gui/GEOM/images/front2.png b/doc/salome/gui/GEOM/images/front2.png new file mode 100644 index 000000000..77cc24d61 Binary files /dev/null and b/doc/salome/gui/GEOM/images/front2.png differ diff --git a/doc/salome/gui/GEOM/input/bounding_box.doc b/doc/salome/gui/GEOM/input/bounding_box.doc index fbb097781..eeb16c4ff 100644 --- a/doc/salome/gui/GEOM/input/bounding_box.doc +++ b/doc/salome/gui/GEOM/input/bounding_box.doc @@ -5,21 +5,21 @@ Returns the dimensions of the bounding box for the selected geometrical object. -\note In order to take into account any possible distortion of a shape +\note To take into account any possible shape distortion that affects the resulting bounding box, the algorithm enlarges -the bounding box to the value of the maximum deflection value of +the bounding box to the maximum deflection value of faces (by iterating through all faces of a shape). -This functionallity is implemented in such a way in order to have -satisfactory performance. +This functionallity is implemented in such a way to have +a satisfactory performance. -Result: Displays the dimensions of the bounding box of a -geometrical object in the form of Python Tuple (Xmin, Xmax, Ymin, +Result: Displays the bounding box dimensions of a +geometrical object in form of a Python Tuple (Xmin, Xmax, Ymin, Ymax, Zmin, Zmax). \n TUI Command: geompy.BoundingBox(Shape), where \em Shape -is a shape for which a bounding box is computed. +is the shape for which a bounding box is computed. See also a \ref tui_bounding_box_page "TUI example". \image html measures5.png -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/GEOM/input/bring_to_front.doc b/doc/salome/gui/GEOM/input/bring_to_front.doc index efb29e1f0..e53e74e20 100644 --- a/doc/salome/gui/GEOM/input/bring_to_front.doc +++ b/doc/salome/gui/GEOM/input/bring_to_front.doc @@ -2,9 +2,20 @@ \page bring_to_front_page Bring To Front -\n This option is relevant for better viewing of the complex 3D models. -This item allow to bring to front of viewer selected geometrical object. +\n This option is relevant for better viewing of complex 3D models. +It allows to bring to the viewer foreground the selected geometrical object. -\image html bring_example.png +Let's take for example two coincident primitives: a box and a cylinder. + +In the first picture the box has been visually superimposed over the +cylinder using Bring to front option. + +\image html front1.png + +In the second picture the box has been returned to its normal state +using Clear Top Level State context menu command, however, the +cylinder has been brought to front. + + \image html front2.png */ diff --git a/doc/salome/gui/GEOM/input/creating_sketcher.doc b/doc/salome/gui/GEOM/input/creating_sketcher.doc index d649a0f05..a150db92c 100644 --- a/doc/salome/gui/GEOM/input/creating_sketcher.doc +++ b/doc/salome/gui/GEOM/input/creating_sketcher.doc @@ -2,14 +2,15 @@ \page create_sketcher_page 2D Sketcher -The 2D Sketcher allows you to draw 2D shapes on a working plane. You can create on this plane: +The 2D Sketcher allows you to draw 2D shapes on a working plane. You +can create sketches of two types: The \b Result is a \b Wire @@ -25,7 +26,8 @@ To create a 2D Sketch:
  • Select the \b plane or the planar face on which to create the sketch. \note By default the sketch is created on the XOY plane of the global coordinate system. -If Local Coordinate Systems have been created in the study they appear in the combobox and can be selected as reference coordinate system.
  • +If Local Coordinate Systems have been created in the study they appear +in the combobox and can be selected as a reference coordinate system.
  • Choose a \b segment or an \b arc element to start a \b profile or choose \b rectangle to draw a rectangle. @@ -46,7 +48,7 @@ origin of the reference coordinate system.
  • \image html line_icon.png -
  • You can define the segment by either it's end point or a \b direction and a \b length. The direction is defined relatively to the tangent at the last point of the sketch. It can be: +
  • You can define the segment by either its end point or \b direction and \b length. The direction is defined relatively to the tangent at the last point of the sketch. It can be: