0024927: Getting rid of "Persistent" functionality -- Code
[occt.git] / src / MgtBRep / MgtBRep_TranslateTool1.cdl
1 -- Created by: DAUTRY Philippe
2 -- Copyright (c) 1998-1999 Matra Datavision
3 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
4 --
5 -- This file is part of Open CASCADE Technology software library.
6 --
7 -- This library is free software; you can redistribute it and/or modify it under
8 -- the terms of the GNU Lesser General Public License version 2.1 as published
9 -- by the Free Software Foundation, with special exception defined in the file
10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 -- distribution for complete text of the license and disclaimer of any warranty.
12 --
13 -- Alternatively, this file may be used under the terms of Open CASCADE
14 -- commercial license or contractual agreement.
15
16 --              --------------------------
17
18 ---Version:     0.0
19 --Version       Date            Purpose
20 --              0.0     Feb  3 1998     Creation
21
22
23 class TranslateTool1 from MgtBRep inherits TranslateTool1 from MgtTopoDS
24
25         ---Purpose: The TranslateTool1 class is provided to support the
26         --          translation of BRep topological data structures.
27         --          Used to call the MgtTopoDS methods.
28 uses
29
30     TransientPersistentMap from PTColStd,
31     PersistentTransientMap from PTColStd,
32     CurveRepresentation    from PBRep,
33     CurveRepresentation    from BRep,
34     Curve                  from Geom,
35     Curve                  from PGeom,
36     Curve                  from Geom2d,
37     Curve                  from PGeom2d,
38     Surface                from Geom,
39     Surface                from PGeom,
40     Shape                  from TopoDS,
41     Shape1                 from PTopoDS,
42     TriangleMode           from MgtBRep
43
44 raises
45     TypeMismatch from Standard
46
47 is
48
49     Create(aTriMode : TriangleMode from MgtBRep)
50     returns TranslateTool1 from MgtBRep;
51         ---Purpose: Creates a new TranslateTool1
52
53     --
54     --     Auxiliairy Protected Methods for Shape Geometrical Rep
55     --     
56
57     Translate(me;
58               TC : Curve                         from Geom;
59               M  : in out TransientPersistentMap from PTColStd)
60     returns Curve from PGeom
61     is protected;
62     ---Purpose: Translates a Transient Curve onto a Persistent Curve
63
64     Translate(me;
65               PC : Curve                         from PGeom;
66               M  : in out PersistentTransientMap from PTColStd)
67     returns Curve from Geom
68     is protected;
69     ---Purpose: Translates a Persistent Curve onto a Transient Curve
70
71
72     Translate(me;
73               TC : Curve                         from Geom2d;
74               M  : in out TransientPersistentMap from PTColStd)
75     returns Curve from PGeom2d
76     is protected;
77     ---Purpose: Translates a Transient Curve2d onto a Persistent Curve
78
79     Translate(me;
80               PC : Curve                         from PGeom2d;
81               M  : in out PersistentTransientMap from PTColStd)
82     returns Curve from Geom2d
83     is protected;
84     ---Purpose: Translates a Persistent Curve2d onto a Transient Curve
85     
86
87     Translate(me;
88               TS : Surface                       from Geom;
89               M  : in out TransientPersistentMap from PTColStd)
90     returns Surface from PGeom
91     is protected;
92     ---Purpose: Translates a Transient Surface onto a Persistent Curve
93
94     Translate(me;
95               PS : Surface                       from PGeom;
96               M  : in out PersistentTransientMap from PTColStd)
97     returns Surface from Geom
98     is protected;
99     ---Purpose: Translates a Persistent Surface onto a Transient Curve
100         
101     --         
102     --     The Add method is used to insert a shape in an other shape.
103     --     
104     
105     Add(me;
106         S1 : in out Shape from TopoDS;
107         S2 : Shape from TopoDS)
108         ---Level: Internal 
109     raises
110         TypeMismatch from Standard;
111     
112     --
113     --       The Make methods should create a new empty  object of the
114     --       given type with  the given Model.   They should raise the
115     --       TypeMismatch   exception  if  the Model   is  not of  the
116     --       expected type.
117     --       
118
119
120     MakeVertex(me; S : in out Shape from TopoDS) 
121         ---Level: Internal 
122     raises
123         TypeMismatch from Standard;
124     
125     MakeVertex(me; S : in out Shape1 from PTopoDS) 
126         ---Level: Internal 
127     raises
128         TypeMismatch from Standard;
129     
130     MakeEdge(me; S : in out Shape from TopoDS) 
131         ---Level: Internal 
132     raises
133         TypeMismatch from Standard;
134     
135     MakeEdge(me; S : in out Shape1 from PTopoDS) 
136         ---Level: Internal 
137     raises
138         TypeMismatch from Standard;
139     
140     MakeWire(me; S : in out Shape from TopoDS) 
141         ---Level: Internal 
142     raises
143         TypeMismatch from Standard;
144     
145     MakeWire(me; S : in out Shape1 from PTopoDS) 
146         ---Level: Internal 
147     raises
148         TypeMismatch from Standard;
149     
150     MakeFace(me; S : in out Shape from TopoDS) 
151         ---Level: Internal 
152     raises
153         TypeMismatch from Standard;
154     
155     MakeFace(me; S : in out Shape1 from PTopoDS) 
156         ---Level: Internal 
157     raises
158         TypeMismatch from Standard;
159     
160     MakeShell(me; S : in out Shape from TopoDS) 
161         ---Level: Internal 
162     raises
163         TypeMismatch from Standard;
164     
165     MakeShell(me; S : in out Shape1 from PTopoDS) 
166         ---Level: Internal 
167     raises
168         TypeMismatch from Standard;
169     
170     MakeSolid(me; S : in out Shape from TopoDS) 
171         ---Level: Internal 
172     raises
173         TypeMismatch from Standard;
174     
175     MakeSolid(me; S : in out Shape1 from PTopoDS) 
176         ---Level: Internal 
177     raises
178         TypeMismatch from Standard;
179     
180     MakeCompSolid(me; S : in out Shape from TopoDS) 
181         ---Level: Internal 
182     raises
183         TypeMismatch from Standard;
184     
185     MakeCompSolid(me; S : in out Shape1 from PTopoDS) 
186         ---Level: Internal 
187     raises
188         TypeMismatch from Standard;
189     
190     MakeCompound(me; S : in out Shape from TopoDS) 
191         ---Level: Internal 
192     raises
193         TypeMismatch from Standard;
194     
195     MakeCompound(me; S : in out Shape1 from PTopoDS) 
196         ---Level: Internal 
197     raises
198         TypeMismatch from Standard;
199     
200     --
201     --     The Update methods should transfer the data from  the first
202     --     shape to the second.
203     --     
204     --     When an update method  is redefined it  should transfer the
205     --     data then call the Update  redefined method to transfer the
206     --     inherited data.
207     --     
208     
209     UpdateVertex(me;
210                  S1 : Shape from TopoDS;
211                  S2 : in out Shape1 from PTopoDS;
212                  M  : in out TransientPersistentMap from PTColStd)
213         ---Level: Internal 
214     is redefined;
215     
216     UpdateVertex(me;
217                  S1 : Shape1 from PTopoDS;
218                  S2 : in out Shape from TopoDS;
219                  M  : in out PersistentTransientMap from PTColStd)
220         ---Level: Internal 
221     is redefined;
222     
223     UpdateEdge(me;
224                S1 : Shape  from TopoDS;
225                S2 : in out Shape1 from PTopoDS;
226                M  : in out TransientPersistentMap from PTColStd)
227         ---Level: Internal 
228     is redefined;
229     
230     UpdateEdge(me;
231                S1 : Shape1 from PTopoDS;
232                S2 : in out Shape from TopoDS;
233                M  : in out PersistentTransientMap from PTColStd)
234         ---Level: Internal 
235     is redefined;
236     
237     UpdateFace(me;
238                S1 : Shape  from TopoDS;
239                S2 : in out Shape1 from PTopoDS;
240                M  : in out TransientPersistentMap from PTColStd)
241         ---Level: Internal 
242     is redefined;
243     
244     UpdateFace(me;
245                S1 : Shape1 from PTopoDS;
246                S2 : in out Shape from TopoDS;
247                M  : in out PersistentTransientMap from PTColStd)
248         ---Level: Internal 
249     is redefined;
250
251 fields
252
253     myTriangleMode       : TriangleMode   from MgtBRep;
254     
255 end TranslateTool1;