Salome HOME
Merge remote branch 'origin/akl/22379'
[modules/geom.git] / doc / salome / gui / GEOM / input / check_shape.doc
index 9ffbf5b9aa244d012ccec960a3667475066bd8ad..fb17270d958388ee267d4bdaa47208b6d5f9e545 100644 (file)
@@ -2,17 +2,51 @@
 
 \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. 
 
-\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
+
+In this dialog:
+
+- \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser. 
+- <b>Check also geometry</b> option allows testing the geometry of the object as well.
+- \b Errors list informs of possible errors. 
+- <b>Incriminated Sub-shapes</b> 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 <b>Apply and Close</b> button. 
+
+\n <b>TUI Commands:</b>
+
+<UL>
+
+<LI>
+<em>geompy.CheckShape(theShape, theIsCheckGeom = 0, theReturnStatus = 0),</em> \n
+where \n
+\em theShape is the shape checked for validity. \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:
+<UL>
+<LI>0 - if theShape is invalid, a description of problem is printed.
+\em IsValid status is returned.</LI>
+<LI>1 - \em IsValid status and the description of problem are returned.</LI>
+<LI>2 - \em IsValid status and the list of error data are returned.</LI>
+</UL>
+</LI>
+
+<LI>
+<em>geompy.PrintShapeErrors(self, theShape, theShapeErrors, theReturnStatus = 0),</em> \n
+where \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:
+<UL>
+<LI>0 - the problem description is printed and \em IsValid status is returned.</LI>
+<LI>1 - the problem description is returned.</LI>
+</UL>
+</LI>
+</UL>
 
 See also a \ref tui_check_shape_page "TUI example".
 
-\image html measures9.png
 
 
 */
\ No newline at end of file