Salome HOME
documentation improvement
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_filling.doc
1 /*!
2
3 \page create_filling_page Filling Surface with Edges
4
5 To generate a \b Filling in the <b>Main Menu</b> select <b>New Entity - > Generation  - > Filling</b>
6
7 To create a curvilinear face from several edges you need to define the
8 following parameters:
9 \n <b>Input Contours</b> - the list of edges/wires to use for creation
10 of the surface. You can select either several edges/wires or a
11 compound of them. To prepare for the filling, each input wire
12 is converted into a single BSpline curve by concatenating its edges.
13 \n \b Minimum and <b>Maximum Degree</b> of equation of the resulting
14 BSpline or Besier curves describing the surface.
15 \n \b Tolerance for \b 2D and for \b 3D - minimum distance between the
16 created surface and the input contours.
17 \n <b>Number of Iterations</b> - defines the maximum number of iterations. The
18 iterations are repeated until the required tolerance is reached. So, a
19 greater number of iterations allows producing a better surface. 
20 \n <b>Method</b> - Kind of method to perform filling operation
21 <ol>
22 <li>Default - the standard behaviour.</li>
23 <li>Use edges orientation - the edges orientation is used: if an edge is
24 reversed, the curve from this edge is reversed before being used by the filling
25 algorithm.</li>
26 <li>Auto-correct edges orientation - curves orientation is changed to 
27 minimize the sum of distances between ends points of edges.</li>
28 </ol>
29
30 <b>Approximation</b> - if checked, BSpline curves are generated in
31 the process of surface construction (using
32 GeomAPI_PointsToBSplineSurface functionality). By default the surface
33 is created using Besier curves. The usage of <b>Approximation</b>
34 slows the algorithm, but allows building the surface for complex cases. 
35
36 \n The \b Result of the operation will be a GEOM_Object (face).
37
38 \n <b>TUI Command:</b> <em>geompy.MakeFilling(Contours, MinDegree, MaxDegree, Tol2D, Tol3D, NbIter)</em><br>
39 <b>Arguments:</b> List/compound of edges/wires + 7 Parameters
40 (Min. degree, Max. degree, 2D tolerance, 3D tolerance, Number of
41 iterations, Method, Approximation).
42 \n <b>Advanced options:</b> \ref preview_anchor "Preview"
43
44 \image html filling.png
45
46 \note This dialog supports navigation through the selectable objects (in OCC 3D viewer only):
47 - Scroll mouse wheel with pressed \em Ctrl key or press \em "S", \em "P" keys when input focus is
48 in the viewer to navigate between selectable objects.
49 - Press left mouse button to select an appropriate object to the dialog box.
50 .
51 For more details, please refer to the \em "Functionality common for OCC and VTK viewers" chapter
52 of the GUI module's documentation.
53
54 <b>Example:</b>
55
56 \image html filling_compoundsn.png "Initial edges"
57
58 \image html fillingsn.png "Resulting surface"
59
60 Sample <b>TUI Scripts</b> provide you with useful examples of creation of
61 \ref tui_creation_filling "Complex Geometric Objects".
62
63 */