]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
Update user documentation
authorvsr <vsr@opencascade.com>
Mon, 14 May 2012 06:05:59 +0000 (06:05 +0000)
committervsr <vsr@opencascade.com>
Mon, 14 May 2012 06:05:59 +0000 (06:05 +0000)
16 files changed:
doc/salome/gui/GEOM/images/bring_example.png [deleted file]
doc/salome/gui/GEOM/images/front1.png [new file with mode: 0644]
doc/salome/gui/GEOM/images/front2.png [new file with mode: 0644]
doc/salome/gui/GEOM/input/bounding_box.doc
doc/salome/gui/GEOM/input/bring_to_front.doc
doc/salome/gui/GEOM/input/creating_sketcher.doc
doc/salome/gui/GEOM/input/extruded_boss_operation.doc
doc/salome/gui/GEOM/input/geometry_preferences.doc
doc/salome/gui/GEOM/input/importing_picture.doc
doc/salome/gui/GEOM/input/index.doc
doc/salome/gui/GEOM/input/material.doc
doc/salome/gui/GEOM/input/multi_rotation_operation.doc
doc/salome/gui/GEOM/input/multi_translation_operation.doc
doc/salome/gui/GEOM/input/shape_recognition.doc
doc/salome/gui/GEOM/input/using_measurement_tools_old.doc [deleted file]
doc/salome/gui/GEOM/input/viewing_geom_obj.doc

diff --git a/doc/salome/gui/GEOM/images/bring_example.png b/doc/salome/gui/GEOM/images/bring_example.png
deleted file mode 100755 (executable)
index 62be78d..0000000
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 (file)
index 0000000..863772b
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 (file)
index 0000000..77cc24d
Binary files /dev/null and b/doc/salome/gui/GEOM/images/front2.png differ
index fbb09778104eba72ef6e26960633cd2f77b5963f..eeb16c4ffc8a547142dadbda2902366ac290edb7 100644 (file)
@@ -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 
+satisfactory performance.
 
-<b>Result:</b> Displays the dimensions of the bounding box of a
-geometrical object in the form of Python Tuple (Xmin, Xmax, Ymin,
+<b>Result:</b> Displays the bounding box dimensions of a
+geometrical object in form of a Python Tuple (Xmin, Xmax, Ymin,
 Ymax, Zmin, Zmax).
 \n <b>TUI Command:</b> <em>geompy.BoundingBox(Shape),</em> 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
+*/
index efb29e1f05090c63fd2b2595762711172b50136a..e53e74e209d0f867f08eb5e819bfd98208bd6b0a 100644 (file)
@@ -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 <b>Bring to front</b> option.
+
+\image html front1.png
+
+In the second picture the box has been returned to its normal state
+using <b>Clear Top Level State</b> context menu command, however, the
+cylinder has been brought to front. 
+
+ \image html front2.png
 
 */
index d649a0f058c08dd4e4429d19d126fc8bba33d9bb..a150db92c9c0c13205e4c765e2d1003b9b552340 100644 (file)
@@ -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:
 
 <ul>
-<li> A \b profile made of connected curves of 2 types: <b>line segments</b> and \b arcs.
+<li> \b Profile made of connected curves of 2 types: <b>line segments</b> and \b arcs.
 
 \b or
 
-<li> A \b rectangle
+<li>  \b Rectangle
 </ul>
 
 The \b Result is a \b Wire
@@ -25,7 +26,8 @@ To create a <b> 2D Sketch</b>:
 
 <li> Select the \b plane or the <b>planar face</b> 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.</li>
+If Local Coordinate Systems have been created in the study they appear
+in the combobox and can be selected as a reference coordinate system.</li>
 
 <li> 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.</li>
 
 \image html line_icon.png </li>
 
-<li> You can define the segment by either it's <b>end point</b> 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:
+<li> You can define the segment by either its <b>end point</b> or \b direction and \b length. The direction is defined relatively to the tangent at the last point of the sketch. It can be:
   <ul>
     <li> Tangent (colinear to the tangent at the last point)</li>
     <li> Perpendicular</li>
@@ -63,7 +65,7 @@ origin of the reference coordinate system.</li>
 <ol>
 <li> In the <b>Element Type</b> part of the dialog box select \image html arc_icon.png </li>
 
-<li> You can define the segment by either it's <b>end point</b> or a \b direction a \b radius and an \b angle. </li>
+<li> You can define the segment by either its <b>end point</b> or \b direction \b radius and \b angle. </li>
 
 <ul>
   <li>In case of an end point the arc can be built in three different ways:</li>
@@ -107,7 +109,7 @@ origin of the reference coordinate system.</li>
 <li>Destination direction by means of:</li>
 <ul>
 <li>angle between the new segment and the previous one;</li>
-<li>perpendicular to the previous segment (same as previous, but angle
+<li>perpendicular to the previous segment (same as previous, but the angle
 is predefined and is equal to 90 degrees);</li>
 <li>tangent to the previous segment;</li>
 <li>vector components DX, DY.</li>
@@ -119,7 +121,8 @@ is predefined and is equal to 90 degrees);</li>
 
 <b>"Restore"</b> button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all its objects. 
 \n <b>"Close"</b> button applies the wire, only the red part will be built.
-\n <b>"Sketch Closure"</b> will close the Sketch by straight line from last red part and apply it.
+\n <b>"Sketch Closure"</b> will close the Sketch by a straight line
+from the last red part and apply it.
 
 \n To draw a \b rectangle:
 
index b2f13f9525e15add60b4d8331f0829166d059266..8338c6db47452bbe3a59413cbf8a98d099b7c7e2 100644 (file)
@@ -12,9 +12,10 @@ To produce the <b>extruded boss</b>:
 <li>Draw the \b profile of the extrusion. It can be:
  
  <ul>
- <li> a <a href="create_sketcher_page.html">\b Sketch </a> drawn on a planar face of the object you want to boss.</li>
+ <li> a <a href="create_sketcher_page.html">\b Sketch </a> drawn on a
+ planar face of the initial shape you want to boss.</li>
  
- <li> any closed edge or wire of the desired shape (circle, ellipse ...).</li>
+ <li> any closed edge or wire of this shape (circle, ellipse ...).</li>
  </ul>
  
 </li>
@@ -34,7 +35,7 @@ The input arguments are:
 
 - The \b profile. It must be a \b closed edge or wire and it must be \b planar.
 
-- The \b height of extrusion. It's calculated from the <b>base profile</b> along the normal to its plane.
+- The \b height of extrusion. It is calculated from the <b>base profile</b> along the normal to its plane.
 
 And optionnaly:
 
@@ -47,4 +48,4 @@ This functionality is available via the textual interface with the command:
 
 \n <b>TUI Command:</b> <em>geompy.MakeExtrudedBoss(InitShape, Profile, Height, Angle),</em>
 
-*/
\ No newline at end of file
+*/
index 29de96ee29def25e156ab45725bd063cff601166..00301daf92604023422b5fdbb6253ea7af19a8ff 100644 (file)
@@ -3,15 +3,14 @@
 \page geometry_preferences_page Geometry preferences
 
 In the \b Geometry module you can set preferences for visualisation of
-geometrical figures which can be used in later sessions with this
-module.
-There is also a special group of preferences controlling input precision for floating-point
-data.
+geometrical figures, which can be used in later sessions with this module.
+There is also a special group of preferences controlling input
+precision for floating-point data.
 
 \image html pref15.png
 
 \par
-For all color definitions click on the respective line to access to
+To redefine any color click on the corresponding line to access to
 the <b>Select Color</b> dialog box.
 
 <ul>
index a8a8826e91bcab6fc3a8a2b269e0e77f1be1eb05..6416a0cc0342cf4bd737bbecf9c57b0c5291f980 100644 (file)
@@ -2,15 +2,15 @@
 
 \page import_picture_page Import a picture in the OCC viewer
 
-It's possible in GEOM to import a picture file in the OCC view.
+It is possible in GEOM to import a picture file in the OCC view.
 The supported formats are : .bmp, .gif, .pix, .xwd, .rgb, .rs
 
 
-The imported picture (engineering drawing, nautical chart ...) may be used then as a support for 2D shape design. 
+The imported picture (engineering drawing, nautical chart, etc.) may be used as a support for 2D shape design. 
 
-You can create a \ref create_sketcher_page "sketch" on the top of this picture or use the 
+It is possible to create a \ref create_sketcher_page "sketch" on top of this picture or use the 
 \ref shape_recognition_page "Shape recognition" 
-functionnalities to build geometrical shapes out from some elements of the picture (contours, corners ...).
+functionalities to build geometrical shapes from some elements of the picture (contours, corners ...).
 
 To <b>import a picture</b> in the view:
 
@@ -24,7 +24,7 @@ To <b>import a picture</b> in the view:
  
 </ul>
 
-A new <b>Picture</b> object is created and pan, zoom and rotation operations are available in the view like for any other object.
+A new <b>Picture</b> object is created. Pan, zoom and rotation operations are available in the view like for any other object.
 
 
 \image html picture_import_dlg.png
index 48c28dfea52489ed16519b2ce23893ccab5038d6..7b87f72dafa69091621cfcadb00c3f8724522006 100644 (file)
@@ -5,24 +5,24 @@
 \image html geomscreen.png
 
 \b Geometry module of SALOME is destined for: 
-<ul>
-<li>\subpage import_export_geom_obj_page "import and export of geometrical models" in IGES, BREP and STEP formats;</li>
-<li>\subpage create_geom_obj_page "construction of geometrical objects"
-using a wide range of functions;</li>
-<li>\subpage view_geom_obj_page "viewing geometrical objects" in the OCC viewer;</li>
-<li>\subpage transform_geom_obj_page "transformation of geometrical objects" using
-various algorithms;</li>
-<li>\subpage repairing_operations_page "optimization of geometrical objects";</li>
-<li>Get information about geometrical objects using
- \subpage using_measurement_tools_page "measurement tools".</li>
-<li>\subpage pictures_page "Design shapes from pictures"
-<li>and viewing \subpage geometrical_obj_prop_page "geometrical object properties".</li>
-<li>easily setting parameters via the variables predefined in
- \subpage using_notebook_geom_page "Salome notebook".</li>
-</ul>
-
-Geometry module preferences are described in the \subpage geometry_preferences_page section of SALOME Geometry Help.
-
+- \subpage import_export_geom_obj_page "import and export of geometrical models"
+  in IGES, BREP and STEP formats;
+\subpage create_geom_obj_page "construction of geometrical objects"
+  using a wide range of functions; 
+- \subpage view_geom_obj_page "viewing geometrical objects" in the OCC
+  viewer; 
+- \subpage transform_geom_obj_page "transformation of geometrical objects"
+  using various algorithms;
+- \subpage repairing_operations_page "optimization of geometrical objects";
+- viewing \subpage geometrical_obj_prop_page "geometrical object properties"
+  and other information about geometrical objects using 
+  \subpage using_measurement_tools_page "measurement tools";
+- \subpage pictures_page "designing shapes from pictures";
+- easily setting parameters via the variables predefined in
+  \subpage using_notebook_geom_page "SALOME notebook".
+
+Geometry module preferences are described in the
+\subpage geometry_preferences_page section of SALOME Geometry Help.
 
 Almost all geometry module functionalities are accessible via
 \subpage geompy_page "Geometry module Python Interface"
index 0821754ff74c345b15c9fa3c92bef8e930a3b174..4960e06f3dc3a7e94c189086c795b28dbba21e35 100644 (file)
@@ -7,7 +7,7 @@
 \section material_general_description General description
 
 \note The functionality related to the material properties is
-\b experimental one. It might work not as expected. The behaviour might
+\b experimental, so it might work not as expected. The behaviour might
 be changed in the future versions of SALOME Geometry module.
 
 \n You can change the material properties of the selected shape(s) in
@@ -18,20 +18,20 @@ context popup menu using "Material properties" item:
 
 In this dialog box you can:
 - modify the properties of the material model currenly assigned to the
-shape presentation
-- assign one of predefined global materials to the shape
-- create custom material model and apply it to the shape
+shape presentation;
+- assign one of predefined global materials to the shape;
+- create a custom material model and apply it to the shape.
 
 \note This functionality is available in both OCC and VTK 3D
-viewers. However, note that due to differences between underlying API
+viewers. However, note that due to the differencies between underlying API
 of OCC and VTK libraries the behaviour of the functionality related to
 the materials is different:
-- presentation of the shape in OCC and VTK viewers is not fully identical
-- some material attributes can affect presentation in a different way
+- presentation of the shape in OCC and VTK viewers is not fully identical;
+- some material attributes can affect presentation in a different way.
 
 \section material_opengl_model OpenGL ligthing model
 
-The material is specifed by the several attributes of the lighting
+The material is specifed by several attributes of the lighting
 model. More details can be found in the documentation related to the
 OpenGL programming, for example here: http://www.glprogramming.com/red/chapter05.html.
 
@@ -40,7 +40,7 @@ light sources; the light sources have an effect only when there are
 surfaces that absorb and reflect light. Each surface is assumed to be
 composed of a material with various properties. A material might emit
 its own light (like headlights on an automobile), it might scatter
-some incoming light in all directions, and it might reflect some
+some incoming light in all directions, and it might reflect a
 portion of the incoming light in a preferential direction like a
 mirror or other shiny surface.
 
@@ -49,7 +49,7 @@ four independent components: emissive, ambient, diffuse, and
 specular. All four components are computed independently and then
 added together. 
 
-Ambient illumination is light that's been scattered so much by the
+Ambient illumination is the light that has been scattered so much by the
 environment that its direction is impossible to determine - it seems
 to come from all directions. Backlighting in a room has a large
 ambient component, since most of the light that reaches your eye has
@@ -57,19 +57,19 @@ first bounced off many surfaces. A spotlight outdoors has a tiny
 ambient component; most of the light travels in the same direction,
 and since you're outdoors, very little of the light reaches your eye
 after bouncing off other objects. When ambient light strikes a
-surface, it's scattered equally in all directions.
+surface, it is scattered equally in all directions.
 
 The diffuse component is the light that comes from one direction, so
-it's brighter if it comes squarely down on a surface than if it barely
+it is brighter if it comes squarely down on a surface than if it barely
 glances off the surface. Once it hits a surface, however, it's
 scattered equally in all directions, so it appears equally bright, no
 matter where the eye is located. Any light coming from a particular
 position or direction probably has a diffuse component.
 
-Finally, specular light comes from a particular direction, and it
+Finally, the specular light comes from a particular direction, and it
 tends to bounce off the surface in a preferred direction. A
 well-collimated laser beam bouncing off a high-quality mirror produces
-almost 100 percent specular reflection. Shiny metal or plastic has a
+specular reflection by almost 100 percent. Shiny metal or plastic has a
 high specular component, and chalk or carpet has almost none. You can
 think of specularity as shininess.
 
@@ -98,13 +98,13 @@ it simulates light originating from an object.
 - \b Shininess
 - \b Type of material model: \em physical or \em artificial.
 
-If material model is specified as \em physical one (like \em Gold,
+If the material model is specified as a \em physical one (like \em Gold,
 for instance), this means that the color of the shape (more precisely
-its \em ambient color) can not be modified. If you assign physical
+its \em ambient color) can not be modified. If you assign physical
 material model to the shape, the "Color" menu item will not be
 available in the popup menu.
 
-If model is non-physical (\em artificial), the color can be changed
+If the model is non-physical (\em artificial), the color can be changed
 to any appopriate one, only other attributes will be constant. In the
 dialog box you will be able to modify the color of the shape via the
 "Color" button. "Ambient color" button becomes disabled to signalize
@@ -118,7 +118,7 @@ the <b>Color and Material Properties</b> dialog:
   currently assigned to the selected shape(s). This model can be
   freely modified by the user.
 - <b>Global</b> material models are shown in blue color in the list;
-  these are the models predefined by the SALOME Geometry module. User
+  these are the models predefined by the SALOME Geometry module. The user
   is not allowed to modify the global models.
 - <b>User</b> materials are shown in black color in the list. These
   models are specified by the user and can be modified at any moment.
@@ -126,9 +126,9 @@ the <b>Color and Material Properties</b> dialog:
 The buttons "Add material" and "Remove material" in the lower part of
 the dialog box can be used to create or remove custom material
 models. The same commands are also available via the popup menu that
-is shown if user presses right mouse button in the materials list
+is shown if the user presses right mouse button in the materials list
 box. An additional "Rename material" command, available in popup menu,
-can be used to change the material model's name.
+can be used to change the name of material model.
 
 <b>Examples:</b>
 
@@ -138,7 +138,7 @@ can be used to change the material model's name.
 \image html material_VTK.png
 <em>Different materials in VTK viewer</em>
 
-Default material model is specified via the preferences of Geometry
+The default material model is specified via the preferences of Geometry
 module.
 
 */
index 3891dabb02360deb2954d6dc0da661cc7e2edc98..cdc6234a17ded3960aa4ae1c80f2b5d447d4f513 100644 (file)
@@ -12,8 +12,8 @@ or two dimensions basing on the initial geometrical object.
 \n To produce a <b>Simple Multi Rotation</b> (in one dimension) you
 need to define a \b Shape to be rotated, an \b Axis of rotation and a
 <b>Number of Times</b> the shape must be rotated. <b>Rotation Angle</b> will
-be 2 * \a PI / \a NbTimes. Number of shapes in resulting compound will be equal
-to \a NbTimes (if \a NbTimes = 1, the result will contain single initial
+be 2 * \a PI / \a NbTimes. Number of shapes in the resulting compound will be equal
+to \a NbTimes (if \a NbTimes = 1, the result will contain only the initial
 non-transformed shape).
 \n <b>TUI Command:</b> <em>geompy.MultiRotate1D(Shape, Axis, NbTimes)</em>
 \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 value
@@ -35,9 +35,9 @@ the same way, but the Axis is defined  by direction and point.
 <b>Number of Times</b> and multi-translates each rotation
 result. Translation direction passes through the center of gravity of
 the rotated shape and its projection on the rotation axis. Number of
-shapes in resulting compound will be equal to \a NbTimes1 x \a NbTimes2 (if
+shapes in the resulting compound will be equal to \a NbTimes1 x \a NbTimes2 (if
 both \a NbTimes1 and \a NbTimes2 are equal to 1, the result will contain
-single initial non-transformed shape).
+only the initial non-transformed shape).
 \b Reverse checkbox allows to set the direction of rotation.
 \n <b>TUI Command:</b> <em>geompy.MultiRotate2D(Shape, Axis, Angle, NbTimes1, Step, NbTimes2)</em>
 \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 angle
index 9afaaffb03ff969752489ba6249c244bac5c1e38..0d084f3c1943b476e950d9ecd6bf2099a57f8804 100644 (file)
@@ -9,13 +9,13 @@ select <b>Operations - > Transformation - > Multi Translation</b>
 two directions.
 \n The \b Result will be one or several \b GEOM_Objects
 (compound). The total number of shapes in the resulting compound (for
-the single initial selected shape) will be equal to:
+a single initial selected shape) will be equal to:
 - in case of \ref single_multi_translation "Single multi translation":
 \a NbTimes (if \a NbTimes parameter is equal to 1, the result will
-contain single, non-translated initial shape). 
+contain only the initial non-translated shape). 
 - in case of \ref double_multi_translation "Double multi translation":
 \a NbTimes1 x \a NbTimes2 (if \a NbTimes1 and \a NbTimes2 parameters
-are both equal to 1, the result will contain single, non-translated
+are both equal to 1, the result will contain a single non-translated
 initial shape). 
 
 \anchor single_multi_translation
