0024624: Lost word in license statement in source files
[occt.git] / src / BRepAlgo / BRepAlgo_BooleanOperation.cdl
1 -- Created on: 1993-10-14
2 -- Created by: Remi LEQUETTE
3 -- Copyright (c) 1993-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 deferred class BooleanOperation from BRepAlgo inherits MakeShape from BRepBuilderAPI
18
19         ---Purpose:  The abstract class BooleanOperation is the root
20         -- class of Boolean operations.
21         -- A BooleanOperation object stores the two shapes in
22         -- preparation for the Boolean operation specified in
23         -- one of the classes inheriting from this one. These include:
24         -- - Common
25         -- - Cut
26         -- - Fuse
27         -- - Section.
28
29 uses
30
31     State from TopAbs,
32     Shape from TopoDS,
33     Face from TopoDS,
34     Edge from TopoDS,
35     MapOfShape from TopTools,
36     DataMapOfShapeShape from TopTools,
37     ListOfShape from TopTools,
38     HBuilder from TopOpeBRepBuild,
39     ShapeModification from BRepBuilderAPI
40     
41 is
42
43     Initialize (S1,S2 : Shape from TopoDS);
44     ---Purpose: Prepares the operations for S1 and S2.
45
46 --modified by NIZNHY-PKV Sun Dec 15 17:16:48 2002  f     
47     Delete(me:  out)   
48         is  redefined  virtual; 
49     ---C++:  alias  "Standard_EXPORT virtual ~BRepAlgo_BooleanOperation() {Delete();}"
50 --modified by NIZNHY-PKV Sun Dec 15 17:16:51 2002  t
51
52     PerformDS(me : in out)
53     ---Purpose: 
54     ---Level: Public
55     is static;
56
57     Perform(me : in out; St1,St2 : State from TopAbs)
58     ---Level: Public
59     is static;
60     
61     Builder(me) returns HBuilder from TopOpeBRepBuild
62     ---Level: Advanced
63     is static;
64     
65     Shape1(me) returns Shape from TopoDS
66     ---Purpose: Returns the first shape involved in this Boolean operation.
67     ---C++: return const &
68     ---Level: Public
69     is static;
70
71     Shape2(me) returns Shape from TopoDS
72     ---Purpose: Returns the second shape involved in this Boolean operation.
73     ---C++: return const &
74     ---Level: Public
75     is static;
76     
77     BuilderCanWork(me : in out; B : Boolean from Standard)
78     is protected;
79     
80     BuilderCanWork(me) returns Boolean from Standard
81     is protected;
82     
83        
84     InitParameters(me : out)
85     ---Purpose: 
86     ---Level: Private
87     is virtual protected;
88
89 ---Category: Querying
90
91     Modified (me: in out; S : Shape from TopoDS)
92         ---Purpose: Returns the list  of shapes modified from the shape
93         --          <S>. 
94         ---C++: return const & 
95         ---Level: Public
96     returns ListOfShape from TopTools
97     is redefined virtual;
98
99
100     IsDeleted (me: in out; S : Shape from TopoDS)
101     returns Boolean
102     is redefined virtual;
103
104
105 fields
106
107     myHBuilder : HBuilder    from TopOpeBRepBuild is protected;
108     myS1 : Shape from TopoDS is protected;
109     myS2 : Shape from TopoDS is protected;
110     myMap : MapOfShape from TopTools;
111     myBuilderCanWork : Boolean from Standard;    
112     topToSew      : DataMapOfShapeShape from TopTools;
113     
114 end BooleanOperation;