0023024: Update headers of OCCT files
[occt.git] / src / BOPTools / BOPTools_ShapeShapeInterference.cdl
1 -- Created on: 2000-11-21
2 -- Created by: Peter KURNEV
3 -- Copyright (c) 2000-2012 OPEN CASCADE SAS
4 --
5 -- The content of this file is subject to the Open CASCADE Technology Public
6 -- License Version 6.5 (the "License"). You may not use the content of this file
7 -- except in compliance with the License. Please obtain a copy of the License
8 -- at http://www.opencascade.org and read it completely before using this file.
9 --
10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 --
13 -- The Original Code and all software distributed under the License is
14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
15 -- Initial Developer hereby disclaims all such warranties, including without
16 -- limitation, any warranties of merchantability, fitness for a particular
17 -- purpose or non-infringement. Please see the License for the specific terms
18 -- and conditions governing the rights and limitations under the License.
19
20
21
22 class ShapeShapeInterference from BOPTools 
23
24         ---Purpose: 
25         --  Root class for storing  an  Interference        
26         --  between a couple BRep shapes  
27 is
28     Create 
29         returns ShapeShapeInterference from BOPTools;  
30         ---Purpose:  
31         --- Empty constructor 
32         ---
33     Create (anIndex1:  Integer from Standard;  
34             anIndex2:  Integer from Standard)
35         returns ShapeShapeInterference from BOPTools;  
36         ---Purpose:   
37         --- Constructor 
38         ---
39     SetIndex1(me:out; anIndex1:Integer from Standard);  
40         ---Purpose:  
41         --- Modifier  
42         --- Sets DS-index for the first shape from the  couple 
43         ---
44     SetIndex2(me:out; anIndex2:Integer from Standard);   
45         ---Purpose:  
46         --- Modifier 
47         --- Sets DS-index for the second shape from the  couple  
48         ---
49     SetNewShape(me:out; anIndex:Integer from Standard);   
50         ---Purpose:  
51         --- Modifier   
52         --- Sets DS-index for the new shape 
53         ---
54     Index1(me) 
55         returns Integer from Standard;
56         ---Purpose:  
57         --- Selector  
58         ---
59     Index2(me) 
60         returns Integer from Standard;
61         ---Purpose:  
62         --- Selector  
63         ---
64     Indices(me; 
65             anIndex1:out Integer from Standard;       
66             anIndex2:out Integer from Standard); 
67         ---Purpose:  
68         --- Selector  
69         ---
70     OppositeIndex(me; 
71              anIndex:Integer from Standard) 
72         returns Integer from Standard;               
73         ---Purpose:  
74         --- Selector  
75         --- Gets the value of index 
76         --- if  anIndex==myIndex1 it returns myIndex2; 
77         --- if  anIndex==myIndex2 it returns myIndex1; 
78         --- otherwise it returns 0; 
79         ---
80     NewShape(me) 
81         returns Integer from Standard; 
82         ---Purpose:  
83         --- Selector  
84         ---
85
86 fields
87     myIndex1  : Integer from Standard; 
88     myIndex2  : Integer from Standard; 
89     myNewShape: Integer from Standard; 
90     
91 end ShapeShapeInterference;