0024157: Parallelization of assembly part of BO
[occt.git] / src / BRepOffset / BRepOffset_Offset.cdl
1 -- Created on: 1995-10-19
2 -- Created by: Bruno DUMORTIER
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 Offset from BRepOffset 
24
25         ---Purpose: class for the creation of Offseting.
26
27 uses
28     
29     Status              from BRepOffset,
30     Shape               from TopoDS,
31     Face                from TopoDS,
32     Edge                from TopoDS,
33     Vertex              from TopoDS,
34     ListOfShape         from TopTools,
35     DataMapOfShapeShape from TopTools, 
36     Shape               from GeomAbs, 
37     JoinType            from GeomAbs
38
39 is
40
41     Create returns Offset from BRepOffset;
42
43     Create( Face   : Face from TopoDS;
44             Offset : Real from Standard;
45             OffsetOutside : Boolean from Standard = Standard_True;
46             JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
47         ---Purpose: 
48     returns Offset from BRepOffset;
49
50     Create( Face    : Face                from TopoDS;
51             Offset  : Real                from Standard;
52             Created : DataMapOfShapeShape from TopTools;
53             OffsetOutside : Boolean from Standard = Standard_True; 
54             JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
55         ---Purpose: This method will be  called when you want to share
56         --          the  edges  soon generated  from  an other  face.
57         --          e.g. when two faces are  tangents the common  edge
58         --          will generate only one edge ( no pipe).
59         --          
60         --          The Map  will be fill  as  follow: 
61         --          
62         --          Created(E) = E'
63         --          with: E  = an edge of <Face> 
64         --                E' = the image of E in the offseting  of 
65         --                     another  face  sharing E  with a
66         --                     continuity at least G1
67         --          
68     returns Offset from BRepOffset;
69
70     Create( Path      : Edge    from TopoDS;
71             Edge1     : Edge    from TopoDS;
72             Edge2     : Edge    from TopoDS;
73             Offset    : Real    from Standard;
74             Polynomial: Boolean from Standard = Standard_False; 
75             Tol       : Real    from Standard =  1.0e-4; 
76             Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
77         ---Purpose: 
78     returns Offset from BRepOffset;
79     
80     Create( Path      : Edge    from TopoDS;
81             Edge1     : Edge    from TopoDS;
82             Edge2     : Edge    from TopoDS;
83             Offset    : Real    from Standard;
84             FirstEdge : Edge    from TopoDS;
85             LastEdge  : Edge    from TopoDS;
86             Polynomial: Boolean from Standard = Standard_False; 
87             Tol       : Real    from Standard =  1.0e-4; 
88             Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
89         ---Purpose: 
90     returns Offset from BRepOffset;
91     
92     Create( Vertex    : Vertex      from TopoDS;
93             LEdge     : ListOfShape from TopTools;
94             Offset    : Real        from Standard;
95             Polynomial: Boolean     from Standard = Standard_False; 
96             Tol       : Real        from Standard =  1.0e-4; 
97             Conti     : Shape       from GeomAbs  =  GeomAbs_C1)
98         ---Purpose: Tol and Conti are only used if Polynomial is True
99         --          (Used to perfrom the approximation)
100     returns Offset from BRepOffset;
101     
102     Init( me     : in out;
103           Face   : Face from TopoDS;
104           Offset : Real from Standard;
105           OffsetOutside : Boolean from Standard = Standard_True; 
106           JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
107         ---Purpose: 
108     is static;
109     
110     Init( me      : in out;
111           Face    : Face                from TopoDS;
112           Offset  : Real                from Standard;
113           Created : DataMapOfShapeShape from TopTools; 
114           OffsetOutside : Boolean from Standard = Standard_True; 
115           JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
116         ---Purpose: 
117     is static;
118     
119     Init( me : in out;
120           Path      : Edge    from TopoDS;
121           Edge1     : Edge    from TopoDS;
122           Edge2     : Edge    from TopoDS;
123           Offset    : Real    from Standard;
124           Polynomial: Boolean from Standard = Standard_False; 
125           Tol       : Real    from Standard =  1.0e-4; 
126           Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
127         ---Purpose: 
128     is static;
129     
130     Init( me : in out;
131           Path      : Edge    from TopoDS;
132           Edge1     : Edge    from TopoDS;
133           Edge2     : Edge    from TopoDS;
134           Offset    : Real    from Standard;
135           FirstEdge : Edge    from TopoDS;
136           LastEdge  : Edge    from TopoDS;
137           Polynomial: Boolean from Standard = Standard_False; 
138           Tol       : Real    from Standard =  1.0e-4; 
139           Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
140         ---Purpose: 
141     is static;
142     
143     Init( me: in out;
144           Vertex    : Vertex      from TopoDS;
145           LEdge     : ListOfShape from TopTools;
146           Offset    : Real        from Standard;
147           Polynomial: Boolean     from Standard = Standard_False; 
148           Tol       : Real        from Standard =  1.0e-4; 
149           Conti     : Shape       from GeomAbs  =  GeomAbs_C1)
150         ---Purpose: Tol and Conti are only used if Polynomial is True
151         --          (Used to perfrom the approximation)
152     is static;
153     
154     Init( me     : in out;
155           Edge   : Edge from TopoDS;
156           Offset : Real from Standard)
157         ---Purpose: Only used in Rolling Ball. Pipe on Free Boundary
158     is static;
159
160     InitialShape(me)
161         ---C++: return const &
162         ---C++: inline
163     returns Shape from TopoDS;
164     
165         
166     Face( me)
167         ---C++: return const &
168     returns Face from TopoDS;
169
170     Generated(me; Shape : Shape from TopoDS)
171         ---Purpose: 
172     returns Shape from TopoDS;
173
174     Status( me) 
175         ---Purpose: 
176     returns Status from BRepOffset;
177
178 fields
179     
180     myShape  : Shape               from TopoDS;
181     myStatus : Status              from BRepOffset;
182     myFace   : Face                from TopoDS;
183     myMap    : DataMapOfShapeShape from TopTools;
184
185 end Offset;