0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_SolidSolid.cdl
1 -- Created on: 2001-05-25
2 -- Created by: Peter KURNEV
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
22 class SolidSolid from BOP inherits ShellSolid from BOP
23
24         ---Purpose:  
25         ---        Performs Boolean Operations  (BO)  
26         ---        Common,Cut,Fuse for solids as      
27         ---        arguments 
28         ---
29 uses 
30     DSFiller     from BOPTools, 
31      
32     WireEdgeSet  from BOP,   
33     ShellFaceSet from BOP, 
34
35     HistoryCollector from BOP,
36     IndexedDataMapOfIntegerIndexedMapOfInteger from BOPTColStd,
37     DataMapOfShapeInteger from TopTools,
38     Shape        from TopoDS,
39     State        from TopAbs,
40     
41     ListOfShape  from TopTools
42     
43     
44 is 
45     Create   
46         returns SolidSolid from BOP; 
47         ---Purpose:  
48         --- Empty constructor;
49         ---
50     DoWithFiller      (me:out; 
51              aDSF: DSFiller from BOPTools) 
52         is  redefined; 
53         ---Purpose:  
54         --- See base classes, please 
55         ---
56     Destroy (me: in out) 
57         is redefined; 
58         ---C++: alias "Standard_EXPORT virtual ~BOP_SolidSolid(){Destroy();}"  
59         ---Purpose:   
60         --- Destructor 
61         ---
62     DoNewFaces(me: out)    
63         is redefined;  
64         ---Purpose:  
65         --- See base classes, please 
66         ---
67     BuildResult (me: out)
68         is  redefined; 
69         ---Purpose:  
70         --- See base classes, please 
71         ---
72
73     SetHistoryCollector(me: in out; theHistory: HistoryCollector from BOP)
74         is redefined virtual;
75
76     --- 
77     ---              P  r  i  v  a  t  e    b  l  o  c  k   
78     ---      
79     PrepareSFS  (me:out; 
80             aFaces: ListOfShape from TopTools; 
81             aSFS  : out ShellFaceSet from BOP) 
82         is  private;         
83
84     PrepareFaceSplits(me: out)
85         is private;
86
87     PropagateFaceStateByEdges(me: in out; theFace:           Shape from TopoDS;
88                                           theMapOfEdgeIndex: DataMapOfShapeInteger from TopTools;
89                                           theState:          out State from TopAbs)
90         returns Boolean from Standard
91         is private;
92         
93     ComputeStateByInsidePoints(me: in out; theFaceIndex: Integer from Standard;
94                                            theBaseFaceIndex: Integer from Standard;
95                                            theFaceRank:  Integer from Standard;
96                                            theFFMap:     IndexedDataMapOfIntegerIndexedMapOfInteger from BOPTColStd;
97                                            theState:     out State from TopAbs)
98         returns Boolean from Standard
99         is private;
100
101     TakeOnSplit(me; theFaceIndex: Integer from Standard;
102                     theBaseFaceIndex: Integer from Standard)
103         returns Boolean from Standard
104         is private;
105
106 --fields
107 end SolidSolid;