0023024: Update headers of OCCT files
[occt.git] / src / BRepFill / BRepFill_CompatibleWires.cdl
1 -- Created on: 1998-07-02
2 -- Created by: Joelle CHAUVET
3 -- Copyright (c) 1998-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
23 class CompatibleWires from BRepFill
24
25         ---Purpose: Constructs a sequence of Wires agreed each other 
26         --          so that the surface passing through these sections
27         --           is not twisted
28
29 uses
30
31     Edge from TopoDS, 
32     SequenceOfShape from TopTools,
33     ListOfShape from TopTools,
34     DataMapOfShapeListOfShape  from TopTools
35     
36 raises
37     ConstructionError from Standard,
38     NoSuchObject      from Standard
39
40 is
41
42     Create returns CompatibleWires from BRepFill;
43
44     Create ( Sections  :  SequenceOfShape     from TopTools)
45     returns CompatibleWires from BRepFill;
46
47     Init ( me    : in out;
48            Sections  :  SequenceOfShape     from TopTools)
49     raises
50         ConstructionError from Standard
51     is static;
52     
53     SetPercent ( me    : in out;    percent  :  Real   =  0.01)
54     is static;
55     
56     Perform (me : in out; 
57              WithRotation  :  Boolean  =  Standard_True)
58         ---Purpose: Performs  CompatibleWires According  to  the orientation
59         --          and the origin of  each other
60     raises
61         ConstructionError from Standard
62     is static;
63         
64     IsDone ( me) 
65     returns Boolean from Standard
66     is static;
67
68
69
70     Shape(me) returns SequenceOfShape from TopTools
71         ---Purpose: returns the generated sequence.
72         ---C++ : return const &
73     is static;
74     
75     GeneratedShapes (me ; SubSection : Edge from TopoDS)
76         ---Purpose: Returns   the  shapes  created  from   a  subshape
77         --          <SubSection> of a section.
78         --          
79         ---C++ : return const &          
80     returns ListOfShape from TopTools
81     is static;                   
82
83     Generated (me)
84         ---C++: return const  &
85     returns DataMapOfShapeListOfShape from TopTools
86     is static;
87     
88     SameNumberByPolarMethod (me : in out; 
89              WithRotation  :  Boolean  =  Standard_True)
90            ---Purpose:  Insert cutting  points  on  closed wires to  have same
91            --          number of edges. The sequence of shapes must
92            --          be a sequence of wires.
93     is static private;
94
95     SameNumberByACR (me : in out;  report  : Boolean from Standard )
96            ---Purpose:  Insert cutting  points  on  open wires to  have same
97            --          number of edges. The sequence of shapes must
98            --          be a sequence of wires.
99     is static private;
100
101     ComputeOrigin  (me : in out;  polar  : Boolean from Standard )
102            ---Purpose:  Computes  origins and orientation  on closed wires to
103            --          avoid twisted results. The sequence of shapes must
104            --          be a sequence of wires. <polar> must be true  
105            --          if SameNumberByPolarMethod was used before. 
106     is static private;
107
108     SearchOrigin (me : in  out)
109            ---Purpose:  Computes  origins and orientation  on open wires to
110            --          avoid twisted results. The sequence of shapes must
111            --          be a sequence of wires. 
112     
113     is static private;
114     
115 fields
116
117     myInit      : SequenceOfShape from TopTools;
118     myWork      : SequenceOfShape from TopTools;
119     myPercent   : Real   from Standard;
120     myDegen1    : Boolean   from Standard;
121     myDegen2    : Boolean   from Standard;
122     myIsDone    : Boolean   from Standard;
123     myMap       : DataMapOfShapeListOfShape from TopTools; 
124
125 end CompatibleWires;
126
127
128
129
130
131
132
133
134