Integration of OCCT 6.5.0 from SVN
[occt.git] / src / BRepBuilderAPI / BRepBuilderAPI_MakeShell.cdl
1 -- File:        BRepBuilderAPI_MakeShell.cdl
2 -- Created:     Wed Feb 16 16:56:46 1994
3 -- Author:      Remi LEQUETTE
4 --              <rle@zerox>
5 --              xab:19Nov96 correction de doc
6 ---Copyright:    Matra Datavision 1994
7
8
9
10 class MakeShell from BRepBuilderAPI inherits MakeShape from BRepBuilderAPI
11
12         ---Purpose: Describes functions to build a
13         -- shape corresponding to the skin of a surface.
14         -- Note that the term shell in the class name has the same definition
15         -- as that of a shell in STEP, in other words the skin of a shape,
16         -- and not a solid model defined by surface and thickness. If you want
17         -- to build the second sort of shell, you must use
18         -- BRepOffsetAPI_MakeOffsetShape. A shell is made of a series of
19         -- faces connected by their common edges.
20         -- If the underlying surface of a face is not C2 continuous and 
21         -- the flag Segment is True, MakeShell breaks the surface down into
22         -- several faces which are all C2 continuous and which are
23         -- connected along the non-regular curves on the surface.
24         -- The resulting shell contains all these faces.
25         -- Construction of a Shell from a non-C2 continuous Surface
26         -- A MakeShell object provides a framework for:
27         -- -      defining the construction of a shell,
28         -- -      implementing the construction algorithm, and
29         -- -      consulting the result.
30         -- Warning
31         -- The connected C2 faces in the shell resulting from a decomposition of
32         -- the surface are not sewn. For a sewn result, you need to use
33         -- BRepOffsetAPI_Sewing. For a shell with thickness, you need to use
34         -- BRepOffsetAPI_MakeOffsetShape.
35         
36 uses
37
38     Surface    from Geom,
39     Shell      from TopoDS,
40     Face       from TopoDS,
41     ShellError from BRepBuilderAPI,
42     MakeShell  from BRepLib
43     
44
45 raises
46     NotDone from StdFail
47
48 is
49     Create  
50         ---Purpose: Constructs an empty shell framework. The Init
51         -- function is used to define the construction arguments.
52         -- Warning
53         -- The function Error will return
54         -- BRepBuilderAPI_EmptyShell if it is called before the function Init.
55     returns MakeShell from BRepBuilderAPI;
56     
57     ----------------------------------------------
58     -- From a set of face
59     ----------------------------------------------
60
61     ----------------------------------------------
62     -- From a surface
63     ----------------------------------------------
64
65     Create(S : Surface from Geom;
66            Segment : Boolean from Standard = Standard_False)
67         ---Purpose: Constructs a shell from the surface S.
68     returns MakeShell from BRepBuilderAPI;
69     
70     Create(S : Surface from Geom; UMin, UMax, VMin, VMax : Real;
71            Segment : Boolean from Standard = Standard_False)
72
73         ---Purpose: Constructs a shell from the surface S,
74         --      limited in the u parametric direction by the two
75         --      parameter values UMin and UMax, and limited in the v
76         --      parametric direction by the two parameter values VMin and VMax.
77     returns MakeShell from BRepBuilderAPI;
78
79     Init(me : in out; S : Surface from Geom; UMin, UMax, VMin, VMax : Real;
80                       Segment : Boolean from Standard = Standard_False)
81         ---Purpose: Defines or redefines the arguments
82         -- for the construction of a shell. The construction is initialized
83         -- with the surface S, limited in the u parametric direction by the
84         -- two parameter values UMin and UMax, and in the v parametric
85         -- direction by the two parameter values VMin and VMax.
86         -- Warning
87         -- The function Error returns:
88         -- -      BRepBuilderAPI_ShellParametersOutOfRange
89         --    when the given parameters are outside the bounds of the
90         --    surface or the basis surface if S is trimmed
91     is static;
92
93
94     ----------------------------------------------
95     -- Results
96     ----------------------------------------------
97
98     IsDone(me) returns Boolean
99         ---Purpose: Returns true if the shell is built.
100     is redefined;
101
102     Error(me) returns ShellError from BRepBuilderAPI
103         ---Purpose: Returns the construction status:
104         -- -   BRepBuilderAPI_ShellDone if the shell is built, or
105         -- -   another value of the BRepBuilderAPI_ShellError
106         --   enumeration indicating why the construction failed.
107         --   This is frequently BRepBuilderAPI_ShellParametersOutOfRange
108         -- indicating that the given parameters are outside the bounds of the surface.
109     is static;
110
111     Shell(me) returns Shell from TopoDS
112         ---Purpose: Returns the new Shell.
113         --          
114         ---C++: return const &
115         ---C++: alias "Standard_EXPORT operator TopoDS_Shell() const;"
116         ---Level: Public
117     raises
118         NotDone from StdFail
119     is static; 
120     
121 fields
122     myMakeShell : MakeShell from BRepLib;
123
124 end MakeShell;