X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fcheck_shape.doc;h=fb17270d958388ee267d4bdaa47208b6d5f9e545;hb=97d9c2c6b1eb1b8c37b74e9409ebdb89c42c8c27;hp=2d5e1dd374d0deee86c90cbe8381a6ec6f896918;hpb=6833ee2b3e774239b93e4d3ea1b2c3c9dfde61d3;p=modules%2Fgeom.git
diff --git a/doc/salome/gui/GEOM/input/check_shape.doc b/doc/salome/gui/GEOM/input/check_shape.doc
index 2d5e1dd37..fb17270d9 100644
--- a/doc/salome/gui/GEOM/input/check_shape.doc
+++ b/doc/salome/gui/GEOM/input/check_shape.doc
@@ -2,13 +2,22 @@
\page check_shape_page Check Shape
-\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 This operation checks the topology of the selected geometrical object and returns
+True if it is valid.
+
+\image html measures9.png
+
+In this dialog:
+
+- \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
+- Check also geometry option allows testing the geometry of the object as well.
+- \b Errors list informs of possible errors.
+- Incriminated Sub-shapes field outputs the list of sub-shapes that cause problem. It is possible to select them in the list and publish in the study for further analysis by clicking \b Apply or Apply and Close button.
-\n Result: Boolean; highlight in the viewer.
\n TUI Commands:
+
+
-
geompy.CheckShape(theShape, theIsCheckGeom = 0, theReturnStatus = 0), \n
where \n
@@ -16,28 +25,28 @@ where \n
\em theIsCheckGeom is the flag that tells if geometry should be checked also.\n
\em theReturnStatus is the flag that can have the following values:
-- 0 - Means that if theShape is invalid, a description of problem is printed.
-IsValid status is returned.
-- 1 - Means that IsValid status and the description of problem are returned.
-- 2 - Means that IsValid status and the list of error data are returned.
+- 0 - if theShape is invalid, a description of problem is printed.
+\em IsValid status is returned.
+- 1 - \em IsValid status and the description of problem are returned.
+- 2 - \em IsValid status and the list of error data are returned.
+
-
geompy.PrintShapeErrors(self, theShape, theShapeErrors, theReturnStatus = 0), \n
where \n
-\em theShape Shape that was checked. \n
-\em theShapeErrors the shape errors obtained by CheckShape. \n
+\em theShape is the shape checked for validity. \n
+\em theShapeErrors are the shape errors obtained by CheckShape. \n
\em theReturnStatus is the flag that can have the following values:
-- 0 - Means that a description of problem is printed.
-IsValid status is returned.
-- 1 - Means that the description of problem is returned.
+- 0 - the problem description is printed and \em IsValid status is returned.
+- 1 - the problem description is returned.
+
See also a \ref tui_check_shape_page "TUI example".
-\image html measures9.png
*/
\ No newline at end of file