]> SALOME platform Git repositories - plugins/canrecplugin.git/blob - doc/salome/gui/CANRECPLUGIN/input/canrecplugin_usage_page.doc
Salome HOME
Statistics of the operation
[plugins/canrecplugin.git] / doc / salome / gui / CANRECPLUGIN / input / canrecplugin_usage_page.doc
1 /*!
2
3 \page canrecplugin_usage_page Constructing of the Canonical Recognition
4
5 To create a <b>Canonical Recognition</b> in the <b>Main Menu</b> select <b>New Entity - > Advanced - > Canonical Recognition</b>
6
7 This Operation constructs a canonical recognition (convert, if possible, a NURBS geometry B-Spline / Bezier curve or surface
8 to its analytical form) of an \b Object. To constructs the canonical recognition you need to define the shape.
9 \n Once you chose an object you can see the number of canonical faces in this object on the label below.
10 \n <b>Merge Surfaces</b> checkbox allows to merge surfaces in the result shape.
11 \n <b>Merge Curves</b> checkbox allows to merge curvies in the result shape.
12 \n The \b Result of the operation will be any \b GEOM_Object.
13
14 \n <b>TUI Commands:</b> 
15 <UL>
16 <LI><em>geompy.MakeCanonicalRecognition(Shape, MergeSurf, MergeCurves, theTolerance=0.01), 
17 </em> where Shape is a shape to be converted into canonical recognition, 
18 MergeSurf and MergeCurv flags to merge surfaces / curves in the result shape,
19 theTolerance is the tolerance of the operation. Default value is 0.01.</LI>
20 <LI><em>geompy.GetNbCanonicalFaces(Shape),</em> where Shape is a shape to be tested.
21 Returns the number of canonical faces in this shape.</LI>
22 </UL>
23
24 \n <b>Arguments:</b> Name + one object.
25
26 \image html canrec_plugin_dlg.png
27
28 Once the user presses the \b Apply or <b>Apply and Close</b> buttons,
29 he will be given with the operation statistics information:
30
31 \image html canrec_plugin_dlg_stat.png
32
33 \n \b Example:
34
35 Our <b>TUI Script</b> provide you with useful example of the use of \ref canrec_example "Canonical Recognition".
36
37 */