index 2aa15f3d9c79b78dc13986cd3c0becd042726e0f..0a894c54d2ff405e16b17382eb0d603d126e35b9 100644 (file)
@@ -10,7 +10,8 @@
   <li>The functionality is only available if SALOME has been built with the optional prerequisite OpenCV. </li>
   </ol>
 
-This tool allows you to create geometrical shapes automatically out from pictures elements by performing shape recognition algorithms.
+This tool allows you to automatically create geometrical shapes from
+pictures with help of shape recognition algorithms.
 <b>Contours</b> or <b>Corners</b> can be built.
 
 \b Example: 
@@ -32,27 +33,29 @@ To use the <b>Shape recogition</b> tool:
   
 
 
-Then you can choose to create either <b>contours</b> or <b>corners</b> out from this picture. 
+Then you can choose to create either <b>contours</b> or <b>corners</b> from this picture. 
 
 \n
 
 To create <b>Contours</b> :
 
 <ol>
-  <li> In the <b>Picture</b> field select a previously imported picture.</li>
+  <li> Select in the <b>Picture</b> field a previously imported picture.</li>
   
   <li> Click on \image html occ_view_camera_dump.png </li>
   
-  <li> Find a zone in the picture which color is representative of the zone you want to find the frontier of. Draw a rectangle on it to take a <b>Snapshot</b>.</li>
+  <li>  Draw a rectangle in the zone whose contour is to be found. The
+  zone will be identified by the colors of this <b>Filtering Sample</b>.
   
   \b Example:
   
