0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_Area3dBuilder.cdl
1 -- Created on: 2001-06-25
2 -- Created by: Michael KLOKOV
3 -- Copyright (c) 2001-2012 OPEN CASCADE SAS
4 --
5 -- The content of this file is subject to the Open CASCADE Technology Public
6 -- License Version 6.5 (the "License"). You may not use the content of this file
7 -- except in compliance with the License. Please obtain a copy of the License
8 -- at http://www.opencascade.org and read it completely before using this file.
9 --
10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 --
13 -- The Original Code and all software distributed under the License is
14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
15 -- Initial Developer hereby disclaims all such warranties, including without
16 -- limitation, any warranties of merchantability, fitness for a particular
17 -- purpose or non-infringement. Please see the License for the specific terms
18 -- and conditions governing the rights and limitations under the License.
19
20
21 class Area3dBuilder from BOP inherits AreaBuilder from BOP
22
23     ---Purpose: 
24         
25     -- The algorithm is used to construct Solids from a LoopSet,
26     -- where the Loop is the composite topological object of the boundary,
27     -- here it is a Shell(s) or block(s) of Faces.
28     -- The LoopSet gives an iteration on Loops.
29     -- For each Loop  it indicates if it is on the boundary (shell) or if it
30     -- results from  an interference (block of faces).
31     -- The result of the algorithm is an iteration on areas.
32     -- An area is described by a set of Loops. 
33     
34 uses
35     LoopSet from BOP,
36     LoopClassifier from BOP
37
38 is
39
40     Create returns Area3dBuilder from BOP;
41         ---Purpose:  
42         --- Empty  Constructor 
43         ---
44     Create(LS:out LoopSet from BOP;
45            LC:out LoopClassifier from BOP;
46            ForceClass: Boolean from Standard = Standard_False)
47         returns Area3dBuilder from BOP;
48         ---Purpose:  
49         --- Creates an  object to build solids on
50         --- the (shells,  blocks of faces) of <LS>,  
51         --- using the classifier <LC>. 
52         ---
53     
54     InitAreaBuilder(me:                in out;
55                     LS:out LoopSet from BOP;
56                     LC:out LoopClassifier from BOP;
57                     ForceClass: Boolean from Standard)
58         is redefined;
59         ---Purpose:  
60         --- Initialize the object to find the areas of
61         --- the shapes described by <LS>, 
62         --- using the classifier <LC>. 
63         ---
64     
65 end Area3dBuilder from BOP;