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