-  In the example shown above the following snapshot was taken in the middle of the chart
+  In the picture shown above, the contours have been drawn basing on
+  the sample, containing white and violet color, thus all white and
+  violet areas in the picture are included in the outlined zone.
   
   \image html feature_detection_dlg3.png
   
-  All the violet and white areas are thus considered as part of the zone we want to find the frontier of.
-  
+
   
   <li> <b> Output type </b> 
 
@@ -68,7 +71,7 @@ To create <b>Contours</b> :
   
   </li>
   
-  \note It's better to use the \b Spline output type unless you want to find the frontier of a polygon (rectangle ...)
+  \note It is better to use the \b Spline output type unless you want to find the frontier of a polygon (rectangle ...)
 
 </ol>
 
@@ -92,4 +95,4 @@ To create <b>Corners</b> :
   
 
 
-*/
\ No newline at end of file
+*/
diff --git a/doc/salome/gui/GEOM/input/using_measurement_tools_old.doc b/doc/salome/gui/GEOM/input/using_measurement_tools_old.doc
deleted file mode 100644 (file)
index e95e6dd..0000000
+++ /dev/null
@@ -1,282 +0,0 @@
-
-
-\page using_measurement_tools_page_old Using measurement tools
-
-\n Measurement tools in GEOM are necessary for getting different data
-concerning created or imported geometrical objects. They are:
-
-<ul>
-<li>\ref point_coord_anchor "Point coordinates"</li>
-<li>\ref basic_prop_anchor "Basic properties"</li>
-<li>\ref center_mass_anchor "Center of mass"</li>
-<li>\ref vertex_by_index "Get Vertex By Index"</li>
-<li>\ref inertia_anchor "Inertia"</li>
-<li>\ref normale_anchor "Normal to a Face"</li>
-<li>\ref boundaries_anchor "Check Free Boundaries"</li>
-<li>\ref faces_anchor "Check Faces"</li>
-<li>\ref bounding_box_anchor "Bounding box"</li>
-<li>\ref min_distance_anchor "Min. distance"</li>
-<li>\ref angle_anchor "Angle"</li>
-<li>\ref tolerance_anchor "Tolerance"</li>
-<li>\ref whatis_anchor "WhatIs"</li>
-<li>\ref check_anchor "Check"</li>
-<li>\ref check_compound_anchor "Check compound of blocks"</li>
-<li>\ref check_self_intersections_anchor "Detect Self-intersections"</li>
-</ul>
-
-\n Our <b>TUI Scripts</b> show how to use
-\ref tui_measurement_tools_page "Measurement Tools" with <b>TUI
-commands</b>.
-
-\n <em>To use measurement tools:</em>
-\par
-In the <b>Main menu</b> select \b Measures submenu.
-
-\anchor point_coord_anchor
-<br><h2>Point coordinates</h2>
-
-\n Returns the coordinates of a point.
-
-\n <b>Result:</b> Point coordinates (X, Y, Z) in 3D space in the form of Python Tuple.
-\n <b>TUI Command:</b> <em>geompy.PointCoordinates(Point),</em>
-where \em Point is a point whose coordinates are inquired.
-
-\image html measures1.png
-
-\anchor basic_prop_anchor
-<br><h2>Basic properties</h2>
-
-\n Returns the properties (Length, Surface & Volume) for the selected
-geometrical object.
-
-\n <b>Result:</b> Display Length, Surface & Volume in the form of
-Python Tuple.
-\n <b>TUI Command:</b> <em>geompy.BasicProperties(Shape),</em> where
-\em Shape is a shape whose properties are inquired.
-
-\image html neo-basicprop.png
-
-\anchor center_mass_anchor
-<br><h2>Center of mass</h2>
-
-\n Calculates and returns the coordinates of the gravity center for
-the selected geometrical object.
-
-\n <b>Result:</b> GEOM_Object (vertex).
-\n <b>TUI Command:</b> <em> geompy.MakeCDG(Shape),</em> where \em Shape is
-the shape for which a center of gravity is computed.
-
-\image html measures3.png
-
-\anchor vertex_by_index
-<br><h2>Get Vertex by Index</h2>
-
-\n It is possible to get the first or the last vertex from an edge or a wire, depending on 
-its direction (orientation), or to find the vertex by the index inside the wire. 
-The numeration of vertexes starts from 0. This function has only a TUI implementation) 
-
-\n <b>Result:</b> GEOM_Object (vertex).
-\n <b>TUI Command:</b> <em> geompy.GetVertexByIndex(Shape, Index),</em>
-<em> geompy.GetFirstVertex(Shape),</em>
-<em> geompy.GetLastVertex(Shape),</em> where \em Shape must be Wire or Edge.
-
-\anchor inertia_anchor
-<br><h2>Inertia</h2>
-
-Returns the axial moments of inertia for the selected geometrical object.
-
-\n <b>Result:</b> Displays the matrix of the own moments of inertia and
-the relative moments of inertia in the form of Python Tuple
- <center>(I11, I12, I13,</center>
-                     <center>I21, I22, I23,</center>
-                     <center>I31, I32, I33,</center>
-                     <center>Ix, Iy, Iz).</center>
-\n <b>TUI Command:</b> <em>geompy.Inertia(Shape),</em> where \em Shape is
-a shape for which the own matrix of inertia and the relative moments of inertia are
-returned.
-
-\image html measures4.png
-
-\anchor normale_anchor
-<br><h2>Normal to a Face</h2>
-
-\n Calculates the normal vector to the selected \b Face. The \b Point
-is a point of the \b Face, where the Normal should be calculated.
-
-\image html normaletoface.png
-
-\anchor boundaries_anchor
-<br><h2>Check Free Boundaries</h2>
-
-\n Detects and highlights  wires and edges that are not shared between
-two faces and are considered a shape's boundary.
-
-\n <b>TUI Command:</b> <em>(NoError, ClosedWires, OpenWires) =
-geompy.GetFreeBoundary(Shape),</em> where \em Shape is a shape to be
-checked, \em NoError is false if an error occurred while checking free
-boundaries, \em ClosedWires is a list of closed free boundary wires,
-\em OpenWires is a list of open free boundary wires.
-
-\image html repair9.png
-
-\anchor faces_anchor
-<br><h2>Check Free Faces</h2>
-
-\n Highlights all free faces of a given shape. A free
-face is a face which is not shared between two objects of the shape.
-
-\n \b NOTE: This functionality works only in VTK viewer.
-
-\n \b Result: a list of IDs of all free faces, containing in the shape.
-\n <b>TUI Command:</b> <em>GetFreeFacesIDs(Shape),</em> where \em Shape is
-a shape to be checked.
-
-\image html repair10.png
-
-\anchor bounding_box_anchor
-<br><h2>Bounding box</h2>
-
-Returns the dimensions of the bounding box for the selected
-geometrical object.
-
-\b NOTE: In order to take into account any possible distortion of a shape 
-that affects the resulting bounding box, the algorithm enlarges 
-the bounding box to the value of 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.
-
-<b>Result:</b> Displays the dimensions of the bounding box of a
-geometrical object in the form of Python Tuple (Xmin, Xmax, Ymin,
-Ymax, Zmin, Zmax).
-\n <b>TUI Command:</b> <em>geompy.BoundingBox(Shape),</em> where \em Shape
-is a shape for which a bounding box is computed.
-
-\image html measures5.png
-
-\anchor min_distance_anchor
-<br><h2>Min. distance</h2>
-
-\n Returns the minimum distance between two geometrical objects and
-the coordinates of the vector of distance and shows the vector in the viewer.
-
-\n <b>TUI Command:</b> <em>geompy.MinDistance(Shape1, Shape2),</em>
-where \em Shape1 and \em Shape2 are shapes between which the minimal
-distance is computed.
-
-\image html distance.png
-
-\anchor angle_anchor
-<br><h2>Angle</h2>
-
-\n Returns the angle between two lines or linear edges in degrees.
-
-\note If both arguments are <b>vectors</b>, the angle is computed in
-      accordance with their orientations, otherwise the minimum angle
-      is computed.
-
-\n <b>TUI Command:</b> <em>geompy.GetAngle(shape1, shape2),</em> where
-Shape1 and Shape2 are shapes between which the angle is computed. 
-Another TUI command is <em>geompy.GetAngleRadians(shape1,shape2),</em> 
-which returns the value of angle in radians.
-
-\image html angle.png
-
-\anchor tolerance_anchor
-<br><h2>Tolerance</h2>
-
-\n Returns the maximum and the minimum tolerance for the selected
-geometrical object.
-
-\n <b>Result:</b> Displays the tolerance values (FaceMinTol,
-FaceMaxTol, EgdeMinTol, EgdeMaxTol, VertexMinTol, VertexMaxTol).
-\n <b>TUI Command:</b> <em>geompy.Tolerance(Shape),</em> where \em Shape
-is a shape for which minimal and maximal tolerances are returned.
-
-\image html new-tolerance.png
-
-\anchor whatis_anchor
-<br><h2>WhatIs</h2>
-
-\n General information about the selected geometrical object is the
-list of types and quantities of all topological entities, composing
-the shape.
-
-\n <b>TUI Command:</b> <em>geompy.WhatIs(Shape),</em> where \em Shape is a
-shape from which a description is returned.
-
-\image html measures8.png
-
-\n <b>Kind of Shape</b> field characterises the
-whole shape. If there is no additional information available for the
-shape, <b>Basic Properties</b> button will be disabled, otherwise it
-will show a dialog with information about
-dimensions, position, orientation and other parameters of the shape.
-
-\n <b>TUI Command:</b> <em>geompy.KindOfShape(Shape),</em> where \em Shape is a
-shape from which a description is returned.
-
-\image html measures8a.png
-
-\anchor check_anchor
-<br><h2>Check</h2>
-
-\n Checks the topology of the selected geometrical object and returns
-True if it is valid. Check also geometry checkbox allows to test the
-geometry as well.
-
-\n <b>Result:</b> Boolean.
-\n <b>TUI Command:</b> <em>geompy.CheckShape(theShape, theIsCheckGeom = 0),</em>
-where \em theShape is the shape checked for validity.
-
-\image html measures9.png
-
-\anchor check_compound_anchor
-<br><h2>Check compound of blocks</h2>
-
-\n Checks whether a shape is a compound of glued blocks. To be
-considered as a compound of blocks, the given shape must satisfy the
-following conditions:
-<ul>
-<li>Each element of the compound should be a Block (6 faces and 12 edges);</li>
-<li>A connection between two Blocks should be an entire quadrangle face or an entire edge;</li>
-<li>The compound should be connected;</li>
-<li>Two quadrangle faces should be glued.</li>
-</ul>
-
-\n Informs of the following possible errors:
-<ul>
-<li>not a block;</li>
-<li>not glued;</li>
-<li>not connected;</li>
-<li>extra or degenerated edge.</li>
-</ul>
-
-\n <b>Result:</b> Boolean; highlight in the viewer.
-\n <b>TUI Command:</b>
-<em>geompy.CheckCompoundOfBlocks(Compound).</em> Checks if the shape
-is a valid compound of blocks. If it is true, then the validity flag
-is returned, and encountered errors are printed in the python console.
-
-\image html measures10.png
-
-\anchor check_self_intersections_anchor
-<br><h2>Detect Self-intersections</h2>
-
-\n Checks the topology of the selected shape to detect self-intersections.
- Returns True if there are no self-intersections. Reports pairs of
- intersected sub-shapes, if there are any.
-
-\note This tool is useful for detection of shapes, not suitable for
-arguments of Boolean operations and Partition algorithm.
-For more information about Partition and Boolean Operations Algorithms
-and their limitations refer to <a href="SALOME_BOA_PA.pdf">this document</a>.
-
-\n <b>Result:</b> Boolean.
-\n <b>TUI Command:</b> <em>geompy.CheckSelfIntersections(theShape),</em>
-where \em theShape is the shape checked for validity.
-
-\image html measures11.png
-
-*/
-
index fdb4e7798cfc1d0c573bcbfa2d0462037f9115be..44cea48a674f9ba6e6bbb881606aef050e1084fb 100644 (file)
@@ -22,9 +22,9 @@ viewer and from the Object Browser.</li>
 <li>\subpage display_mode_page "Display Mode" - allows to select between
 Wireframe and Shading presentation.</li>
 <li>\subpage bring_to_front_page "Bring To Front" - allows to bring to 
-front of the viewer selected geometrical object.</li>
-<li><b>Clear Top Level State</b> - allows to remove from foregroung of the viewer 
-geometrical objects which were added there via <b>Bring To Front</b> command.</li>
+front of the viewer the selected geometrical object.</li>
+<li><b>Clear Top Level State</b> - allows to remove from the viewer foreground 
+geometrical objects that have been placed there via <b>Bring To Front</b> command.</li>
 <li>\subpage color_page "Color" - allows to change the filling color in
 the standard <b>Select Color</b> menu.</li>
 <li>\subpage transparency_page "Transparency" - allows to change the
@@ -38,7 +38,7 @@ material properties of a shape.</li>
 <li>\subpage point_marker_page "Point Marker" - allows to change the
 representation of geometrical vertices.</li>
 <li>\subpage line_width_page "Line Width" - allows to change the
-width of the edges and isolines.</li>
+width of edges and isolines.</li>
 <li><b>Auto color</b> / <b>Disable auto color</b> - activates the auto color
 mode. When the auto color mode is enabled, the groups created on the
 sub-shapes of the selected geometrical object are automatically