0023024: Update headers of OCCT files
[occt.git] / src / BRepOffset / BRepOffset_Analyse.cdl
1 -- Created on: 1995-10-20
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
21
22
23 class Analyse from BRepOffset 
24
25         ---Purpose: Analyse of a shape consit to
26         --          Find the part of edges convex concave tangent.
27
28 uses
29
30     Shape                            from TopoDS,
31     Face                             from TopoDS,
32     Edge                             from TopoDS,
33     Vertex                           from TopoDS,
34     Compound                         from TopoDS,
35     IndexedDataMapOfShapeListOfShape from TopTools,
36     ListOfShape                      from TopTools,
37     MapOfShape                       from TopTools,
38     Interval                         from BRepOffset,
39     ListOfInterval                   from BRepOffset,
40     DataMapOfShapeListOfInterval     from BRepOffset,
41     Type                             from BRepOffset
42     
43 is
44     Create;
45     
46     Create (S         : Shape  from TopoDS  ;
47             Angle     : Real   from Standard) 
48     returns Analyse from BRepOffset;
49     
50     Perform (me        : in out ;
51              S         : Shape  from TopoDS  ;
52              Angle     : Real   from Standard)   
53     is static;
54             
55     IsDone (me) 
56     returns Boolean from Standard
57     is static;
58
59     Clear(me : in out)
60     is static;
61
62     Type (me; E : Edge from TopoDS) 
63         ---C++: return const&
64     returns  ListOfInterval from BRepOffset
65     is static;
66     
67     Edges (me; 
68            V :        Vertex      from TopoDS; 
69            T :        Type        from BRepOffset;
70            L : in out ListOfShape from TopTools)
71         ---Purpose: Stores in <L> all the edges of Type <T>
72         --          on the vertex <V>.
73     is static;
74     
75     Edges (me; 
76            F :        Face        from TopoDS; 
77            T :        Type        from BRepOffset;
78            L : in out ListOfShape from TopTools)
79         ---Purpose: Stores in <L> all the edges of Type <T>
80         --          on the face <F>.
81     is static;
82
83     TangentEdges(me;
84                  Edge   :        Edge        from TopoDS;
85                  Vertex :        Vertex      from TopoDS;
86                  Edges  : in out ListOfShape from TopTools)
87         ---Purpose: set in <Edges> all  the Edges of <Shape> which are
88         --          tangent to <Edge> at the vertex <Vertex>.
89     is static;                           
90
91     HasAncestor (me ; S : Shape from TopoDS)
92     returns Boolean from Standard
93     is static;
94     
95     Ancestors (me ; S : Shape from TopoDS)
96     ---C++: return const &
97     returns ListOfShape from TopTools
98     is static;
99     
100     Explode (me;
101              L    : in out ListOfShape from TopTools;
102              Type : in     Type        from BRepOffset) 
103         ---Purpose: Explode in compounds of faces where
104         --          all the connex edges are of type <Side>
105     is static;
106
107     Explode (me;
108              L     : in out ListOfShape from TopTools;
109              Type1 : in     Type        from BRepOffset; 
110              Type2 : in     Type        from BRepOffset) 
111         ---Purpose: Explode in compounds of faces where
112         --          all the connex edges are of type <Side1> or <Side2>
113     is static;
114
115     AddFaces(me;
116              Face :        Face       from TopoDS;
117              Co   : in out Compound   from TopoDS;
118              Map  : in out MapOfShape from TopTools;
119              Type : in     Type       from BRepOffset) 
120         ---Purpose: Add in <CO> the faces of the shell containing <Face>
121         --          where all the connex edges are of type <Side>.
122     is static;
123
124     AddFaces(me;
125              Face  :        Face       from TopoDS;
126              Co    : in out Compound   from TopoDS;
127              Map   : in out MapOfShape from TopTools;
128              Type1 : in     Type       from BRepOffset;
129              Type2 : in     Type       from BRepOffset) 
130         ---Purpose: Add in <CO> the faces of the shell containing <Face>
131         --          where all the connex edges are of type <Side1> or <Side2>.
132
133     is static;
134
135 fields
136
137     myDone      : Boolean                          from Standard;
138     myShape     : Shape                            from TopoDS;
139     mapEdgeType : DataMapOfShapeListOfInterval     from BRepOffset;
140     ancestors   : IndexedDataMapOfShapeListOfShape from TopTools;
141     angle       : Real                             from Standard;
142     
143 end Analyse;