0023024: Update headers of OCCT files
[occt.git] / src / BRepAlgo / BRepAlgo_FaceRestrictor.cdl
CommitLineData
b311480e 1-- Created on: 1995-09-01
2-- Created by: Yves FRICAUD
3-- Copyright (c) 1995-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
7fd59977 21
22
23class FaceRestrictor from BRepAlgo
24
25 ---Purpose: Builds all the faces limited with a set of non
26 -- jointing and planars wires. if
27 -- <ControlOrientation> is false The Wires must have
28 -- correct orientations. Sinon orientation des wires
29 -- de telle sorte que les faces ne soient pas infinies
30 -- et qu'elles soient disjointes.
31
32uses
33 Wire from TopoDS,
34 Face from TopoDS,
35 ListOfShape from TopTools,
36 DataMapOfShapeListOfShape from TopTools
37is
38
39 Create returns FaceRestrictor from BRepAlgo;
40
41 Init (me : in out;
42 F : Face from TopoDS;
43 Proj : Boolean from Standard = Standard_False;
44 ControlOrientation : Boolean from Standard = Standard_False)
45 ---Purpose: the surface of <F> will be the the surface of each new
46 -- faces built.
47 -- <Proj> is used to update pcurves on edges if necessary.
48 -- See Add().
49 is static;
50
51 Add( me : in out;
52 W : in out Wire from TopoDS)
53 ---Purpose: Add the wire <W> to the set of wires.
54 --
55 -- Warning:
56 -- The Wires must be closed.
57 --
58 -- The edges of <W> can be modified if they have not pcurves
59 -- on the surface <S> of <F>. In this case
60 -- if <Proj> is false the first pcurve of the edge
61 -- is positionned on <S>.
62 -- if <Proj> is True ,the Pcurve On <S> is the
63 -- projection of the curve 3d on <F>.
64 is static;
65
66 Clear(me : in out)
67 ---Purpose: Removes all the Wires
68 is static;
69
70 Perform( me : in out)
71 ---Purpose: Evaluate all the faces limited by the set of Wires.
72 is static;
73
74 IsDone( me)
75 returns Boolean from Standard
76 is static;
77
78 More( me)
79 returns Boolean from Standard
80 is static;
81
82 Next( me : in out)
83 is static;
84
85 Current(me)
86 returns Face from TopoDS
87 is static;
88
89 PerformWithCorrection( me : in out)
90 ---Purpose: Evaluate all the faces limited by the set of Wires.
91 is static private;
92
93fields
94
95 myDone : Boolean from Standard;
96 modeProj : Boolean from Standard;
97 myFace : Face from TopoDS;
98 wires : ListOfShape from TopTools;
99 faces : ListOfShape from TopTools;
100
101 myCorrection : Boolean from Standard;
102 keyIsIn : DataMapOfShapeListOfShape from TopTools;
103 keyContains : DataMapOfShapeListOfShape from TopTools;
104
105end FaceRestrictor;
106