0024023: Revamp the OCCT Handle -- ambiguity
[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-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 class Offset from BRepOffset 
18
19         ---Purpose: This class compute elemenary offset surface.
20         --          Evaluate the offset generated :
21         --               1 - from a face.
22         --               2 - from an edge.
23         --               3 - from a vertex.
24 uses
25     
26     Status              from BRepOffset,
27     Shape               from TopoDS,
28     Face                from TopoDS,
29     Edge                from TopoDS,
30     Vertex              from TopoDS,
31     ListOfShape         from TopTools,
32     DataMapOfShapeShape from TopTools, 
33     Shape               from GeomAbs, 
34     JoinType            from GeomAbs
35
36 is
37
38     Create returns Offset from BRepOffset;
39
40     Create( Face   : Face from TopoDS;
41             Offset : Real from Standard;
42             OffsetOutside : Boolean from Standard = Standard_True;
43             JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
44         ---Purpose: 
45     returns Offset from BRepOffset;
46
47     Create( Face    : Face                from TopoDS;
48             Offset  : Real                from Standard;
49             Created : DataMapOfShapeShape from TopTools;
50             OffsetOutside : Boolean from Standard = Standard_True; 
51             JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
52         ---Purpose: This method will be  called when you want to share
53         --          the  edges  soon generated  from  an other  face.
54         --          e.g. when two faces are  tangents the common  edge
55         --          will generate only one edge ( no pipe).
56         --          
57         --          The Map  will be fill  as  follow: 
58         --          
59         --          Created(E) = E'
60         --          with: E  = an edge of <Face> 
61         --                E' = the image of E in the offseting  of 
62         --                     another  face  sharing E  with a
63         --                     continuity at least G1
64         --          
65     returns Offset from BRepOffset;
66
67     Create( Path      : Edge    from TopoDS;
68             Edge1     : Edge    from TopoDS;
69             Edge2     : Edge    from TopoDS;
70             Offset    : Real    from Standard;
71             Polynomial: Boolean from Standard = Standard_False; 
72             Tol       : Real    from Standard =  1.0e-4; 
73             Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
74         ---Purpose: 
75     returns Offset from BRepOffset;
76     
77     Create( Path      : Edge    from TopoDS;
78             Edge1     : Edge    from TopoDS;
79             Edge2     : Edge    from TopoDS;
80             Offset    : Real    from Standard;
81             FirstEdge : Edge    from TopoDS;
82             LastEdge  : Edge    from TopoDS;
83             Polynomial: Boolean from Standard = Standard_False; 
84             Tol       : Real    from Standard =  1.0e-4; 
85             Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
86         ---Purpose: 
87     returns Offset from BRepOffset;
88     
89     Create( Vertex    : Vertex      from TopoDS;
90             LEdge     : ListOfShape from TopTools;
91             Offset    : Real        from Standard;
92             Polynomial: Boolean     from Standard = Standard_False; 
93             Tol       : Real        from Standard =  1.0e-4; 
94             Conti     : Shape       from GeomAbs  =  GeomAbs_C1)
95         ---Purpose: Tol and Conti are only used if Polynomial is True
96         --          (Used to perfrom the approximation)
97     returns Offset from BRepOffset;
98     
99     Init( me     : in out;
100           Face   : Face from TopoDS;
101           Offset : Real from Standard;
102           OffsetOutside : Boolean from Standard = Standard_True; 
103           JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
104         ---Purpose: 
105     is static;
106     
107     Init( me      : in out;
108           Face    : Face                from TopoDS;
109           Offset  : Real                from Standard;
110           Created : DataMapOfShapeShape from TopTools; 
111           OffsetOutside : Boolean from Standard = Standard_True; 
112           JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
113         ---Purpose: 
114     is static;
115     
116     Init( me : in out;
117           Path      : Edge    from TopoDS;
118           Edge1     : Edge    from TopoDS;
119           Edge2     : Edge    from TopoDS;
120           Offset    : Real    from Standard;
121           Polynomial: Boolean from Standard = Standard_False; 
122           Tol       : Real    from Standard =  1.0e-4; 
123           Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
124         ---Purpose: 
125     is static;
126     
127     Init( me : in out;
128           Path      : Edge    from TopoDS;
129           Edge1     : Edge    from TopoDS;
130           Edge2     : Edge    from TopoDS;
131           Offset    : Real    from Standard;
132           FirstEdge : Edge    from TopoDS;
133           LastEdge  : Edge    from TopoDS;
134           Polynomial: Boolean from Standard = Standard_False; 
135           Tol       : Real    from Standard =  1.0e-4; 
136           Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
137         ---Purpose: 
138     is static;
139     
140     Init( me: in out;
141           Vertex    : Vertex      from TopoDS;
142           LEdge     : ListOfShape from TopTools;
143           Offset    : Real        from Standard;
144           Polynomial: Boolean     from Standard = Standard_False; 
145           Tol       : Real        from Standard =  1.0e-4; 
146           Conti     : Shape       from GeomAbs  =  GeomAbs_C1)
147         ---Purpose: Tol and Conti are only used if Polynomial is True
148         --          (Used to perfrom the approximation)
149     is static;
150     
151     Init( me     : in out;
152           Edge   : Edge from TopoDS;
153           Offset : Real from Standard)
154         ---Purpose: Only used in Rolling Ball. Pipe on Free Boundary
155     is static;
156
157     InitialShape(me)
158         ---C++: return const &
159         ---C++: inline
160     returns Shape from TopoDS;
161     
162         
163     Face( me)
164         ---C++: return const &
165     returns Face from TopoDS;
166
167     Generated(me; Shape : Shape from TopoDS)
168         ---Purpose: 
169     returns Shape from TopoDS;
170
171     Status( me) 
172         ---Purpose: 
173     returns Status from BRepOffset;
174
175 fields
176     
177     myShape  : Shape               from TopoDS;
178     myStatus : Status              from BRepOffset;
179     myFace   : Face                from TopoDS;
180     myMap    : DataMapOfShapeShape from TopTools;
181
182 end Offset;