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 <b>Merge Surfaces</b> checkbox allows to merge surfaces in the result shape.
  10 \n <b>Merge Curves</b> checkbox allows to merge curvies in the result shape.
  11 \n The \b Result of the operation will be any \b GEOM_Object.
  12
  13 \n <b>TUI Command:</b> <em>geompy.MakeCanonicalRecognition(Shape, MergeSurf, MergeCurves),
  14 </em> where Shape is a shape to be converted into canonical recognition,
  15 MergeSurf and MergeCurv flags to merge surfaces / curves in the result shape.
  16
  17
  18 \n <b>Arguments:</b> Name + one object.
  19
  20 \image html canrec_plugin_dlg.png
  21
  22 \n \b Example:
  23
  24 Our <b>TUI Script</b> provide you with useful example of the use of \ref canrec_example "Canonical Recognition".
  25
  26 */