0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_SolidClassifier.cdl
1 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
2 --
3 -- The content of this file is subject to the Open CASCADE Technology Public
4 -- License Version 6.5 (the "License"). You may not use the content of this file
5 -- except in compliance with the License. Please obtain a copy of the License
6 -- at http://www.opencascade.org and read it completely before using this file.
7 --
8 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
9 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
10 --
11 -- The Original Code and all software distributed under the License is
12 -- distributed on an "AS IS" basis, without warranty of any kind, and the
13 -- Initial Developer hereby disclaims all such warranties, including without
14 -- limitation, any warranties of merchantability, fitness for a particular
15 -- purpose or non-infringement. Please see the License for the specific terms
16 -- and conditions governing the rights and limitations under the License.
17
18
19 class SolidClassifier from BOP
20
21     ---Purpose: 
22     --  The  auxiliary class to classify points with 
23     --  a solid  
24     --       
25 uses 
26
27     State from TopAbs,
28     Shell from TopoDS,
29     Solid from TopoDS,
30     Pnt   from gp,
31     PSoClassif                      from BOP,
32     IndexedDataMapOfSolidClassifier from BOP,
33     Builder from BRep
34     
35 is
36
37     Create  
38         returns SolidClassifier from BOP;
39         ---Purpose:  
40         --- Empty  Constructor 
41         ---
42     Clear(me:out)  
43         is static;
44         ---Purpose:  
45         --- Clear internal state  
46         ---
47     LoadSolid(me: out;  
48             aS : Solid from TopoDS)  
49         is static;
50         ---Purpose:  
51         --- Modifier  
52         ---
53     Classify(me:out;  
54             aS : Solid from TopoDS;  
55             aP : Pnt from gp;  
56             aTol: Real from Standard) 
57     returns State from TopAbs
58         is static;
59         ---Purpose:  
60         --- Compute the position of point <P> regarding with the
61         --- geometric domain of the solid <S>.  
62         ---
63         
64
65     LoadShell(me:out;  
66             S : Shell from TopoDS) 
67          is static;
68         ---Purpose:  
69         --- Modifier  
70         ---
71     Classify(me:out;  
72             aS : Shell from TopoDS;  
73             aP : Pnt from gp;  
74             aTol : Real  from  Standard) 
75     returns State from TopAbs
76         is static;
77         ---Purpose:  
78         --- Compute the position of point <P> regarding with the
79         --- geometric domain of the shell <S>. 
80         ---
81     State(me)  
82         returns State from TopAbs
83         is static;   
84         ---Purpose: 
85         --- Returns computed 3D-State   
86         ---
87     Destroy (me:out); 
88         ---C++: alias "Standard_EXPORT virtual ~BOP_SolidClassifier(){Destroy();}"  
89         ---Purpose: 
90         --- Destructor   
91         ---
92     
93 fields
94
95     myPClassifier   : PSoClassif from BOP;  
96     myClassifierMap : IndexedDataMapOfSolidClassifier from BOP;
97     myState         : State from TopAbs;    
98     myShell         : Shell from TopoDS;
99     mySolid         : Solid from TopoDS;
100     myBuilder       : Builder from BRep;
101     
102 end SolidClassifier from BOP;