0023024: Update headers of OCCT files
[occt.git] / src / BRepAlgo / BRepAlgo_BooleanOperations.cdl
1 -- Created on: 1993-10-14
2 -- Created by: Prestataire Mary FABIEN
3 -- Copyright (c) 1993-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22 class BooleanOperations from BRepAlgo
23
24 uses
25
26     State from TopAbs,
27     Shape from TopoDS,
28     Face from TopoDS,
29     Edge from TopoDS,
30     MapOfShape from TopTools,
31     ListOfShape from TopTools,
32     HBuilder from TopOpeBRepBuild,
33     HDataStructure from TopOpeBRepDS,
34     DSAccess from BRepAlgo
35     
36 is
37
38     Create returns BooleanOperations from BRepAlgo;
39     
40     Shapes2d(me : in out; S1,S2 : Shape from TopoDS);
41     ---Purpose: S1 is a Shell with ALL faces supported by the SAME S2 is 
42     --          an Edge INCLUDED in that surface with pcurve.
43     --          this avoids a time-consuming 3D operation, compared to Shapes.
44
45     Shapes(me : in out; S1,S2 : Shape from TopoDS);
46     ---Purpose: Defines the arguments.
47
48     SetApproxParameters(me : in out; NbPntMax : Integer from Standard;
49                                      Tol3D, Tol2D : Real from Standard;
50                                      RelativeTol : Boolean from Standard);
51     ---Purpose: Sets different parameters for the curve approximations :
52     --          NbPntMax : Maximum number of points to be approximated at
53     --                     the same time in one curve.
54     --          Tol3D, Tol2D : Tolerances to be reached by the approximation.
55     --          RelativeTol : The given tolerances are relative.
56
57     Perform(me : in out)
58     ---Purpose: Performs the global boolean operation.
59     is private ;
60
61     Perform(me : in out; State1, State2 : State from TopAbs)
62     ---Purpose: Performs the global boolean operation and build the
63     --          result in regards of the given states.
64     is private ;
65
66     Define(me : in out; S1,S2 : Shape from TopoDS;
67                         HDS : in out HDataStructure from TopOpeBRepDS);
68     ---Purpose: 
69     
70     Common(me : in out)
71     ---Purpose: returns the common part of the shapes.
72     ---C++: return const &
73     returns Shape from TopoDS;
74     
75     Fus(me : in out)
76     ---Purpose: returns the fuse part of the shapes.
77     ---C++: return const &
78     returns Shape from TopoDS;
79     
80     Cut(me : in out)
81     ---Purpose: returns the cut part of the shapes.
82     ---C++: return const &
83     returns Shape from TopoDS;
84     
85     Section(me : in out)
86     ---Purpose: returns the intersection of the shapes.
87     ---C++: return const &
88     returns Shape from TopoDS;
89     
90     Shape(me : in out)
91     ---Purpose: returns the result of the boolean operation.
92     ---C++: return const &
93     returns Shape from TopoDS;
94
95     ShapeFrom(me : in out; S : Shape from TopoDS)
96     ---Purpose: Returns the shape(s) resulting of the boolean operation
97     --          issued from the shape <S>.
98     ---C++: return const &
99     returns Shape from TopoDS ;
100
101     Modified (me: in out; S : Shape from TopoDS)
102     ---Purpose: Returns the list of the descendant shapes of the shape <S>.
103     ---C++: return const & 
104     returns ListOfShape from TopTools ;
105
106     IsDeleted (me: in out; S : Shape from TopoDS)
107     ---Purpose: Returns the fact that the shape <S> has been deleted or not
108     --          by the boolean operation.
109     returns Boolean;
110
111     DataStructure(me) returns HDataStructure from TopOpeBRepDS;
112     ---C++: return const &
113
114     ChangeDataStructure(me : in out) returns HDataStructure from TopOpeBRepDS;
115     ---C++: return &
116
117     Builder(me) returns HBuilder from TopOpeBRepBuild;
118     ---C++: return const &
119
120     ChangeBuilder(me : in out) returns HBuilder from TopOpeBRepBuild;
121     ---C++: return &
122     --      
123     DataStructureAccess(me : in out) returns DSAccess from BRepAlgo;
124     ---Purpose: returns the member myDSA. It is useful to then access
125     --          the method GetSectionEdgeSet (wich is a member of DSAccess)
126     ---C++: return &
127
128
129 fields
130
131     myDSA : DSAccess from BRepAlgo;
132     myS1 : Shape from TopoDS;
133     myS2 : Shape from TopoDS;
134     myShape : Shape from TopoDS;
135     myMapShape : MapOfShape from TopTools;
136 --    myModified : ListOfShape from TopTools;
137     myResult : Shape from TopoDS;
138     myApproxNbPntMax : Integer from Standard;
139     myApproxTol3D : Real from Standard;
140     myApproxTol2D : Real from Standard;
141     myApproxRelativeTol : Boolean from Standard;
142
143 end BooleanOperations from BRepAlgo;