Salome HOME
Statistics of the operation
[plugins/canrecplugin.git] / doc / salome / gui / CANRECPLUGIN / input / canrecplugin_usage_page.doc
index c654a5a54f00f54a71e76d411b188dc8753a5b9e..bc2da0b7e5a69abc580b567372dd261fc9aee55d 100644 (file)
@@ -6,19 +6,30 @@ To create a <b>Canonical Recognition</b> in the <b>Main Menu</b> select <b>New E
 
 This Operation constructs a canonical recognition (convert, if possible, a NURBS geometry B-Spline / Bezier curve or surface
 to its analytical form) of an \b Object. To constructs the canonical recognition you need to define the shape.
+\n Once you chose an object you can see the number of canonical faces in this object on the label below.
 \n <b>Merge Surfaces</b> checkbox allows to merge surfaces in the result shape.
 \n <b>Merge Curves</b> checkbox allows to merge curvies in the result shape.
 \n The \b Result of the operation will be any \b GEOM_Object.
 
-\n <b>TUI Command:</b> <em>geompy.MakeCanonicalRecognition(Shape, MergeSurf, MergeCurves), 
+\n <b>TUI Commands:</b> 
+<UL>
+<LI><em>geompy.MakeCanonicalRecognition(Shape, MergeSurf, MergeCurves, theTolerance=0.01), 
 </em> where Shape is a shape to be converted into canonical recognition, 
-MergeSurf and MergeCurv flags to merge surfaces / curves in the result shape.
-
+MergeSurf and MergeCurv flags to merge surfaces / curves in the result shape,
+theTolerance is the tolerance of the operation. Default value is 0.01.</LI>
+<LI><em>geompy.GetNbCanonicalFaces(Shape),</em> where Shape is a shape to be tested.
+Returns the number of canonical faces in this shape.</LI>
+</UL>
 
 \n <b>Arguments:</b> Name + one object.
 
 \image html canrec_plugin_dlg.png
 
+Once the user presses the \b Apply or <b>Apply and Close</b> buttons,
+he will be given with the operation statistics information:
+
+\image html canrec_plugin_dlg_stat.png
+
 \n \b Example:
 
 Our <b>TUI Script</b> provide you with useful example of the use of \ref canrec_example "Canonical Recognition".