0022904: Clean up sccsid variables
[occt.git] / src / QANewBRepNaming / QANewBRepNaming_Loader.cdl
1 -- File:        QANewBRepNaming_Loader.cdl
2 -- Created:     Mon Oct 25 11:48:40 1999
3 -- Author:      Sergey ZARITCHNY <szy@philipox.nnov.matra-dtv.fr>
4 ---Copyright:    Matra Datavision 1999
5
6 -- Lastly modified by :
7 -- +---------------------------------------------------------------------------+
8 -- !       szy ! Added bool param. to LoadModifiedShapes !16-05-2003! 3.0-00-%L%!
9 -- +---------------------------------------------------------------------------+
10
11 class Loader from QANewBRepNaming 
12
13         ---Purpose: 
14
15 uses MakeShape      from BRepBuilderAPI, 
16      Shape          from TopoDS,  
17      Edge           from TopoDS,
18      ShapeEnum      from TopAbs, 
19      Builder        from TNaming, 
20      DataMapOfShapeShape from TopTools, 
21      MapOfShape     from TopTools,
22      Label          from TDF, 
23      TagSource      from TDF
24
25 is 
26
27     LoadGeneratedShapes (myclass; 
28                          MakeShape          : in out MakeShape from BRepBuilderAPI;
29                          ShapeIn       : in     Shape     from TopoDS;
30                          GeneratedFrom : in     ShapeEnum from TopAbs;
31                          Buider        : in out Builder   from TNaming);
32         ---Purpose :  Load in   the naming data-structure   the  shape
33         --          generated  from FACE,  EDGE, VERTEX,..., after the
34         --          MakeShape   operation.  <ShapeIn>  is  the initial
35         --          shape.   <GeneratedFrom>   defines  the   kind  of
36         --          shape generation    to    record  in   the  naming
37         --          data-structure. The <builder> is used to store the
38         --          set of evolutions in the data-framework of TDF.
39
40                          
41     LoadModifiedShapes (myclass; 
42                         MakeShape          : in out MakeShape from BRepBuilderAPI; 
43                         ShapeIn      : in     Shape     from TopoDS;
44                         ModifiedFrom : in     ShapeEnum from TopAbs;
45                         Buider       : in out Builder   from TNaming; 
46                         theBool      : Boolean from Standard = Standard_False);
47         ---Purpose  : Load in the naming data-structure the shape
48         --              modified from FACE, EDGE, VERTEX,...,
49         --              after the MakeShape operation.
50         --            <ShapeIn> is the initial shape.
51         --            <ModifiedFrom> defines the kind of shape modification
52         --              to record in the naming data-structure.
53         --            The <builder> is used to store the set of evolutions
54         --              in the data-framework of TDF.
55          
56    LoadDeletedShapes (myclass; 
57                       MakeShape          : in out MakeShape from BRepBuilderAPI; 
58                       ShapeIn            : in     Shape     from TopoDS;
59                       KindOfDeletedShape : in     ShapeEnum from TopAbs;
60                       Buider             : in out Builder   from TNaming);
61         ---Purpose : Load in the naming data-structure the shape
62         --             deleted after the MakeShape operation.
63         --           <ShapeIn> is the initial shape.
64         --           <KindOfDeletedShape> defines the kind of
65         --             deletion to record in the naming data-structure.
66         --           The <builder> is used to store the set of evolutions
67         --             in the data-framework of TDF.                   
68                       
69     LoadAndOrientGeneratedShapes (myclass;
70       MakeShape          : in out MakeShape from BRepBuilderAPI;
71       ShapeIn            : in     Shape               from TopoDS;
72       GeneratedFrom      : in     ShapeEnum           from TopAbs;
73       Buider             : in out Builder             from TNaming;
74       SubShapesOfResult  : in     DataMapOfShapeShape from TopTools);        
75       ---Purpose  : The same as LoadGeneratedShapes plus performs orientation of
76       --           loaded shapes according orientation of SubShapes
77
78
79     LoadAndOrientModifiedShapes (myclass;
80       MakeShape          : in out MakeShape from BRepBuilderAPI;
81       ShapeIn            : in     Shape               from TopoDS;
82       ModifiedFrom       : in     ShapeEnum           from TopAbs;
83       Buider             : in out Builder             from TNaming;
84       SubShapesOfResult  : in     DataMapOfShapeShape from TopTools);        
85       ---Purpose  : The same as LoadModifiedShapes plus performs orientation of
86       --            loaded shapes according orientation of SubShapes
87
88
89     ModifyPart (myclass; 
90                 PartShape  : in     Shape    from TopoDS;
91                 Primitive  : in     Shape    from TopoDS;
92                 Label      : in     Label    from TDF);
93         ---Category: Tool
94         ---Level: Internal
95     
96     HasDangleShapes(myclass; ShapeIn : in Shape from TopoDS) 
97     returns Boolean from Standard;
98
99     LoadGeneratedDangleShapes(myclass;  
100                               ShapeIn       : in     Shape from TopoDS; 
101                               GeneratedFrom : in     ShapeEnum from TopAbs; 
102                               GenBuider     : in out Builder from TNaming);  
103
104     LoadGeneratedDangleShapes(myclass;  
105                               ShapeIn       : in     Shape from TopoDS; 
106                               GeneratedFrom : in     ShapeEnum from TopAbs;  
107                               OnlyThese     : in     MapOfShape from TopTools;
108                               GenBuider     : in out Builder from TNaming); 
109
110     LoadModifiedDangleShapes(myclass;   
111                              MakeShape     : in out MakeShape from BRepBuilderAPI;
112                              ShapeIn       : in     Shape from TopoDS; 
113                              GeneratedFrom : in     ShapeEnum from TopAbs; 
114                              GenBuider     : in out Builder from TNaming); 
115
116     LoadDeletedDangleShapes(myclass;  
117                             MakeShape     : in out MakeShape from BRepBuilderAPI;
118                             ShapeIn       : in     Shape from TopoDS; 
119                             ShapeType     : in     ShapeEnum from TopAbs; 
120                             DelBuider     : in out Builder from TNaming); 
121     
122     LoadDangleShapes(myclass;  
123                      theShape : Shape from TopoDS;                   
124                      theLabelGenerator : Label from TDF); 
125
126     LoadDangleShapes(myclass;  
127                      theShape : Shape from TopoDS;      
128                      ignoredShape : Shape from TopoDS;       
129                      theLabelGenerator : Label from TDF); 
130
131     GetDangleShapes(myclass;
132                     ShapeIn : Shape from TopoDS;
133                     GeneratedFrom : ShapeEnum from TopAbs;
134                     Dangles : out DataMapOfShapeShape from TopTools)
135     ---Purpose: Returns dangle sub shapes Generator - Dangle.
136     returns Boolean from Standard;
137
138     GetDangleShapes(myclass;
139                     ShapeIn : Shape from TopoDS;
140                     GeneratedFrom : ShapeEnum from TopAbs;
141                     Dangles : out MapOfShape from TopTools)
142     ---Purpose: Returns dangle sub shapes.
143     returns Boolean from Standard;
144
145     IsDangle(myclass;
146              theDangle : Shape from TopoDS;
147              theShape : Shape from TopoDS)
148     ---Warning!: Don't use this method inside an iteration process!
149     returns Boolean from Standard;
150
151 end Loader;
152
153 -- @@SDM: begin
154
155 -- Lastly modified by : szy                                    Date : 25-10-1999
156
157 -- File history synopsis (creation,modification,correction)
158 -- +---------------------------------------------------------------------------+
159 -- ! Developer !              Comments                   !   Date   ! Version  !
160 -- +-----------!-----------------------------------------!----------!----------+
161 -- !       szy ! Creation                                !25-10-1999!3.0-00-4!
162 -- !       szy ! Removed all LoadSeparately*** methods   ! 8-05-2003! 3.0-00-%L%!
163 -- !       szy ! Added bool param. to LoadModifiedShapes !16-05-2003! 3.0-00-%L%!
164 -- +---------------------------------------------------------------------------+
165 -- Lastly modified by : szy                                    Date : 16-05-2003
166 -- @@SDM: end