8ed3c762c22a57fa6b9974246e7aaf4c6a82e2db
[occt.git] / src / BOP / BOP_Loop.cdl
1 -- File:        BOP_Loop.cdl
2 -- Created:     Tue Dec 19 19:44:23 1995
3 -- Author:      Jean Yves LEBEY
4 --              <jyl@meteox>
5 ---Copyright:    Matra Datavision 1995
6
7 class Loop from BOP inherits TShared from MMgt
8
9     ---Purpose: 
10     --         A Loop is an existing shape (Shell,Wire) or a set
11     --         of shapes (Faces,Edges) which are connex.
12     --         a set of connex shape is represented by a BlockIterator
13
14 uses
15
16     Shape from TopoDS,
17     BlockIterator from BOP,
18     ShapeEnum from TopAbs
19
20 is
21
22     Create(S : Shape from TopoDS)  
23         returns mutable Loop;
24         ---Purpose:  
25         --- Creates the object using the  shape S;  
26         ---
27     Create(BI : BlockIterator from BOP)  
28         returns mutable Loop;
29         ---Purpose:  
30         --- Creates the object using the BlockIterator BI;  
31         ---
32     IsShape(me)  
33         returns Boolean from Standard  
34         is virtual;
35         ---Purpose:  
36         --- Returns TRUE if the object was created using shape    
37         ---
38     Shape(me)  
39         returns Shape from TopoDS  
40         is virtual;
41         ---C++: return const & 
42         ---Purpose: 
43         --- Returns Shape from which  the object was created
44         --- Valid only when IsShape() is TRUE
45         ---
46     BlockIterator(me)  
47         returns BlockIterator  
48         is static;
49         ---C++: return const & 
50         --- Returns BlockIterator from which the object was created
51         --- Valid only when IsShape() is FALSE
52         ---
53
54 fields
55     myIsShape       : Boolean from Standard   
56         is protected;
57     myShape         : Shape from TopoDS       
58         is protected;
59     myBlockIterator : BlockIterator from BOP  
60         is protected;
61
62 end Loop from BOP;