]> SALOME platform Git repositories - modules/geom.git/blob - src/NMTAlgo/NMTAlgo_Splitter.cdl
Salome HOME
Change comments style in geompy.py for right processing with HappyDoc
[modules/geom.git] / src / NMTAlgo / NMTAlgo_Splitter.cdl
1 -- File:        NMTAlgo_Splitter.cdl
2 -- Created:     Tue Jan 27 15:09:45 2004
3 -- Author:      Peter KURNEV
4 --              <pkv@irinox>
5 ---Copyright:    Matra Datavision 2004
6
7
8 class Splitter from NMTAlgo  
9     inherits Builder from NMTAlgo 
10
11         ---Purpose: 
12
13 uses  
14     Builder             from BRep,
15     ShapeEnum           from TopAbs,
16     Compound            from TopoDS,
17     Face                from TopoDS,
18     Edge                from TopoDS,
19     Shape               from TopoDS,
20     MapOfOrientedShape  from TopTools,
21     IndexedMapOfShape   from TopTools,
22     DataMapOfShapeShape from TopTools,
23     ListOfShape         from TopTools,
24     MapOfShape          from TopTools,
25     AsDes               from BRepAlgo,
26     Image               from BRepAlgo, 
27      
28     DSFiller from NMTTools
29
30 --raises
31
32 is 
33     Create 
34         returns Splitter from NMTAlgo;  
35     ---C++: alias "Standard_EXPORT virtual ~NMTAlgo_Splitter();" 
36
37     AddShape (me:out;  
38             S : Shape from TopoDS) 
39         is virtual;
40      
41     AddTool (me:out;  
42             S : Shape from TopoDS) 
43         is virtual;  
44      
45     Compute(me:out) 
46         is virtual; 
47
48     Build (me:out; 
49             aLimit:ShapeEnum from TopAbs=TopAbs_SHAPE) 
50         is virtual; 
51   
52     ComputeWithFiller(me:out; 
53         aDSF: DSFiller from NMTTools) 
54         is redefined;  
55      
56 ----vv 
57     KeepShapesInside (me:out;  
58             S : Shape from TopoDS);
59         ---Purpose: remove shapes that are outside of S from result.
60         --          S should be an object shape.
61         ---Warning: call it after Build()
62
63     RemoveShapesInside (me:out;  
64             S : Shape from TopoDS);
65         ---Purpose: remove shapes that are inside S from result.
66         --          S should be an object shape.
67         ---Warning: call it after Build()
68
69     Modified(me:out;  
70             S : Shape from TopoDS) 
71         returns ListOfShape from TopTools;
72     ---Purpose: Returns the list  of shapes modified from the shape <S>. 
73     ---C++: return const & 
74     ---Level: Public
75
76     Generated(me:out;  
77             S : Shape from TopoDS) 
78         returns ListOfShape from TopTools;
79     ---Purpose: Returns the list of shapes generated from the shape <S>. 
80     ---C++: return const & 
81     ---Level: Public
82
83     IsDeleted (me:out;  
84             S : Shape from TopoDS)
85        returns Boolean  from  Standard;
86 ----^^
87
88     Clear (me:out) 
89         is redefined; 
90
91     SourceShapes(me) 
92         returns ListOfShape from TopTools; 
93     ---C++: return const &   
94      
95     FillResult(me:out) 
96         is protected; 
97      
98     FillImageShape(me:out) 
99         is protected; 
100          
101     SplittedFaces (me:out) 
102         is protected; 
103          
104     SplittedWires (me:out) 
105         is protected;   
106      
107     SplitsAndSections (me:out) 
108         is protected;    
109      
110     ShellsAndSolids(me:out) 
111         is protected;  
112         
113     MakeShells(me:out; 
114             aS  :Shape from TopoDS; 
115             aLNS:out ListOfShape from TopTools) 
116         is protected;  
117          
118     MakeSolids (me:out;  
119             Solid : Shape from TopoDS;
120             Shells: out ListOfShape from TopTools) 
121         is protected;   
122
123     FindFacesInside (me:out;  
124             S : Shape from TopoDS;
125             CheckClosed : Boolean from Standard= Standard_False;
126             All         : Boolean from Standard= Standard_False) 
127         returns Shape from TopoDS  
128         is protected;
129      
130     IsInside (myclass;  
131             S1,S2 : Shape from TopoDS)
132         returns Boolean from Standard is protected;   
133         ---Purpose: Return True if the first vertex of S1 inside S2.
134         --          If S1.IsNull(), check infinite point against S2.
135
136     GetOriginalShape(me;  
137             aShape : Shape from TopoDS)
138         returns Shape from TopoDS  
139         is protected;  
140                 
141 fields 
142     myDoneStep     : ShapeEnum           from TopAbs is protected;   -- rebuilt level
143     myBuilder      : Builder             from BRep   is protected;
144                                            
145     myListShapes   : ListOfShape         from TopTools is protected; -- object shapes
146     myMapFaces     : MapOfShape          from TopTools is protected; -- object faces
147     myMapTools     : MapOfShape          from TopTools is protected; -- tool faces
148     myEqualEdges   : MapOfShape          from TopTools is protected; -- equal splits
149     myNewSection   : MapOfShape          from TopTools is protected; -- new secton edges
150     myClosedShapes : MapOfShape          from TopTools is protected;
151     myWrappingSolid: MapOfShape          from TopTools is protected; -- solids having other shapes inside
152     myFaceShapeMap : DataMapOfShapeShape from TopTools is protected; -- to find a shape by face
153                                            
154     myInternalFaces: DataMapOfShapeShape from TopTools is protected; -- shape and its internal faces
155     myIntNotClFaces: DataMapOfShapeShape from TopTools is protected; -- internal but not closed 
156
157     myImageShape   : Image               from BRepAlgo is protected;
158
159     -- avoid rebuilding twice commont part of solids
160     myAddedFacesMap: MapOfOrientedShape  from TopTools is protected; 
161     --***-- 
162     mySourceShapes : ListOfShape         from TopTools is protected;  
163     myLimit        : ShapeEnum           from TopAbs   is protected; 
164     myToolShapes   : MapOfShape          from TopTools is protected;        
165     myObjShapes    : MapOfShape          from TopTools is protected; 
166     myMapSIFC      : DataMapOfShapeShape from TopTools is protected;  
167 ----vv    
168     myGenerated    : ListOfShape         from TopTools is protected;
169 ----^^
170 end Splitter;