Salome HOME
add documentation about "Reduce Study" functionality
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_smoothingsurface.doc
index 9f2263ec6ee5ad45ab70d6913d58dbb94b5ec7e8..a4d3fb6471d6940d3971141779ba866a439cca94 100644 (file)
@@ -1,20 +1,34 @@
 /*!
 
-\page create_smoothingsurface_page SmoothingSurface
+\page create_smoothingsurface_page Smoothing Surface
 
-To create a \b SmoothingSurface in the <b>Main Menu</b> select <b>New Entity - >
+To create a <b> Smoothing Surface</b> in the <b>Main Menu</b> select <b>New Entity - >
 Advanced - > SmoothingSurface </b>
 
-Specify the parameters of the SmoothingSurface object creation in the opened dialog
-box and press "Apply" or "Apply & Close" button.
-Result of each operation will be a GEOM_Object.
+\image html smoothingsurface_dlg.png
 
-<b>TUI Command:</b> <em>geompy.MakeSmoothingSurface(lPoints)</em>
+In this dialog you can specify the following parameters:
+- \b Name of the surface; 
+- the list of \b Points or compounds of points, from which it is approximated;
+- <b>Max nbr of Bezier pieces</b> in the resulting surface;
+- <b>Max BSpline surface degree</b> of the resulting BSpline surface;
+- <b>3D tolerance of initial approximation</b>
 
-<b>Arguments:</b>
-- \b lPoints - list of  points
+\note <b>3D tolerance of initial approximation</b> represents a tolerance of
+initial plate surface approximation. If this parameter is equal to 0 (default),
+its value is automatically computed as <em> max(0.0001, 10*error)</em>,
+where <em>error</em> is a 3D tolerance of the surface representing a maximal
+distance between computed plate surface and given points.
 
-\image html smoothingsurface_dlg.png
+<b>Advanced options:</b> \ref preview_anchor "Preview"
+
+Press "Apply" or "Apply & Close" button to get the resulting <em>GEOM_Object(Surface)</em>.
+
+<b>TUI Command:</b> <em>geompy.MakeSmoothingSurface(thelPoints, theNbMax, theDegMax, theDMax)</em>, where:
+- \em thelPoints is a list of points or compounds of points;
+- \em theNbMax maximum number of Bezier pieces in the resulting surface;
+- \em theDegMax maximum degree;  
+- \em theDMax specifies 3D tolerance of initial approximation
 
 Example: